Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

The OPS-COM Controller provides a simple JSON based API to integrate with. Clients use this API to push to OPS-COM new users and update existing users directly from another system. For example, you may wish to push Student and Staff information from Banner directly to OPS-COM.



Make sure you set the HTTP Content-Type header to be application/json.


Making API Requests

Raw Request

POST /api/OC_TOMA/v1/profiles/push HTTP/1.1
Host: controller.operationscommander.com
Accept: application/json
Content-Type: application/json
Cache-Control: no-cache

{
	"apiToken": "YOUR-API-TOKEN",
	"unique_id": "tester23", 
	"login_source": "OPSCOM", 
	"first_name":"firstname",
	"last_name":"lastname",
	"user_name":"username",
	"email":"test@test.com",
	"street":"123 Main Street, 123 Main Street,123 Main Street,123 Main Street,123 Main Street,123 Main Street",
	"city":"Everywhere",
	"province":"bc",
	"state":"NY",
	"postal_code":"HOHOHO",
	"zip":"12345-1212",
	"phone_cell":"613-555-1212",
	"user_type_id":"6",
	"employ_no":"employee number: default",
	"employee_phone":"emp ph. klondike 555",
	"student_no":"SN 543209854",
	"student_phone":"999",
	"driver_licence_num":"QC 99999999",
	"driver_license_num":"NYNY",
	"date_of_birth":"1901-01-31",
	"locker_user_type_id":"3",
	"driver_licence_prov":"BC", 
	"driver_license_state":"CA"
}

JavaScript Request

var request = new XMLHttpRequest();

request.open('POST', 'https://controller.operationscommander.com/api/OC_TOMA/v1/profiles/push');

request.setRequestHeader('Content-Type', 'application/json');
request.setRequestHeader('Accept', 'application/json');

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};


var body = {
	"apiToken": "YOUR-API-TOKEN",
	"unique_id": "tester23", 
	"login_source": "OPSCOM", 
	"first_name":"firstname",
	"last_name":"lastname",
	"user_name":"username",
	"email":"test@test.com",
	"street":"123 Main Street, 123 Main Street,123 Main Street,123 Main Street,123 Main Street,123 Main Street",
	"city":"Everywhere",
	"province":"bc",
    "state":"NY",
    "postal_code":"HOHOHO",
    "zip":"12345-1212",
    "phone_cell":"613-555-1212",
    "user_type_id":"6",
    "employ_no":"employee number: default",
    "employee_phone":"emp ph. klondike 555",
    "student_no":"SN 543209854",
    "student_phone":"999",
    "driver_licence_num":"QC 99999999",
    "driver_license_num":"NYNY",
    "date_of_birth":"1901-01-31",
    "locker_user_type_id":"3",
    "driver_licence_prov":"BC", 
    "driver_license_state":"CA"
}
request.send(JSON.stringify(body));

Request Object Attributes

AttributeTypeLimitsPossible NamesDescription
apiTokenString

50-character alphanumeric including dashes.

apiToken(Required) Your supplied API Token.
unique_idString50-character alphanumeric including dashes.
(Required) Your unique_id.
login_sourceString20-character alphanumeric including dashes.
(Required) Your supplied login source.
first_nameString50-character alphanumeric including dashes.
(Optional)  User's first name
last_nameString50-character alphanumeric including dashes.
(Optional) User's last name
user_nameString50-character alphanumeric including dashes.
(Optional) Unique username
emailString100-character alphanumeric including dashes.
(Optional) Valid email address 
streetString

(Optional)
cityString50-character alphanumeric including dashes.
(Optional)
provinceString2-character postal abbreviation eg. "MA"

province,

state

(Optional) 
postal_codeString20-character alphanumeric including dashes.

postal_code,

zip

(Optional)
street2String20-character alphanumeric including dashes.

city2String50-character alphanumeric including dashes.

province2String2-character postal abbreviation eg. "MA"

province2,

state2


postal_code2String20-character alphanumeric including dashes.

postal_code2,

zip2


phone_cellString20-character alphanumeric including dashes.
(Optional)
user_type_idStringId number of UserType
(Optional)
employ_noString50-character alphanumeric including dashes.
(Optional)
employee_phoneString50-character alphanumeric including dashes.
(Optional)
student_noString50-character alphanumeric including dashes.
(Optional)
student_phoneString50-character alphanumeric including dashes.
(Optional)
driver_licence_numString255-character alphanumeric including dashes.

driver_licence_num,

driver_license_num

(Optional)
date_of_birthString10-character date in format 'yyyy-mm-dd'
(Optional)
locker_user_type_idStringId number of LockerUserType
(Optional)
driver_licence_provString2-character postal abbreviation eg. "MA"

driver_licence_prov,

driver_license_state

(Optional)



Successful Response

The response will be a json object. 

Content-Type: application/json

{
    "status": "success",
    "reference_id": 44
}

  • No labels