Page Comparison

Info

icon	false

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.

Table of Contents

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

Section

border	true

Making API Requests

Column

width	50%

Raw Request

Code Block

language	text
theme	Midnight

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",
    "street2":"123 General Street",
	"city2":"Somewhere",
	"province2":"AB",
	"state2":"MA",
	"postal_code2":"A9A9A9",
	"zip2":"54321-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"
}

Column

width	50%

JavaScript Request

Code Block

language	js
theme	Midnight

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",
    "street2":"123 General Street",
	"city2":"Somewhere",
	"province2":"AB",
	"state2":"MA",
	"postal_code2":"A9A9A9",
	"zip2":"54321-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

Attribute	Type	Limits	Possible Names	Description
apiToken	String	50-character alphanumeric including dashes.	apiToken	(Required)Your supplied API Token.
unique_id	String	50-character alphanumeric including dashes.		(Required)Your unique_id.
login_source	String	20-character alphanumeric including dashes.		(Required)Your supplied login source.
first_name	String	50-character alphanumeric including dashes.		(Optional) User's first name
last_name	String	50-character alphanumeric including dashes.		(Optional) User's last name
user_name	String	50-character alphanumeric including dashes.		(Optional) Unique username
email	String	100-character alphanumeric including dashes.		(Optional) Valid email address
street	String			(Optional) User's first address
city	String	50-character alphanumeric including dashes.		(Optional) User's first address
province	String	2-character postal abbreviation eg. "MA"	province, state	(Optional) User's first address
postal_code	String	20-character alphanumeric including dashes.	postal_code, zip	(Optional) User's first address
street2	String	20-character alphanumeric including dashes.		(Optional) User's second address
city2	String	50-character alphanumeric including dashes.		(Optional) User's second address
province2	String	2-character postal abbreviation eg. "MA"	province2, state2	(Optional) User's second address
postal_code2	String	20-character alphanumeric including dashes.	postal_code2, zip2	(Optional) User's second address
phone_cell	String	20-character alphanumeric including dashes.		(Optional)
user_type_id	String	Id number of UserType		(Optional)
employ_no	String	50-character alphanumeric including dashes.		(Optional)
employee_phone	String	50-character alphanumeric including dashes.		(Optional)
student_no	String	50-character alphanumeric including dashes.		(Optional)
student_phone	String	50-character alphanumeric including dashes.		(Optional)
driver_licence_num	String	255-character alphanumeric including dashes.	driver_licence_num, driver_license_num	(Optional)
date_of_birth	String	10-character date in format 'yyyy-mm-dd'		(Optional)
locker_user_type_id	String	Id number of LockerUserType		(Optional)
driver_licence_prov	String	2-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

Code Block

language	js
theme	Midnight

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

Related Pages

Filter by label (Content by label)

showLabels	false
showSpace	false
sort	title
cql	label = "apis" and space = currentSpace()

Show if

special	@authenticated

Support Agent Notes

In order for a client to use this, they would have to have paid for the right to integrate with OPS-COM, been issued an API Key and had their integration validated by testing with us.

Server setup

nGinx needs to have Access-Control-Allow-Origin : * to work.

The controller also needs to be behind a certificate.

Client Setup

There is some setup related to getting clients to use the API. First, they must have an API token that exists on the API token table. They then have to have an api_permission record that lists what kind of permission the token can have.

The permission needed for this api request is user-create.

Versions Compared

Old Version 9

New Version 10

Key

Making API Requests

Raw Request

JavaScript Request

Request Object Attributes

Successful Response

Related Pages