UP Intellinet API Documentation

Owned by Jason Reel (Deactivated)
Jun 06, 2018
1 min read

Background

Based on the requirements provided by USS and Intellinet we have developed an API. The information below will assist users so they have the necessary information to use the API.


Solution

Intellinet will require a token for accessing the API which should be added as a header value in every API request. Each request should contain the following headers:
Accept: application/json
Content-Type: application/json
System-Token: 8D593885-B622-4DAE-839E-144F1125E701

There are two API calls required to pull the data back:

  • POST /api/unit/search
    • NOTE a POST method is required for this call
    • This method returns all added or changed units that were added/changed within the date range provided
    • The date of the add/update is listed as LastModifiedDate on the unit object
  • GET /api/unit/all-deleted
    • The date of the deletion is listed as DeletedTime on the unit object

The links above provide the documentation required to make the requests. I've also added a few additional notes to the links.

The results map to the requested fields as follows:

  • Term/Unit GUID – UnitId
  • Term/Unit Name – Name
  • Termset Name – requires additional call to GET /api/unit/{unit ID}/division to retrieve the command/division info
  • Term group name – should be "Units" for all units
  • CRUD operations – this should be determined based on the status in the target system. If the unit exists (checked by querying on unit ID), it should be an update. Otherwise, it's an add. Delete operations are grouped into a separate API endpoint (see "all-deleted" api endpoint noted above).
  • Parent GUID – ParentUnitId
  • From date – LastModifiedDate or DeletedTime depending on API endpoint used