{"info":{"_postman_id":"22d8c889-32b1-49e9-aec4-2b78ee31c249","name":"HSI Public API","description":"

Contained here are a set of tools to allow you to manage your organization in HSI without going through the HSI Platform UI. These tools are designed to make it possible for you to integrate data from HSI into your own systems via HTTP web requests.

In the following subsections you will find general descriptions of authorization handling, and of general request/response object formatting practices that HSI adheres to.

All request/response objects use JSON, and dates are all in UTC.

Following this section are descriptions of the actions you can perform through the HSI API, with examples.

Thank you for choosing HSI.

Authorization

Authorization is handled using an X-HSI-API-KEY. When you receive your organization's API key from HSI, you will need to add it to the header of any request sent to the HSI API.

X-HSI-API-KEY: {Your API Key}

Standard Responses

Most responses will follow this GenericResult pattern.

data contains an object with the result data from the request.
\n
error is an ErrorReturn object. It is null if the request succeeded.
\n
message is an additional message string. It is typically null.
\n
success is a boolean that is true if the request succeeded, and false otherwise.
\n

{\n    \"data\": {},\n    \"error\": null,\n    \"message\": null,\n    \"success\": true\n}\n\n

ErrorReturn objects look like the following:

type is unused, and will be null.
\n
message is a string containing the error message.
\n
httpcode is the HTTP response code of the error.
\n
exception is a largely internal field, and will always be returned with the same value.
\n
hsiErrorLogId is the ID of an error in HSI's logging database. Not all failed requests generate an error log. This value defaults to 0.
\n

{\n    \"type\": null,\n    \"message\": \"string\",\n    \"httpcode\": 400,\n    \"exception\": \"There was an error processing the request\",\n    \"hsiErrorLogId\": 0\n}\n\n

List Requests

All list requests follow a standard ListRequest pattern.

data contains an object with the specific parameters for the request.
\n
offset sets the number of results to skip. Default is 0.
\n
limit sets the maximum number of results to return. Default is 50, maximum is 500.
\n

{\n    \"data\": {},\n    \"offset\": 0,\n    \"limit\": 50\n}\n\n

Responses to list requests are also standardized as a ListResponse.

data is an array containing the specific result objects for the request.
\n
error, message, and success are the same as in GenericResult.
\n
totalResults is the count of all results that matched the search parameter. This number is not affected by offset or limit.
\n
moreResults is a boolean that returns true if the returned results did not reach the end of the totalResults.
\n
offset returns the offset value that used in the request.
\n
limit returns the limit value that used in the request.
\n

{\n    \"data\": [],\n    \"error\": null,\n    \"message\": null,\n    \"success\": true,\n    \"totalResults\": 0,\n    \"moreResults\": false,\n    \"offset\": 0,\n    \"limit\": 50\n}\n\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"12295920","collectionId":"22d8c889-32b1-49e9-aec4-2b78ee31c249","publishedId":"T1LJjTTm","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-08-07T22:25:03.000Z"},"item":[{"name":"Member","item":[{"name":"Get Member List","id":"8a1768f2-a94d-49ec-850f-9549cb6d4f8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\",\r\n \"emailAddress\": \"string\",\r\n \"address1\": \"string\",\r\n \"address2\": \"string\",\r\n \"city\": \"string\",\r\n \"state\": \"string\",\r\n \"zip\": \"string\",\r\n \"country\": \"string\",\r\n \"language\": \"string\",\r\n \"phoneNumber\": \"string\",\r\n \"active\": 0,\r\n \"metadata\": [\r\n {\r\n \"metadataFieldGuid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"teamIds\": [\r\n 0\r\n ]\r\n },\r\n \"offset\": 0,\r\n \"limit\": 50\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/member/list","description":"

Gets the list of members affiliated with your organization.

Search parameters can be passed in as a ListRequest via the body of the request. Active is the only required parameter, and can be set to 0 (Inactive), 1 (Active), or 2 (Both)

{\n    \"data\": \n    {\n        \"active\": 1\n    }\n}\n

The metadata array allows you to filter Members by your organization's custom metadata fields. You can use Get Metadata Fields List to get metadataFieldGuid values.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"f1cfb64d-90f9-44c3-a8b4-2e70a50e7795","id":"f1cfb64d-90f9-44c3-a8b4-2e70a50e7795","name":"Member","type":"folder"}},"urlObject":{"protocol":"https","path":["member","list"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"b9676c43-b333-4bb3-84d1-d122c8dff0fe","name":"Get Member List","originalRequest":{"method":"POST","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/member/list"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"memberId\": 0,\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\",\r\n \"memberName\": \"string\",\r\n \"emailAddress\": \"string\",\r\n \"alternateEmailAddress\": \"string\",\r\n \"addressLine1\": \"string\",\r\n \"addressLine2\": \"string\",\r\n \"city\": \"string\",\r\n \"stateOrRegion\": \"string\",\r\n \"postalCodeOrZip\": \"string\",\r\n \"country\": \"string\",\r\n \"customerNumber\": \"string\",\r\n \"phoneNumber\": \"string\",\r\n \"fax\": \"string\",\r\n \"active\": true,\r\n \"loginId\": \"string\",\r\n \"failedAttempts\": 0,\r\n \"isLockedOut\": true,\r\n \"metadata\": [\r\n {\r\n \"metadataFieldGuid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"seqNo\": 0,\r\n \"fieldLabel\": \"string\",\r\n \"fieldDataType\": \"string\",\r\n \"fieldLength\": 0,\r\n \"fieldDescription\": \"string\",\r\n \"listValues\": \"string\",\r\n \"customerMetadataGuid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"value\": \"string\",\r\n \"required\": true,\r\n \"active\": true\r\n }\r\n ],\r\n \"samlFederationIds\": [\r\n {\r\n \"identityProviderId\": 0,\r\n \"federationId\": \"string\"\r\n }\r\n ],\r\n \"languages\": [\r\n {\r\n \"code\": \"string\",\r\n \"englishDescription\": \"string\",\r\n \"localizedDescription\": \"string\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true,\r\n \"totalResults\": 0,\r\n \"moreResults\": true,\r\n \"offset\": 0,\r\n \"limit\": 50\r\n}"}],"_postman_id":"8a1768f2-a94d-49ec-850f-9549cb6d4f8f"},{"name":"Create A Member","id":"944de3a7-924a-4b68-b783-c519d80faebd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\",\r\n \"emailAddress\": \"string\",\r\n \"alternateEmailAddress\": \"string\",\r\n \"addressLine1\": \"string\",\r\n \"addressLine2\": \"string\",\r\n \"city\": \"string\",\r\n \"stateOrRegion\": \"string\",\r\n \"postalCodeOrZip\": \"string\",\r\n \"country\": \"string\",\r\n \"customerNumber\": \"string\",\r\n \"phoneNumber\": \"string\",\r\n \"fax\": \"string\",\r\n \"active\": true,\r\n \"loginId\": \"string\",\r\n \"failedAttempts\": 0,\r\n \"isLockedOut\": true,\r\n \"metadata\": [\r\n {\r\n \"metadataFieldGuid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"seqNo\": 0,\r\n \"fieldLabel\": \"string\",\r\n \"fieldDataType\": \"string\",\r\n \"fieldLength\": 0,\r\n \"fieldDescription\": \"string\",\r\n \"listValues\": \"string\",\r\n \"customerMetadataGuid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"value\": \"string\",\r\n \"required\": true,\r\n \"active\": true\r\n }\r\n ],\r\n \"samlFederationIds\": [\r\n {\r\n \"identityProviderId\": 0,\r\n \"federationId\": \"string\"\r\n }\r\n ],\r\n \"languages\": [\r\n {\r\n \"code\": \"string\",\r\n \"englishDescription\": \"string\",\r\n \"localizedDescription\": \"string\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/member/create","description":"

Create a single member in the system.

Get a single member's information. The {id} in the URL is the HSI Member ID of the member you would like to retrieve.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"f1cfb64d-90f9-44c3-a8b4-2e70a50e7795","id":"f1cfb64d-90f9-44c3-a8b4-2e70a50e7795","name":"Member","type":"folder"}},"urlObject":{"protocol":"https","path":["member","{id}"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"b2a54369-3629-4c05-8445-716813a33823","name":"Get Member By Id","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":{"raw":"https://hsipublicapi.azure-api.net/member/{id}","protocol":"https","host":["hsipublicapi","azure-api","net"],"path":["member","{id}"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"memberId\": 0,\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"memberName\": \"string\",\n \"emailAddress\": \"string\",\n \"alternateEmailAddress\": \"string\",\n \"addressLine1\": \"string\",\n \"addressLine2\": \"string\",\n \"city\": \"string\",\n \"stateOrRegion\": \"string\",\n \"postalCodeOrZip\": \"string\",\n \"country\": \"string\",\n \"customerNumber\": \"string\",\n \"phoneNumber\": \"string\",\n \"fax\": \"string\",\n \"active\": true,\n \"loginId\": \"string\",\n \"failedAttempts\": 0,\n \"isLockedOut\": true,\n \"metadata\": [\n {\n \"metadataFieldGuid\": \"00000000-0000-0000-0000-000000000000\",\n \"seqNo\": 0,\n \"fieldLabel\": \"string\",\n \"fieldDataType\": \"string\",\n \"fieldLength\": 0,\n \"fieldDescription\": \"string\",\n \"listValues\": \"string\",\n \"customerMetadataGuid\": \"00000000-0000-0000-0000-000000000000\",\n \"value\": \"string\",\n \"required\": true,\n \"active\": true\n }\n ],\n \"samlFederationIds\": [\n {\n \"identityProviderId\": 0,\n \"federationId\": \"string\"\n }\n ],\n \"languages\": [\n {\n \"code\": \"string\",\n \"englishDescription\": \"string\",\n \"localizedDescription\": \"string\"\n }\n ]\n },\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"d914c7b4-aacc-406a-91cc-179aeb9d3b44"},{"name":"Update A Member","id":"219f3228-182a-4963-a220-705c99c707c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\",\r\n \"emailAddress\": \"string\",\r\n \"alternateEmailAddress\": \"string\",\r\n \"addressLine1\": \"string\",\r\n \"addressLine2\": \"string\",\r\n \"city\": \"string\",\r\n \"stateOrRegion\": \"string\",\r\n \"postalCodeOrZip\": \"string\",\r\n \"country\": \"string\",\r\n \"customerNumber\": \"string\",\r\n \"phoneNumber\": \"string\",\r\n \"fax\": \"string\",\r\n \"active\": true,\r\n \"loginId\": \"string\",\r\n \"failedAttempts\": 0,\r\n \"isLockedOut\": true,\r\n \"metadata\": [\r\n {\r\n \"metadataFieldGuid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"seqNo\": 0,\r\n \"fieldLabel\": \"string\",\r\n \"fieldDataType\": \"string\",\r\n \"fieldLength\": 0,\r\n \"fieldDescription\": \"string\",\r\n \"listValues\": \"string\",\r\n \"customerMetadataGuid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"value\": \"string\",\r\n \"required\": true,\r\n \"active\": true\r\n }\r\n ],\r\n \"samlFederationIds\": [\r\n {\r\n \"identityProviderId\": 0,\r\n \"federationId\": \"string\"\r\n }\r\n ],\r\n \"languages\": [\r\n {\r\n \"code\": \"string\",\r\n \"englishDescription\": \"string\",\r\n \"localizedDescription\": \"string\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/member/{id}","description":"

Update a single member's information. The {id} in the URL is the HSI Member ID of the member you would like to update.

Remove a single member from the system. The {id} in the URL is the HSI Member ID of the member you would like to remove.

Gets the recent activity record for a single member. The {id} in the URL is the member's ID.

Get a training summary for a member. The {id} in the URL is the member's ID.

Get a summary transcript for the last six months for a member. The {id} in the URL is the member's ID.

Add a member to group(s). You can pass multiple group IDs as part of the post body in a json array. The {id} in the URL is the member's ID.

Get the groups a member is affiliated with. The {id} in the URL is the member's ID.

Remove a member from group(s). You can pass multiple group IDs as part of the request body in a json array. The {id} in the URL is the member's ID.

Add a member to team(s). You can pass multiple team IDs as part of the post body in a json array. The {id} in the URL is the member's ID.

Get the teams a member is part of. The {id} in the URL is the member's ID.

Remove a member from team(s). You can pass multiple team IDs as part of the request body in a json array. The {id} in the URL is the member's ID.

This contains the API tools to create, read, update, and delete members and member team/group assignments.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"e8e55ce8-cd52-4bdf-a41e-67912ee88ad9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d10ea5fe-fb9d-4c3c-9f73-51ce06264047","type":"text/javascript","exec":[""]}}],"_postman_id":"f1cfb64d-90f9-44c3-a8b4-2e70a50e7795"},{"name":"Training","item":[{"name":"List Enrollments","id":"e9870743-5a67-4181-a2f8-2580287f5083","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"courseName\": \"string\",\r\n \"memberIds\": [\r\n 0\r\n ],\r\n \"groupIds\": [\r\n 0\r\n ],\r\n \"teamIds\": [\r\n 0\r\n ],\r\n \"startDate\": [\r\n {\r\n \"from\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"to\": \"yyyy-MM-ddTHH:mm:ssZ\"\r\n }\r\n ],\r\n \"dueDate\": [\r\n {\r\n \"from\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"to\": \"yyyy-MM-ddTHH:mm:ssZ\"\r\n }\r\n ],\r\n \"expirationDate\": [\r\n {\r\n \"from\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"to\": \"yyyy-MM-ddTHH:mm:ssZ\"\r\n }\r\n ],\r\n \"completionDate\": [\r\n {\r\n \"from\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"to\": \"yyyy-MM-ddTHH:mm:ssZ\"\r\n }\r\n ],\r\n \"batchId\": 0,\r\n \"hideChildEnrollments\": true,\r\n \"enrollmentTypes\": [\r\n \"Requirement\"\r\n ],\r\n \"completionStatuses\": [\r\n \"NotStarted\"\r\n ]\r\n },\r\n \"offset\": 0,\r\n \"limit\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"hsipublicapi.azure-api.net/training/enrollment/list","description":"

Return a list of all the enrollments in the system that match the search parameters.

Search parameters can be passed in as a ListRequest via the body of the request. There are no required search parameters, so the data field can be passed in as an empty object.

{\n    \"data\": {}\n}\n\n

By default, only enrollments with a startDateUtc between 6 months ago and 6 months from now will be returned.

courseName filters enrollments by the name of the enrolled course. A null value applies no filtering.
\n
memberIds filter enrollments by an array of MemberIds.
\n
groupIds filter enrollments by an array of GroupIds. Only enrollments for members in one or more of the supplied groups will be returned.
\n
teamIds filter enrollments by an array of TeamIds. Only enrollments for members in one or more of the supplied teams will be returned.
\n
startDate is an array of DateRange objects. Only enrollments with a startDateUtc between the from and to values or one or more of the supplied date ranges will be returned.
\n
dueDate is as startDate, but filters on dueDateUtc.
\n
expirationDate is as startDate, but filters on expirationDateUtc.
\n
completionDate is as startDate, but filters on completionDateUtc.
\n
batchId filters by batchId. A null value applies no filtering.
\n
hideChildEnrollments is a boolean value. When true, child enrollments of Multi-Lesson Courses (MLCs) will not be returned. The parent enrollment will still be returned.
\n
enrollmentTypes filters enrollments by an array of enrollmentTypes.
\n
completionStatuses filters enrollments by an array of completionStatuses. By default, 'Expired' and 'Deleted' enrollments are excluded.
\n

\n","urlObject":{"path":["training","enrollment","list"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"2a9ebb68-94b5-4efd-be20-9b3a68ccfc4b","name":"List Enrollments","originalRequest":{"method":"POST","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"hsipublicapi.azure-api.net/training/enrollment/list"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"id\": 0,\r\n \"classType\": \"string\",\r\n \"dueDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"enrollmentDueDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"enrollmentExpirationDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"expirationDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"completionDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"startDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"courseName\": \"string\",\r\n \"completionStatus\": \"NotStarted\",\r\n \"enrollmentType\": \"Requirement\",\r\n \"timeSpentInSeconds\": 0,\r\n \"hasChildTasks\": true,\r\n \"memberName\": \"string\",\r\n \"memberId\": 0,\r\n \"programId\": 0\r\n }\r\n ],\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true,\r\n \"totalResults\": 0,\r\n \"moreResults\": true,\r\n \"offset\": 0,\r\n \"limit\": 0\r\n}"}],"_postman_id":"e9870743-5a67-4181-a2f8-2580287f5083"},{"name":"Create Enrollments","id":"ef5e2a7c-bfe3-4d31-af52-2a30963eaf7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"programID\": 0,\r\n \"memberID\": 0,\r\n \"startDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"expirationDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"dueDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"hsipublicapi.azure-api.net/training/enrollment","description":"

Add enrollments to the system. All enrollments created by the API will be Direct Enrollments. Multiple enrollments to be created can be passed in via the body of the request.

programID is the programId of the course to enroll in.
memberID is the id of the member to enroll in the course.
startDateUtc sets when the training will become available to the member.
expirationDateUtc sets when the enrollment will become expired.
dueDateUtc sets the due date of the enrollment.

StartDateUtc must be before dueDateUtc which must be before expirationDateUtc.

\n","urlObject":{"path":["training","enrollment"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"56dd3bf1-b152-43ab-9d9d-2ca548a26668","name":"Create Enrollments","originalRequest":{"method":"POST","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"hsipublicapi.azure-api.net/training/enrollment"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 0,\n \"programID\": 0,\n \"memberID\": 0,\n \"rosterGuid\": \"00000000-0000-0000-0000-000000000000\",\n \"completionStatus\": \"NotStarted\",\n \"completionDateUtc\": null,\n \"startDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"testScore\": null,\n \"timeSpentInSeconds\": null,\n \"testAttemptsOverride\": null,\n \"testAttemptsOverriddenBy\": null,\n \"testAttemptsOverriddenDateUtc\": null,\n \"archivedDateUtc\": null,\n \"isMultiLesson\": false,\n \"parentEnrollmentID\": null,\n \"adminNotes\": null,\n \"publicNotes\": null,\n \"expirationDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"dueDate\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"enrollmentType\": \"Direct\",\n \"percentComplete\": 0.0,\n \"batchId\": 0\n }\n ],\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"ef5e2a7c-bfe3-4d31-af52-2a30963eaf7c"},{"name":"Get Enrollments","id":"010330ee-dbb1-4e80-b82c-a8b41b3d7688","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"hsipublicapi.azure-api.net/training/enrollment/{id}","description":"

Get a single enrollment. The {id} in the URL is the enrollment's ID.

\n","urlObject":{"path":["training","enrollment","{id}"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"975cfca9-bd47-478e-88fc-8b6da36b44e4","name":"Get Enrollments","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"hsipublicapi.azure-api.net/training/enrollment/{id}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"id\": 0,\r\n \"programID\": 0,\r\n \"memberID\": 0,\r\n \"rosterGuid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"completionStatus\": \"NotStarted\",\r\n \"completionDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"startDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"testScore\": 0,\r\n \"timeSpentInSeconds\": 0,\r\n \"testAttemptsOverride\": 0,\r\n \"testAttemptsOverriddenBy\": 0,\r\n \"testAttemptsOverriddenDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"archivedDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"isMultiLesson\": true,\r\n \"parentEnrollmentID\": 0,\r\n \"adminNotes\": \"string\",\r\n \"publicNotes\": \"string\",\r\n \"expirationDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"dueDate\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"enrollmentType\": \"Requirement\",\r\n \"percentComplete\": 0.0,\r\n \"batchId\": 0\r\n }\r\n ],\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"010330ee-dbb1-4e80-b82c-a8b41b3d7688"},{"name":"Update Enrollments","id":"c3749df7-f8b9-43a1-b9d3-d0419e22a325","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"id\": 0,\r\n \"startDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"dueDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"expirationDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"hsipublicapi.azure-api.net/training/enrollment","description":"

Modify the data for an existing enrollment. Multiple enrollments can be updated at the same time by passing them in via the body of the request.

Only 'Direct' enrollments can be updated.
'Complete' or 'Deleted' enrollments cannot be updated.
StartDateUtc can only be updated for enrollments with a completionStatus of 'NotStarted'. To update enrollments that have been started, you must pass in the existing value for startDateUtc.

\n","urlObject":{"path":["training","enrollment"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"e50d4554-68dc-45c6-995f-0793f00fb51e","name":"Update Enrollments","originalRequest":{"method":"PUT","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"hsipublicapi.azure-api.net/training/enrollment"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 0,\n \"programID\": 0,\n \"memberID\": 0,\n \"rosterGuid\": \"00000000-0000-0000-0000-000000000000\",\n \"completionStatus\": \"NotStarted\",\n \"completionDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"startDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"testScore\": 0,\n \"timeSpentInSeconds\": 0,\n \"testAttemptsOverride\": 0,\n \"testAttemptsOverriddenBy\": 0,\n \"testAttemptsOverriddenDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"archivedDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"isMultiLesson\": true,\n \"parentEnrollmentID\": 0,\n \"adminNotes\": \"string\",\n \"publicNotes\": \"string\",\n \"expirationDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"dueDate\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"enrollmentType\": \"Requirement\",\n \"percentComplete\": 0.0,\n \"batchId\": 0\n }\n ],\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"c3749df7-f8b9-43a1-b9d3-d0419e22a325"},{"name":"Remove Enrollments","id":"7d4b0f5a-7461-4a2d-a9d2-e9d6f6719832","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"[\r\n 0\r\n]","options":{"raw":{"language":"json"}}},"url":"hsipublicapi.azure-api.net/training/enrollment","description":"

Sets enrollments to the 'Deleted' status. Multiple enrollment ids can be passed in to be removed via the body of the request.

Only 'Direct' enrollments can be deleted.
'Complete' enrollments cannot be deleted.

\n","urlObject":{"path":["training","enrollment"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"cd0dc0a6-ee5d-443a-8af5-4daa16712dbb","name":"Remove Enrollments","originalRequest":{"method":"DELETE","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"hsipublicapi.azure-api.net/training/enrollment"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": \"Enrollments archived successfully.\",\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"7d4b0f5a-7461-4a2d-a9d2-e9d6f6719832"},{"name":"Create Completions","id":"ae32b3cb-e48b-4475-b468-8d05ce925ba0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"id\": 0,\r\n \"completionDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"testScore\": 0,\r\n \"timeSpentInSeconds\": 0,\r\n \"publicNotes\": \"string\",\r\n \"adminNotes\": \"string\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"hsipublicapi.azure-api.net/training/completion","description":"

Sets enrollments to the 'Complete' status. Multiple completions can be passed in via the body of the request.

Only enrollments for 'General Task' type courses can be completed via the API.
'Deleted' enrollments cannot be completed.

id is the ID of the enrollment to complete.
completionDateUtc sets when the enrollment is recorded as having been completed.
testScore is an optional int field. Valid values are 0-100.
timeSpentInSeconds is an optional int field.
publicNotes is an optional string. These notes can be viewed by admins and members.
adminNotes is an optional string. These notes can only be viewed by admins.

\n","urlObject":{"path":["training","completion"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"66cf1fb6-9dd8-4b3b-b061-39fb715f9690","name":"Create Completions","originalRequest":{"method":"POST","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"hsipublicapi.azure-api.net/training/completion"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 0,\n \"programID\": 0,\n \"memberID\": 0,\n \"rosterGuid\": \"00000000-0000-0000-0000-000000000000\",\n \"completionStatus\": \"Complete\",\n \"completionDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"startDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"testScore\": 0,\n \"timeSpentInSeconds\": 0,\n \"testAttemptsOverride\": 0,\n \"testAttemptsOverriddenBy\": 0,\n \"testAttemptsOverriddenDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"archivedDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"isMultiLesson\": true,\n \"parentEnrollmentID\": 0,\n \"adminNotes\": \"string\",\n \"publicNotes\": \"string\",\n \"expirationDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"dueDate\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"enrollmentType\": \"Requirement\",\n \"percentComplete\": 0.0,\n \"batchId\": 0\n }\n ],\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"ae32b3cb-e48b-4475-b468-8d05ce925ba0"},{"name":"Update Completions","id":"36b657be-e636-43a1-8c18-531d78a00713","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"id\": 0,\r\n \"completionDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"testScore\": 0,\r\n \"timeSpentInSeconds\": 0,\r\n \"publicNotes\": \"string\",\r\n \"adminNotes\": \"string\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"hsipublicapi.azure-api.net/training/completion","description":"

Updates enrollment completion details. Multiple completions can be passed in via the body of the request.

Only enrollments for 'General Task' type courses can be completed via the API.
'Deleted' enrollments cannot be completed.

id is the ID of the enrollment to update.
completionDateUtc sets when the enrollment is recorded as having been completed.
testScore is an optional int field. Valid values are 0-100.
timeSpentInSeconds is an optional int field.
publicNotes is an optional string. These notes can be viewed by admins and members.
adminNotes is an optional string. These notes can only be viewed by admins.

\n","urlObject":{"path":["training","completion"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"b8bce070-a431-4b94-94ff-708f399acb5a","name":"Update Completions","originalRequest":{"method":"PUT","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"hsipublicapi.azure-api.net/training/completion"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 0,\n \"programID\": 0,\n \"memberID\": 0,\n \"rosterGuid\": \"00000000-0000-0000-0000-000000000000\",\n \"completionStatus\": \"Complete\",\n \"completionDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"startDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"testScore\": 0,\n \"timeSpentInSeconds\": 0,\n \"testAttemptsOverride\": 0,\n \"testAttemptsOverriddenBy\": 0,\n \"testAttemptsOverriddenDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"archivedDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"isMultiLesson\": true,\n \"parentEnrollmentID\": 0,\n \"adminNotes\": \"string\",\n \"publicNotes\": \"string\",\n \"expirationDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"dueDate\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"enrollmentType\": \"Requirement\",\n \"percentComplete\": 0.0,\n \"batchId\": 0\n }\n ],\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"36b657be-e636-43a1-8c18-531d78a00713"},{"name":"Remove Completions","id":"4ff968c4-72f3-47ed-bb05-b32ea55a4c81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"id\": 0,\r\n \"completionDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\r\n \"testScore\": 0,\r\n \"timeSpentInSeconds\": 0,\r\n \"publicNotes\": \"string\",\r\n \"adminNotes\": \"string\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"hsipublicapi.azure-api.net/training/completion","description":"

Removes completion data from selected enrollments. Multiple enrollments to be un-completed can be passed in via the body of the request.

Only enrollments for 'General Task' type courses can be un-completed via the API.\n'Deleted' enrollments cannot be un-completed.

Removing completion from a 'Direct' enrollment sets completionDateUtc, testScore, timeSpentInSeconds, publicNotes, and adminNotes to null, and completionStatus to 'NotStarted'.

Removing completion from a 'Requirement' enrollment sets completionDateUtc to null, and completionStatus to 'Deleted'.

\n","urlObject":{"path":["training","completion"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"ec61d56f-cc61-4a10-a442-f66afc32eaf1","name":"Remove Completions","originalRequest":{"method":"DELETE","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"hsipublicapi.azure-api.net/training/completion"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 0,\n \"programID\": 0,\n \"memberID\": 0,\n \"rosterGuid\": \"00000000-0000-0000-0000-000000000000\",\n \"completionStatus\": \"NotStarted\",\n \"completionDateUtc\": null,\n \"startDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"testScore\": null,\n \"timeSpentInSeconds\": null,\n \"testAttemptsOverride\": 0,\n \"testAttemptsOverriddenBy\": 0,\n \"testAttemptsOverriddenDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"archivedDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"isMultiLesson\": true,\n \"parentEnrollmentID\": 0,\n \"adminNotes\": null,\n \"publicNotes\": null,\n \"expirationDateUtc\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"dueDate\": \"yyyy-MM-ddTHH:mm:ssZ\",\n \"enrollmentType\": \"Direct\",\n \"percentComplete\": 0.0,\n \"batchId\": 0\n }\n ],\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"4ff968c4-72f3-47ed-bb05-b32ea55a4c81"},{"name":"List Courses","id":"9ae64727-b0b5-44c0-83d4-6e2a8ee4eee4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"active\": true,\r\n \"classType\": \"string\",\r\n \"search\": \"string\",\r\n \"tagIds\": [\r\n 0\r\n ],\r\n \"vendorName\": \"string\",\r\n \"locale\": \"string\"\r\n },\r\n \"offset\": 0,\r\n \"limit\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"hsipublicapi.azure-api.net/training/course/list","description":"

Return a list of all the courses in the system that match the search parameters.

Search parameters can be passed in as a ListRequest via the body of the request. There are no required search parameters, so the data field can be passed in as an empty object.

{\n    \"data\": {}\n}\n

active is a boolean. It filters courses by their active status. Defaults to true.
classType is a string that filters courses by class type. Valid values are:
- AICC
- Blended
- ContentOnly
- Curriculum
- DigitalRights
- Exam
- GeneralTask
- DocumentTask
- MultiLessonCourse
- Classroom
- Online
- DVDRental
- Scorm
- Streaming
- Survey
\n
tagIds filter courses by an array of TagIds.
vendorName is a string that filters courses by vendor. Vendor name must match exactly.
locale filters courses by locale.

\n","urlObject":{"path":["training","course","list"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"369ca197-2ba7-4176-8e3d-d7d75b101581","name":"List Courses","originalRequest":{"method":"POST","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"hsipublicapi.azure-api.net/training/course/list"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"programId\": 0,\r\n \"courseName\": \"string\",\r\n \"classType\": \"string\",\r\n \"active\": true,\r\n \"locale\": \"string\",\r\n \"estimatedTimeMinutes\": 0,\r\n \"vendorName\": \"string\",\r\n \"description\": \"string\"\r\n }\r\n ],\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true,\r\n \"totalResults\": 0,\r\n \"moreResults\": true,\r\n \"offset\": 0,\r\n \"limit\": 0\r\n}"}],"_postman_id":"9ae64727-b0b5-44c0-83d4-6e2a8ee4eee4"},{"name":"Get Course","id":"b3becd99-83a5-4de0-9d79-d960ce134599","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"hsipublicapi.azure-api.net/training/course/{id}","description":"

Get a single course. The {id} in the URL is the course's programID.

\n","urlObject":{"path":["training","course","{id}"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"3e715311-4cd1-4243-a04b-cdafedc31a01","name":"Get Course","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"hsipublicapi.azure-api.net/training/course/{id}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"programId\": 0,\r\n \"courseName\": \"string\",\r\n \"courseDescription\": \"string\",\r\n \"active\": true,\r\n \"classType\": \"string\",\r\n \"isOSHA\": true,\r\n \"learningObjectives\": \"string\",\r\n \"brand\": \"string\",\r\n \"daysUntilExpiration\": 0,\r\n \"allowPreview\": true,\r\n \"locale\": \"string\",\r\n \"estimatedTimeMinutes\": 0,\r\n \"vendorName\": \"string\"\r\n },\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true,\r\n \"totalResults\": 0,\r\n \"moreResults\": true,\r\n \"offset\": 0,\r\n \"limit\": 0\r\n}"}],"_postman_id":"b3becd99-83a5-4de0-9d79-d960ce134599"},{"name":"List Group Requirements","id":"d2ddaed9-3b55-41a2-85b1-9e5933947cc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"groupId\": 0\r\n },\r\n \"offset\": 0,\r\n \"limit\": 50\r\n}","options":{"raw":{"language":"json"}}},"url":"hsipublicapi.azure-api.net/training/group/requirements","description":"

Get a list of requirements for a group.

\n","urlObject":{"path":["training","group","requirements"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"ad4dd8c0-ece0-440b-bfbe-b9a19a7201eb","name":"List Group Requirements","originalRequest":{"method":"POST","header":[],"url":"hsipublicapi.azure-api.net/group/requirements"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 0,\n \"name\": \"string\",\n \"status\": 1,\n \"scheduleType\": 0,\n \"description\": \"string\",\n \"welcomeMessage\": \"string\",\n \"hasScheduleOverride\": true,\n \"startDate\": \"2023-08-24T17:03:26.631Z\",\n \"endDate\": \"2023-08-24T17:03:26.631Z\",\n \"daysUntilDue\": 0,\n \"retrainFrequency\": 0,\n \"retrainInterval\": 0,\n \"minimumTestScore\": 0,\n \"minimumTimeSpent\": 0,\n \"numberOfAttemptsAllowed\": 0,\n \"considerHistorical\": true\n },\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true,\n \"totalResults\": 0,\n \"moreResults\": true,\n \"offset\": 0,\n \"limit\": 0\n}"}],"_postman_id":"d2ddaed9-3b55-41a2-85b1-9e5933947cc7"}],"id":"0a6b664c-7257-441b-92d9-707b098ffca6","description":"

This contains the API tools to manage enrollments.

Enrollments of all EnrollmentTypes can be viewed through the API.
Only 'Direct' enrollments can be created, updated, and deleted.
Completions can only be created, updated, and deleted for Enrollments of 'General Task' type courses.

Valid values for CompletionStatus and EnrollmentType are listed below.

CompletionStatus:

NotStarted
\n
InProgess
\n
Complete
\n
Failed
\n
TimeRequirementNotMet
\n
PendingApproval
\n
Locked
\n
DidNotAttend
\n
Expired
\n
Deleted
\n

EnrollmentType:

Requirement
\n
Historical
\n
Direct
\n
Optional
\n
Member
\n

\n","event":[{"listen":"prerequest","script":{"id":"e4567810-dff6-4d01-8bb1-0ca25309e1e0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f2309cb4-48da-454e-b86f-824fc536a499","type":"text/javascript","exec":[""]}}],"_postman_id":"0a6b664c-7257-441b-92d9-707b098ffca6"},{"name":"Admin","item":[{"name":"Get Admin List","id":"28f87f81-ae4a-4532-9b60-e621eff15488","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"active\": 0,\r\n \"name\": \"string\",\r\n \"email\": \"string\",\r\n \"loginId\": \"string\",\r\n \"filterAssociatedTeamAdmins\": true,\r\n \"teamIds\": [\r\n 0\r\n ]\r\n },\r\n \"offset\": 0,\r\n \"limit\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/admin/list","description":"

Gets the list of administrators affiliated with your organization. Search parameter requires at least one field to function. Including {\"active\": 1} will return all active administrators for your organization.

Valid values for the search parameter 'active' are 0 (inactive), 1 (active), or 2 (all).

\n","urlObject":{"protocol":"https","path":["admin","list"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"272669b9-5b0c-4142-a1c5-2cb8036ad26f","name":"Get Admin List","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/admin/list"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"name\": \"string\",\n \"active\": \"string\",\n \"loginDateTime\": \"string\",\n \"adminId\": 0,\n \"email\": \"string\",\n \"loginId\": \"string\",\n \"phone\": \"string\"\n }\n ],\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true,\n \"totalResults\": 0,\n \"moreResults\": true,\n \"offset\": 0,\n \"limit\": 0\n}"}],"_postman_id":"28f87f81-ae4a-4532-9b60-e621eff15488"},{"name":"Remove Admin","id":"fd3fa82f-79cb-4753-bad2-ae10759af038","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://hsipublicapi.azure-api.net/admin/{id}","description":"

Remove an administrator from the system. The {id} in the URL is the HSI Admin ID of the administrator you would like to remove.

\n","urlObject":{"protocol":"https","path":["admin","{id}"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"6f87db09-1df7-4330-b4c6-e19f6215c29d","name":"Remove Admin","originalRequest":{"method":"DELETE","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/admin/{id}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": \"string\",\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"fd3fa82f-79cb-4753-bad2-ae10759af038"},{"name":"Create Admin","id":"b410613f-76e2-4225-b17e-212f48fc5220","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"active\": true, // Required \r\n \"localization\": \"string\", // Required\r\n \"name\": \"string\", // Required\r\n \"loginId\": \"string\", // Required\r\n \"email\": \"string\", // Required\r\n \"phone\": \"string\",\r\n \"samlAuthentications\": [\r\n {\r\n \"identityProviderId\": 0,\r\n \"federationId\": \"string\"\r\n }\r\n ],\r\n \"phone2\": \"string\",\r\n \"address1\": \"string\",\r\n \"address2\": \"string\",\r\n \"city\": \"string\",\r\n \"state\": \"string\",\r\n \"zip\": \"string\",\r\n \"country\": \"string\",\r\n \"teamLimited\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/admin/create","description":"

Create a single administrator in the system.

Required fields:

{\n  \"active\": true,\n  \"localization\": \"string\",\n  \"name\": \"string\",\n  \"loginId\": \"string\",\n  \"email\": \"string\"\n}\n

'active' is a boolean indicating if the administrator is active.
'localization' is the language code. Currently accepted values are:
- \"en\" - English
- \"en-us\" - English-US
- \"es\" - Español (Spanish)
- \"es-419\" - Español de América Latina (Spanish (Latin America))
- \"fr\" - Français (French)
- \"fr-ca\" - Français (Canada) (French (Canada))
- \"it\" - Italiano (Italian)
\n
'name' is the administrator's name.
'loginId' is the ID that the administrator will use to log in to the system.
'email' is the administrator's email address.

\n","urlObject":{"protocol":"https","path":["admin","create"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"476256bb-a67f-472f-8eb7-d6ed871635f1","name":"Create Admin","originalRequest":{"method":"POST","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/admin/create"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"active\": true,\n \"email\": \"string\",\n \"localization\": \"string\",\n \"languages\": [\n {\n \"code\": \"string\",\n \"englishDescription\": \"string\",\n \"localizedDescription\": \"string\"\n }\n ],\n \"loginId\": \"string\",\n \"name\": \"string\",\n \"phone\": \"string\",\n \"isLocked\": true,\n \"securityLockout\": true,\n \"creationMethod\": \"string\",\n \"batchId\": 0,\n \"samlAuthentications\": [\n {\n \"identityProviderId\": 0,\n \"federationId\": \"string\"\n }\n ],\n \"adminId\": 0,\n \"phone2\": \"string\",\n \"address1\": \"string\",\n \"address2\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"zip\": \"string\",\n \"country\": \"string\",\n \"teamLimited\": true,\n \"rootAdmin\": true,\n \"lastRootAdminWithoutRestrictions\": true\n },\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"b410613f-76e2-4225-b17e-212f48fc5220"},{"name":"Update Admin","id":"5578cafa-92cd-4523-b427-7ae8f36c3067","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"active\": true,\r\n \"localization\": \"string\",\r\n \"name\": \"string\",\r\n \"loginId\": \"string\",\r\n \"email\": \"string\",\r\n \"phone\": \"string\",\r\n \"isLocked\": true,\r\n \"securityLockout\": true,\r\n \"creationMethod\": \"string\",\r\n \"samlAuthentications\": [\r\n {\r\n \"identityProviderId\": 0,\r\n \"federationId\": \"string\"\r\n }\r\n ],\r\n \"phone2\": \"string\",\r\n \"address1\": \"string\",\r\n \"address2\": \"string\",\r\n \"city\": \"string\",\r\n \"state\": \"string\",\r\n \"zip\": \"string\",\r\n \"country\": \"string\",\r\n \"teamLimited\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/admin/{id}","description":"

Modify the data for a single administrator in the system. The {id} in the URL is the HSI Admin ID of the administrator you would like to modify.

\n","urlObject":{"protocol":"https","path":["admin","{id}"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"f36ce7ca-13aa-4855-b792-6d15d5b0918e","name":"Update Admin","originalRequest":{"method":"PUT","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/admin/{id}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"active\": true,\n \"email\": \"string\",\n \"localization\": \"string\",\n \"languages\": [\n {\n \"code\": \"string\",\n \"englishDescription\": \"string\",\n \"localizedDescription\": \"string\"\n }\n ],\n \"loginId\": \"string\",\n \"name\": \"string\",\n \"phone\": \"string\",\n \"isLocked\": true,\n \"securityLockout\": true,\n \"creationMethod\": \"string\",\n \"batchId\": 0,\n \"samlAuthentications\": [\n {\n \"identityProviderId\": 0,\n \"federationId\": \"string\"\n }\n ],\n \"adminId\": 0,\n \"phone2\": \"string\",\n \"address1\": \"string\",\n \"address2\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"zip\": \"string\",\n \"country\": \"string\",\n \"teamLimited\": true,\n \"rootAdmin\": true,\n \"lastRootAdminWithoutRestrictions\": true\n },\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"5578cafa-92cd-4523-b427-7ae8f36c3067"},{"name":"Get Admin By ID","id":"3adf32a7-de98-4044-ae2e-b29a26184623","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-HSI-API-KEY"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://hsipublicapi.azure-api.net/admin/3549809","description":"

Get a single administrator's information. The {id} in the URL is the HSI Admin ID of the administrator you would like to retrieve.

\n","urlObject":{"protocol":"https","path":["admin","3549809"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"e2434441-3f56-42f4-9210-61f2d1261613","name":"Get Admin By ID","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/admin/{id}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"active\": true,\r\n \"email\": \"string\",\r\n \"localization\": \"string\",\r\n \"languages\": [\r\n {\r\n \"code\": \"string\",\r\n \"englishDescription\": \"string\",\r\n \"localizedDescription\": \"string\"\r\n }\r\n ],\r\n \"loginId\": \"string\",\r\n \"name\": \"string\",\r\n \"phone\": \"string\",\r\n \"isLocked\": true,\r\n \"securityLockout\": true,\r\n \"creationMethod\": \"string\",\r\n \"batchId\": 0,\r\n \"samlAuthentications\": [\r\n {\r\n \"identityProviderId\": 0,\r\n \"federationId\": \"string\"\r\n }\r\n ],\r\n \"adminId\": 0,\r\n \"phone2\": \"string\",\r\n \"address1\": \"string\",\r\n \"address2\": \"string\",\r\n \"city\": \"string\",\r\n \"state\": \"string\",\r\n \"zip\": \"string\",\r\n \"country\": \"string\",\r\n \"teamLimited\": true,\r\n \"rootAdmin\": true,\r\n \"lastRootAdminWithoutRestrictions\": true\r\n },\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"3adf32a7-de98-4044-ae2e-b29a26184623"}],"id":"644c81b6-db97-4035-a22f-e68c247d0a71","description":"

Contains the API tools to manage administrators within your organization.

\n","event":[{"listen":"prerequest","script":{"id":"f35f749e-75ae-4526-af79-69b89d5bf286","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6d07b9c7-6fcf-4cdd-928f-bad5bdf7612c","type":"text/javascript","exec":[""]}}],"_postman_id":"644c81b6-db97-4035-a22f-e68c247d0a71"},{"name":"Group","item":[{"name":"Get Groups List","id":"bab7f643-ce3c-4825-b08e-cdf5de9cabaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"offset\": 0,\r\n \"limit\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/group/list","description":"

Get a paged set of the groups associated with your organization.

\n","urlObject":{"protocol":"https","path":["group","list"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"fa1d2f45-3b74-4705-bc6e-06e5673e54a0","name":"Get Groups List","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/group/list"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 0,\n \"name\": \"string\",\n \"description\": \"string\",\n \"messageText\": \"string\",\n \"statusId\": 1,\n \"adminCount\": 0,\n \"requirementCount\": 0,\n \"activeRequirementCount\": 0,\n \"additionalResourcesCount\": 0,\n \"color\": {\n \"id\": 0,\n \"name\": \"string\",\n \"hexValue\": \"string\"\n },\n \"memberCount\": 0\n },\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"bab7f643-ce3c-4825-b08e-cdf5de9cabaf"},{"name":"Add Members To Group","id":"e183e2e1-9365-4b49-8cf8-ba6a3edafc91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n 1,\r\n 2\r\n]","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/group/{groupId}/members","description":"

Add members to a group. Multiple members can be added to the same group by passing in an array of HSI Member IDs via the body.

Remove members from a group. Multiple members can be removed from the same group by passing in an array of HSI Member IDs via the body.

\n","urlObject":{"protocol":"https","path":["group","{groupId}","members"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"6f937f51-d201-4126-ab76-760a4661e8a7","name":"Delete Members From Group","originalRequest":{"method":"DELETE","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/group/{groupId}/members"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": \"string\",\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"0a8c80de-1f19-45cd-a65c-76aabd178530"},{"name":"Get Group Members List","id":"4207d3c5-912d-491c-8302-ed713419820a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"offset\": 0,\r\n \"limit\": 10\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/group/{groupId}/members/list","urlObject":{"protocol":"https","path":["group","{groupId}","members","list"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"f5de511c-c7db-444e-920a-a7bc85c86feb","name":"Get Group Members List","originalRequest":{"method":"POST","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/group/{groupId}/members"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"memberId\": 1,\n \"firstName\": \"Joe\",\n \"lastName\": \"Smith\",\n \"emailAddress\": \"example@hsi.com\",\n \"active\": true,\n \"customerNumber\": \"444-44-4444\",\n \"loginId\": \"JoeSmith\"\n }\n ],\n \"error\": null,\n \"message\": null,\n \"success\": true,\n \"totalResults\": 10,\n \"moreResults\": true,\n \"offset\": 0,\n \"limit\": 1\n}"}],"_postman_id":"4207d3c5-912d-491c-8302-ed713419820a"}],"id":"46f6326a-6120-4c73-9fba-56c6f56e5705","description":"

Contains the API tools to manage groups in the system.

\n","_postman_id":"46f6326a-6120-4c73-9fba-56c6f56e5705"},{"name":"Team","item":[{"name":"Get Teams List","id":"86600ab4-ce00-4de5-bdd4-b43492d28800","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"offset\": 0,\r\n \"limit\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/team/list","description":"

Gets a paged set of teams in the system that are available to the requesting administrator.

\n","urlObject":{"protocol":"https","path":["team","list"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"dc5abeaa-96ad-49bb-af36-78267e8319b2","name":"Get Teams List","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/team/list"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"id\": 0,\r\n \"name\": \"string\",\r\n \"color\": 0,\r\n \"createdDateUTC\": \"2021-09-28T16:51:12.103Z\",\r\n \"createdByAdminId\": 0,\r\n \"createdByAdminName\": \"string\",\r\n \"adminCount\": 0,\r\n \"memberCount\": 0\r\n }\r\n ],\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"86600ab4-ce00-4de5-bdd4-b43492d28800"},{"name":"Create Team","id":"ad212841-c444-4941-9046-c6b01db233ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"name\": \"string\",\r\n \"description\": \"string\",\r\n \"welcomeMessage\": \"string\",\r\n \"color\": \"LightGreen\",\r\n \"trackingCode\": \"string\",\r\n \"members\": [\r\n {\r\n \"memberId\": 0\r\n }\r\n ],\r\n \"admins\": [\r\n {\r\n \"adminId\": 0,\r\n \"receiveNotifications\": true,\r\n \"teamContact\": true\r\n }\r\n ]\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/team/create","description":"

Create a single team in the system.

Definition of input parameters:

'color' is a string and can be any of the default colors in the HSI System.
- The default color values that the system will recognize are:
  - LightGreen
  - Orange
  - Purple
  - DarkPurple
  - Teal
  - Magenta
  - Blue
  - MediumBlue
  - Yellow
  - BlackClay
  - MidnightBlue
  - WetAsphalt
  - Stone
  - BlueGrey
  - Steel
  - Concrete
  \n
\n
'trackingCode' is a string, and will accept any string as input. It is an optional custom field for your organization to use if you would like to include it.
'members' is an array of {\"memberId\": int} objects.
- \"memberId\" is the HSI Member ID of the member you would like to add to the team.
\n
'admins' is an array of objects representing the administrators you would like to add to the Team. A team must have at least one administrator in order to be created.
- \"adminId\" is the HSI Admin ID of the administrator.
- \"receiveNotifications\" is a boolean indicating if the administrator should recieve notifications pertaining to this team.
- \"teamContact\" is a boolean.
  - When adding administrators to a team, there can be up to one administrator designated as the Team Contact.
  - i.e. at most one administrator model per team may be set to \"teamContact\": true; the others must all be \"teamContact\": false.
  \n
\n

\n","urlObject":{"protocol":"https","path":["team","create"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"2a7d74df-ad90-47ef-9041-723ed0f808ba","name":"Create Team","originalRequest":{"method":"POST","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/team/create"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"teamId\": 0,\r\n \"teamName\": \"string\"\r\n }\r\n ],\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"ad212841-c444-4941-9046-c6b01db233ed"},{"name":"Get Team","id":"7832842f-17cb-4b81-9c67-48f94165a91b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hsipublicapi.azure-api.net/team/{id}","description":"

Gets a single team. The {id} in the URL is the HSI Team ID.

\n","urlObject":{"protocol":"https","path":["team","{id}"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"10dcca60-dfad-43fa-a472-28a1f61bdd4c","name":"Get Team","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/team/{id}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"id\": 0,\r\n \"name\": \"string\",\r\n \"description\": \"string\",\r\n \"welcomeMessage\": \"string\",\r\n \"color\": \"LightGreen\",\r\n \"trackingCode\": \"string\",\r\n \"isActive\": true,\r\n \"createdByAdminId\": 0,\r\n \"createdByAdminName\": \"string\",\r\n \"createdDate\": \"2021-11-02T19:03:59.379Z\",\r\n \"members\": [\r\n {\r\n \"memberId\": 0,\r\n \"name\": \"string\",\r\n \"lastLoginDate\": \"2021-11-02T19:03:59.379Z\",\r\n \"active\": true\r\n }\r\n ],\r\n \"admins\": [\r\n {\r\n \"adminId\": 0,\r\n \"receiveNotifications\": true,\r\n \"teamContact\": true,\r\n \"name\": \"string\",\r\n \"lastLoginDate\": \"2021-11-02T19:03:59.379Z\",\r\n \"active\": true\r\n }\r\n ]\r\n },\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"7832842f-17cb-4b81-9c67-48f94165a91b"},{"name":"Update Team","id":"f07af1e4-f957-479f-af8c-980102f39a69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"string\",\r\n \"description\": \"string\",\r\n \"welcomeMessage\": \"string\",\r\n \"color\": \"LightGreen\",\r\n \"trackingCode\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/team/{id}","description":"

Modify the metadata of a single team in the system. The {id} in the URL is the HSI Team ID.

\n","urlObject":{"protocol":"https","path":["team","{id}"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"a2c4e6a7-5abb-4531-b916-3d0b120121a0","name":"Update Team","originalRequest":{"method":"PUT","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/team/update"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 0,\n \"name\": \"string\",\n \"description\": \"string\",\n \"welcomeMessage\": \"string\",\n \"color\": \"LightGreen\",\n \"trackingCode\": \"string\",\n \"isActive\": true,\n \"createdByAdminId\": 0,\n \"createdByAdminName\": \"string\",\n \"createdDate\": \"2021-11-02T19:03:59.379Z\",\n \"members\": [\n {\n \"memberId\": 0,\n \"name\": \"string\",\n \"lastLoginDate\": \"2021-11-02T19:03:59.379Z\",\n \"active\": true\n }\n ],\n \"admins\": [\n {\n \"adminId\": 0,\n \"receiveNotifications\": true,\n \"teamContact\": 0,\n \"name\": \"string\",\n \"lastLoginDate\": \"2021-11-02T19:03:59.379Z\",\n \"active\": true\n }\n ]\n },\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"f07af1e4-f957-479f-af8c-980102f39a69"},{"name":"Delete Team","id":"24d12400-08d0-4362-b1f3-967c0871147b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://hsipublicapi.azure-api.net/team/{id}","description":"

Remove a single team from the system. The {id} in the URL is the HSI Team ID.

\n","urlObject":{"protocol":"https","path":["team","{id}"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"adb430a2-fad0-4c44-baa1-8eeba6ff78c9","name":"Delete Team","originalRequest":{"method":"DELETE","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/team/delete"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": \"string\",\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"24d12400-08d0-4362-b1f3-967c0871147b"},{"name":"Add Admins To Team","id":"cbbf5122-469b-41af-bc60-38b5e835c071","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"adminId\": 0,\r\n \"receiveNotifications\": true,\r\n \"teamContact\": true\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/team/{id}/admins","description":"

Add administrators to a team. Multiple administrators can be added to a team at once by passing in the administrators' information via the body of the request.

\n","urlObject":{"protocol":"https","path":["team","{id}","admins"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"f356363f-e451-4dd5-8b53-83810c70f0c1","name":"Add Admins To Team","originalRequest":{"method":"PUT","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/team/{id}/admins"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": \"string\",\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"cbbf5122-469b-41af-bc60-38b5e835c071"},{"name":"Add Members To Team","id":"58ffd397-f3c8-4034-8116-706e07e062c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"memberId\": 0\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/team/{id}/members","description":"

Add members to a team. The {id} in the URL is the HSI Team ID. Multiple members can be added at once by passing in the members' information via the body of the request.

\n","urlObject":{"protocol":"https","path":["team","{id}","members"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"7ac26362-bdd2-4083-bcc3-89e964cebb22","name":"Add Members To Team","originalRequest":{"method":"PUT","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/team/{id}/members"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": \"string\",\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"58ffd397-f3c8-4034-8116-706e07e062c4"}],"id":"e44ef97b-0fe4-4c55-92f2-c0d5acc7d5b7","description":"

The API tools to manage Teams in the system.

\n","_postman_id":"e44ef97b-0fe4-4c55-92f2-c0d5acc7d5b7"},{"name":"Customer","item":[{"name":"Get Metadata Fields List","id":"bda201b4-521c-4437-a8e9-a47017810e81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"active\": \"true\",\r\n \"keywords\": \"\"\r\n },\r\n \"offset\": 0,\r\n \"limit\": 50\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/customer/metadata/field/list","description":"

Get a paged set of the metadata fields associated with your organization. Both search parameters within 'data' are required.

Search Parameters

'active' is a boolean. true will return all active metadata fields.
'keywords' is a string that will return metadata fields with names ('fieldLabel') similar to the keyword entered.

To return all of your organization's active metadata fields, use the search object:

{\n    \"active\": \"true\", \n    \"keywords\": \"\"\n}\n

","urlObject":{"protocol":"https","path":["customer","metadata","field","list"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"4158bbe3-c8b0-4407-84bf-571ab531ca5a","name":"Get Metadata Fields List","originalRequest":{"method":"POST","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"active\": \"true\",\r\n \"keywords\": \"\"\r\n },\r\n \"offset\": 0,\r\n \"limit\": 50\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/customer/metadata/field/list"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"metadataFieldGuid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"seqNo\": 0,\r\n \"fieldLabel\": \"string\",\r\n \"fieldDatatype\": \"string\",\r\n \"fieldLength\": 0,\r\n \"createDateTime\": \"2021-10-29T19:11:19.670Z\",\r\n \"lastUpdateDateTime\": \"2021-10-29T19:11:19.670Z\",\r\n \"target\": \"string\",\r\n \"listValues\": \"string\",\r\n \"isActive\": true\r\n }\r\n ],\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true,\r\n \"totalResults\": 0,\r\n \"moreResults\": true,\r\n \"offset\": 0,\r\n \"limit\": 0\r\n}"}],"_postman_id":"bda201b4-521c-4437-a8e9-a47017810e81"},{"name":"Create Metadata Field","id":"79a209b7-c92e-47cd-a284-2c68272ae61e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"fieldLabel\": \"string\",\r\n \"fieldDataType\": \"string\",\r\n \"fieldLength\": 0,\r\n \"fieldDescription\": \"string\",\r\n \"target\": \"string\",\r\n \"listValues\": \"string\",\r\n \"isActive\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/customer/metadata/field","description":"

Create a single metadata field

Definitions of input parameters:

'target' is a string and defines if the metadata field is intended to apply to members within your organization or to other objects within your organization.
- The values it accepts are \"member\" or \"site\".
\n
'fieldLabel' is a string and defines the name of the metadata field.
- Duplicate metadata field names are not supported.
\n
'fieldDataType' defines what information you would like the metadata field to reflect. It is a string and accepts as values:
- \"TEXT\"
- \"LONG TEXT\"
- \"DATE\"
- \"YES NO\"
  - a boolean metadata field.
  \n
- \"DROP DOWN LIST\"
  - a metadata field with multiple options, only one of which may be selected.
  \n
- \"DROP DOWN LIST MULTIPLE\"
  - a metadata field with multiple options, any number of which may be selected.
  \n
\n
'fieldLength' is an int, and the value depends on the 'fieldDataType' setting:
- \"TEXT\" or \"LONG TEXT\":
  - 'fieldLength' must be set to a value greater than 1 representing the number of characters to to displayed on the metadata field.
  \n
- \"YES NO\":
  - 'fieldLength' must be set to 1.
  \n
- \"DATE\", \"DROP DOWN LIST\", or \"DROP DOWN LIST MULTIPLE\":
  - 'fieldLength' must be set to 0.
  \n
\n
'listValues' is a string, and the setting depends on the 'fieldDataType' setting:
- \"TEXT\", \"LONG TEXT\", \"DATE\", or \"YES NO\":
  - 'listValues' must be set to \"\" (empty string).
  \n
- \"DROP DOWN LIST\", or \"DROP DOWN LIST MULTIPLE\":
  - 'listValues' must be set to a string of semicolon separated values. These will be the available options in the list.
  - For example: \"Jeff;Amy;Andy;Jack\" or \"Option One;Option Two;Option Three\".
  \n
\n
'fieldDescription' is a string, and is a description of the metadata field. It is optional to include.

\n","urlObject":{"protocol":"https","path":["customer","metadata","field"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"797b078b-3fea-4ef4-80d7-6df60963bad8","name":"Create Metadata Field","originalRequest":{"method":"POST","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/customer/metadata/field"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"metadataFieldGuid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"seqNo\": 0,\r\n \"fieldLabel\": \"string\",\r\n \"fieldDatatype\": \"string\",\r\n \"fieldLength\": 0,\r\n \"createDateTime\": \"2021-10-29T19:11:19.686Z\",\r\n \"lastUpdateDateTime\": \"2021-10-29T19:11:19.686Z\",\r\n \"target\": \"string\",\r\n \"listValues\": \"string\",\r\n \"isActive\": true\r\n },\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"79a209b7-c92e-47cd-a284-2c68272ae61e"},{"name":"Get Metadata Field By Id","id":"56735225-77a6-400c-92f5-d41a803bcb6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hsipublicapi.azure-api.net/customer/metadata/{guid}","description":"

Gets a single metadata field. The {guid} is the metadata field's guid.

\n","urlObject":{"protocol":"https","path":["customer","metadata","{guid}"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"4869468d-1d0f-4457-b53f-60a0c0e12d2e","name":"Get Metadata Field By Id","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/customer/metadata/{guid}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"metadataFieldGuid\": \"00000000-0000-0000-0000-000000000000\",\r\n \"seqNo\": 0,\r\n \"fieldLabel\": \"string\",\r\n \"fieldDatatype\": \"string\",\r\n \"fieldLength\": 0,\r\n \"createDateTime\": \"2021-10-29T19:11:19.682Z\",\r\n \"lastUpdateDateTime\": \"2021-10-29T19:11:19.682Z\",\r\n \"target\": \"string\",\r\n \"listValues\": \"string\",\r\n \"isActive\": true\r\n },\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"56735225-77a6-400c-92f5-d41a803bcb6b"},{"name":"Update Metadata Field","id":"774cdd4a-dfcb-4d22-b4a3-df006cf48e8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"fieldLabel\": \"string\",\r\n \"fieldDataType\": \"string\",\r\n \"fieldLength\": 0,\r\n \"fieldDescription\": \"string\",\r\n \"target\": \"string\",\r\n \"listValues\": \"string\",\r\n \"isActive\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/customer/metadata/{guid}","description":"

Update a single metadata field. The {guid} is the metadata field's guid. Refer to the documentation for Create Metadata Field for what the input parameters mean.

Delete a single metadata field. The {guid} is the metadata field's guid.

This contains the API tools to manage your organization's custom metadata fields.

\n","_postman_id":"eb13403c-0410-42ac-8643-e52a1f4e09f6"},{"name":"Tag","item":[{"name":"Get Tags List","id":"fda70ea9-4167-4d15-be43-68019acc285f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"includeHsiTags\": true\r\n },\r\n \"offset\": 0,\r\n \"limit\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/tag/list","description":"

Get a paged set of tags for your organization. The 'includeHsiTags' field in the search parameters is optional. If set to 'true', tags that are owned by HSI will be returned along with your organization's custom tags.

\n","urlObject":{"protocol":"https","path":["tag","list"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"cd25af09-0544-400b-a746-51feca00510e","name":"Get Tags List","originalRequest":{"method":"POST","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/tag/list"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 0,\n \"name\": \"string\",\n \"description\": \"string\",\n \"groupCount\": 0,\n \"courseCount\": 0,\n \"requirementCount\": 0,\n \"hsiOwned\": true,\n \"color\": \"LightGreen\"\n }\n ],\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true,\n \"totalResults\": 0,\n \"moreResults\": true,\n \"offset\": 0,\n \"limit\": 0\n}"}],"_postman_id":"fda70ea9-4167-4d15-be43-68019acc285f"},{"name":"Create Tags","id":"31e1df21-b837-4847-a4b3-66fa9e1cd199","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"name\": \"string\",\r\n \"description\": \"string\",\r\n \"color\": \"LightGreen\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/tag/create","description":"

Create tags in the system.

Definition of input parameters:

'color' is a string and can be any of the default colors in the HSI System.
- The default color values that the system will recognize are:
  - LightGreen
  - Orange
  - Purple
  - DarkPurple
  - Teal
  - Magenta
  - Blue
  - MediumBlue
  - Yellow
  - BlackClay
  - MidnightBlue
  - WetAsphalt
  - Stone
  - BlueGrey
  - Steel
  - Concrete
  \n
\n
'name' is the name you would like your tag to have in the system.
'description' is the description of the tag.

The tag IDs of the newly-created tags are returned in an array of integers.

\n","urlObject":{"protocol":"https","path":["tag","create"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"fa5f5341-66c3-4714-aa56-ebf0264fb141","name":"Create Tag","originalRequest":{"method":"POST","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/tag/create"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n 0\r\n ],\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"31e1df21-b837-4847-a4b3-66fa9e1cd199"},{"name":"Get Tag by Id","id":"691c5e7d-d716-4c03-bdb4-57c72a055aca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hsipublicapi.azure-api.net/tag/{id}","description":"

Get a single tag by tag ID.

\n","urlObject":{"protocol":"https","path":["tag","{id}"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"13941cec-e5c6-42be-aacf-7999fb10498f","name":"Get Tag by Id","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/tag/{id}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"id\": 0,\r\n \"name\": \"string\",\r\n \"description\": \"string\",\r\n \"groupCount\": 0,\r\n \"courseCount\": 0,\r\n \"requirementCount\": 0,\r\n \"hsiOwned\": true,\r\n \"color\": 1\r\n },\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"691c5e7d-d716-4c03-bdb4-57c72a055aca"},{"name":"Update Tags","id":"8f8594ce-77f0-4add-b47f-96d2fa7c121d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"id\": 0,\r\n \"name\": \"string\",\r\n \"description\": \"string\",\r\n \"color\": \"LightGreen\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/tag/update","description":"

Update tags by tag ID.

Definition of input parameters:

'color' is a string and can be any of the default colors in the HSI System.
- The default color values that the system will recognize are:
  - LightGreen
  - Orange
  - Purple
  - DarkPurple
  - Teal
  - Magenta
  - Blue
  - MediumBlue
  - Yellow
  - BlackClay
  - MidnightBlue
  - WetAsphalt
  - Stone
  - BlueGrey
  - Steel
  - Concrete
  \n
\n
'name' is the name you would like your tag to have in the system.
'description' is the description of the tag.

Tag IDs of the updated tags are returned as an array of integers.

\n","urlObject":{"protocol":"https","path":["tag","update"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"7ab6ffc1-7ea9-467a-be84-a4975a6400dd","name":"Update Tags","originalRequest":{"method":"PUT","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/tag/update"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n 0\r\n ],\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"8f8594ce-77f0-4add-b47f-96d2fa7c121d"},{"name":"Delete Tag","id":"76354aba-a23f-438f-bfe1-adef5e512348","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://hsipublicapi.azure-api.net/tag/{id}","description":"

Delete a single tag by tag ID.

\n","urlObject":{"protocol":"https","path":["tag","{id}"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"6875c1ef-221c-4119-ac68-b828d126267d","name":"Delete Tag","originalRequest":{"method":"DELETE","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/tag/{id}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": 0,\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"76354aba-a23f-438f-bfe1-adef5e512348"},{"name":"Get Tagged Objects","id":"5987d755-463f-4e53-b8eb-51cadad67deb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"id\": 0,\r\n \"type\": \"string\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/tag/objects","description":"

Get a set of tags with the object ID and object Type that the tag is associated with. Each tag/object association is returned as a single object.

'id' is the ID of the object you would like to get the tag associations for.
'type' is the type of object that the object ID belongs to. It accepts as values:
- \"Group\"
- \"Course\"
- \"TrainingRequirement\"
\n

\n","urlObject":{"protocol":"https","path":["tag","objects"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"dab70eb4-dee9-450a-b92a-f8fb3af66839","name":"Get Tagged Objects","originalRequest":{"method":"POST","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/tag/objects"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"id\": 0,\r\n \"name\": \"string\",\r\n \"description\": \"string\",\r\n \"groupCount\": 0,\r\n \"courseCount\": 0,\r\n \"requirementCount\": 0,\r\n \"hsiOwned\": true,\r\n \"color\": 1,\r\n \"taggedObject\": {\r\n \"id\": 0,\r\n \"type\": \"string\"\r\n }\r\n }\r\n ],\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"5987d755-463f-4e53-b8eb-51cadad67deb"},{"name":"Add Tag to Object","id":"153e4304-c7a3-4e6f-a301-c69af78daa87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 0,\r\n \"type\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/tag/{id}/assign","description":"

Associate a tag with an object.

\n","urlObject":{"protocol":"https","path":["tag","{id}","assign"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"72d051a1-d035-4d52-8e21-0e6284fedbff","name":"Add Tag to Object","originalRequest":{"method":"POST","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/tag/{id}/assign"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": \"string\",\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"153e4304-c7a3-4e6f-a301-c69af78daa87"},{"name":"Remove Tag from Object","id":"e8855f9d-e362-440d-ba5c-1a0e71b0bf23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 0,\r\n \"type\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/tag/{id}/remove","description":"

Remove a tag from an object.

\n","urlObject":{"protocol":"https","path":["tag","{id}","remove"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"8fb36ed2-bb03-4193-8ca0-6236f27ed7b1","name":"Remove Tag from Object","originalRequest":{"method":"DELETE","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/tag/{id}/remove"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": \"string\",\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"e8855f9d-e362-440d-ba5c-1a0e71b0bf23"}],"id":"9df5f780-0e06-4c7b-b1f3-764fc86a0d1c","description":"

This contains the API tools for you to manage your organization's tags.

Tags can be attached to Groups, Courses, or Training Requirements.

\n","_postman_id":"9df5f780-0e06-4c7b-b1f3-764fc86a0d1c"},{"name":"LibraryDocument","item":[{"name":"Get Library Document By ID","id":"40bbe6f9-1a5a-42a9-bf26-686932242ec9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hsipublicapi.azure-api.net/libraryDocument/{id}","description":"

Get a single Library Document. The {id} in the URL is unique identifier for the Library Document you would like to retrieve.

\n","urlObject":{"protocol":"https","path":["libraryDocument","{id}"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"b64cbe61-f605-48fb-9815-c4a0457e030d","name":"Get Library Document By ID","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/libraryDocument/{id}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"Id\": \"string\",\r\n \"DocumentFormatIds\": [\r\n \"string\"\r\n ],\r\n \"Unmatchable\": true,\r\n \"ProprietaryCustomerId\": 0,\r\n \"FieldValues\": [\r\n {\r\n \"Identifier\": \"string\",\r\n \"Attributes\": [\r\n {\r\n \"Type\": \"string\",\r\n \"Comment\": \"string\"\r\n }\r\n ],\r\n \"Value\": {}\r\n }\r\n ],\r\n \"Language\": \"string\",\r\n \"PdfUri\": \"string\",\r\n \"UpdatedAt\": \"2022-05-12T23:12:27.085Z\",\r\n \"PdfUpdatedAt\": \"2022-05-12T23:12:27.085Z\",\r\n \"IsInvalid\": true,\r\n \"Specifier\": \"string\"\r\n },\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"40bbe6f9-1a5a-42a9-bf26-686932242ec9"},{"name":"Get PDF By LibraryDocument ID","id":"01a2de92-6e42-455c-96de-029e8ccaaf7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hsipublicapi.azure-api.net/libraryDocument/{libraryDocumentId}/pdf","description":"

Retrieve the byte array of the PDF for a Library Document. The {libraryDocumentId} in the URL is the unique identifier for the Library Document whose pdf you would like to retrieve.

\n","urlObject":{"protocol":"https","path":["libraryDocument","{libraryDocumentId}","pdf"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"569440f4-84f3-4153-b37c-fd62bfbc4134","name":"Get PDF by Library Document ID","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/libraryDocument/{libraryDocumentId}/pdf"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"01a2de92-6e42-455c-96de-029e8ccaaf7c"},{"name":"Get PDF Temp Url By LibraryDocument ID","id":"e988ddb8-3f64-4498-b8ea-d9f8e586e862","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hsipublicapi.azure-api.net/libraryDocument/{libraryDocumentId}/pdf/temp-url","description":"

Retrieves a url for the PDF for a Library Document. The {libraryDocumentId} in the URL is the unique identifier for the Library Document whose pdf you would like to retrieve. The url will be valid for one day or 500 views.

\n","urlObject":{"protocol":"https","path":["libraryDocument","{libraryDocumentId}","pdf","temp-url"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"b8cfe25d-78c2-42e1-862a-7afb4b88e1d1","name":"Get PDF by Library Document ID","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/libraryDocument/pdf/{libraryDocumentId}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": \"\",\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"e988ddb8-3f64-4498-b8ea-d9f8e586e862"},{"name":"Get Library Document With CaptureField Overrides By Customer MaterialId and Thread Id","id":"ea0c130c-58e7-43c2-ae3e-fe070a1798f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hsipublicapi.azure-api.net/libraryDocument/WithCustomerOverrides?customerMaterialId={customerMaterialId}&threadId={threadId}","description":"

Get a single Library Document with additional override data. The {id} in the URL is the unique identifier for the Library Document you would like to retrieve.

\n","urlObject":{"protocol":"https","path":["libraryDocument","WithCustomerOverrides"],"host":["hsipublicapi","azure-api","net"],"query":[{"key":"customerMaterialId","value":"{customerMaterialId}"},{"key":"threadId","value":"{threadId}"}],"variable":[]}},"response":[{"id":"fbb7d3d0-7768-4028-8bcc-eca1b608957e","name":"Get Library Document With CaptureField Overrides By Customer MaterialId and Thread Id","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":{"raw":"https://hsipublicapi.azure-api.net/libraryDocument/WithCustomerOverrides?customerMaterialId={customerMaterialId}&threadId={threadId}","protocol":"https","host":["hsipublicapi","azure-api","net"],"path":["libraryDocument","WithCustomerOverrides"],"query":[{"key":"customerMaterialId","value":"{customerMaterialId}","type":"text"},{"key":"threadId","value":"{threadId}","type":"text"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"Id\": \"string\",\r\n \"DocumentFormatIds\": [\r\n \"string\"\r\n ],\r\n \"Unmatchable\": true,\r\n \"ProprietaryCustomerId\": 0,\r\n \"FieldValues\": [\r\n {\r\n \"Identifier\": \"string\",\r\n \"Attributes\": [\r\n {\r\n \"Type\": \"string\",\r\n \"Comment\": \"string\"\r\n }\r\n ],\r\n \"Value\": {}\r\n }\r\n ],\r\n \"Language\": \"string\",\r\n \"PdfUri\": \"string\",\r\n \"UpdatedAt\": \"2022-05-12T23:12:27.085Z\",\r\n \"PdfUpdatedAt\": \"2022-05-12T23:12:27.085Z\",\r\n \"IsInvalid\": true,\r\n \"Specifier\": \"string\",\r\n \"Overrides\": [\r\n {\r\n \"Identifier\": \"string\",\r\n \"Attributes\": [\r\n {\r\n \"Type\": \"string\",\r\n \"Comment\": \"string\"\r\n }\r\n ],\r\n \"Value\": {}\r\n }\r\n ]\r\n },\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"ea0c130c-58e7-43c2-ae3e-fe070a1798f3"}],"id":"99decbd7-9785-48ef-990e-1d39772fb2bd","description":"

Contains the API tools to manage Library Documents within your organization.

\n","event":[{"listen":"prerequest","script":{"id":"b7772a90-f211-4385-9832-d76b5bf785db","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6410b708-edbd-4332-911b-6691d9a428d7","type":"text/javascript","exec":[""]}}],"_postman_id":"99decbd7-9785-48ef-990e-1d39772fb2bd"},{"name":"CustomerMaterial","item":[{"name":"Sync","id":"45818b9d-7c12-4612-945f-007dd1aa5d8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hsipublicapi.azure-api.net/customermaterial/sync?globalNumber={globalNumber}&pagesize={pagesize}","description":"

Gets a list of Customer Materials. The {pageSize} in the URL allows up to 1000 records to be retrieve. The {globalNumber} in the URL will tell the endpoint where to begin returning records from. By using the maxGlobalNumber returned in the results you can request the next batch.

\n","urlObject":{"protocol":"https","path":["customermaterial","sync"],"host":["hsipublicapi","azure-api","net"],"query":[{"key":"globalNumber","value":"{globalNumber}"},{"key":"pagesize","value":"{pagesize}"}],"variable":[]}},"response":[{"id":"0571fac3-df8b-4178-80c4-eb16012f4472","name":"Sync","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":{"raw":"https://hsipublicapi.azure-api.net/customermaterial/sync?globalNumber={globalNumber}&pagesize={pagesize}","protocol":"https","host":["hsipublicapi","azure-api","net"],"path":["customermaterial","sync"],"query":[{"key":"globalNumber","value":"{globalNumber}"},{"key":"pagesize","value":"{pagesize}"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"Id\": \"string\",\n \"Name\": \"string\",\n \"CustomerId\": 0,\n \"CustomerMaterialLocations\": [\n {\n \"LocationId\": \"string\",\n \"IsActive\": true,\n \"DeactivatedAt\": \"2022-09-01T18:54:54.653Z\",\n \"AssociatedAt\": \"2022-09-01T18:54:54.653Z\",\n \"CustomerApprovalTypeId\": \"string\"\n }\n ],\n \"CustomerLibraryMaterials\": [\n {\n \"LibraryMaterial\": {\n \"Id\": \"string\",\n \"LatestLibraryDocument\": {\n \"Id\": \"string\",\n \"DocumentFormatIds\": [\n \"string\"\n ],\n \"Unmatchable\": true,\n \"ProprietaryCustomerId\": 0,\n \"FieldValues\": [\n {\n \"Identifier\": \"string\",\n \"Attributes\": [\n {\n \"Type\": \"string\",\n \"Comment\": \"string\"\n }\n ],\n \"Value\": {}\n }\n ],\n \"Language\": \"string\",\n \"PdfUri\": \"string\",\n \"UpdatedAt\": \"2022-09-01T18:54:54.653Z\",\n \"PdfUpdatedAt\": \"2022-09-01T18:54:54.653Z\",\n \"IsInvalid\": true,\n \"Specifier\": \"string\",\n \"UpdatedTimestamp\": 0,\n \"KitId\": \"string\",\n \"Proprietary\": true\n },\n \"LatestMaterialRevisions\": [\n \"string\"\n ],\n \"CreatedAt\": \"2022-09-01T18:54:54.653Z\",\n \"ReplacedBy\": {\n \"LibraryMaterialId\": \"string\",\n \"ReplacedAt\": \"2022-09-01T18:54:54.653Z\",\n \"ReplacedByUserId\": 0\n },\n \"Timestamp\": 0\n },\n \"CurrentLibraryDocument\": {\n \"Id\": \"string\",\n \"DocumentFormatIds\": [\n \"string\"\n ],\n \"Unmatchable\": true,\n \"ProprietaryCustomerId\": 0,\n \"FieldValues\": [\n {\n \"Identifier\": \"string\",\n \"Attributes\": [\n {\n \"Type\": \"string\",\n \"Comment\": \"string\"\n }\n ],\n \"Value\": {}\n }\n ],\n \"Language\": \"string\",\n \"PdfUri\": \"string\",\n \"UpdatedAt\": \"2022-09-01T18:54:54.653Z\",\n \"PdfUpdatedAt\": \"2022-09-01T18:54:54.653Z\",\n \"IsInvalid\": true,\n \"Specifier\": \"string\",\n \"UpdatedTimestamp\": 0,\n \"KitId\": \"string\",\n \"Proprietary\": true\n },\n \"CreatedAt\": \"2022-09-01T18:54:54.653Z\",\n \"UserId\": 0,\n \"Overrides\": [\n {\n \"Identifier\": \"string\",\n \"Attributes\": [\n {\n \"Type\": \"string\",\n \"Comment\": \"string\"\n }\n ],\n \"Value\": {}\n }\n ],\n \"ThreadId\": \"string\",\n \"Action\": \"string\",\n \"DocumentNumber\": 0,\n \"Metadata\": \"string\",\n \"IsActive\": true,\n \"IsMerged\": true,\n \"IsLatest\": true\n }\n ],\n \"CreatedAt\": \"2022-09-01T18:54:54.653Z\",\n \"ReplacedBy\": {\n \"CustomerMaterialId\": \"string\",\n \"ReplacedBy\": 0,\n \"ReplacedAt\": \"2022-09-01T18:54:54.653Z\"\n },\n \"IsActive\": true,\n \"MaterialNumber\": 0,\n \"PreviousMaterialNumbers\": [\n 0\n ],\n \"ClassificationIds\": [\n \"string\"\n ],\n \"CustomFields\": [\n {\n \"TemplateInstanceId\": \"string\"\n }\n ],\n \"GlobalNumber\": 0,\n \"CustomerApprovalTypeId\": \"string\",\n \"HazardClassIds\": [\n 0\n ]\n }\n ],\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"45818b9d-7c12-4612-945f-007dd1aa5d8c"},{"name":"Customer Library Material Thread History","id":"0f7d1da5-b279-4b3c-ba17-60342faad7f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"customerId\": 0,\r\n \"createdDate\": \"string\"\r\n },\r\n \"offset\": 0,\r\n \"limit\": 0\r\n}"},"url":"https://hsipublicapi.azure-api.net/customermaterial/ThreadHistory","description":"

Retrieve the Customer Material histories using the created date passed in.

\n","urlObject":{"protocol":"https","path":["customermaterial","ThreadHistory"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"6a609b92-a51e-42d5-9e5b-9255d5a52b40","name":"Customer Library Material Thread History","originalRequest":{"method":"POST","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/customermaterial/ThreadHistory"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"Id\": \"string\",\r\n \"Name\": \"string\",\r\n \"CustomerId\": 0,\r\n \"CustomerMaterialLocations\": [\r\n {\r\n \"LocationId\": \"string\",\r\n \"IsActive\": true,\r\n \"DeactivatedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"AssociatedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"CustomerApprovalTypeId\": \"string\"\r\n }\r\n ],\r\n \"CustomerLibraryMaterials\": [\r\n {\r\n \"LibraryMaterial\": {\r\n \"Id\": \"string\",\r\n \"LatestLibraryDocument\": {\r\n \"Id\": \"string\",\r\n \"DocumentFormatIds\": [\r\n \"string\"\r\n ],\r\n \"Unmatchable\": true,\r\n \"ProprietaryCustomerId\": 0,\r\n \"FieldValues\": [\r\n {\r\n \"Identifier\": \"string\",\r\n \"Attributes\": [\r\n {\r\n \"Type\": \"string\",\r\n \"Comment\": \"string\"\r\n }\r\n ],\r\n \"Value\": {}\r\n }\r\n ],\r\n \"Language\": \"string\",\r\n \"PdfUri\": \"string\",\r\n \"UpdatedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"PdfUpdatedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"IsInvalid\": true,\r\n \"Specifier\": \"string\",\r\n \"UpdatedTimestamp\": 0,\r\n \"KitId\": \"string\",\r\n \"Proprietary\": true\r\n },\r\n \"LatestMaterialRevisions\": [\r\n \"string\"\r\n ],\r\n \"CreatedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"ReplacedBy\": {\r\n \"LibraryMaterialId\": \"string\",\r\n \"ReplacedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"ReplacedByUserId\": 0\r\n },\r\n \"Timestamp\": 0\r\n },\r\n \"CurrentLibraryDocument\": {\r\n \"Id\": \"string\",\r\n \"DocumentFormatIds\": [\r\n \"string\"\r\n ],\r\n \"Unmatchable\": true,\r\n \"ProprietaryCustomerId\": 0,\r\n \"FieldValues\": [\r\n {\r\n \"Identifier\": \"string\",\r\n \"Attributes\": [\r\n {\r\n \"Type\": \"string\",\r\n \"Comment\": \"string\"\r\n }\r\n ],\r\n \"Value\": {}\r\n }\r\n ],\r\n \"Language\": \"string\",\r\n \"PdfUri\": \"string\",\r\n \"UpdatedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"PdfUpdatedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"IsInvalid\": true,\r\n \"Specifier\": \"string\",\r\n \"UpdatedTimestamp\": 0,\r\n \"KitId\": \"string\",\r\n \"Proprietary\": true\r\n },\r\n \"CreatedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"UserId\": 0,\r\n \"Overrides\": [\r\n {\r\n \"Identifier\": \"string\",\r\n \"Attributes\": [\r\n {\r\n \"Type\": \"string\",\r\n \"Comment\": \"string\"\r\n }\r\n ],\r\n \"Value\": {}\r\n }\r\n ],\r\n \"ThreadId\": \"string\",\r\n \"Action\": \"string\",\r\n \"DocumentNumber\": 0,\r\n \"Metadata\": \"string\",\r\n \"IsActive\": true,\r\n \"IsMerged\": true,\r\n \"IsLatest\": true\r\n }\r\n ],\r\n \"CreatedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"ReplacedBy\": {\r\n \"CustomerMaterialId\": \"string\",\r\n \"ReplacedBy\": 0,\r\n \"ReplacedAt\": \"2022-09-01T18:54:54.653Z\"\r\n },\r\n \"IsActive\": true,\r\n \"MaterialNumber\": 0,\r\n \"PreviousMaterialNumbers\": [\r\n 0\r\n ],\r\n \"ClassificationIds\": [\r\n \"string\"\r\n ],\r\n \"CustomFields\": [\r\n {\r\n \"TemplateInstanceId\": \"string\"\r\n }\r\n ],\r\n \"GlobalNumber\": 0,\r\n \"CustomerApprovalTypeId\": \"string\",\r\n \"HazardClassIds\": [\r\n 0\r\n ]\r\n },\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"0f7d1da5-b279-4b3c-ba17-60342faad7f0"},{"name":"Update","id":"c825c187-a7ec-4f4f-86e2-9ebe7af350fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"\r\n\r\n{\r\n \"isActive\": 0,\r\n \"name\": \"string\",\r\n \"classificationIds\": [\r\n \"string\"\r\n ],\r\n \"customFieldValues\": [\r\n \"string\"\r\n ]\r\n}"},"url":"https://hsipublicapi.azure-api.net/customermaterial/{id}","description":"

Updates a Customer Material by Id. The {customermaterialId} in the URL represents the id of the Customer Material you want to update.

\n","urlObject":{"protocol":"https","path":["customermaterial","{id}"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"2a6a6e5c-8f55-4770-89b4-36d523d6fe93","name":"Update","originalRequest":{"method":"PUT","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/customermaterial/{id}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"Id\": \"string\",\r\n \"Name\": \"string\",\r\n \"CustomerId\": 0,\r\n \"CustomerMaterialLocations\": [\r\n {\r\n \"LocationId\": \"string\",\r\n \"IsActive\": true,\r\n \"DeactivatedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"AssociatedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"CustomerApprovalTypeId\": \"string\"\r\n }\r\n ],\r\n \"CustomerLibraryMaterials\": [\r\n {\r\n \"LibraryMaterial\": {\r\n \"Id\": \"string\",\r\n \"LatestLibraryDocument\": {\r\n \"Id\": \"string\",\r\n \"DocumentFormatIds\": [\r\n \"string\"\r\n ],\r\n \"Unmatchable\": true,\r\n \"ProprietaryCustomerId\": 0,\r\n \"FieldValues\": [\r\n {\r\n \"Identifier\": \"string\",\r\n \"Attributes\": [\r\n {\r\n \"Type\": \"string\",\r\n \"Comment\": \"string\"\r\n }\r\n ],\r\n \"Value\": {}\r\n }\r\n ],\r\n \"Language\": \"string\",\r\n \"PdfUri\": \"string\",\r\n \"UpdatedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"PdfUpdatedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"IsInvalid\": true,\r\n \"Specifier\": \"string\",\r\n \"UpdatedTimestamp\": 0,\r\n \"KitId\": \"string\",\r\n \"Proprietary\": true\r\n },\r\n \"LatestMaterialRevisions\": [\r\n \"string\"\r\n ],\r\n \"CreatedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"ReplacedBy\": {\r\n \"LibraryMaterialId\": \"string\",\r\n \"ReplacedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"ReplacedByUserId\": 0\r\n },\r\n \"Timestamp\": 0\r\n },\r\n \"CurrentLibraryDocument\": {\r\n \"Id\": \"string\",\r\n \"DocumentFormatIds\": [\r\n \"string\"\r\n ],\r\n \"Unmatchable\": true,\r\n \"ProprietaryCustomerId\": 0,\r\n \"FieldValues\": [\r\n {\r\n \"Identifier\": \"string\",\r\n \"Attributes\": [\r\n {\r\n \"Type\": \"string\",\r\n \"Comment\": \"string\"\r\n }\r\n ],\r\n \"Value\": {}\r\n }\r\n ],\r\n \"Language\": \"string\",\r\n \"PdfUri\": \"string\",\r\n \"UpdatedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"PdfUpdatedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"IsInvalid\": true,\r\n \"Specifier\": \"string\",\r\n \"UpdatedTimestamp\": 0,\r\n \"KitId\": \"string\",\r\n \"Proprietary\": true\r\n },\r\n \"CreatedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"UserId\": 0,\r\n \"Overrides\": [\r\n {\r\n \"Identifier\": \"string\",\r\n \"Attributes\": [\r\n {\r\n \"Type\": \"string\",\r\n \"Comment\": \"string\"\r\n }\r\n ],\r\n \"Value\": {}\r\n }\r\n ],\r\n \"ThreadId\": \"string\",\r\n \"Action\": \"string\",\r\n \"DocumentNumber\": 0,\r\n \"Metadata\": \"string\",\r\n \"IsActive\": true,\r\n \"IsMerged\": true,\r\n \"IsLatest\": true\r\n }\r\n ],\r\n \"CreatedAt\": \"2022-09-01T18:54:54.653Z\",\r\n \"ReplacedBy\": {\r\n \"CustomerMaterialId\": \"string\",\r\n \"ReplacedBy\": 0,\r\n \"ReplacedAt\": \"2022-09-01T18:54:54.653Z\"\r\n },\r\n \"IsActive\": true,\r\n \"MaterialNumber\": 0,\r\n \"PreviousMaterialNumbers\": [\r\n 0\r\n ],\r\n \"ClassificationIds\": [\r\n \"string\"\r\n ],\r\n \"CustomFields\": [\r\n {\r\n \"TemplateInstanceId\": \"string\"\r\n }\r\n ],\r\n \"GlobalNumber\": 0,\r\n \"CustomerApprovalTypeId\": \"string\",\r\n \"HazardClassIds\": [\r\n 0\r\n ]\r\n },\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"c825c187-a7ec-4f4f-86e2-9ebe7af350fd"}],"id":"f32b8609-c469-4fc0-ae6d-f653d2c9b1da","description":"

Contains the API tools to manage Customer Library Materials within your organization.

\n","event":[{"listen":"prerequest","script":{"id":"b7772a90-f211-4385-9832-d76b5bf785db","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6410b708-edbd-4332-911b-6691d9a428d7","type":"text/javascript","exec":[""]}}],"_postman_id":"f32b8609-c469-4fc0-ae6d-f653d2c9b1da"},{"name":"Inventory","item":[{"name":"Get Inventory","id":"e23bee64-19ec-4c32-8054-5e046261b24c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"offset\": 0,\r\n \"limit\": 50\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/inventory/sync?offset={offset}&pageSize={pageSize}","description":"

Returns a list of inventory sync history for the customers inventory records

\n","urlObject":{"protocol":"https","path":["inventory","sync"],"host":["hsipublicapi","azure-api","net"],"query":[{"key":"offset","value":"{offset}"},{"key":"pageSize","value":"{pageSize}"}],"variable":[]}},"response":[{"id":"4c5625b1-ac5b-496b-ad8c-e658cc222ec5","name":"Get Inventory","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/inventory/sync"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"insertedOrupdatedInventoryRecords\": [\r\n {\r\n \"Id\": \"00000000-0000-0000-0000-000000000000\",\r\n \"CustomerLibraryMaterialThreadId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"FacilityId\": 0,\r\n \"LocationId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"InventoryPeriodStart\": \"2019-01-01T00:00:00\",\r\n \"InventoryPeriodEnd\": \"2019-12-31T00:00:00\",\r\n \"PreviousInventoryRecordId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"UnitOfMeasure\": \"string\",\r\n \"ContainerSize\": 0,\r\n \"ContainerType\": \"string\",\r\n \"BulkMaxOnHandInput\": 0,\r\n \"ContainerMaxOnHandInput\": 0,\r\n \"MaxOnHandConverted\": 0,\r\n \"AverageOnHandInput\": 0,\r\n \"AverageOnHandConverted\": 0,\r\n \"ContainerAverageOnHand\": 0,\r\n \"DaysOnSite\": 0,\r\n \"TemperatureCondition\": \"string\",\r\n \"PressureCondition\": \"string\",\r\n \"Epcra312Exempt\": true,\r\n \"Epcra313Exempt\": true,\r\n \"IsActive\": true,\r\n \"IsCurrentPeriod\": true,\r\n \"GasProperties\": {\r\n \"MolecularWeight\": 0,\r\n \"GaugePressure\": 0,\r\n \"TemperatureValue\": 0,\r\n \"TemperatureUnit\": \"string\"\r\n },\r\n \"PurchasedQuantity\": 0,\r\n \"PurchasedConverted\": 0,\r\n \"UsageQuantity\": 0,\r\n \"UsageConverted\": 0,\r\n \"WasteQuantity\": 0,\r\n \"WasteConverted\": 0,\r\n \"ConversionType\": \"string\"\r\n }\r\n ],\r\n \"deletedInventoryRecords\": [\r\n \"00000000-0000-0000-0000-000000000000\"\r\n ],\r\n \"globalNumberStart\": 0,\r\n \"globalNumberEnd\": 0\r\n },\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"e23bee64-19ec-4c32-8054-5e046261b24c"},{"name":"Create","id":"b264a43b-f250-4292-bb4e-a6ff46337c1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerLibraryMaterialThreadId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"locationId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"unitOfMeasure\": \"string\",\r\n \"containerSize\": 0,\r\n \"containerType\": 0,\r\n \"bulkMaxOnHandInput\": 0,\r\n \"containerMaxOnHandInput\": 0,\r\n \"averageOnHandInput\": 0,\r\n \"containerAverageOnHandInput\": 0,\r\n \"daysOnSite\": 0,\r\n \"temperatureCondition\": 0,\r\n \"pressureCondition\": 0,\r\n \"epcra312Exempt\": true,\r\n \"epcra313Exempt\": true,\r\n \"gasProperties\": {\r\n \"molecularWeight\": 0,\r\n \"gaugePressure\": 0,\r\n \"temperatureValue\": 0,\r\n \"temperatureUnit\": \"string\"\r\n },\r\n \"purchasedQuantity\": 0,\r\n \"usageQuantity\": 0,\r\n \"wasteQuantity\": 0,\r\n \"conversionType\": 0,\r\n \"isActive\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/inventory/create","urlObject":{"protocol":"https","path":["inventory","create"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"ad7cf237-c241-4a60-9f19-0d93bdb672ea","name":"Create","originalRequest":{"method":"POST","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerLibraryMaterialThreadId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"locationId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"unitOfMeasure\": \"string\",\r\n \"containerSize\": 0,\r\n \"containerType\": 0,\r\n \"bulkMaxOnHandInput\": 0,\r\n \"containerMaxOnHandInput\": 0,\r\n \"averageOnHandInput\": 0,\r\n \"containerAverageOnHandInput\": 0,\r\n \"daysOnSite\": 0,\r\n \"temperatureCondition\": 0,\r\n \"pressureCondition\": 0,\r\n \"epcra312Exempt\": true,\r\n \"epcra313Exempt\": true,\r\n \"gasProperties\": {\r\n \"molecularWeight\": 0,\r\n \"gaugePressure\": 0,\r\n \"temperatureValue\": 0,\r\n \"temperatureUnit\": \"string\"\r\n },\r\n \"purchasedQuantity\": 0,\r\n \"usageQuantity\": 0,\r\n \"wasteQuantity\": 0,\r\n \"conversionType\": 0,\r\n \"isActive\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/inventory/create"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"id\": \"00000000-0000-0000-0000-000000000000\",\r\n \"customerLibraryMaterialThreadId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"facilityId\": 0,\r\n \"locationId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"inventoryPeriodStart\": \"2025-01-01T00:00:00\",\r\n \"inventoryPeriodEnd\": \"2025-12-31T00:00:00\",\r\n \"previousInventoryRecordId\": null,\r\n \"unitOfMeasure\": \"Pounds\",\r\n \"containerSize\": null,\r\n \"containerType\": \"AboveGroundTank\",\r\n \"bulkMaxOnHandInput\": 100.0000,\r\n \"containerMaxOnHandInput\": null,\r\n \"maxOnHandConverted\": 100.0000,\r\n \"averageOnHandInput\": 100.0000,\r\n \"averageOnHandConverted\": 100.0000,\r\n \"containerAverageOnHand\": null,\r\n \"daysOnSite\": 365,\r\n \"temperatureCondition\": \"AmbientTemperature\",\r\n \"pressureCondition\": \"AmbientPressure\",\r\n \"epcra312Exempt\": false,\r\n \"epcra313Exempt\": false,\r\n \"isActive\": true,\r\n \"isCurrentPeriod\": true,\r\n \"gasProperties\": null,\r\n \"purchasedQuantity\": 100.0000,\r\n \"purchasedConverted\": 100.0000,\r\n \"usageQuantity\": null,\r\n \"usageConverted\": null,\r\n \"wasteQuantity\": null,\r\n \"wasteConverted\": null,\r\n \"conversionType\": \"MassToPounds\"\r\n }\r\n ],\r\n \"error\": null,\r\n \"message\": null,\r\n \"success\": true\r\n}"}],"_postman_id":"b264a43b-f250-4292-bb4e-a6ff46337c1c"},{"name":"Update","id":"4ffd001f-8cb1-487d-a28f-01c60c4d815d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerLibraryMaterialThreadId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"locationId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"unitOfMeasure\": \"string\",\r\n \"containerSize\": 0,\r\n \"containerType\": 0,\r\n \"bulkMaxOnHandInput\": 0,\r\n \"containerMaxOnHandInput\": 0,\r\n \"averageOnHandInput\": 0,\r\n \"containerAverageOnHandInput\": 0,\r\n \"daysOnSite\": 0,\r\n \"temperatureCondition\": 0,\r\n \"pressureCondition\": 0,\r\n \"epcra312Exempt\": true,\r\n \"epcra313Exempt\": true,\r\n \"gasProperties\": {\r\n \"molecularWeight\": 0,\r\n \"gaugePressure\": 0,\r\n \"temperatureValue\": 0,\r\n \"temperatureUnit\": \"string\"\r\n },\r\n \"purchasedQuantity\": 0,\r\n \"usageQuantity\": 0,\r\n \"wasteQuantity\": 0,\r\n \"conversionType\": 0,\r\n \"isActive\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/inventory/update/{id}","urlObject":{"protocol":"https","path":["inventory","update","{id}"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"c7f15b93-ce07-4bd3-b5fc-d0d7dc1102e6","name":"Update","originalRequest":{"method":"PUT","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerLibraryMaterialThreadId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"locationId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"unitOfMeasure\": \"string\",\r\n \"containerSize\": 0,\r\n \"containerType\": 0,\r\n \"bulkMaxOnHandInput\": 0,\r\n \"containerMaxOnHandInput\": 0,\r\n \"averageOnHandInput\": 0,\r\n \"containerAverageOnHandInput\": 0,\r\n \"daysOnSite\": 0,\r\n \"temperatureCondition\": 0,\r\n \"pressureCondition\": 0,\r\n \"epcra312Exempt\": true,\r\n \"epcra313Exempt\": true,\r\n \"gasProperties\": {\r\n \"molecularWeight\": 0,\r\n \"gaugePressure\": 0,\r\n \"temperatureValue\": 0,\r\n \"temperatureUnit\": \"string\"\r\n },\r\n \"purchasedQuantity\": 0,\r\n \"usageQuantity\": 0,\r\n \"wasteQuantity\": 0,\r\n \"conversionType\": 0,\r\n \"isActive\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hsipublicapi.azure-api.net/inventory/update/{id}"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"id\": \"00000000-0000-0000-0000-000000000000\",\r\n \"customerLibraryMaterialThreadId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"facilityId\": 0,\r\n \"locationId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"inventoryPeriodStart\": \"2025-01-01T00:00:00\",\r\n \"inventoryPeriodEnd\": \"2025-12-31T00:00:00\",\r\n \"previousInventoryRecordId\": null,\r\n \"unitOfMeasure\": \"Pounds\",\r\n \"containerSize\": null,\r\n \"containerType\": \"AboveGroundTank\",\r\n \"bulkMaxOnHandInput\": 100.0000,\r\n \"containerMaxOnHandInput\": null,\r\n \"maxOnHandConverted\": 100.0000,\r\n \"averageOnHandInput\": 100.0000,\r\n \"averageOnHandConverted\": 100.0000,\r\n \"containerAverageOnHand\": null,\r\n \"daysOnSite\": 365,\r\n \"temperatureCondition\": \"AmbientTemperature\",\r\n \"pressureCondition\": \"AmbientPressure\",\r\n \"epcra312Exempt\": false,\r\n \"epcra313Exempt\": false,\r\n \"isActive\": true,\r\n \"isCurrentPeriod\": true,\r\n \"gasProperties\": null,\r\n \"purchasedQuantity\": 100.0000,\r\n \"purchasedConverted\": 100.0000,\r\n \"usageQuantity\": null,\r\n \"usageConverted\": null,\r\n \"wasteQuantity\": null,\r\n \"wasteConverted\": null,\r\n \"conversionType\": \"MassToPounds\"\r\n }\r\n ],\r\n \"error\": null,\r\n \"message\": null,\r\n \"success\": true\r\n}"}],"_postman_id":"4ffd001f-8cb1-487d-a28f-01c60c4d815d"}],"id":"a3c8899c-b989-4d4c-842c-bac6f7598d75","description":"

StartFragment

Contains the API tools to manage Inventory within your organization.

EndFragment

\n","_postman_id":"a3c8899c-b989-4d4c-842c-bac6f7598d75"},{"name":"Sites","item":[{"name":"Get Sites By Id","id":"41886961-efd7-4372-af68-b750b2657146","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hsipublicapi.azure-api.net/sites/{id}","description":"

Get a single Site. The {id} in the URL is identifier for the Site you would like to retrieve.

\n","urlObject":{"protocol":"https","path":["sites","{id}"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"03430d75-7ba4-4fc0-8fd1-6d2a42f3a9fd","name":"Get Sites By Id","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":{"raw":"https://hsipublicapi.azure-api.net/inventory?X-HSI-API-KEY={Your API Key}","protocol":"https","host":["hsipublicapi","azure-api","net"],"path":["inventory"],"query":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"active\": true,\r\n \"address1\": \"string\",\r\n \"address2\": \"string\",\r\n \"chemicalManagement\": false,\r\n \"city\": \"string\",\r\n \"contactFirstName\": \"string\",\r\n \"contactLastName\": \"string\",\r\n \"country\": \"string\",\r\n \"email\": \"string\",\r\n \"fax\": \"string\",\r\n \"id\": 0,\r\n \"language\": [\r\n \"string\"\r\n ],\r\n \"metaData\": [\r\n {\r\n \"id\": \"00000000-0000-0000-0000-000000000000\",\r\n \"name\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"name\": \"string\",\r\n \"phone\": \"string\",\r\n \"siteCode\": \"string\",\r\n \"siteAssignmentId\": 0,\r\n \"state\": \"string\",\r\n \"zip\": \"string\"\r\n },\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"41886961-efd7-4372-af68-b750b2657146"},{"name":"Get Sites","id":"df2b5cdf-1199-45c2-a1c5-5e2cad14d0b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hsipublicapi.azure-api.net/sitest","description":"

Get a list of all Sites based on the associated Customer Id of the requesting User.

\n","urlObject":{"protocol":"https","path":["sitest"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"cc91a170-bca5-45a8-82c5-f02901b4ec65","name":"Get Sites","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/sites"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [{\r\n \"active\": true,\r\n \"address1\": \"string\",\r\n \"address2\": \"string\",\r\n \"chemicalManagement\": false,\r\n \"city\": \"string\",\r\n \"contactFirstName\": \"string\",\r\n \"contactLastName\": \"string\",\r\n \"country\": \"string\",\r\n \"email\": \"string\",\r\n \"fax\": \"string\",\r\n \"id\": 0,\r\n \"language\": [\r\n \"string\"\r\n ],\r\n \"metaData\": [\r\n {\r\n \"id\": \"00000000-0000-0000-0000-000000000000\",\r\n \"name\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"name\": \"string\",\r\n \"phone\": \"string\",\r\n \"siteCode\": \"string\",\r\n \"siteAssignmentId\": 0,\r\n \"state\": \"string\",\r\n \"zip\": \"string\"\r\n }],\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"df2b5cdf-1199-45c2-a1c5-5e2cad14d0b3"},{"name":"Get Locations By Site Id","id":"fb7193fe-67c3-48ad-a649-b7834df70cf1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hsipublicapi.azure-api.net/sites/{id}/locations","description":"

Get the location hierarchy at the specified Site. The {id} in the URL is the identifier for the Site whose locations you would like to retrieve.

\n","urlObject":{"protocol":"https","path":["sites","{id}","locations"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"a51d0852-b168-4f85-82f6-fda8e5297eab","name":"GetLocations By Site Id","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/sites/{id}/locations"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"Id\" : \"string\",\r\n \"Name\" : \"string\",\r\n \"Active\" : true,\r\n \"SubLocations\" : [\r\n {\r\n \"Id\" : \"string\",\r\n \"Name\" : \"string\",\r\n \"Active\" : true,\r\n \"SubLocations\" : []\r\n }\r\n ]\r\n },\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"fb7193fe-67c3-48ad-a649-b7834df70cf1"},{"name":"Update Existing Location","id":"bab6b7fd-bb6c-4cf7-bdb2-3c095316d9bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"LocationName\": \"string\",\r\n \"IsActive\": 0\r\n}"},"url":"https://hsipublicapi.azure-api.net/sites/{id}/locations/{locationId}","description":"

Updates a single location. The {id} in the URL is identifier for the Site you would like to retrieve. Optionally the {locationId} can be passed in if known.

\n","urlObject":{"protocol":"https","path":["sites","{id}","locations","{locationId}"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"2afb8317-77fe-4d2b-a938-a6c798c53ca1","name":"Update Existing Location","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":{"raw":"https://hsipublicapi.azure-api.net/inventory?X-HSI-API-KEY={Your API Key}","protocol":"https","host":["hsipublicapi","azure-api","net"],"path":["inventory"],"query":[{"key":"X-HSI-API-KEY","value":"{Your API Key}"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\"\"],\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"bab6b7fd-bb6c-4cf7-bdb2-3c095316d9bb"},{"name":"Create Sublocations","id":"d45a43d9-af2a-4e70-a297-d08238d806c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Name\":\"\",\r\n \"SubLocations\":[\r\n {\r\n \"Name\":\"\",\r\n \"SubLocations\":[ \r\n ]\r\n }\r\n ]\r\n }"},"url":"https://hsipublicapi.azure-api.net/sites/{id}/locations/{parentLocationId}","description":"

Creates sublocations for the parent location or facility passed in. The {id} in the URL is identifier for the Site you would like to retrieve. Optional the {parentLocationId} can be passed in if known

\n","urlObject":{"protocol":"https","path":["sites","{id}","locations","{parentLocationId}"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"433fa8e5-0018-4b68-9daa-1922f4f825e1","name":"Create Sublocations","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":{"raw":"https://hsipublicapi.azure-api.net/inventory?X-HSI-API-KEY={Your API Key}","protocol":"https","host":["hsipublicapi","azure-api","net"],"path":["inventory"],"query":[{"key":"X-HSI-API-KEY","value":"{Your API Key}"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\"\"],\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"d45a43d9-af2a-4e70-a297-d08238d806c0"},{"name":"Create Site","id":"dbfa730c-b7f0-41f1-8288-ec46352309d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"active\": true,\r\n \"address1\": \"string\",\r\n \"address2\": \"string\",\r\n \"chemicalManagement\": true,\r\n \"city\": \"string\",\r\n \"contactFirstName\": \"string\",\r\n \"contactLastName\": \"string\",\r\n \"country\": \"string\",\r\n \"email\": \"string\",\r\n \"fax\": \"string\",\r\n \"language\": [\r\n \"string\"\r\n ],\r\n \"metaData\": [\r\n {\r\n \"id\": \"00000000-0000-0000-0000-000000000000\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"name\": \"string\",\r\n \"phone\": \"string\",\r\n \"siteCode\": \"string\",\r\n \"siteAssignmentId\": 0,\r\n \"state\": \"string\",\r\n \"zip\": \"string\"\r\n }"},"url":"https://hsipublicapi.azure-api.net/sites","description":"

Creates a new Site.

\n","urlObject":{"protocol":"https","path":["sites"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"a8e5aaa7-5418-4e3c-91d5-6ee48016d93c","name":"Create Site","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":{"raw":"https://hsipublicapi.azure-api.net/inventory?X-HSI-API-KEY={Your API Key}","protocol":"https","host":["hsipublicapi","azure-api","net"],"path":["inventory"],"query":[{"key":"X-HSI-API-KEY","value":"{Your API Key}"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"active\": true,\n \"address1\": \"string\",\n \"address2\": \"string\",\n \"chemicalManagement\": false,\n \"city\": \"string\",\n \"contactFirstName\": \"string\",\n \"contactLastName\": \"string\",\n \"country\": \"string\",\n \"email\": \"string\",\n \"fax\": \"string\",\n \"id\": 0,\n \"language\": [\n \"string\"\n ],\n \"metaData\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"name\": \"string\",\n \"phone\": \"string\",\n \"siteCode\": \"string\",\n \"siteAssignmentId\": 0,\n \"state\": \"string\",\n \"zip\": \"string\"\n },\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"httpcode\": 100,\n \"exception\": \"string\",\n \"hsiErrorLogId\": 0\n },\n \"message\": \"string\",\n \"success\": true\n}"}],"_postman_id":"dbfa730c-b7f0-41f1-8288-ec46352309d2"},{"name":"Create Location For Chemical Management enabled Site","id":"50636a24-1a2d-4da0-b3f5-33ba37584d40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"Name\":\"\",\r\n \"SubLocations\":[\r\n {\r\n \"Name\":\"\",\r\n \"SubLocations\":[ \r\n ]\r\n }\r\n ]\r\n }\r\n]"},"url":"https://hsipublicapi.azure-api.net/sites/{id}/locations","description":"

Creates a Location for a Chemical Management enabled Site. The {id} in the URL is identifier for the Site you would like to add the Location to.

\n","urlObject":{"protocol":"https","path":["sites","{id}","locations"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"d8a3182c-9036-481e-b722-b3b8ab117a5c","name":"Create Location for Chemical Management enabled Site","originalRequest":{"method":"POST","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/sites/{id}/locations"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\"\"],\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"50636a24-1a2d-4da0-b3f5-33ba37584d40"},{"name":"Update Site","id":"2139cbb3-3493-4c2c-a40a-0ab94a13c748","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"active\": true,\r\n \"address1\": \"string\",\r\n \"address2\": \"string\",\r\n \"chemicalManagement\": true,\r\n \"city\": \"string\",\r\n \"contactFirstName\": \"string\",\r\n \"contactLastName\": \"string\",\r\n \"country\": \"string\",\r\n \"email\": \"string\",\r\n \"fax\": \"string\",\r\n \"language\": [\r\n \"string\"\r\n ],\r\n \"metaData\": [\r\n {\r\n \"id\": \"00000000-0000-0000-0000-000000000000\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"name\": \"string\",\r\n \"phone\": \"string\",\r\n \"siteCode\": \"string\",\r\n \"siteAssignmentId\": 0,\r\n \"state\": \"string\",\r\n \"zip\": \"string\"\r\n }"},"url":"https://hsipublicapi.azure-api.net/site/{id}","description":"

Updates a Site. The {id} in the URL is identifier for the Site you would like to update.

\n","urlObject":{"protocol":"https","path":["site","{id}"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"b37d2823-3575-4e67-b535-0159890d78f0","name":"Update Site","originalRequest":{"method":"PUT","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/site/{id}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\"\"],\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true\r\n}"}],"_postman_id":"2139cbb3-3493-4c2c-a40a-0ab94a13c748"}],"id":"c8e6acb8-2e16-4284-89e4-ecb239e6bfc4","description":"

Contains the API tools to manage Sites and Locations within your organization.

\n","_postman_id":"c8e6acb8-2e16-4284-89e4-ecb239e6bfc4"},{"name":"Location","item":[{"name":"Get Location Hierarchy","id":"79c1c94b-714b-4735-a927-83daae1953cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hsipublicapi.azure-api.net/locationhierarchy/list","description":"

Retrieves the location hierarchy for the Customer of the authorized requester.

\n","urlObject":{"protocol":"https","path":["locationhierarchy","list"],"host":["hsipublicapi","azure-api","net"],"query":[],"variable":[]}},"response":[{"id":"14f5ca4a-4a0e-41cd-ba7e-9d1b367e0a8f","name":"Get Library Document By ID","originalRequest":{"method":"GET","header":[{"key":"X-HSI-API-KEY","value":"{Your API Key}","type":"text"}],"url":"https://hsipublicapi.azure-api.net/locationhierarchy/list"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"data\": [\r\n {\r\n \"Id\": \"string\",\r\n \"LocationName\": \"string\",\r\n \"ParentId\": \"string\",\r\n \"LevelNum\": 0,\r\n \"Active\": true\r\n }\r\n ],\r\n \"error\": {\r\n \"type\": \"string\",\r\n \"message\": \"string\",\r\n \"httpcode\": 100,\r\n \"exception\": \"string\",\r\n \"hsiErrorLogId\": 0\r\n },\r\n \"message\": \"string\",\r\n \"success\": true,\r\n \"totalResults\": 0,\r\n \"moreResults\": true,\r\n \"offset\": 0,\r\n \"limit\": null\r\n}"}],"_postman_id":"79c1c94b-714b-4735-a927-83daae1953cb"}],"id":"af67905e-7949-46e3-84e3-5766e57ffa61","description":"

StartFragment

Contains the API tools to manage Locations within your organization.

EndFragment

\n","_postman_id":"af67905e-7949-46e3-84e3-5766e57ffa61"}]}