Service Guides for ResourceIQ

Investigate use cases. Find sample scenarios. Learn how your applications can best use ResourceIQ.

Retrieve Contact, License, External Document Reference or Admin Access Details from a Transaction

After you have retrieved the transactions for your contacts, licenses, external document references, or administrative access details (GET /{custid}/transactions), you can search for the contact, license, external document reference or administrative access details referenced in each transaction. The search will yield the extension object that you have requested, any errors and a success flag.

For this example, the extension type contact and transaction type update was used. The retrieve transactions endpoint (GET /{custid}/transactions) yields a list of transactions. Each transaction contains the transaction id, customer id, transaction type, extension type, extension object id and the date of the transaction. A transaction from our example is below.

{
  "transactionId": 215869,
  "customerId": "123355",
  "transactionType": "UPDATE",
  "extensionType": "CONTACT",
  "objectId": "065cb541-681c-4dd9-a059-e78b72e31bc4",
  "dateCreated": "2019-01-17T18:52:59.000Z"
}

To Search for the Contact from the Transaction (example):

Gather the following information for the request:

  • The customer ID and the API Key.
  • The objectid from the transaction. This will be the ID parameter in the GET contact by id request.

Request

GET https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/contact/ID

Response


200 OK

{
  "errors": [],
  "contact": {
    "extensionObject": {
      "id": "065cb541-681c-4dd9-a059-e78b72e31bc4",
      "customerId": "123355",
      "status": "active",
      "objectType": "contact",
      "objectDescription": "This is a contact object."
    },
    "contactPoint": {
      "name": "John Frederick",
      "telephone": "1234567890",
      "contactType": "Sales",
      "email": "jFrederick@ebsco.com",
      "description": "This contact point is for a salesperson at EBSCO.  Updated Contact"
    },
    "organization": {
      "name": "EBSCO Publishing",
      "address": {
        "streetAddress": "1600 Amphitheatre Pkwy",
        "addressLocality": "Mountain View",
        "addressRegion": "CA",
        "addressCountry": "USA",
        "postalCode": "94043"
      }
    },
    "contact": {
      "designation": "sample designation"
    },
    "dateCreated": "2019-01-17T16:32:34.000Z",
    "dateLastUpdated": "2019-01-17T18:53:00.000Z"
  },
  "successful": true
}

We used the contact extension type in this example, but you can also gather the transactions for the license, external document references or administrative access details extension types. Then, use the corresponding GET endpoint to retrieve the extension object:

GET /{custid}/license/{licenseid}
GET /{custid}/adminaccess/{id}
GET /{custid}/externaldocument/{id}

For more information on the ResourceIQ service, please refer to our interactive or service reference documentation.