Arlo

REST Auth API: OrganisationMergeRequests

OrganisationMergeRequest resources describe details of completed merges between two Organisation resources. Merge requests are executed by administrators to resolve duplicate resources by merging details from a source organisation into a target destination organisation. At the end of the operation, the source organisation is effectively deleted.

OrganisationMergeRequests are important for integrators as they provide an audit trail for tracking organisations that are no longer available because they have been merged with another record. Arlo recommends that any integration with organisations also uses this resource to track changes to organisations that will no longer be available in the API.

Requests are described by details about the source and destination organisations along with the date of the request.

This resource supports retrieval of individual organisation merge request instances, collections of organisation merge requests, and creating new organisation merge requests.

OrganisationMergeRequests instance resource

Resource URI

/api/2012-02-01/auth/resources/organisationmergerequests/{RequestID}/

General structure

<OrganisationMergeRequest>
  <RequestID>3176d891-25e8-4741-9a37-08fa0dd6ad20</RequestID>
  <SourceOrganisationInfo>
    <OrganisationID>13265</OrganisationID>
    <UniqueIdentifier>dbeeb7b2-12de-4f26-9b1c-48454a3bb69d</UniqueIdentifier>
  </SourceOrganisationInfo>
  <DestinationOrganisationInfo>
    <OrganisationID>13390</OrganisationID>
    <UniqueIdentifier>41326d7d-2edd-4eb5-b176-2f408693b8fc</UniqueIdentifier>
  </DestinationOrganisationInfo>
  <CreatedDateTime>2015-05-28T17:51:51.941+12:00</CreatedDateTime>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/organisationmergerequests/3176d891-25e8-4741-9a37-08fa0dd6ad20/" />
</OrganisationMergeRequest>

Resource properties

Property Description
RequestID A GUID value that uniquely identifies this resource across any platform. This value is read-only.
SourceOrganisationInfo Structure containing information about the source organisation for the merge. This refers to the organisation that was deleted at the end of the operation.
Structure fields
  • OrganisationID: An integer value identifying the organisation.
  • UniqueIdentifier: GUID value identifying the organisation.
DestinationOrganisationInfo Structure containing information about the destination organisation for the merge. This refers to the organisation that was the final result of the merge between the two.
Structure fields
  • OrganisationID: An integer value identifying the organisation.
  • UniqueIdentifier: GUID value identifying the organisation.
CreatedDateTime A DateTime value indicating when this resource was created.

HTTP GET

Returns a representation of a OrganisationMergeRequest, including the properties above.

Example

GET /api/2012-02-01/auth/resources/organisationmergerequests/3176d891-25e8-4741-9a37-08fa0dd6ad20/

<OrganisationMergeRequest>
  <RequestID>3176d891-25e8-4741-9a37-08fa0dd6ad20</RequestID>
  <SourceOrganisationInfo>
    <OrganisationID>13265</OrganisationID>
    <UniqueIdentifier>dbeeb7b2-12de-4f26-9b1c-48454a3bb69d</UniqueIdentifier>
  </SourceOrganisationInfo>
  <DestinationOrganisationInfo>
    <OrganisationID>13390</OrganisationID>
    <UniqueIdentifier>41326d7d-2edd-4eb5-b176-2f408693b8fc</UniqueIdentifier>
  </DestinationOrganisationInfo>
  <CreatedDateTime>2015-05-28T17:51:51.941+12:00</CreatedDateTime>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/organisationmergerequests/3176d891-25e8-4741-9a37-08fa0dd6ad20/" />
</OrganisationMergeRequest>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

OrganisationMergeRequests collection resource

The OrganisationMergeRequests collection resource represents the set of OrganisationMergeRequests resources on the platform.

Resource URI

/api/2012-02-01/auth/resources/organisationmergerequests/

HTTP GET

Returns a representation of the collection as a set of Link elements which can be followed to access individual OrganisationMergeRequests resources, or link expansion can be used via the expand query parameter to inline the entities with the HTTP GET response. See querying collections for general information on handling resource collections.

Optional parameters
Parameter Description
expand Expression referencing Link elements to expand when generating the response. See link expansion.
filter A filter expression to apply to the collection. See collection filters. The following properties (and link titles) may be used in filter expressions:
  • CreatedDateTime
skip Returns a subset of records from the collection, starting at index N+1 specified by this parameter. The skip and top parameters are generally used for collection paging.
top Returns a subset of records from the collection, starting at index 0 or index skip, and returns the first N records. The skip and top parameters are generally used for collection paging.
Example 1

Retrieve a collection of OrganisationMergeRequest links with the default parameters, and no link expansion.

GET /api/2012-02-01/auth/resources/organisationmergerequests/

<OrganisationMergeRequests>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/OrganisationMergeRequest" type="application/xml" title="OrganisationMergeRequests" href="https://demo.arlo.co/api/2012-02-01/auth/resources/organisationmergerequests/2f7b5157-9fe9-443a-965c-bd0720525815/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/OrganisationMergeRequest" type="application/xml" title="OrganisationMergeRequests" href="https://demo.arlo.co/api/2012-02-01/auth/resources/organisationmergerequests/98006758-d886-41eb-a008-7b9da4c8f543/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/OrganisationMergeRequest" type="application/xml" title="OrganisationMergeRequests" href="https://demo.arlo.co/api/2012-02-01/auth/resources/organisationmergerequests/da69cbb3-64ce-47ee-88b0-ab780e723988/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/OrganisationMergeRequest" type="application/xml" title="OrganisationMergeRequests" href="https://demo.arlo.co/api/2012-02-01/auth/resources/organisationmergerequests/d5d9a4ad-e500-4f54-9e6d-23ad65e8182f/"/>
  ...
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/organisationmergerequests/"/>
</Organisations>

HTTP POST

Performs a merge of two Organisations by merging into the DestinationOrganisation and then deleting the SourceOrganisation.

The submitted OrganisationMergeRequest representation must be complete but excluding properties:

  • RequestID
  • CreatedDateTime
  • Link
Response

See HTTP response status codes for a general overview of all possible API status codes. Common response codes for POST operations are listed below.

Status Description
200 Created Resource was successfully created. The body of the response will contain a complete OrganisationMergeRequest representation.
400 Bad Request HTTP request body contains malformed or invalid parameters.

Possible exceptions Code and Message:
  • OrganisationNotFound - Organisation with ID {OrganisationId} and unique identifier {OrganisationGuid} was not found.
Example

POST /api/2012-02-01/auth/resources/organisationmergerequests/

<OrganisationMergeRequest>
  <SourceOrganisationInfo>
    <OrganisationID>13265</OrganisationID>
    <UniqueIdentifier>dbeeb7b2-12de-4f26-9b1c-48454a3bb69d</UniqueIdentifier>
  </SourceOrganisationInfo>
  <DestinationOrganisationInfo>
    <OrganisationID>13390</OrganisationID>
    <UniqueIdentifier>41326d7d-2edd-4eb5-b176-2f408693b8fc</UniqueIdentifier>
  </DestinationOrganisationInfo>
</OrganisationMergeRequest>

HTTP PUT

Not supported.

HTTP DELETE

Not supported.