Shift iQCMDS

Directory

get

Returns a list of all people in your organization, including names, email addresses, and home addresses.

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

OK

{}
get

Returns a person using the person's unique globally unique identifier or individual account code. Account codes are alphanumeric values assigned by your organization.

Path parameters
idstringRequired
Responses
200
OK
Responseobject
get
GET /api/learners/{id} HTTP/1.1
Host: dev-demo.shiftiq.com
Accept: */*
200

OK

{}
post

Updates the person's name, email address, and home address. If the person is not in the database, then this method adds them as a new person.

Body
Identifierstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000
FirstNamestringOptional
MiddleNamestringOptional
LastNamestringOptional
EmailstringOptional
CodestringOptional
PasswordstringOptional
IsAdministratorbooleanOptional
IsLearnerbooleanOptional
AccessGrantedstring · date-timeOptional
AccessRevokedstring · date-timeOptional
Responses
200
OK
Responseobject
post
POST /api/learners/save HTTP/1.1
Host: dev-demo.shiftiq.com
Content-Type: application/json
Accept: */*
Content-Length: 399

{
  "Identifier": "00000000-0000-0000-0000-000000000000",
  "FirstName": "text",
  "MiddleName": "text",
  "LastName": "text",
  "Email": "text",
  "Code": "text",
  "Password": "text",
  "IsAdministrator": true,
  "IsLearner": true,
  "AccessGranted": "2025-07-16T19:19:50.191Z",
  "AccessRevoked": "2025-07-16T19:19:50.191Z",
  "HomeAddress": {
    "Street1": "text",
    "Street2": "text",
    "City": "text",
    "State": "text",
    "Country": "text",
    "PostalCode": "text"
  }
}
200

OK

{}
post

Updates the person's name, email address, and home address. If the person is not in the database, then this method adds them as a new person.

Path parameters
idstringRequired
Body
Identifierstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000
FirstNamestringOptional
MiddleNamestringOptional
LastNamestringOptional
EmailstringOptional
CodestringOptional
PasswordstringOptional
IsAdministratorbooleanOptional
IsLearnerbooleanOptional
AccessGrantedstring · date-timeOptional
AccessRevokedstring · date-timeOptional
Responses
200
OK
Responseobject
post
POST /api/learners/{id}/save HTTP/1.1
Host: dev-demo.shiftiq.com
Content-Type: application/json
Accept: */*
Content-Length: 399

{
  "Identifier": "00000000-0000-0000-0000-000000000000",
  "FirstName": "text",
  "MiddleName": "text",
  "LastName": "text",
  "Email": "text",
  "Code": "text",
  "Password": "text",
  "IsAdministrator": true,
  "IsLearner": true,
  "AccessGranted": "2025-07-16T19:19:50.191Z",
  "AccessRevoked": "2025-07-16T19:19:50.191Z",
  "HomeAddress": {
    "Street1": "text",
    "Street2": "text",
    "City": "text",
    "State": "text",
    "Country": "text",
    "PostalCode": "text"
  }
}
200

OK

{}
post

Counts the learners who match your search criteria. You can search based on any of the following property values: Code, Email, FirstName, and/or LastName.

Body
FirstNamestringOptional
LastNamestringOptional
EmailstringOptional
CodestringOptional
Responses
200
OK
Responseobject
post
POST /api/learners/count HTTP/1.1
Host: dev-demo.shiftiq.com
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "FirstName": "text",
  "LastName": "text",
  "Email": "text",
  "Code": "text"
}
200

OK

{}
post

Counts the learners who match your search criteria. You can search based on any of the following property values: Code, Email, FirstName, and/or LastName.

Path parameters
idstringRequired
Body
FirstNamestringOptional
LastNamestringOptional
EmailstringOptional
CodestringOptional
Responses
200
OK
Responseobject
post
POST /api/learners/{id}/count HTTP/1.1
Host: dev-demo.shiftiq.com
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "FirstName": "text",
  "LastName": "text",
  "Email": "text",
  "Code": "text"
}
200

OK

{}
post

Searches for learners who match your search criteria. You can search based on any of the following property values: Code, Email, FirstName, and/or LastName.

Body
FirstNamestringOptional
LastNamestringOptional
EmailstringOptional
CodestringOptional
Responses
200
OK
Responseobject
post
POST /api/learners/search HTTP/1.1
Host: dev-demo.shiftiq.com
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "FirstName": "text",
  "LastName": "text",
  "Email": "text",
  "Code": "text"
}
200

OK

{}
post

Searches for learners who match your search criteria. You can search based on any of the following property values: Code, Email, FirstName, and/or LastName.

Path parameters
idstringRequired
Body
FirstNamestringOptional
LastNamestringOptional
EmailstringOptional
CodestringOptional
Responses
200
OK
Responseobject
post
POST /api/learners/{id}/search HTTP/1.1
Host: dev-demo.shiftiq.com
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "FirstName": "text",
  "LastName": "text",
  "Email": "text",
  "Code": "text"
}
200

OK

{}
PreviousContentNextIntegration

Was this helpful?