Licenses Endpoint for Orbit

Licensing

An Orbit License is required to utilize this Endpoint. This license is disabled by default. Please contact PCR to obtain a license for the external Orbit application.

Overview

This endpoint does not support POST, PUT, or DELETE operations. API Calls can only be made to retrieve information (GET) from the Endpoint, not to create or modifying existing records.

Read Call

Available Fields

Parameter	Required	Data Type	Notes
components	Yes	Array	an array of values as defined below

Component Fields

Parameter	Required	Data Type	Notes
name	Yes	String	Name of the component
is_active	Yes	Boolean	Is this component Active?
has_user_limit	Yes	Boolean	Does this component have a User Limit?
user_limit	Yes	Integer	The User Limit (null when has_user_limit = false)
authorized_users	No	Array	an array of values as defined below

Authorized User Fields

Parameter	Required	Data Type	Notes
module	Yes	String	Module Name
expiration_date	Yes	String	The expiration date and time of the authorization
recid	Yes	Integer	the Module’s RECID
userid	Yes	String	The User ID
display_name	Yes	String	The User’s Display Name
status	Yes	Integer	Is the User Active (1 = Yes, 0 = No)?
email	Yes	String	The User’s Email Address
phone	Yes	Integer	The User’s Phone Number
department_code	Yes	String	The User’s Department Code
department_name	Yes	String	The User’s Department Name
roles	No	Array of Strings	Array of system defined Roles

Request Example

Call

http://DOMAIN/api/API_KEY/licenses.OUTPUT

Headers

Key	Value
Content-Type	application/json
PCR-AUTH-TOKEN	example: e036a785-4d7a-40ed-a04a-c8e339327f55

Body

Key	Value
components	see array below

Components Array

Key	Value
name	mobile
is_active	true
has_user_limit	true
user_limit	6
authorized_users	see array below

Authorized Users Array

Key	Value
module	mobile=6
expiration_date	2026-02-18 18:52:00
recid	1
userid	Demo
display_name	PCR Demo
status	1
email	demo@pcr.com
phone	5558675309
department_code	DEM-OH
department_name	ITS QA
roles	[“Coordinator”, “SysAdmin”]

JSON Response:

JSON

{
	"status": "success",
	"page": 1,
	"count": 1,
	"total_count": 18,
	"licenses": {
		"components": [

			{
				"name": "mobile",
				"is_active": true,
				"has_user_limit": true,
				"user_limit": 6,
				"authorized_users": [
    			{
    				"module": "mobile=6",
    				"expiration_date": "2026-02-18 18:52:00",
    				"recid": "1170",
    				"userid": "demo",
    				"display_name": "PCR Demo",
    				"status": "1",
    				"email": "PCR360-7089-test7@mailinator.com",
    				"phone": "3172475605",
    				"department_code": "SB-FM",
    				"department_name": "FACILITIES MANAGEMENT",
    				"roles": [
    					"Coordinator",
    					"SysAdmin"
    				]
                  }
			}
		],
	"api_key": {
		"description": "Orbit Integration",
		"expiration_date": null
		},
	"software_version": "2025.2.2"
    }
}