Variant: CMDS

get

Use this request to query for a listing of the departments in your organization, and the learners assigned to each department.

Query parameters
includestringOptional
Responses
200
OK
Responseobject
get
GET /api/cmds/contacts/departments HTTP/1.1
Host: dev-demo.shiftiq.com
Accept: */*
200

OK

{}
get

Use this request to query for a listing of the users in your organization, and the departments to which each learner is assigned.

Responses
200
OK
Responseobject
get
GET /api/cmds/contacts/users HTTP/1.1
Host: dev-demo.shiftiq.com
Accept: */*
200

OK

{}
get

Use this request to query for a listing of the monthly statistics for mandatory critical primary competencies.

Query parameters
yearinteger · int32Required
monthinteger · int32Required
Responses
200
OK
Responseobject
get
GET /api/cmds/reports/statistics HTTP/1.1
Host: dev-demo.shiftiq.com
Accept: */*
200

OK

{}

Gets a summary of billable user accounts

get
Query parameters
classificationstringRequired
Responses
200
OK
Responseobject
get
GET /api/cmds/reports/billable-user-summaries HTTP/1.1
Host: dev-demo.shiftiq.com
Accept: */*
200

OK

{}
get

Use this request to query for a listing of the achievements assigned to learners in your organization.

Query parameters
achievementstringOptional
learnerstringOptional
Responses
200
OK
Responseobject
get
GET /api/cmds/documents/achievements HTTP/1.1
Host: dev-demo.shiftiq.com
Accept: */*
200

OK

{}
get

Use this request to query for a listing of the competencies assigned to learners in your organization.

Query parameters
competencystringOptional
learnerstringOptional
Responses
200
OK
Responseobject
get
GET /api/cmds/documents/competencies HTTP/1.1
Host: dev-demo.shiftiq.com
Accept: */*
200

OK

{}
get

Use this request to query for a listing of the profiles assigned to learners in your organization.

Query parameters
profilestringOptional
learnerstringOptional
Responses
200
OK
Responseobject
get
GET /api/cmds/documents/profiles HTTP/1.1
Host: dev-demo.shiftiq.com
Accept: */*
200

OK

{}
get

Use this request to query for a listing of all the achievements in your CMDS library. Achievements include e-learning modules, time-sensitive safety certificates, orientations, codes of practice, safe operating practices, site-specific operating procedures, training guides, and others.

Responses
200
OK
Responseobject
get
GET /api/cmds/templates/achievements HTTP/1.1
Host: dev-demo.shiftiq.com
Accept: */*
200

OK

{}
get

Use this request to query for a listing of all the competencies in your CMDS library, and the profiles that contain each competency.

Responses
200
OK
Responseobject
get
GET /api/cmds/templates/competencies HTTP/1.1
Host: dev-demo.shiftiq.com
Accept: */*
200

OK

{}
get

Use this request to query for a listing of all the profiles in your CMDS library, and the competencies contained in each profile.

Responses
200
OK
Responseobject
get
GET /api/cmds/templates/profiles HTTP/1.1
Host: dev-demo.shiftiq.com
Accept: */*
200

OK

{}

Was this helpful?