Service Guides for ResourceIQ

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

Create and Assign a Contact

Overview

The Contact Management Resources consist of five endpoints that allow you to create, retrieve, update and delete contacts. A contact is defined by a contact object. A contact object is a set of data elements related to a contact that are described by a JSON schema. The contact object details include such things as an email, description, name, telephone and organization. The Contact Management Resources allow you to capture contacts related to your resources so that library staff can quickly answer questions related to who to contact for various needs related to the resources.

A system entity is an EBSCO-KB or external entity such as a provider, package or package-title. An assignment maps a contact to a system entity. The Assignment Resources consist of five endpoints that allow you to create, retrieve, delete and update your contact assignments. The process to create a contact and assign it to a system entity consists of the following steps:

  1. Create the Contact
  2. Search for the Contact (optional)
  3. Update the Contact (optional)
  4. Assign the Contact

To access the Contact Management Resources and the Assignment Resources, you will need a customer ID and an API key. If you need assistance obtaining you API key, please contact EBSCO customer satisfaction.