Service Guides for ResourceIQ

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

Create a Contact Assignment

After you have created your contact (POST /{custid}/contact), you can assign your contact to a system entity that is either within EBSCO-KB or external to EBSCO-KB. A system entity is an EBSCO-KB entity such as a provider, package or package-title or an external URI. The request will yield an assignment id for the assignment.

To Assign a Contact to a System Entity (example):

Gather the following information for the request:

  • The customer ID and the API Key.
  • The contact ID for the contact that you would like to create the assignment for. This will be the object id parameter.
  • The assignment object. The assignment object defines the access, assignment details and the system entity link for the assignment.

Request

POST https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/assignment/OBJECTID
Body Request Parameter

{
  "access": "allow",
  "assignmentContext": "assignmentContext",
  "assignmentType": "sample_assignment_type",
  "extensionObject": {
    "objectDescription": "Sample description",
    "objectType": "contact"
  },
  "link": {
    "application": {
      "name": "test application",
      "softwareVersion": "version 2.1"
    },
    "description": "test description",
    "url": "http://hostnametest.com"
  },
  "relativeUrl": "http://hostnametest.com"
}

Response

201 Created

{
  "assignmentId": "9661a089-f518-42b6-9d69-efc1a80aa87a",
  "errors": [],
  "successful": true
}


For more information on the POST create contact assignment resource, please refer to our interactive or service reference documentation.