Arlo

REST Auth API: ContactMergeRequests

ContactMergeRequests resources describe details of completed merges between two Contact resources. Merge requests are executed by administrator to resolve duplicate resources by merging details from a source contact into a target destination contact. At the end of the operation, the source contact is effecitvely deleted.

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

After a merge is completed, HTTP GET requests to the URI of the source (deleted) contact will return a HTTP 308 Permanent Redirect status with headers referring to the merged contact URI and the original ContactMergeRequest.

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

ContactMergeRequests instance resource

Resource URI

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

General structure

<ContactMergeRequest>
  <RequestID>3176d891-25e8-4741-9a37-08fa0dd6ad20</RequestID>
  <SourceContactInfo>
    <ContactID>13265</ContactID>
    <UniqueIdentifier>dbeeb7b2-12de-4f26-9b1c-48454a3bb69d</UniqueIdentifier>
  </SourceContactInfo>
  <DestinationContactInfo>
    <ContactID>13390</ContactID>
    <UniqueIdentifier>41326d7d-2edd-4eb5-b176-2f408693b8fc</UniqueIdentifier>
  </DestinationContactInfo>
  <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/contactmergerequests/3176d891-25e8-4741-9a37-08fa0dd6ad20/" />
</ContactMergeRequest>

Resource properties

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

HTTP GET

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

Example

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

<ContactMergeRequest>
  <RequestID>3176d891-25e8-4741-9a37-08fa0dd6ad20</RequestID>
  <SourceContactInfo>
    <ContactID>13265</ContactID>
    <UniqueIdentifier>dbeeb7b2-12de-4f26-9b1c-48454a3bb69d</UniqueIdentifier>
  </SourceContactInfo>
  <DestinationContactInfo>
    <ContactID>13390</ContactID>
    <UniqueIdentifier>41326d7d-2edd-4eb5-b176-2f408693b8fc</UniqueIdentifier>
  </DestinationContactInfo>
  <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/contactmergerequests/3176d891-25e8-4741-9a37-08fa0dd6ad20/" />
</ContactMergeRequest>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

Contact collection resource

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

Resource URI

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

HTTP GET

Returns a representation of the collection as a set of Link elements which can be followed to access individual Contact 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 ContactMergeRequest links with the default parameters, and no link expansion.

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

<ContactMergeRequests>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/Contact" type="application/xml" title="Contact" href="https://demo.arlo.co/api/2012-02-01/auth/resources/contacts/562/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/Contact" type="application/xml" title="Contact" href="https://demo.arlo.co/api/2012-02-01/auth/resources/contacts/563/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/Contact" type="application/xml" title="Contact" href="https://demo.arlo.co/api/2012-02-01/auth/resources/contacts/564/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/Contact" type="application/xml" title="Contact" href="https://demo.arlo.co/api/2012-02-01/auth/resources/contacts/565/"/>
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/contacts/?skip=100"/>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/contacts/"/>
</Contacts>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.