iLMS API Documentation | Inspired eLearning Support

The iLMS API is for use in developing integrations with other systems. The iLMS API is a REST API which uses JSON for responses and features a unique login ID and key.

Getting Started

To get started with the API, please enable the iLMS API from Settings->iLMS API, generate your Transaction Key, and browse our full documentation (links are here in this page).

Users

User Object Fields

A user object looks like this:

Field Code Data Type Description Validations
F001 string First Name
Is Required: Yes
Maximum Length: 200 characters
Restricted Characters: < > " % ; +
& # are restricted by functionality and not error if using iLMS connect
F002 string Middle Name
Is Required: depend on ilms settings
Maximum Length: 100 characters
Restricted Characters: < > " % ; +
F003 string Last Name
Is Required: Yes
Maximum Length: 200 characters
Restricted Characters: < > " % ; +
& # are restricted by functionality and not error if using iLMS connect
F004 string Employee ID
Is Required: depend on ilms settings
Maximum Length: 100 characters
Restricted Characters: < > " % ; +
& # are restricted by functionality and not error if using iLMS connect
F005 Date Time Hire Date
Is Required: depend on ilms settings
F006 string User Language
Is Required: depend on ilms settings
Maximum Length: 100 characters
Restricted Characters: % \ + ; " < > : ?
It accepts language name available to your organization in iLMS. Please go to Settings > Languages in your organization account in iLMS to see what are the languages available to your organization. A full list of all the languages can be seen in Language section.
F007 string Job Title
Is Required: depend on ilms settings
Maximum Length: 50 characters
Restricted Characters: < > " % ; +
F008 string Address 1
Is Required: depend on ilms settings
Maximum Length: 100 characters
Restricted Characters: < > " % ; +
F009 string Address 2
Is Required: depend on ilms settings
Maximum Length: 100 characters
Restricted Characters: < > " % ; +
F010 string City
Is Required: depend on ilms settings
Maximum Length: 100 characters
Restricted Characters: < > " % ; +
F011 string Country
Is Required: depend on ilms settings
Maximum Length: 100 characters
Restricted Characters: < > " % ; +
It accepts Country Name and Country Code. Please see the Country section to get all the country name and codes.
F012 string State (US or Canada)
Is Required: depend on ilms settings
Maximum Length: 100 characters
Restricted Characters: < > " % ; +
It accepts State Name and State Code. Please see the State section to get all the country name and codes.
F013 string
State/Province/Region
(Non US or Candadian)
Is Required: depend on ilms settings
Maximum Length: 100 characters
Restricted Characters: < > " % ; +
F014 string Zip Code/Postal Code
Is Required: depend on ilms settings
Maximum Length: 100 characters
Restricted Characters: < > " % ; +
F015 string Email ID
Is Required: depend on ilms settings
Maximum Length: 200 characters
Restricted Characters: < > " % ; +
If using LDAP, these cannot be the first character:
`~!@#$&*()=}{|':./_
F016 string Password
Is Required: No
Maximum Length: depend on ilms settings
Restricted Characters: < > " % ; +
F017 string Phone
Is Required: depend on ilms settings
Maximum Length: 100 characters
Restricted Characters: < > " % ; +
F018 string Fax
Is Required: depend on ilms settings
Maximum Length: 100 characters
Restricted Characters: < > " % ; +
F019 string Region
Is Required: Yes
Maximum Length: 100 characters
Restricted Characters: % \ + ; " < > : ?
& # are restricted by functionality and not error if using iLMS connect
F020 string Division
Is Required: Yes
Maximum Length: 100 characters
Restricted Characters: % \ + ; " < > : ?
& # are restricted by functionality and not error if using iLMS connect
F021 string Department
Is Required: Yes
Maximum Length: 100 characters
Restricted Characters: % \ + ; " < > : ?
& # are restricted by functionality and not error if using iLMS connect
F022 string Company/Employer
Is Required: depend on ilms settings
Maximum Length: 100 characters
Restricted Characters: < > " % ; +
F023 string Time Zone
Is Required: depend on ilms settings
Maximum Length: 100 characters
It takes time zone full name. Please see Timezone section for the same.
F024 string Custom Field 1
Is Required: depend on ilms settings
Maximum Length: 100 characters
Restricted Characters: < > " % ; +
F025 string Custom Field 2
Is Required: depend on ilms settings
Maximum Length: 100 characters
Restricted Characters: < > " % ; +
F026 string Custom Field 3
Is Required: depend on ilms settings
Maximum Length: 100 characters
Restricted Characters: < > " % ; +
F027 string Custom Field 4
Is Required: depend on ilms settings
Maximum Length: 100 characters
Restricted Characters: < > " % ; +
F031 string Registration Type. It tells about how user is registered.
Is Required: No. It is read only property.
Read only: Yes
Possible Values are: API, iLMS, Self Registration, iLMS Connect, LDAP, SAML, Unknown

F032 DateTime Registration Date
Is Required: No. It is read only property.
Read only: Yes
F033 string Supervisor Name
Is Required: depend on ilms settings
Maximum Length: 500 characters
Restricted Characters: < > " % ; +
F034 string Supervisor Email
Is Required: depend on ilms settings
Maximum Length: 500 characters
Restricted Characters: < > " % ; +
If using LDAP, these cannot be the first character:
`~!@#$&*()=}{|':./_

Field Code	Data Type	Description	Validations
F001	string	First Name	Is Required: Yes Maximum Length: 200 characters Restricted Characters: < > " % ; + & # are restricted by functionality and not error if using iLMS connect
F002	string	Middle Name	Is Required: depend on ilms settings Maximum Length: 100 characters Restricted Characters: < > " % ; +
F003	string	Last Name	Is Required: Yes Maximum Length: 200 characters Restricted Characters: < > " % ; + & # are restricted by functionality and not error if using iLMS connect
F004	string	Employee ID	Is Required: depend on ilms settings Maximum Length: 100 characters Restricted Characters: < > " % ; + & # are restricted by functionality and not error if using iLMS connect
F005	Date Time	Hire Date	Is Required: depend on ilms settings
F006	string	User Language	Is Required: depend on ilms settings Maximum Length: 100 characters Restricted Characters: % \ + ; " < > : ? It accepts language name available to your organization in iLMS. Please go to Settings > Languages in your organization account in iLMS to see what are the languages available to your organization. A full list of all the languages can be seen in Language section.
F007	string	Job Title	Is Required: depend on ilms settings Maximum Length: 50 characters Restricted Characters: < > " % ; +
F008	string	Address 1	Is Required: depend on ilms settings Maximum Length: 100 characters Restricted Characters: < > " % ; +
F009	string	Address 2	Is Required: depend on ilms settings Maximum Length: 100 characters Restricted Characters: < > " % ; +
F010	string	City	Is Required: depend on ilms settings Maximum Length: 100 characters Restricted Characters: < > " % ; +
F011	string	Country	Is Required: depend on ilms settings Maximum Length: 100 characters Restricted Characters: < > " % ; + It accepts Country Name and Country Code. Please see the Country section to get all the country name and codes.
F012	string	State (US or Canada)	Is Required: depend on ilms settings Maximum Length: 100 characters Restricted Characters: < > " % ; + It accepts State Name and State Code. Please see the State section to get all the country name and codes.
F013	string	State/Province/Region (Non US or Candadian)	Is Required: depend on ilms settings Maximum Length: 100 characters Restricted Characters: < > " % ; +
F014	string	Zip Code/Postal Code	Is Required: depend on ilms settings Maximum Length: 100 characters Restricted Characters: < > " % ; +
F015	string	Email ID	Is Required: depend on ilms settings Maximum Length: 200 characters Restricted Characters: < > " % ; + If using LDAP, these cannot be the first character: `~!@#$&*()=}{\|':./_
F016	string	Password	Is Required: No Maximum Length: depend on ilms settings Restricted Characters: < > " % ; +
F017	string	Phone	Is Required: depend on ilms settings Maximum Length: 100 characters Restricted Characters: < > " % ; +
F018	string	Fax	Is Required: depend on ilms settings Maximum Length: 100 characters Restricted Characters: < > " % ; +
F019	string	Region	Is Required: Yes Maximum Length: 100 characters Restricted Characters: % \ + ; " < > : ? & # are restricted by functionality and not error if using iLMS connect
F020	string	Division	Is Required: Yes Maximum Length: 100 characters Restricted Characters: % \ + ; " < > : ? & # are restricted by functionality and not error if using iLMS connect
F021	string	Department	Is Required: Yes Maximum Length: 100 characters Restricted Characters: % \ + ; " < > : ? & # are restricted by functionality and not error if using iLMS connect
F022	string	Company/Employer	Is Required: depend on ilms settings Maximum Length: 100 characters Restricted Characters: < > " % ; +
F023	string	Time Zone	Is Required: depend on ilms settings Maximum Length: 100 characters It takes time zone full name. Please see Timezone section for the same.
F024	string	Custom Field 1	Is Required: depend on ilms settings Maximum Length: 100 characters Restricted Characters: < > " % ; +
F025	string	Custom Field 2	Is Required: depend on ilms settings Maximum Length: 100 characters Restricted Characters: < > " % ; +
F026	string	Custom Field 3	Is Required: depend on ilms settings Maximum Length: 100 characters Restricted Characters: < > " % ; +
F027	string	Custom Field 4	Is Required: depend on ilms settings Maximum Length: 100 characters Restricted Characters: < > " % ; +
F031	string	Registration Type. It tells about how user is registered.	Is Required: No. It is read only property. Read only: Yes Possible Values are: API, iLMS, Self Registration, iLMS Connect, LDAP, SAML, Unknown
F032	DateTime	Registration Date	Is Required: No. It is read only property. Read only: Yes
F033	string	Supervisor Name	Is Required: depend on ilms settings Maximum Length: 500 characters Restricted Characters: < > " % ; +
F034	string	Supervisor Email	Is Required: depend on ilms settings Maximum Length: 500 characters Restricted Characters: < > " % ; + If using LDAP, these cannot be the first character: `~!@#$&*()=}{\|':./_

Get All Users / Search Users

Description:

Get all the users of an organization based on search parameters. if none of the search parameter is used, then it returns all the users. It supports pagination.

URL:

https://api.inspiredlms.com/organizations/{orgID}/users

Method:

GET

Response Type:

JSON

Parameters:

Besides standard pagination and sort parameters, it accepts search on any user profile field.
Query String Parameter Data Type Description Validations
Pass one or more than one user profile field code string
It supports 4 types of search.
Exact search: e.g. F001="John"
It'll return all the users whose first name is John.
Like/Contains search: e.g. F001=John
It'll return all the users whose first name contains word John.
Starts with search: e.g. F001=Jo*
It'll return all the users whose first name starts with Jo.
Ends with search: e.g. F001=*hn
It'll return all the users whose first name ends with hn.

For datetime type of fields, use the following format:
Date range: (From:YYYY-MM-DDTHH:mm:ssTo:YYYY-MM-DDThh:mm:ss)
e.g. F005=(From:2012-01-01T00:00:00To:2012-12-31T23:59:59) will return all the users who are hired in Year 2012.
Greater than: Just skip 'To' part.
e.g. F005=(From:2012-01-01T00:00:00) will return all the users who are hired on or after 1st January, 2012.
Less than: Just skip 'From' part.
e.g. F005=(To:2012-12-31T23:59:59) will return all the users who are hired on or before 31st December, 2012.

groupids string Get the unique set of users who belongs to any of the groups supplied.
Is Required: No
Valid Values are: Numeric group IDs
Multiple values can be used separated by commas. e.g. "groupids=363,370,384" will return all the unique set of users who belongs to any of the group (i.e. 363 or 370 or 384)
sort string Get the results in specified sorting order. If nothing is passed, it returns result in F003 ascending order.
Supported field code for sorting are: F001, F002, F003, F004, F006, F011, F012, F015, F019, F020, F021
userstatus string Get users filtered by their status. i.e. active, inactive and/or deleted.
Is Required: No. If not passed, it only returns active users.
Valid values are: active, inactive, deleted
Multiple values can be used separated by commas. e.g. "userstatus=active,inactive" will return all the users whose status is either active or inactive.

Query String Parameter	Data Type	Description	Validations
Pass one or more than one user profile field code	string	It supports 4 types of search. Exact search: e.g. F001="John" It'll return all the users whose first name is John. Like/Contains search: e.g. F001=John It'll return all the users whose first name contains word John. Starts with search: e.g. F001=Jo* It'll return all the users whose first name starts with Jo. Ends with search: e.g. F001=*hn It'll return all the users whose first name ends with hn. For datetime type of fields, use the following format: Date range: (From:YYYY-MM-DDTHH:mm:ssTo:YYYY-MM-DDThh:mm:ss) e.g. F005=(From:2012-01-01T00:00:00To:2012-12-31T23:59:59) will return all the users who are hired in Year 2012. Greater than: Just skip 'To' part. e.g. F005=(From:2012-01-01T00:00:00) will return all the users who are hired on or after 1st January, 2012. Less than: Just skip 'From' part. e.g. F005=(To:2012-12-31T23:59:59) will return all the users who are hired on or before 31st December, 2012.
groupids	string	Get the unique set of users who belongs to any of the groups supplied.	Is Required: No Valid Values are: Numeric group IDs Multiple values can be used separated by commas. e.g. "groupids=363,370,384" will return all the unique set of users who belongs to any of the group (i.e. 363 or 370 or 384)
sort	string	Get the results in specified sorting order. If nothing is passed, it returns result in F003 ascending order.	Supported field code for sorting are: F001, F002, F003, F004, F006, F011, F012, F015, F019, F020, F021
userstatus	string	Get users filtered by their status. i.e. active, inactive and/or deleted.	Is Required: No. If not passed, it only returns active users. Valid values are: active, inactive, deleted Multiple values can be used separated by commas. e.g. "userstatus=active,inactive" will return all the users whose status is either active or inactive.

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/users
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/users"

Response:

Since it supports pagination, response may include link header if resultant records are more than the page_size.

You can't retrieve password of an user. So password's field code F016 will always show value as null.

HTTP/1.1 200 Ok
X-Total-Count: 658
next: https://api.inspiredlms.com/organizations/99999/users?per_page=100&page=2
last: https://api.inspiredlms.com/organizations/99999/groups?per_page=100&page=7
[
{
"ID": 517244,
"UserStatus": "Active",
"Profile": {
"F001": "John",
"F002": "",
"F003": "Doe",
"F004": "Emp001",
"F005": null,
"F006": "English",
"F007": "Manager",
"F008": "",
"F009": "",
"F010": "San Antonio",
"F011": "United States",
"F012": "Texas",
"F013": "",
"F014": "",
"F015": "[email protected]",
"F016": null,
"F017": "",
"F018": "",
"F019": "Region 1",
"F019_ID": 13306,
"F020": "Division 1",
"F020_ID": 8463,
"F021": "Department 1",
"F021_ID": 15136,
"F022": "",
"F023": "(GMT-06.00) Central Time (US & Canada)",
"F024": "",
"F025": "",
"F026": "",
"F027": "",
"F031": "API",
"F032": "2013-10-23T13:30:38.22",
"F033": "",
"F034": ""
}
},
{
"ID": 517226,
"UserStatus": "Active",
"Profile": {
"F001": "Demo",
"F002": "",
"F003": "User",
"F004": "Emp002",
"F005": null,
"F006": "English",
"F007": "",
"F008": "",
"F009": "",
"F010": "",
"F011": "US",
"F012": "NE",
"F013": "",
"F014": "",
"F015": "[email protected]",
"F016": null,
"F017": "",
"F018": "",
"F019": "Region 1",
"F019_ID": 13306,
"F020": "Division 1",
"F020_ID": 8463,
"F021": "Department 1",
"F021_ID": 15136,
"F022": "",
"F023": "(GMT-06.00) Central Time (US & Canada)",
"F024": "",
"F025": "",
"F026": "",
"F027": "",
"F031": "LDAP",
"F032": "2013-10-17T12:34:34.61",
"F033": "",
"F034": ""
}
},
{
.......
.......
}
]

Get a User

Description:

Get a user of an organization specified by userid.

URL:

https://api.inspiredlms.com/organizations/{orgID}/users/{userid}

Method:

GET

Response Type:

JSON

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/users/517244
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/users/517244"

Response:

You can't retrieve password of an user. So password's field code F016 will always show value as null.

HTTP/1.1 200 Ok

{
"ID": 517244,
"UserStatus": "Active",
"Profile": {
"F001": "John",
"F002": "",
"F003": "Doe",
"F004": "Emp001",
"F005": null,
"F006": "English",
"F007": "Manager",
"F008": "",
"F009": "",
"F010": "San Antonio",
"F011": "United States",
"F012": "Texas",
"F013": "",
"F014": "",
"F015": "[email protected]",
"F016": null,
"F017": "",
"F018": "",
"F019": "Region 1",
"F019_ID": 13306,
"F020": "Division 1",
"F020_ID": 8463,
"F021": "Department 1",
"F021_ID": 15136,
"F022": "",
"F023": "(GMT-06.00) Central Time (US & Canada)",
"F024": "",
"F025": "",
"F026": "",
"F027": "",
"F031": "API",
"F032": "2013-10-23T13:30:38.22",
"F033": "",
"F034": ""
}
}

Create a User

Description:

Create a new user based on the parameters specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/users

Method:

POST

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
sendRegistrationMail boolean If true, system will also send registration email to user, after user account is created.
Is Required: No. If not passed, it will not send registration email.
Valid values are: true, false
changePasswordAtNextLogin boolean If true, system will force user to change his password when he logs in next time.
Is Required: No.
Valid values are: true, false
Pass one or more than one user profile field code and respective value(s) to update. string It accepts key value pair combination.
Is Required: Yes. It is must to send information to mandatory profile fields.
Each field code value is validated as per the rules mentioned at top of this page.

Parameter	Data Type	Description	Validations
sendRegistrationMail	boolean	If true, system will also send registration email to user, after user account is created.	Is Required: No. If not passed, it will not send registration email. Valid values are: true, false
changePasswordAtNextLogin	boolean	If true, system will force user to change his password when he logs in next time.	Is Required: No. Valid values are: true, false
Pass one or more than one user profile field code and respective value(s) to update.	string	It accepts key value pair combination.	Is Required: Yes. It is must to send information to mandatory profile fields. Each field code value is validated as per the rules mentioned at top of this page.

HTTP Request Example:

POST
https://api.inspiredlms.com/organizations/99999/users
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"userProfileData":[{"Key":"F001","Value":"John"},{"Key":"F003","Value":"Doe"},{"Key":"F015","Value":"[email protected]"},{"Key":"F019","Value":"region 1"},{"Key":"F020","Value":"Division 1"},{"Key":"F021","Value":"Department 1"}],"sendRegistrationMail":true,"changePasswordAtNextLogin":true}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X POST -d "@createuser.json" "https://api.inspiredlms.com/organizations/99999/users"

here, content of @createreg.json file is:

{"userProfileData":[{"Key":"F001","Value":"John"},{"Key":"F003","Value":"Doe"},{"Key":"F015","Value":"[email protected]"},{"Key":"F019","Value":"region 1"},{"Key":"F020","Value":"Division 1"},{"Key":"F021","Value":"Department 1"}],"sendRegistrationMail":true,"changePasswordAtNextLogin":true}

Response:

If successful, 201 status code will be return along with ID of new user.

HTTP/1.1 201 Created
Location: https://api.inspiredlms.com/organizations/99999/users/123456

123456

Update User Profile

Description:

Modify user profile based on the parameters specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/users/{userid}

Method:

PUT

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
Pass one or more than one user profile field code and respective value(s) to update. string
It accepts key value pair combination. Pass only the field code and value which requires to be updated. System will remain rest of the profile information as it is.
Region(F019), Division(F020) and Department(F021) needs to be passed together. In other words, only F019 or F020 will not able to make any change in user profile.

As mentioned at top of this page.

Parameter	Data Type	Description	Validations
Pass one or more than one user profile field code and respective value(s) to update.	string	It accepts key value pair combination. Pass only the field code and value which requires to be updated. System will remain rest of the profile information as it is. Region(F019), Division(F020) and Department(F021) needs to be passed together. In other words, only F019 or F020 will not able to make any change in user profile.	As mentioned at top of this page.

HTTP Request Example:

PUT
https://api.inspiredlms.com/organizations/99999/users/123456
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
[{"Key":"F001","Value":"John"},{"Key":"F003","Value":"Doe"}]

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X PUT -d "@updateuser.json" "https://api.inspiredlms.com/organizations/99999/users/123456"

here, content of @updateuser.json file is:

[{"Key":"F001","Value":"John"},{"Key":"F003","Value":"Doe"}]

Response:

HTTP/1.1 204 No Content

Inactivate a user

Description:

Inactivate the user account identified by userID.

URL:

https://api.inspiredlms.com/organizations/{orgID}/users/{userID}/Activate

Method:

DELETE

Response Type:

JSON

HTTP Request Example:

DELETE
https://api.inspiredlms.com/organizations/99999/users/123456/Activate
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X DELETE "https://api.inspiredlms.com/organizations/99999/users/123456/Activate"

Response:

HTTP/1.1 204 No Content

Activate a user

Description:

Activate the user account identified by userID.

URL:

https://api.inspiredlms.com/organizations/{orgID}/users/{userID}/Activate

Method:

PUT

Response Type:

JSON

HTTP Request Example:

PUT
https://api.inspiredlms.com/organizations/99999/users/123456/Activate
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X PUT -d "" "https://api.inspiredlms.com/organizations/99999/users/123456/Activate"

Response:

HTTP/1.1 204 No Content

Delete a user

Description:

Delete the user account identified by userID.

URL:

https://api.inspiredlms.com/organizations/{orgID}/users/{userID}

Method:

DELETE

Response Type:

JSON

HTTP Request Example:

DELETE
https://api.inspiredlms.com/organizations/99999/users/123456
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X DELETE "https://api.inspiredlms.com/organizations/99999/users/123456"

Response:

HTTP/1.1 204 No Content

Purge a user

Description:

purge the user account identified by userID.

URL:

https://api.inspiredlms.com/organizations/{orgID}/users/{userID}/purge

Method:

DELETE

Response Type:

JSON

HTTP Request Example:

DELETE
https://api.inspiredlms.com/organizations/99999/users/123456/purge
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X DELETE "https://api.inspiredlms.com/organizations/99999/users/123456/purge"

Response:

HTTP/1.1 204 No Content

Reset Password and/or Force user to change password after login

Description:

set a new password for the user and/or force him to change his password in next login.

URL:

https://api.inspiredlms.com/organizations/{orgID}/users/{userID}/password

Method:

PUT

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
newPassword string new password of user account
Is Required: Yes.
Minimum Length: as per ilms settings.
Maximum Length: as per ilms settings.
changePasswordAtNextLogin boolean If true, system will force user to change his password when he logs in next time.
Is Required: No.
Valid values are: true, false

Parameter	Data Type	Description	Validations
newPassword	string	new password of user account	Is Required: Yes. Minimum Length: as per ilms settings. Maximum Length: as per ilms settings.
changePasswordAtNextLogin	boolean	If true, system will force user to change his password when he logs in next time.	Is Required: No. Valid values are: true, false

HTTP Request Example:

DELETE
https://api.inspiredlms.com/organizations/99999/users/123456/password
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"newpassword":"password123","changepasswordatnextlogin":"true"}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X PUT -d "@newpassword.json" "https://api.inspiredlms.com/organizations/99999/users/123456/password"

here, content of @newpassword.json file is:

{"newpassword":"password123","changepasswordatnextlogin":"true"}

Response:

HTTP/1.1 204 No Content

Groups

Get All Groups
Get a Group
Get All Members / Users Of a Group
Add a Member / User in Group
Remove a Member / User from Group
Get All Courses Of a Group
Add a Course in Group
Remove a Course from Group
Modify Default Due Date and Requirement Type Settings For A Group's Course
Refresh a Group
Get All Members / Users Of a Group's Explicit Inclusion List
Add a User in Group's Explicit Inclusion List
Remove a User from a Group's Explicit Inclusion List
Get All Members / Users Of a Group's Explicit Exclusion List
Add a User in Group's Explicit Exclusion List
Remove a User from a Group's Explicit Exclusion List

Get All Groups

Description:

Get all the groups of an organization based on parameters specified. It supports pagination.

URL:

https://api.inspiredlms.com/organizations/{orgID}/groups

Method:

GET

Response Type:

JSON

Parameters:

Query String Parameter Data Type Description Validations
sort string
By default results are sorted in group name ascending order.
Use "sort=-name" to sort results in group name descending order.
Is Required: No

Query String Parameter	Data Type	Description	Validations
sort	string	By default results are sorted in group name ascending order. Use "sort=-name" to sort results in group name descending order.	Is Required: No

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/groups?page=3&per_page=2
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/groups?page=3&per_page=2"

Response:

Since it supports pagination, response may include link header if resultant records are more than the page_size.

HTTP/1.1 200 Ok
X-Total-Count: 10
first: https://api.inspiredlms.com/organizations/99999/groups?per_page=2&page=1
prev: https://api.inspiredlms.com/organizations/99999/groups?per_page=2&page=2
next: https://api.inspiredlms.com/organizations/99999/groups?per_page=2&page=4
last: https://api.inspiredlms.com/organizations/99999/groups?per_page=2&page=5

[
{
"ID": 2,
"Name": "Sales",
"Description": "Group for all sales persons.",
"NumberOfCourses": 1,
"NumberOfUsers": 20
},
{
"ID": 3,
"Name": "Manager",
"Description": "",
"NumberOfCourses": 5,
"NumberOfUsers": 3
}
]

Get a Group

Description:

Get a group of an organization specified by groupid.

URL:

https://api.inspiredlms.com/organizations/{orgID}/groups/{groupid}

Method:

GET

Response Type:

JSON

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/groups/2
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/groups/2"

Response:

HTTP/1.1 200 Ok

{
"ID": 2,
"Name": "Sales",
"Description": "Group for all sales persons.",
"NumberOfCourses": 1,
"NumberOfUsers": 20
}

Get All Members / Users Of a Group

Description:

Get all the users of a group based on the specified parameters. It supports pagination.

URL:

https://api.inspiredlms.com/organizations/{orgID}/groups/{groupID}/members

Method:

GET

Response Type:

JSON

Parameters:

Query String Parameter Data Type Description Validations
sort string get the results in specified sorting order. If nothing is passed, it returns result in F003 (user's last name) ascending order.
Supported user profile field code for sorting are: F001, F002, F003, F004, F006, F011, F012, F015, F019, F020, F021

Query String Parameter	Data Type	Description	Validations
sort	string	get the results in specified sorting order. If nothing is passed, it returns result in F003 (user's last name) ascending order.	Supported user profile field code for sorting are: F001, F002, F003, F004, F006, F011, F012, F015, F019, F020, F021

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/groups/345/members?page=3&per_page=2
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/groups/345/members?page=3&per_page=2"

Response:

Since it supports pagination, response may include link header if resultant records are more than the page_size.

HTTP/1.1 200 Ok
X-Total-Count: 10
first: https://api.inspiredlms.com/organizations/99999/groups/345/members?per_page=2&page=1
prev: https://api.inspiredlms.com/organizations/99999/groups/345/members?per_page=2&page=2
next: https://api.inspiredlms.com/organizations/99999/groups/345/members?per_page=2&page=4
last: https://api.inspiredlms.com/organizations/99999/groups/345/members?per_page=2&page=5

[
{
"ID": 517244,
"UserStatus": "Active",
"Profile": {
"F001": "John",
"F002": "",
"F003": "Doe",
"F004": "Emp001",
"F005": null,
"F006": "English",
"F007": "Manager",
"F008": "",
"F009": "",
"F010": "San Antonio",
"F011": "United States",
"F012": "Texas",
"F013": "",
"F014": "",
"F015": "[email protected]",
"F016": null,
"F017": "",
"F018": "",
"F019": "Region 1",
"F019_ID": 13306,
"F020": "Division 1",
"F020_ID": 8463,
"F021": "Department 1",
"F021_ID": 15136,
"F022": "",
"F023": "(GMT-06.00) Central Time (US & Canada)",
"F024": "",
"F025": "",
"F026": "",
"F027": "",
"F031": "API",
"F032": "2013-10-23T13:30:38.22",
"F033": "",
"F034": ""
}
},
{
"ID": 517226,
"UserStatus": "Active",
"Profile": {
"F001": "Demo",
"F002": "",
"F003": "User",
"F004": "Emp002",
"F005": null,
"F006": "English",
"F007": "",
"F008": "",
"F009": "",
"F010": "",
"F011": "US",
"F012": "NE",
"F013": "",
"F014": "",
"F015": "[email protected]",
"F016": null,
"F017": "",
"F018": "",
"F019": "Region 1",
"F019_ID": 13306,
"F020": "Division 1",
"F020_ID": 8463,
"F021": "Department 1",
"F021_ID": 15136,
"F022": "",
"F023": "(GMT-06.00) Central Time (US & Canada)",
"F024": "",
"F025": "",
"F026": "",
"F027": "",
"F031": "LDAP",
"F032": "2013-10-17T12:34:34.61",
"F033": "",
"F034": ""
}
}
]

Add a Member / User in Group

Description:

Add a new user in group membership.

URL:

https://api.inspiredlms.com/organizations/{orgID}/groups/{groupID}/members

Method:

POST

Response Type:

JSON

HTTP Request Example:

POST
https://api.inspiredlms.com/organizations/99999/groups/{groupID}/members
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"userid":"444038"}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X POST -d "@addmember.json" "https://api.inspiredlms.com/organizations/99999/groups/345/members"

here, content of @addmember.json file is:

{"userid":"444038"}

Response:

HTTP/1.1 201 Created
Location: https://api.inspiredlms.com/organizations/99999/groups/345/members/444038

Remove a Member / User from Group

Description:

Remove a user's membership from group.

URL:

https://api.inspiredlms.com/organizations/{orgID}/groups/{groupID}/members/{userID}

Method:

DELETE

Response Type:

JSON

HTTP Request Example:

DELETE
https://api.inspiredlms.com/organizations/99999/groups/345/members/12345
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X DELETE "https://api.inspiredlms.com/organizations/99999/groups/345/members/12345"

Response:

HTTP/1.1 204 No Content

Get All Courses Of a Group

Description:

Get all the courses of a group based on the specified parameters. It supports pagination.

URL:

https://api.inspiredlms.com/organizations/{orgID}/groups/{groupID}/groupcourses

Method:

GET

Response Type:

JSON

Parameters:

Query String Parameter Data Type Description Validations
sort string
By default results are sorted in course name ascending order.
Use "sort=-coursename" to sort results in course name descending order.
Is Required: No

Query String Parameter	Data Type	Description	Validations
sort	string	By default results are sorted in course name ascending order. Use "sort=-coursename" to sort results in course name descending order.	Is Required: No

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/groups/345/groupcourses?page=1&per_page=2
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/groups/345/groupcourses?page=1&per_page=2"

Response:

Since it supports pagination, response may include link header if resultant records are more than the page_size.

HTTP/1.1 200 Ok

[
{
"ID": "i4pkE0es",
"Name": "Security",
"DefaultRequirementType": "Mandatory",
"DefaultDueDateSettings": {
"DefaultDueDate": null,
"DaysAfterEnrollment": 10
}
},
{
"ID": "VvptYCj4",
"Name": "Data Security",
"DefaultRequirementType": "Mandatory",
"DefaultDueDateSettings": {
"DefaultDueDate": "2012-12-21T00:00:00",
"DaysAfterEnrollment": null
}
}
]

Add a Course in Group

Description:

Add a course in group based on parameter specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/groups/{groupID}/groupcourses

Method:

POST

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
courseid string course id of the course which is required to be part of group.
Is Required: Yes

Parameter	Data Type	Description	Validations
courseid	string	course id of the course which is required to be part of group.	Is Required: Yes

HTTP Request Example:

POST
https://api.inspiredlms.com/organizations/99999/groups/{groupID}/groupcourses
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"courseid":"WErt98k"}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X POST -d "@addcourse.json" "https://api.inspiredlms.com/organizations/99999/groups/345/groupcourses"

here, content of @addcoursejson file is:

{"courseid":"WErt98k"}

Response:

HTTP/1.1 201 Created
Location: https://api.inspiredlms.com/organizations/99999/groups/345/groupcourses/WErt98k

Remove a Course from Group

Description:

Remove a course from group.

URL:

https://api.inspiredlms.com/organizations/{orgID}/groups/{groupID}/groupcourses/{courseID}

Method:

DELETE

Response Type:

JSON

HTTP Request Example:

DELETE
https://api.inspiredlms.com/organizations/99999/groups/345/groupcourses/WErt98k
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X DELETE "https://api.inspiredlms.com/organizations/99999/groups/345/groupcourses/WErt98k"

Response:

HTTP/1.1 204 No Content

Modify Default Due Date and Requirement Type For A Group's Course

Description:

Remove a course from group.

URL:

https://api.inspiredlms.com/organizations/{orgID}/groups/{groupID}/groupcourses/{courseID}/settings

Method:

PUT

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
RequirementType
string
Set the requirement type "mandatory" or "optional" for the course under the group.
Is Required: Yes.
Valid values: mandatory, optional
DefaultDueDate
iso8601 UTC string
Format: "yyyy-MM-ddTHH:mm:ss"
Set a default due date for the course. Pass null to remove any previous date set for the course.
Is Required: Yes.
Valid values: iso8601 UTC string, or null.
DaysAfterEnrollment integer
Set number of days after enrollment, after which course will be set to due for a user.
Is Required: Yes.
Valid values: any positive integer (1-999), or null

Parameter	Data Type	Description	Validations
RequirementType	string	Set the requirement type "mandatory" or "optional" for the course under the group.	Is Required: Yes. Valid values: mandatory, optional
DefaultDueDate	iso8601 UTC string Format: "yyyy-MM-ddTHH:mm:ss"	Set a default due date for the course. Pass null to remove any previous date set for the course.	Is Required: Yes. Valid values: iso8601 UTC string, or null.
DaysAfterEnrollment	integer	Set number of days after enrollment, after which course will be set to due for a user.	Is Required: Yes. Valid values: any positive integer (1-999), or null

HTTP Request Example:

PUT
https://api.inspiredlms.com/organizations/99999/groups/345/groupcourses/WErt98k/settings
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"RequirementType":"mandatory","DefaultDueDateSettings":{"DefaultDueDate":null,"DaysAfterEnrollment":30}}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X PUT -d "@modifySettings.json" "https://api.inspiredlms.com/organizations/99999/groups/345/groupcourses/WErt98k"

here, content of @modifySettings.json file is:

{
"RequirementType": "mandatory",
"DefaultDueDateSettings": {
"DefaultDueDate": null,
"DaysAfterEnrollment": 30
}
}

Response:

HTTP/1.1 204 No Content

Refresh a Group

Description:

Refresh a group to update membership.

URL:

https://api.inspiredlms.com/organizations/{orgID}/groups/{groupID}/refresh

Method:

PUT

Response Type:

JSON

HTTP Request Example:

PUT
https://api.inspiredlms.com/organizations/99999/groups/345/refresh
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X PUT -d "" "https://api.inspiredlms.com/organizations/99999/groups/345/refresh"

Response:

HTTP/1.1 204 No Content

Get All Members / Users Of a Group's Explicit Inclusion List

Description:

Get all the users of a group's explicit inclusion list based on the specified parameters. Supports pagination.

URL:

https://api.inspiredlms.com/organizations/{orgID}/groups/{groupID}/explicitinclusionlistusers

Method:

GET

Response Type:

JSON

Parameters:

Besides standard pagination and sort parameters, it accepts search on any user profile field.
Query String Parameter Data Type Description Validations
sort string get the results in specified sorting order. If nothing is passed, it returns result in F003 ascending order.
Supported user profile field code for sorting are: F001, F002, F003, F004, F006, F011, F012, F015, F019, F020, F021

Query String Parameter	Data Type	Description	Validations
sort	string	get the results in specified sorting order. If nothing is passed, it returns result in F003 ascending order.	Supported user profile field code for sorting are: F001, F002, F003, F004, F006, F011, F012, F015, F019, F020, F021

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/groups/345/explicitinclusionlistusers
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/groups/345/explicitinclusionlistusers"

Response:

Since it supports pagination, response may include link header if resultant records are more than the page_size.

HTTP/1.1 200 Ok

[
{
"ID": 517244,
"UserStatus": "Active",
"Profile": {
"F001": "John",
"F002": "",
"F003": "Doe",
"F004": "Emp001",
"F005": null,
"F006": "English",
"F007": "Manager",
"F008": "",
"F009": "",
"F010": "San Antonio",
"F011": "United States",
"F012": "Texas",
"F013": "",
"F014": "",
"F015": "[email protected]",
"F016": null,
"F017": "",
"F018": "",
"F019": "Region 1",
"F019_ID": 13306,
"F020": "Division 1",
"F020_ID": 8463,
"F021": "Department 1",
"F021_ID": 15136,
"F022": "",
"F023": "(GMT-06.00) Central Time (US & Canada)",
"F024": "",
"F025": "",
"F026": "",
"F027": "",
"F031": "API",
"F032": "2013-10-23T13:30:38.22",
"F033": "",
"F034": ""
}
},
{
"ID": 517226,
"UserStatus": "Active",
"Profile": {
"F001": "Demo",
"F002": "",
"F003": "User",
"F004": "Emp002",
"F005": null,
"F006": "English",
"F007": "",
"F008": "",
"F009": "",
"F010": "",
"F011": "US",
"F012": "NE",
"F013": "",
"F014": "",
"F015": "[email protected]",
"F016": null,
"F017": "",
"F018": "",
"F019": "Region 1",
"F019_ID": 13306,
"F020": "Division 1",
"F020_ID": 8463,
"F021": "Department 1",
"F021_ID": 15136,
"F022": "",
"F023": "(GMT-06.00) Central Time (US & Canada)",
"F024": "",
"F025": "",
"F026": "",
"F027": "",
"F031": "LDAP",
"F032": "2013-10-17T12:34:34.61",
"F033": "",
"F034": ""
}
}
]

Add a User in Group's Explicit Inclusion List

Description:

Add a new user in group's explicit inclusion list.

URL:

https://api.inspiredlms.com/organizations/{orgID}/groups/{groupID}/explicitinclusionlistusers

Method:

POST

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
sort string get the results in specified sorting order. If nothing is passed, it returns result in F003 ascending order.
Supported user profile field code for sorting are: F001, F002, F003, F004, F006, F011, F012, F015, F019, F020, F021

Parameter	Data Type	Description	Validations
sort	string	get the results in specified sorting order. If nothing is passed, it returns result in F003 ascending order.	Supported user profile field code for sorting are: F001, F002, F003, F004, F006, F011, F012, F015, F019, F020, F021

HTTP Request Example:

POST
https://api.inspiredlms.com/organizations/99999/groups/{groupID}/explicitinclusionlistusers
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"userid":"444038"}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X POST -d "@addmember.json" "https://api.inspiredlms.com/organizations/99999/groups/345/explicitinclusionlistusers"

here, content of @addmember.json file is:

{"userid":"444038"}

Response:

HTTP/1.1 201 Created
Location: https://api.inspiredlms.com/organizations/99999/groups/345/explicitinclusionlistusers/444038

Remove a User from a Group's Explicit Inclusion List

Description:

Remove a user from a group's explicit inclusion list.

URL:

https://api.inspiredlms.com/organizations/{orgID}/groups/{groupID}/explicitinclusionlistusers/{userID}

Method:

DELETE

Response Type:

JSON

HTTP Request Example:

DELETE
https://api.inspiredlms.com/organizations/99999/groups/345/explicitinclusionlistusers/12345
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X DELETE "https://api.inspiredlms.com/organizations/99999/groups/345/explicitinclusionlistusers/12345"

Response:

HTTP/1.1 204 No Content

Get All Members / Users Of a Group's Explicit Exclusion List

Description:

Get all the users of a group's explicit exclusion list based on the specified parameters. Supports pagination.

URL:

https://api.inspiredlms.com/organizations/{orgID}/groups/{groupID}/explicitexclusionlistusers

Method:

GET

Response Type:

JSON

Parameters:

Besides standard pagination and sort parameters, it accepts search on any user profile field.
Query String Parameter Data Type Description Validations
sort string get the results in specified sorting order. If nothing is passed, it returns result in F003 ascending order.
Supported user profile field code for sorting are: F001, F002, F003, F004, F006, F011, F012, F015, F019, F020, F021

Query String Parameter	Data Type	Description	Validations
sort	string	get the results in specified sorting order. If nothing is passed, it returns result in F003 ascending order.	Supported user profile field code for sorting are: F001, F002, F003, F004, F006, F011, F012, F015, F019, F020, F021

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/groups/345/explicitexclusionlistusers
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/groups/345/explicitexclusionlistusers"

Response:

Since it supports pagination, response may include link header if resultant records are more than the page_size.

HTTP/1.1 200 Ok

[
{
"ID": 517244,
"UserStatus": "Active",
"Profile": {
"F001": "John",
"F002": "",
"F003": "Doe",
"F004": "Emp001",
"F005": null,
"F006": "English",
"F007": "Manager",
"F008": "",
"F009": "",
"F010": "San Antonio",
"F011": "United States",
"F012": "Texas",
"F013": "",
"F014": "",
"F015": "[email protected]",
"F016": null,
"F017": "",
"F018": "",
"F019": "Region 1",
"F019_ID": 13306,
"F020": "Division 1",
"F020_ID": 8463,
"F021": "Department 1",
"F021_ID": 15136,
"F022": "",
"F023": "(GMT-06.00) Central Time (US & Canada)",
"F024": "",
"F025": "",
"F026": "",
"F027": "",
"F031": "API",
"F032": "2013-10-23T13:30:38.22",
"F033": "",
"F034": ""
}
},
{
"ID": 517226,
"UserStatus": "Active",
"Profile": {
"F001": "Demo",
"F002": "",
"F003": "User",
"F004": "Emp002",
"F005": null,
"F006": "English",
"F007": "",
"F008": "",
"F009": "",
"F010": "",
"F011": "US",
"F012": "NE",
"F013": "",
"F014": "",
"F015": "[email protected]",
"F016": null,
"F017": "",
"F018": "",
"F019": "Region 1",
"F019_ID": 13306,
"F020": "Division 1",
"F020_ID": 8463,
"F021": "Department 1",
"F021_ID": 15136,
"F022": "",
"F023": "(GMT-06.00) Central Time (US & Canada)",
"F024": "",
"F025": "",
"F026": "",
"F027": "",
"F031": "LDAP",
"F032": "2013-10-17T12:34:34.61",
"F033": "",
"F034": ""
}
}
]

Add a User in Group's Explicit Exclusion List

Description:

Add a new user in group's explicit exclusion list.

URL:

https://api.inspiredlms.com/organizations/{orgID}/groups/{groupID}/explicitexclusionlistusers

Method:

POST

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
sort string get the results in specified sorting order. If nothing is passed, it returns result in F003 ascending order.
Supported user profile field code for sorting are: F001, F002, F003, F004, F006, F011, F012, F015, F019, F020, F021

Parameter	Data Type	Description	Validations
sort	string	get the results in specified sorting order. If nothing is passed, it returns result in F003 ascending order.	Supported user profile field code for sorting are: F001, F002, F003, F004, F006, F011, F012, F015, F019, F020, F021

HTTP Request Example:

POST
https://api.inspiredlms.com/organizations/99999/groups/345/explicitexclusionlistusers
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"userid":"444038"}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X POST -d "@adduser.json" "https://api.inspiredlms.com/organizations/99999/groups/345/explicitexclusionlistusers"

here, content of @adduser.json file is:

{"userid":"444038"}

Response:

HTTP/1.1 201 Created
Location: https://api.inspiredlms.com/organizations/99999/groups/345/explicitexclusionlistusers/444038

Remove a User from a Group's Explicit Exclusion List

Description:

Remove a user from a group's explicit exclusion list.

URL:

https://api.inspiredlms.com/organizations/{orgID}/groups/{groupID}/explicitexclusionlistusers/{userID}

Method:

DELETE

Response Type:

JSON

HTTP Request Example:

DELETE
https://api.inspiredlms.com/organizations/99999/groups/{groupID}/explicitexclusionlistusers/12345
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X DELETE "https://api.inspiredlms.com/organizations/99999/groups/{groupID}/explicitexclusionlistusers/12345"

Response:

HTTP/1.1 204 No Content

User Hierarchy - Region, Division, and Department

Region

Get All Regions

Description:

Get all the regions of an organization specified by orgID.

URL:

https://api.inspiredlms.com/organizations/{orgID}/regions

Method:

GET

Response Type:

JSON

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/regions
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/regions"

Response:

HTTP/1.1 200 Ok
X-Total-Count: 3
[
{
"ID": 13298,
"Name": "Region1",
"NumberOfUsers":10
},
{
"ID": 13299,
"Name": "Region2",
"NumberOfUsers":5
},
{
"ID": 13320,
"Name": "Region3",
"NumberOfUsers":7
}
]

Create a Region

Description:

Create a new region based on the parameters specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/regions

Method:

POST

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
name string Name of the region
Is Required: Yes
Maximum Length: 100 characters
Restricted Characters: % \ + ; " < > : ?
& # are restricted by functionality and not error if using iLMS connect

Parameter	Data Type	Description	Validations
name	string	Name of the region	Is Required: Yes Maximum Length: 100 characters Restricted Characters: % \ + ; " < > : ? & # are restricted by functionality and not error if using iLMS connect

HTTP Request Example:

POST
https://api.inspiredlms.com/organizations/99999/regions
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"name":"MyRegion"}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X POST -d "@createreg.json" "https://api.inspiredlms.com/organizations/99999/regions"

here, content of @createreg.json file is:

{
"name": "MyRegion"
}

Response:

If successful, 201 status code will be return along with ID of new region.

HTTP/1.1 201 Created
Location: https://api.inspiredlms.com/organizations/99999/regions/123456

123456

Update Region Name

Description:

Modify region name based on the parameters specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/regions/{regionID}

Method:

PUT

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
name string Name of the region
Is Required: Yes
Maximum Length: 100 characters
Restricted Characters: % \ + ; " < > : ?
& # are restricted by functionality and not error if using iLMS connect

Parameter	Data Type	Description	Validations
name	string	Name of the region	Is Required: Yes Maximum Length: 100 characters Restricted Characters: % \ + ; " < > : ? & # are restricted by functionality and not error if using iLMS connect

HTTP Request Example:

PUT
https://api.inspiredlms.com/organizations/99999/regions/123456
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"name":"MyNewRegion"}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X PUT -d "@updatereg.json" "https://api.inspiredlms.com/organizations/99999/regions/123456"

here, content of @updatereg.json file is:

{
"name": "MyNewRegion"
}

Response:

HTTP/1.1 204 No Content

Delete a Region

Description:

Delete the region identified by regionID.

URL:

https://api.inspiredlms.com/organizations/{orgID}/regions/{regionID}

Method:

DELETE

Response Type:

JSON

HTTP Request Example:

DELETE
https://api.inspiredlms.com/organizations/99999/regions/123456
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X DELETE "https://api.inspiredlms.com/organizations/99999/regions/123456"

Response:

HTTP/1.1 204 No Content

Division

Get All Divisions

Description:

Get all the divisions of a region specified by regionID.

URL:

https://api.inspiredlms.com/organizations/{orgID}/regions/{regionID}/divisions

Method:

GET

Response Type:

JSON

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/regions/123456/divisions
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/regions/123456/divisions"

Response:

HTTP/1.1 200 Ok
X-Total-Count: 3
[
{
"ID": 8685,
"Name": "Division1",
"NumberOfUsers":5
},
{
"ID": 8690,
"Name": "Division2",
"NumberOfUsers":15
},
{
"ID": 8691,
"Name": "Division3",
"NumberOfUsers":45
}
]

Create a Division

Description:

Create a new division inside a region based on the parameters specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/regions/{regionID}/divisions

Method:

POST

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
name string Name of the division
Is Required: Yes
Maximum Length: 100 characters
Restricted Characters: % \ + ; " < > : ?

Parameter	Data Type	Description	Validations
name	string	Name of the division	Is Required: Yes Maximum Length: 100 characters Restricted Characters: % \ + ; " < > : ?

HTTP Request Example:

POST
https://api.inspiredlms.com/organizations/99999/regions/123456/divisions
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"name":"MyDivision"}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X POST -d "@creatediv.json" "https://api.inspiredlms.com/organizations/99999/regions/123456/divisions"

here, content of @creatediv.json file is:

{
"name": "MyDivision"
}

Response:

HTTP/1.1 201 Created
Location: https://api.inspiredlms.com/organizations/99999/regions/123456/divisions/234567

234567

Update Division Name

Description:

Modify division name based on the parameters specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/regions/{regionID}/divisions/{divisionID}

Method:

PUT

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
name string Name of the division
Is Required: Yes
Maximum Length: 100 characters
Restricted Characters: % \ + ; " < > : ?
& # are restricted by functionality and not error if using iLMS connect

Parameter	Data Type	Description	Validations
name	string	Name of the division	Is Required: Yes Maximum Length: 100 characters Restricted Characters: % \ + ; " < > : ? & # are restricted by functionality and not error if using iLMS connect

HTTP Request Example:

PUT
https://api.inspiredlms.com/organizations/99999/regions/123456/divisions/234567
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"name":"MyNewDivision"}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X PUT -d "@updatediv.json" "https://api.inspiredlms.com/organizations/99999/regions/123456/divisions/234567"

here, content of @updatediv.json file is:

{
"name": "MyNewDivision"
}

Response:

HTTP/1.1 204 No Content

Delete a Division

Description:

Delete the division identified by divisionID.

URL:

https://api.inspiredlms.com/organizations/{orgID}/regions/{regionID}/divisions/{divisionID}

Method:

DELETE

Response Type:

JSON

HTTP Request Example:

DELETE
https://api.inspiredlms.com/organizations/99999/regions/123456/divisions/234567
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X DELETE "https://api.inspiredlms.com/organizations/99999/regions/123456/divisions/234567"

Response:

HTTP/1.1 204 No Content

Department

Get All Departments

Description:

Get all the departments of a division and region specified by divisionID and regionID.

URL:

https://api.inspiredlms.com/organizations/{orgID}/regions/{regionID}/divisions/{divisionID}/departments

Method:

GET

Response Type:

JSON

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/regions/123456/divisions/{divisionID}/departments
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/regions/123456/divisions/234567/departments"

Response:

HTTP/1.1 200 Ok
X-Total-Count: 3
[
{
"ID": 9101,
"Name": "Department1",
"NumberOfUsers":36
},
{
"ID": 9102,
"Name": "Department2",
"NumberOfUsers":4
},
{
"ID": 9105,
"Name": "Department3",
"NumberOfUsers":1
}
]

Create a Department

Description:

Create a new department inside a division and region based on the parameters specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/regions/{regionID}/divisions/{divisionID}/departments

Method:

POST

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
name string Name of the department
Is Required: Yes
Maximum Length: 100 characters
Restricted Characters: % \ + ; " < > : ?
& # are restricted by functionality and not error if using iLMS connect

Parameter	Data Type	Description	Validations
name	string	Name of the department	Is Required: Yes Maximum Length: 100 characters Restricted Characters: % \ + ; " < > : ? & # are restricted by functionality and not error if using iLMS connect

HTTP Request Example:

POST
https://api.inspiredlms.com/organizations/99999/regions/123456/divisions/234567/departments
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"name":"MyDepartment"}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X POST -d "@createdep.json" "https://api.inspiredlms.com/organizations/99999/regions/123456/divisions/234567/departments"

here, content of @createdep.json file is:

{
"name": "MyDepartment"
}

Response:

HTTP/1.1 201 Created
Location: https://api.inspiredlms.com/organizations/99999/regions/123456/divisions/234567/departments/345678
345678

Update Department Name

Description:

Modify department name based on the parameters specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/regions/{regionID}/divisions/{divisionID}/departments/{deptID}

Method:

PUT

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
name string Name of the department
Is Required: Yes
Maximum Length: 100 characters
Restricted Characters: % \ + ; " < > : ?

Parameter	Data Type	Description	Validations
name	string	Name of the department	Is Required: Yes Maximum Length: 100 characters Restricted Characters: % \ + ; " < > : ?

HTTP Request Example:

PUT
https://api.inspiredlms.com/organizations/99999/regions/123456/divisions/234567/departments/345678
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"name":"MyNewDepartment"}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X PUT -d "@updatedep.json" "https://api.inspiredlms.com/organizations/99999/regions/123456/divisions/234567/departments/345678"

here, content of @updatedep.json file is:

{
"name": "MyNewDepartment"
}

Response:

HTTP/1.1 204 No Content

Delete a Department

Description:

Delete the department identified by deptID.

URL:

https://api.inspiredlms.com/organizations/{orgID}/regions/{regionID}/divisions/{divisionID}/departments/{deptID}

Method:

DELETE

Response Type:

JSON

HTTP Request Example:

DELETE
https://api.inspiredlms.com/organizations/99999/regions/123456/divisions/234567/departments/345678
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X DELETE "https://api.inspiredlms.com/organizations/99999/regions/123456/divisions/234567/departments/345678"

Response:

HTTP/1.1 204 No Content

Transcripts

Get Transcripts Of A User

Description:

Get the transcript of a user as per parameter specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/users/{userid}/transcripts

Method:

GET

Response Type:

JSON

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/users/123456/transcripts
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/users/123456/transcripts"

Response:

HTTP/1.1 200 Ok

[
{
"CourseName": "Security Awareness",
"CourseID": "fO1uIKJO",
"SessionName": "",
"SessionID": 0,
"RequirementType": "Mandatory",
"LicenseExpirationDate": "2014-01-28T16:30:39.37",
"EnrollmentDate": "2013-12-09T16:30:39.37",
"DueDate": "2014-01-01T04:00:00",
"StartDate": null,
"CompletionDate": null,
"Score": 0,
"Status": "Not Started",
"TimeSpent": 0,
"CertificationStatus": "Never Certified",
"CertificationExpirationDate": null,
"Credits": 0.0,
"Hours": 0.0
},
{
"CourseName": "Data Security",
"CourseID": "wqivr6aA",
"SessionName": "",
"SessionID": 0,
"RequirementType": "Mandatory",
"LicenseExpirationDate": null,
"EnrollmentDate": "2013-12-09T16:30:48.213",
"DueDate": null,
"StartDate": "2013-12-13T05:21:20.84",
"CompletionDate": "2013-12-13T05:21:20.84",
"Score": 100,
"Status": "Pass",
"TimeSpent": 20,
"CertificationStatus": null,
"CertificationExpirationDate": null,
"Credits": 0.0,
"Hours": 0.0
}
]

Get Transcripts Of A User For A Specific Course

Description:

Get the transcript of a user for a course as per parameter specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/users/{userID}/courses/{courseID}/transcripts

Method:

GET

Response Type:

JSON

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/users/123456/courses/fO1uIKJO/transcripts
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/users/123456/courses/fO1uIKJO/transcripts"

Response:

HTTP/1.1 200 Ok
[
{
"CourseName": "Security Awareness",
"CourseID": "fO1uIKJO",
"SessionName": "",
"SessionID": 0,
"RequirementType": "Mandatory",
"LicenseExpirationDate": "2014-01-28T16:30:39.37",
"EnrollmentDate": "2013-12-09T16:30:39.37",
"DueDate": "2014-01-01T04:00:00",
"StartDate": null,
"CompletionDate": null,
"Score": 0,
"Status": "Not Started",
"TimeSpent": 0,
"CertificationStatus": null,
"CertificationExpirationDate": null,
"Credits": 0.0,
"Hours": 0.0
}
]

Get Transcripts Of A User For A Specific Curriculum

Description:

Get the transcript of a user for a curriculum as per parameter specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/users/{userID}/curricula/{courseID}/transcripts

Method:

GET

Response Type:

JSON

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/users/123456/curricula/PP1uIKJO/transcripts
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/users/123456/curricula/PP1uIKJO/transcripts"

Response:

HTTP/1.1 200 Ok
[
{
"CourseName": "Security_Curriculum",
"CourseID": "PP1uIKJO",
"SessionName": "",
"SessionID": 0,
"RequirementType": "Mandatory",
"LicenseExpirationDate": "2014-01-28T16:30:39.37",
"EnrollmentDate": "2013-12-09T16:30:39.37",
"DueDate": "2014-01-01T04:00:00",
"StartDate": null,
"CompletionDate": null,
"Score": 0,
"Status": "Not Started",
"TimeSpent": 0,
"CertificationStatus": null,
"CertificationExpirationDate": null,
"Credits": 0.0,
"Hours": 0.0
}
]

Get Transcripts Of A User For A Specific Session

Description:

Get the transcript of a user for a specific session as per parameter specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/users/{userID}/courses/{courseID}/sessions/{sessionID}/transcripts

Method:

GET

Response Type:

JSON

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/users/123456/courses/iiOYhg6E/sessions/517378/transcripts
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/users/123456/courses/iiOYhg6E/sessions/517378/transcripts"

Response:

HTTP/1.1 200 Ok
{

"CourseName": "ILT Test",
"CourseID": "iiOYhg6E",
"SessionName": "Sep 8, 2013 7:30 PM (CDT) to Sep 9, 2013 1:30 AM (CDT)",
"SessionID": 5119,
"RequirementType": "Mandatory",
"LicenseExpirationDate": null,
"DueDate": null,
"StartDate": null,
"CompletionDate": null,
"EnrollmentDate": "2013-07-13T07:54:27.59",
"Score": 0,
"Status": "Not Started",
"TimeSpent": 0,
"CertificationStatus": null,
"CertificationExpirationDate": null,
"Hours": 0,
"Credits": 0
}

Modify User's Transcript For A Course/Curriculum/Session

Description:

Modify the user's transcript for a course/curriculum/session identified by courseID and/or sessionID.

URL:

Course: https://api.inspiredlms.com/organizations/{orgID}/users/{userID}/courses/{courseID}/transcripts
Curriculum: https://api.inspiredlms.com/organizations/{orgID}/users/{userID}/curricula/{courseID}/transcripts
Session: https://api.inspiredlms.com/organizations/{orgID}/users/{userID}/courses/{courseID}/sessions/{sessionID}/transcripts

Method:

PUT

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
EnrollmentDate
iso8601 UTC string
Format: "yyyy-MM-ddTHH:mm:ss"
Modify enrollment date.
Is Required: No.
Valid values: iso8601 UTC string
LicenseExpirationDate
iso8601 UTC string
Format: "yyyy-MM-ddTHH:mm:ss"
Modify license expiration date for the course. User will not be able to launch the course after this date.
Is Required: No.
Valid values: iso8601 UTC string
StartDate
iso8601 UTC string
Format: "yyyy-MM-ddTHH:mm:ss"
Modify start date.
Is Required: No.
Valid values: iso8601 UTC string
Only valid if status is not "Not Started"
DueDate
iso8601 UTC string
Format: "yyyy-MM-ddTHH:mm:ss"
Modify due date. pass null to remove any due date already set.
Is Required: No.
Valid values: iso8601 UTC string or null
CompletionDate
iso8601 UTC string
Format: "yyyy-MM-ddTHH:mm:ss"
Modify completion date.
Is Required: No.
Valid values: iso8601 UTC string
Only valid if status is "Pass" or "Fail"
CertificationExpirationDate
iso8601 UTC string
Format: "yyyy-MM-ddTHH:mm:ss"
Modify the certification expiration date.
Is Required: No.
Valid values: iso8601 UTC string
Only valid when course is a certification enabled course.
RequirementType string
Modify the requirement type.
Is Required: No.
Valid values: mandatory, optional
Status string Modify the course status of the course. It has high priority on other fields. For example, if status is set to "Not Started" system will ignore other dates such as completion date, start date which are ir-relevant with this status. In another case, if new status is "Pass" but no other dates are passed, system will set current date in start date, completion date with score as 100% etc.
Is Required: No.
Valid values: not started, pass, fail, waived
Score integer Modify the % score.
Is Required: No.
Valid values: 0 - 100
Only valid when course status is "pass" or "fail"

Parameter	Data Type	Description	Validations
EnrollmentDate	iso8601 UTC string Format: "yyyy-MM-ddTHH:mm:ss"	Modify enrollment date.	Is Required: No. Valid values: iso8601 UTC string
LicenseExpirationDate	iso8601 UTC string Format: "yyyy-MM-ddTHH:mm:ss"	Modify license expiration date for the course. User will not be able to launch the course after this date.	Is Required: No. Valid values: iso8601 UTC string
StartDate	iso8601 UTC string Format: "yyyy-MM-ddTHH:mm:ss"	Modify start date.	Is Required: No. Valid values: iso8601 UTC string Only valid if status is not "Not Started"
DueDate	iso8601 UTC string Format: "yyyy-MM-ddTHH:mm:ss"	Modify due date. pass null to remove any due date already set.	Is Required: No. Valid values: iso8601 UTC string or null
CompletionDate	iso8601 UTC string Format: "yyyy-MM-ddTHH:mm:ss"	Modify completion date.	Is Required: No. Valid values: iso8601 UTC string Only valid if status is "Pass" or "Fail"
CertificationExpirationDate	iso8601 UTC string Format: "yyyy-MM-ddTHH:mm:ss"	Modify the certification expiration date.	Is Required: No. Valid values: iso8601 UTC string Only valid when course is a certification enabled course.
RequirementType	string	Modify the requirement type.	Is Required: No. Valid values: mandatory, optional
Status	string	Modify the course status of the course. It has high priority on other fields. For example, if status is set to "Not Started" system will ignore other dates such as completion date, start date which are ir-relevant with this status. In another case, if new status is "Pass" but no other dates are passed, system will set current date in start date, completion date with score as 100% etc.	Is Required: No. Valid values: not started, pass, fail, waived
Score	integer	Modify the % score.	Is Required: No. Valid values: 0 - 100 Only valid when course status is "pass" or "fail"

HTTP Request Example:

PUT
https://api.inspiredlms.com/organizations/99999/users/123456/transcripts?courseid=fO1uIKJO
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"enrollmentdate":"2013-10-10T10:00:00","startdate":"2013-10-12T10:00:00","completiondate":"2013-10-14T10:00:00","score":"100","status":"pass"}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X PUT -d "@modifyTranscript.json" "https://api.inspiredlms.com/organizations/99999/users/123456/transcripts?courseid=fO1uIKJO"

here, content of @modifyTranscript.json file is:

{
"enrollmentdate": "2013-10-10T10:00:00",
"startdate": "2013-10-12T10:00:00",
"completiondate": "2013-10-14T10:00:00",
"score": "100",
"status": "pass"
}

Response:

HTTP/1.1 204 No Content

Courses

Get All Courses

Description:

Get all the courses. It supports pagination.

URL:

https://api.inspiredlms.com/organizations/{orgID}/courses

Method:

GET

Response Type:

JSON

Parameters:

Query String Parameter Data Type Description Validations
courseType string Filter courses based on their type. Use from the followings:

iComposer: to return all icomposer courses

SCORM: to return all SCORM courses

ILT: to return all ILT courses

EVENTS: to return all even courses
Is Required: No. By default API returns all types of courses.
Other: Pass only one value at a time.
includeHistorical boolean If true, historical courses will also be included in the result set.
Is Required: No. By default API returns non-historical courses.
search string It will be a like search and look this text in course name, description, outline and keywords.
Is Required: No
sort boolean By default results are sorted in course name ascending order.

Use "sort=-name" to sort results in course name descending order.
Is Required: No

Query String Parameter	Data Type	Description	Validations
courseType	string	Filter courses based on their type. Use from the followings: iComposer: to return all icomposer courses SCORM: to return all SCORM courses ILT: to return all ILT courses EVENTS: to return all even courses	Is Required: No. By default API returns all types of courses. Other: Pass only one value at a time.
includeHistorical	boolean	If true, historical courses will also be included in the result set.	Is Required: No. By default API returns non-historical courses.
search	string	It will be a like search and look this text in course name, description, outline and keywords.	Is Required: No
sort	boolean	By default results are sorted in course name ascending order. Use "sort=-name" to sort results in course name descending order.	Is Required: No

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/courses
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/courses"

Response:

HTTP/1.1 200 Ok
X-Total-Count: 20
next: http://api.ilmsdev/organizations/824/courses?page=2&per_page=2
last: http://api.ilmsdev/organizations/824/courses?page=10&per_page=2

[
{
"ID": "p1gyJg4a",
"Name": "Security",
"Type": "iComposer",
"DeliveryType": "Web-based",
"DefaultRequirementType": "Mandatory",
"Credits": "10",
"Hours": "4",
"Status": "Active",
"DefaultDueDateSettings": {
"DefaultDueDate": null,
"DaysAfterEnrollment": 4
}
},
{
"ID": "x56QjLXI",
"Name": "Security Awareness",
"Type": "SCORM",
"DeliveryType": "Web-based",
"DefaultRequirementType": "Mandatory",
"Credits": "0",
"Hours": "0",
"Status": "Active",
"DefaultDueDateSettings": {
"DefaultDueDate": "2014-11-22T23:01:00",
"DaysAfterEnrollment": null
}
}
]

Get A Course

Description:

Get a course based on the parameter specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/courses/{courseID}

Method:

GET

Response Type:

JSON

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/courses/p1gyJg4a
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/courses/p1gyJg4a"

Response:

HTTP/1.1 200 Ok

{
"ID": "p1gyJg4a",
"Name": "Security",
"Type": "iComposer",
"DeliveryType": "Web-based",
"DefaultRequirementType": "Mandatory",
"Credits": "10",
"Hours": "4",
"Status": "Active",
"DefaultDueDateSettings": {
"DefaultDueDate": null,
"DaysAfterEnrollment": 4
}
}

Get Only Due Date Settings of a Course

Description:

Get Due Date settings of a course based on the parameter specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/courses/{courseID}/duedate

Method:

GET

Response Type:

JSON

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/courses/p1gyJg4a/duedate
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/courses/p1gyJg4a/duedate"

Response:

HTTP/1.1 200 Ok

{
"DefaultDueDate": null,
"DaysAfterEnrollment": 4
}

Modify Due Date Settings of a course

Description:

Modify the default due date settings of a course identified by courseID.

URL:

https://api.inspiredlms.com/organizations/{orgID}/courses/{courseID}/DueDate

Method:

PUT

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
DefaultDueDate iso8601 UTC string

Format: "yyyy-MM-ddTHH:mm:ss" Set a default due date for the course. Pass null to remove any previous date set for the course.
Is Required: Yes.
Valid values: iso8601 UTC string, or null.
DaysAfterEnrollment integer Set number of days after enrollment, after which course will be set to due for a user.
Is Required: Yes.
Valid values: any positive integer (1-999), or null

Parameter	Data Type	Description	Validations
DefaultDueDate	iso8601 UTC string Format: "yyyy-MM-ddTHH:mm:ss"	Set a default due date for the course. Pass null to remove any previous date set for the course.	Is Required: Yes. Valid values: iso8601 UTC string, or null.
DaysAfterEnrollment	integer	Set number of days after enrollment, after which course will be set to due for a user.	Is Required: Yes. Valid values: any positive integer (1-999), or null

HTTP Request Example:

PUT
https://api.inspiredlms.com/organizations/99999/courses/p1gyJg4a/DueDate
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"DefaultDueDate":"2014-11-22T00:00:00","DaysAfterEnrollment":null}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X PUT -d "@modifyDueDate.json" "https://api.inspiredlms.com/organizations/99999/courses/p1gyJg4a/DueDate"

here, content of @modifyDueDate.json file is:

{
"DefaultDueDate": "2014-11-22T00:00:00",
"DaysAfterEnrollment": null
}

Response:

HTTP/1.1 204 No Content

Inactivate a course

Description:

Inactivate the course identified by courseID.

URL:

https://api.inspiredlms.com/organizations/{orgID}/courses/{courseID}

Method:

DELETE

Response Type:

JSON

HTTP Request Example:

DELETE
https://api.inspiredlms.com/organizations/99999/courses/p1gyJg4a/Activate
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X DELETE "https://api.inspiredlms.com/organizations/99999/courses/p1gyJg4a/Activate"

Response:

HTTP/1.1 204 No Content

Activate a course

Description:

Activate the course identified by courseID.

URL:

https://api.inspiredlms.com/organizations/{orgID}/courses/{courseID}/Activate

Method:

PUT

Response Type:

JSON

HTTP Request Example:

PUT
https://api.inspiredlms.com/organizations/99999/courses/p1gyJg4a/Activate
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X PUT -d "" "https://api.inspiredlms.com/organizations/99999/courses/p1gyJg4a/Activate"

Response:

HTTP/1.1 204 No Content

Curricula

Get All Curricula/Search by Name

Description:

Get all the curricula.

URL:

https://api.inspiredlms.com/organizations/{orgID}/curricula

Method:

GET

Response Type:

JSON

Parameters:

Query String Parameter Data Type Description Validations
name string It will be a like search and look this text in group name.
Is Required: No

Query String Parameter	Data Type	Description	Validations
name	string	It will be a like search and look this text in group name.	Is Required: No

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/curricula
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/curricula"

Response:

HTTP/1.1 200 Ok

[
{
"ID": "dHg6Kdl8",
"Name": "Security Awareness Curriculum",
"DefaultDueDateSettings": {
"DefaultDueDate": "2014-11-22T23:01:00",
"DaysAfterEnrollment": null
}
},
{
"ID": "h0lHIuoD",
"Name": "Curriculum2",
"DefaultDueDateSettings": {
"DefaultDueDate": null,
"DaysAfterEnrollment": 30
}
}
]

Get A Curriculum

Description:

Get a curriculum based on the parameter specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/curricula/{curriculumID}

Method:

GET

Response Type:

JSON

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/curricula/dHg6Kdl8
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/curricula/dHg6Kdl8"

Response:

HTTP/1.1 200 Ok

{
"ID": "dHg6Kdl8",
"Name": "Security Awareness Curriculum",
"DefaultDueDateSettings": {
"DefaultDueDate": "2014-11-22T23:01:00",
"DaysAfterEnrollment": null
}
}

Modify Due Date Settings of a curriculum

Description:

Modify the default due date settings of a curriculum identified by curriculumID.

URL:

https://api.inspiredlms.com/organizations/{orgID}/curriculum/{curriculumID}/DueDate

Method:

PUT

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
DefaultDueDate iso8601 UTC string

Format: "yyyy-MM-ddTHH:mm:ss" Set a default due date for the course. Pass null to remove any previous date set for the course.
Is Required: Yes.
Valid values: iso8601 UTC string, or null.
DaysAfterEnrollment integer Set number of days after enrollment, after which course will be set to due for a user.
Is Required: Yes.
Valid values: any positive integer (1-999), or null

Parameter	Data Type	Description	Validations
DefaultDueDate	iso8601 UTC string Format: "yyyy-MM-ddTHH:mm:ss"	Set a default due date for the course. Pass null to remove any previous date set for the course.	Is Required: Yes. Valid values: iso8601 UTC string, or null.
DaysAfterEnrollment	integer	Set number of days after enrollment, after which course will be set to due for a user.	Is Required: Yes. Valid values: any positive integer (1-999), or null

HTTP Request Example:

PUT
https://api.inspiredlms.com/organizations/99999/curriculum/dHg6Kdl8/DueDate
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"DefaultDueDate":"2014-11-22T00:00:00","DaysAfterEnrollment":null}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X PUT -d "@modifyDueDate.json" "https://api.inspiredlms.com/organizations/99999/curriculum/dHg6Kdl8/DueDate"

here, content of @modifyDueDate.json file is:

{
"DefaultDueDate": "2014-11-22T00:00:00",
"DaysAfterEnrollment": null
}

Response:

HTTP/1.1 204 No Content

Instructor-Lead Training Sessions

Get All Sessions of a ILT/Event

Description:

Get sessions of a ILT/event based on the parameters specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/courses/{courseid}/sessions

Method:

GET

Response Type:

JSON

Parameters:

Querystring Parameter Data Type Description Validations
sessionstartdate datetime Use this to return sessions whose start date is equal or in future than this.
Is Required: No
sessionenddate datetime Use this to return sessions whose end date is equal or in past than this.
Is Required: No
sort string results can be sort on following: sessionstartdate, sessionenddate, locationname, roomname

To return results in descending order, use dash before field value.

For example: sort=-sessionstartdate
Is Required: No. If not passed, results will return in session start date ascending order.
it supports pagination. So standard pagination parameters (page & per_page) can be used in query string.

Querystring Parameter	Data Type	Description	Validations
sessionstartdate	datetime	Use this to return sessions whose start date is equal or in future than this.	Is Required: No
sessionenddate	datetime	Use this to return sessions whose end date is equal or in past than this.	Is Required: No
sort	string	results can be sort on following: sessionstartdate, sessionenddate, locationname, roomname To return results in descending order, use dash before field value. For example: sort=-sessionstartdate	Is Required: No. If not passed, results will return in session start date ascending order.

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/courses/pyOgaoIi/sessions?sessionstartdate=2009-10-10&sessionenddate=2014-01-01&sort=-sessionstartdate&page=1&per_page=5
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/courses/pyOgaoIi/sessions?sessionstartdate=2009-10-10&sessionenddate=2014-01-01&sort=-sessionstartdate&page=1&per_page=5"

Response:

HTTP/1.1 200 Ok
X-Total-Count: 8
next: http://api.ilmsdev/organizations/707/courses/pyOgaoIi/sessions?sessionstartdate=2009-10-10&sessionenddate=2014-01-01&sort=-sessionstartdate&page=2&per_page=5
last: http://api.ilmsdev/organizations/707/courses/pyOgaoIi/sessions?sessionstartdate=2009-10-10&sessionenddate=2014-01-01&sort=-sessionstartdate&page=2&per_page=5

[
{
"CourseName": "Security Awareness",
"CourseID": "pyOgaoIi",
"SessionID": 4855,
"StartDateTime": "2011-03-21T15:00:00",
"EndDateTime": "2011-03-21T21:00:00",
"RoomName": "Confrence 1",
"Location": {
"Name": " San Antonio",
"TimeZoneName": "(GMT-06.00) Central Time (US & Canada)"
},
"Instructors": [
{
"ID": 45921,
"F001": "John",
"F003": "Doe",
"F015": "[email protected]",
"F004": ""
}
]
},
{
"CourseName": "Security Awareness",
"CourseID": "pyOgaoIi",
"SessionID": 4860,
"StartDateTime": "2011-02-15T15:00:00",
"EndDateTime": "2011-02-15T23:00:00",
"RoomName": "Confrence 1",
"Location": {
"Name": " San Antonio",
"TimeZoneName": "(GMT-06.00) Central Time (US & Canada)"
},
"Instructors": [
{
"ID": 45921,
"F001": "John",
"F003": "Doe",
"F015": "[email protected]",
"F004": ""
}
]
},
{
"CourseName": "Security Awareness",
"CourseID": "pyOgaoIi",
"SessionID": 4827,
"StartDateTime": "2011-01-29T15:00:00",
"EndDateTime": "2011-01-29T23:00:00",
"RoomName": "Confrence 1",
"Location": {
"Name": " San Antonio",
"TimeZoneName": "(GMT-06.00) Central Time (US & Canada)"
},
"Instructors": [
{
"ID": 45921,
"F001": "John",
"F003": "Doe",
"F015": "[email protected]",
"F004": ""
}
]
},
{
"CourseName": "Security Awareness",
"CourseID": "pyOgaoIi",
"SessionID": 4813,
"StartDateTime": "2011-01-01T15:00:00",
"EndDateTime": "2011-01-01T23:00:00",
"RoomName": "Confrence 1",
"Location": {
"Name": " San Antonio",
"TimeZoneName": "(GMT-06.00) Central Time (US & Canada)"
},
"Instructors": [
{
"ID": 45921,
"F001": "John",
"F003": "Doe",
"F015": "[email protected]",
"F004": ""
}
]
},
{
"CourseName": "Security Awareness",
"CourseID": "pyOgaoIi",
"SessionID": 4798,
"StartDateTime": "2010-12-25T15:00:00",
"EndDateTime": "2010-12-25T23:00:00",
"RoomName": "Confrence 1",
"Location": {
"Name": " San Antonio",
"TimeZoneName": "(GMT-06.00) Central Time (US & Canada)"
},
"Instructors": [
{
"ID": 45921,
"F001": "John",
"F003": "Doe",
"F015": "[email protected]",
"F004": ""
}
]
}
]

Get A Session

Description:

Get a session of a ILT/event based on the parameters specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/courses/{courseid}/sessions/sessionid

Method:

GET

Response Type:

JSON

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/courses/pyOgaoIi/sessions/4855
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/courses/pyOgaoIi/sessions/4855"

Response:

HTTP/1.1 200 Ok

{
"CourseName": "Security Awareness",
"CourseID": "pyOgaoIi",
"SessionID": 4855,
"StartDateTime": "2011-03-21T15:00:00",
"EndDateTime": "2011-03-21T21:00:00",
"RoomName": "Confrence 1",
"Location": {
"Name": " San Antonio",
"TimeZoneName": "(GMT-06.00) Central Time (US & Canada)"
},
"Instructors": [
{
"ID": 45921,
"F001": "John",
"F003": "Doe",
"F015": "[email protected]",
"F004": ""
}
]
}

Enrollments

Get All The Enrollments Of A Course

Description:

Get all the enrollment records of a course. It supports pagination.

URL:

https://api.inspiredlms.com/organizations/{orgID}/courses/{courseID}/enrollments

Method:

GET

Response Type:

JSON

Parameters:

Query String Parameter Data Type Description Validations
includeInactiveUsers boolean If true, inactive users will also be included in the result set.
Is Required: No. By default API returns active users only.
sort boolean Get the results in specified sorting order. If nothing is passed, it returns result in F003 ascending order.
Is Required: No
Supported field code for sorting are: F001, F003, F004, F015, F019, F020, F021

Query String Parameter	Data Type	Description	Validations
includeInactiveUsers	boolean	If true, inactive users will also be included in the result set.	Is Required: No. By default API returns active users only.
sort	boolean	Get the results in specified sorting order. If nothing is passed, it returns result in F003 ascending order.	Is Required: No Supported field code for sorting are: F001, F003, F004, F015, F019, F020, F021

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/courses/meOexN1A/enrollments?page=1&per_page=2
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/courses/meOexN1A/enrollments"

Response:

HTTP/1.1 200 Ok
X-Total-Count: 20
next: http://api.ilmsdev/organizations/824/courses?page=2&per_page=2
last: http://api.ilmsdev/organizations/824/courses?page=10&per_page=2

[
{
"User": {
"ID": 517371,
"UserStatus": "Inactive",
"Profile_Basic": {
"F001": "John",
"F003": "Doe",
"F004": "emp001",
"F015": "[email protected]",
"F006": "English",
"F019": "Demo Region",
"F019_ID": 8090,
"F020": "Demo Division",
"F020_ID": 3196,
"F021": "Demo Department",
"F021_ID": 4680
}
},
"CourseName": "Course 99",
"CourseID": "meOexN1A",
"SessionName": "",
"SessionID": null,
"RequirementType": "Mandatory",
"DueDate": null,
"StartDate": null,
"CompletionDate": null,
"Score": null,
"CourseStatus": "Not Started",
"EnrollmentDate": "2013-12-08T10:05:59.877",
"TimeSpent": 0
},
{
"User": {
"ID": 517372,
"UserStatus": "Inactive",
"Profile_Basic": {
"F001": "deepak",
"F003": "jain",
"F004": "",
"F015": "[email protected]",
"F006": "English",
"F019": "",
"F019_ID": 8090,
"F020": "B3",
"F020_ID": 3196,
"F021": "B3",
"F021_ID": 4680
}
},
"CourseName": "Course 99",
"CourseID": "meOexN1A",
"SessionName": "",
"SessionID": null,
"RequirementType": "Mandatory",
"DueDate": null,
"StartDate": "2013-12-11T18:18:39.857",
"CompletionDate": "2013-12-11T18:18:39.857",
"Score": null,
"CourseStatus": "Pass",
"EnrollmentDate": "2013-12-08T22:00:38.897",
"TimeSpent": 10
}
]

Enroll User In A Course

Description:

Enroll user in a course based on the parameter specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/courses/{courseID}/enrollments

Method:

POST

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
userID integer Identifier of user.
Is Required: Yes.

Parameter	Data Type	Description	Validations
userID	integer	Identifier of user.	Is Required: Yes.

HTTP Request Example:

POST
https://api.inspiredlms.com/organizations/99999/courses/meOexN1A/enrollments
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"userid":"444038"}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X POST -d "@enrolluser.json" "https://api.inspiredlms.com/organizations/99999/courses/meOexN1A/enrollments"

here, content of @enrolluser.json file is:

{"userid":"444038"}

Response:

HTTP/1.1 204 No Content

Un-enroll User From A Course

Description:

Un-enroll user from a course based on the parameter specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/courses/{courseID}/enrollments

Method:

DELETE

Response Type:

JSON

HTTP Request Example:

DELETE
https://api.inspiredlms.com/organizations/99999/courses/meOexN1A/enrollments
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"userid":"444038"}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X DELETE -d "@unenrolluser.json" "https://api.inspiredlms.com/organizations/99999/courses/meOexN1A/enrollments"

here, content of @unenrolluser.json file is:

{"userid":"444038"}

Response:

HTTP/1.1 204 No Content

Get All The Enrollments Of A Curriculum

Description:

Get all the enrollment records of a curriculum. It supports pagination.

URL:

https://api.inspiredlms.com/organizations/{orgID}/curricula/{courseID}/Enrollments

Method:

GET

Response Type:

JSON

Parameters:

Query String Parameter Data Type Description Validations
includeInactiveUsers boolean If true, inactive users will also be included in the result set.
Is Required: No. By default API returns active users only.
sort boolean Get the results in specified sorting order. If nothing is passed, it returns result in F003 ascending order.
Is Required: No
Supported field code for sorting are: F001, F003, F004, F015, F019, F020, F021

Query String Parameter	Data Type	Description	Validations
includeInactiveUsers	boolean	If true, inactive users will also be included in the result set.	Is Required: No. By default API returns active users only.
sort	boolean	Get the results in specified sorting order. If nothing is passed, it returns result in F003 ascending order.	Is Required: No Supported field code for sorting are: F001, F003, F004, F015, F019, F020, F021

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/curricula/h0lHIuoD/enrollments?page=1&per_page=2
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/curricula/h0lHIuoD/enrollments"

Response:

HTTP/1.1 200 Ok
X-Total-Count: 20
next: http://api.ilmsdev/organizations/824/courses?page=2&per_page=2
last: http://api.ilmsdev/organizations/824/courses?page=10&per_page=2

[
{
"User": {
"ID": 517371,
"UserStatus": "Inactive",
"Profile_Basic": {
"F001": "John",
"F003": "Doe",
"F004": "emp001",
"F015": "[email protected]",
"F006": "English",
"F019": "Demo Region",
"F019_ID": 8090,
"F020": "Demo Division",
"F020_ID": 3196,
"F021": "Demo Department",
"F021_ID": 4680
}
},
"CourseName": "Course 99",
"CourseID": "meOexN1A",
"SessionName": "",
"SessionID": null,
"RequirementType": "Mandatory",
"DueDate": null,
"StartDate": null,
"CompletionDate": null,
"Score": null,
"CourseStatus": "Not Started",
"EnrollmentDate": "2013-12-08T10:05:59.877",
"TimeSpent": 0
},
{
"User": {
"ID": 517372,
"UserStatus": "Inactive",
"Profile_Basic": {
"F001": "deepak",
"F003": "jain",
"F004": "",
"F015": "[email protected]",
"F006": "English",
"F019": "",
"F019_ID": 8090,
"F020": "B3",
"F020_ID": 3196,
"F021": "B3",
"F021_ID": 4680
}
},
"CourseName": "Course 99",
"CourseID": "meOexN1A",
"SessionName": "",
"SessionID": null,
"RequirementType": "Mandatory",
"DueDate": null,
"StartDate": "2013-12-11T18:18:39.857",
"CompletionDate": "2013-12-11T18:18:39.857",
"Score": null,
"CourseStatus": "Pass",
"EnrollmentDate": "2013-12-08T22:00:38.897",
"TimeSpent": 10
}
]

Enroll User In A Curriculum

Description:

Enroll user in a course based on the parameter specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/curricula/{courseID}/enrollments

Method:

POST

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
userID integer Identifier of user.
Is Required: Yes.

Parameter	Data Type	Description	Validations
userID	integer	Identifier of user.	Is Required: Yes.

HTTP Request Example:

POST
https://api.inspiredlms.com/organizations/99999/curricula/h0lHIuoD/enrollments
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"userid":"444038"}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X POST -d "@enrolluser.json" "https://api.inspiredlms.com/organizations/99999/curricula/h0lHIuoD/enrollments"

here, content of @enrolluser.json file is:

{"userid":"444038"}

Response:

HTTP/1.1 204 No Content

Un-enroll User From A Curriculum

Description:

Un-enroll user from a course based on the parameter specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/curricula/{courseID}/enrollments

Method:

DELETE

Response Type:

JSON

HTTP Request Example:

DELETE
https://api.inspiredlms.com/organizations/99999/curricula/h0lHIuoD/enrollments
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"userid":"444038"}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X DELETE -d "@unenrolluser.json" "https://api.inspiredlms.com/organizations/99999/curricula/h0lHIuoD/enrollments"

here, content of @unenrolluser.json file is:

{"userid":"444038"}

Response:

HTTP/1.1 204 No Content

Get All The Enrollments Of A Session

Description:

Get all the enrollment records of a session. It supports pagination.

URL:

https://api.inspiredlms.com/organizations/{orgID}/courses/{courseID}/sessions/{sessionID}/enrollments

Method:

GET

Response Type:

JSON

Parameters:

Query String Parameter Data Type Description Validations
includeInactiveUsers boolean If true, inactive users will also be included in the result set.
Is Required: No. By default API returns active users only.
sort boolean Get the results in specified sorting order. If nothing is passed, it returns result in F003 ascending order.
Is Required: No
Supported field code for sorting are: F001, F003, F004, F015, F019, F020, F021

Query String Parameter	Data Type	Description	Validations
includeInactiveUsers	boolean	If true, inactive users will also be included in the result set.	Is Required: No. By default API returns active users only.
sort	boolean	Get the results in specified sorting order. If nothing is passed, it returns result in F003 ascending order.	Is Required: No Supported field code for sorting are: F001, F003, F004, F015, F019, F020, F021

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/courses/iiOYhg6E/sessions/1234/enrollments?page=1&per_page=2
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/courses/iiOYhg6E/sessions/1234/enrollments?page=1&per_page=2"

Response:

HTTP/1.1 200 Ok
X-Total-Count: 20
next: http://api.ilmsdev/organizations/824/courses?page=2&per_page=2
last: http://api.ilmsdev/organizations/824/courses?page=10&per_page=2

[
{
"User": {
"ID": 517371,
"UserStatus": "Inactive",
"Profile_Basic": {
"F001": "John",
"F003": "Doe",
"F004": "emp001",
"F015": "[email protected]",
"F006": "English",
"F019": "Demo Region",
"F019_ID": 8090,
"F020": "Demo Division",
"F020_ID": 3196,
"F021": "Demo Department",
"F021_ID": 4680
}
},
"CourseName": "ILT Test",
"CourseID": "iiOYhg6E",
"SessionName": "ILT Test :: Sep 8, 2014 7:30 PM (CDT) to Sep 9, 2014 1:30 AM (CDT)",
"SessionID": 1234,
"RequirementType": "Mandatory",
"DueDate": null,
"StartDate": null,
"CompletionDate": null,
"Score": null,
"CourseStatus": "Not Started",
"EnrollmentDate": "2013-12-08T10:05:59.877",
"TimeSpent": 0
},
{
"User": {
"ID": 517372,
"UserStatus": "Inactive",
"Profile_Basic": {
"F001": "deepak",
"F003": "jain",
"F004": "",
"F015": "[email protected]",
"F006": "English",
"F019": "",
"F019_ID": 8090,
"F020": "B3",
"F020_ID": 3196,
"F021": "B3",
"F021_ID": 4680
}
},
"CourseName": "ILT Test",
"CourseID": "iiOYhg6E",
"SessionName": "ILT Test :: Sep 8, 2014 7:30 PM (CDT) to Sep 9, 2014 1:30 AM (CDT)",
"SessionID": 1234,
"RequirementType": "Mandatory",
"DueDate": null,
"StartDate": null,
"CompletionDate": null,
"Score": null,
"CourseStatus": "Not Started",
"EnrollmentDate": "2013-12-08T22:00:38.897",
"TimeSpent": 0
}
]

Enroll User In A Session

Description:

Enroll user in a session based on the parameter specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/courses/{courseID}/sessions/{sessionID}/enrollments

Method:

POST

Response Type:

JSON

Parameters:

Parameter Data Type Description Validations
userID integer Identifier of user.
Is Required: Yes.

Parameter	Data Type	Description	Validations
userID	integer	Identifier of user.	Is Required: Yes.

HTTP Request Example:

POST
https://api.inspiredlms.com/organizations/99999/courses/iiOYhg6E/sessions/1234/enrollments
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"userid":"444038"}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X POST -d "@enrolluser.json" "https://api.inspiredlms.com/organizations/99999/courses/iiOYhg6E/sessions/1234/enrollments"

here, content of @enrolluser.json file is:

{"userid":"444038"}

Response:

HTTP/1.1 204 No Content

Un-enroll User From A Session

Description:

Un-enroll user from a session based on the parameter specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/courses/{courseID}/sessions/{sessionID}/enrollments

Method:

DELETE

Response Type:

JSON

HTTP Request Example:

DELETE
https://api.inspiredlms.com/organizations/99999/courses/iiOYhg6E/sessions/1234/enrollments
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999
{"userid":"444038"}

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" -X DELETE -d "@unenrolluser.json" "https://api.inspiredlms.com/organizations/99999/courses/iiOYhg6E/sessions/1234/enrollments"

here, content of @unenrolluser.json file is:

{"userid":"444038"}

Response:

HTTP/1.1 204 No Content

Reports

Get Summary Report Of a Course, Curriculum or ILT Session

Description:

Get the summary report of a course, curriculum or ILT session based on the parameters specified.

URL:

https://api.inspiredlms.com/organizations/{orgID}/reports/enrollmentsummary?courseid={courseID}
https://api.inspiredlms.com/organizations/{orgID}/reports/enrollmentsummary?courseid={courseID}&sessionid={sessionID}

Method:

GET

Response Type:

JSON

Parameters:

Querystring Parameter Data Type Description Validations
courseid string represents ID of the course or curriculum
Is Required: Yes
sessionid integer represents ID of a ILT/Event session.

Use this parameter to get a report of a ILT/Event session.
Is Required: No
includeinactiveusers boolean true will include inactive users in report.
Is Required: No

Querystring Parameter	Data Type	Description	Validations
courseid	string	represents ID of the course or curriculum	Is Required: Yes
sessionid	integer	represents ID of a ILT/Event session. Use this parameter to get a report of a ILT/Event session.	Is Required: No
includeinactiveusers	boolean	true will include inactive users in report.	Is Required: No

HTTP Request Example:

GET
https://api.inspiredlms.com/organizations/99999/reports/enrollmentsummary?courseid=plokiuytr&includeinactiveusers=true
HTTP 1.1
Content-type: application/json
Accept: application/json
APILoginID: YBA3hyozzqWGeA2koTvI1Q==
TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==
OrgID: 99999

CURL Request Example:

curl -k -i -H "Content-Type: application/json" -H "Accept: application/json" -H "APILoginID: YBA3hyozzqWGeA2koTvI1Q==" -H "TransactionKey: ggcyFzoFKxbUm+3DFd/N9Q==" -H "OrgID: 99999" "https://api.inspiredlms.com/organizations/99999/reports/enrollmentsummary?courseid=plokiuytr&includeinactiveusers=true"

Response:

If courseid represents a course:

HTTP/1.1 200 Ok
[
{
"CourseName": "Security Awareness",
"CourseType": "SCORM",
"CourseID": "plokiuytr",
"ParentCurriculumNameOfCourse": "",
"ParentCurriculumIDOfCourse": "",
"SessionID": 0,
"SessionName": "",
"Enrolled": 22,
"NotStarted": 19,
"InProgress": 0,
"Passed": 3,
"Failed": 0,
"Waived": 0
}
]

If courseid represents a curriculum. For a curriculum, output also includes all the sub-courses of that curriculum.

[
{
"CourseName": "Security",
"CourseType": "Curriculum",
"CourseID": "4mnvYSIi",
"ParentCurriculumNameOfCourse": "",
"ParentCurriculumIDOfCourse": "",
"SessionID": 0,
"SessionName": "",
"Enrolled": 5,
"NotStarted": 1,
"InProgress": 1,
"Passed": 1,
"Failed": 1,
"Waived": 1
},
{
"CourseName": "Security Awareness",
"CourseType": "iComposer",
"CourseID": "7E29dkwr",
"ParentCurriculumNameOfCourse": "Security",
"ParentCurriculumIDOfCourse": "4mnvYSIi",
"SessionID": 0,
"SessionName": "",
"Enrolled": 5,
"NotStarted": 1,
"InProgress": 1,
"Passed": 1,
"Failed": 1,
"Waived": 1
},
{
"CourseName": "Data Security",
"CourseType": "SCORM",
"CourseID": "Ux3oKZbz",
"ParentCurriculumNameOfCourse": "Security",
"ParentCurriculumIDOfCourse": "4mnvYSIi",
"SessionID": 0,
"SessionName": "",
"Enrolled": 5,
"NotStarted": 2,
"InProgress": 1,
"Passed": 1,
"Failed": 1,
"Waived": 0
}
]

If courseid represents a ILT/Event. For a IEL/EVENT, output also includes all the sessions of that ILT/Event.

[
{
"CourseName": "Security",
"CourseType": "ILT",
"CourseID": "pyOgaoIi",
"ParentCurriculumNameOfCourse": "",
"ParentCurriculumIDOfCourse": "",
"SessionID": 0,
"SessionName": "",
"Enrolled": 22,
"NotStarted": 12,
"InProgress": 0,
"Passed": 10,
"Failed": 0,
"Waived": 0
},
{
"CourseName": "Security",
"CourseType": "Session",
"CourseID": "pyOgaoIi",
"ParentCurriculumNameOfCourse": "",
"ParentCurriculumIDOfCourse": "",
"SessionID": 4746,
"SessionName": "Oct 14, 2010 3:00 AM to Oct 14, 2010 9:00 AM",
"Enrolled": 12,
"NotStarted": 12,
"InProgress": 0,
"Passed": 0,
"Failed": 0,
"Waived": 0
},
{
"CourseName": "Security",
"CourseType": "Session",
"CourseID": "pyOgaoIi",
"ParentCurriculumNameOfCourse": "",
"ParentCurriculumIDOfCourse": "",
"SessionID": 4760,
"SessionName": "Oct 20, 2010 10:00 AM to Oct 21, 2010 4:00 PM",
"Enrolled": 10,
"NotStarted": 0,
"InProgress": 0,
"Passed": 10,
"Failed": 0,
"Waived": 0
}
]

If sessionid is also passed along with courseid to get detail of a specific session.

[
{
"CourseName": "Security",
"CourseType": "Session",
"CourseID": "pyOgaoIi",
"ParentCurriculumNameOfCourse": "",
"ParentCurriculumIDOfCourse": "",
"SessionID": 4760,
"SessionName": "Oct 20, 2010 10:00 AM to Oct 21, 2010 4:00 PM",
"Enrolled": 10,
"NotStarted": 0,
"InProgress": 0,
"Passed": 10,
"Failed": 0,
"Waived": 0
}
]

Status Codes

Common status codes used in iLMS API

200s - Success
400s - Error Client Side
500s - Error on Server Side

2xx - Success

Status Code Description
200 Ok The request is successful. The actual response will depend on the resource and request method. In a GET request, the response will contain the data respective to the requested resource.
201 Created This status confirms that a new resource is created. Response will have the unique ID of newly created resource. It is very common status code for "Post" request method.
204 No Content This status code confirms that server successfully processed the request, but is not returning any content. It is a very common status code for "PUT" and "DELETE" request method.

Status Code	Description
200 Ok	The request is successful. The actual response will depend on the resource and request method. In a GET request, the response will contain the data respective to the requested resource.
201 Created	This status confirms that a new resource is created. Response will have the unique ID of newly created resource. It is very common status code for "Post" request method.
204 No Content	This status code confirms that server successfully processed the request, but is not returning any content. It is a very common status code for "PUT" and "DELETE" request method.

4xx - Error Client Slide

Status Code Description
400 Bad Request There can be several reasons for getting this error. Generally it happens when request doesn't have all the parameters which is required to fulfill a request. Or it has invalid data. You should see the exact reason in the response.
401 Unauthorized Each request must have correct credentials information. Credential information is set of orgID, APILoginID, TransactionKey which is available in your iLMS account (Settings > API).
403 Forbidden This status code appears when a request is made to a resource which is not available for the organization. In other words, that feature is not available to the organization.
404 Not Found Invalid URI. The resource you're looking for is not available or doesn't exist.
415 Unsupported Media Type iLMS API only supports "Application/JSON" media type. For any other media type, the unsupported media type error will be returned.

Status Code	Description
400 Bad Request	There can be several reasons for getting this error. Generally it happens when request doesn't have all the parameters which is required to fulfill a request. Or it has invalid data. You should see the exact reason in the response.
401 Unauthorized	Each request must have correct credentials information. Credential information is set of orgID, APILoginID, TransactionKey which is available in your iLMS account (Settings > API).
403 Forbidden	This status code appears when a request is made to a resource which is not available for the organization. In other words, that feature is not available to the organization.
404 Not Found	Invalid URI. The resource you're looking for is not available or doesn't exist.
415 Unsupported Media Type	iLMS API only supports "Application/JSON" media type. For any other media type, the unsupported media type error will be returned.

5xx - Error on Server Side

Status Code Description
500 Internal Server Error It appears when an unhandled error occurred. We're automatically informed about such type of errors and we fix such errors as early as possible.
503 Service Unavailable System might be temporary down due to up-gradation. Or your request can't be accepted at that point of time.

Status Code	Description
500 Internal Server Error	It appears when an unhandled error occurred. We're automatically informed about such type of errors and we fix such errors as early as possible.
503 Service Unavailable	System might be temporary down due to up-gradation. Or your request can't be accepted at that point of time.

Region, Time, and Language Codes

Time Zone

Here is the list of all the available time zones

Full Name Short Name Offset
(GMT-05.00) Eastern Time (US & Canada) EST
-5.00
(GMT-06.00) Central Time (US & Canada) CST
-6.00
(GMT-07.00) Mountain Time (US & Canada) MST
-7.00
(GMT-08.00) Pacific Time (US & Canada) PST
-8.00
(GMT-12.00) International Date Line West IDLW
-12.00
(GMT-11.00) Midway Island, Samoa SST
-11.00
(GMT-10.00) Hawaii HST
-10.00
(GMT-09.00) Alaska AKST
-9.00
(GMT-08.00) Tijuana, Baja California) PST
-8.00
(GMT-07.00) Chihuahua, La Paz, Mazatlan - Old MST
-7.00
(GMT-07.00) Chihuahua, La Paz, Mazatlan - New MST
-7.00
(GMT-07.00) Arizona MST
-7.00
(GMT-06.00) Saskatchewan CST
-6.00
(GMT-06.00) Guadalajara, Mexico City, Monterrey - Old CST
-6.00
(GMT-06.00) Guadalajara, Mexico City, Monterrey - New CST
-6.00
(GMT-06.00) Central America CST
-6.00
(GMT-05.00) Indiana (East) EST
-5.00
(GMT-05.00) Bogota, Lima, Quito, Rio Branco COT
-5.00
(GMT-04.30) Caracas VET
-4.30
(GMT-04.00) Santiago CLT
-4.00
(GMT-04.00) Manaus AMT
-4.00
(GMT-04.00) La Paz BOT
-4.00
(GMT-04.00) Atlantic Time (Canada) AST
-4.00
(GMT-03.30) Newfoundland NST
-3.30
(GMT-03.00) Montevideo UYT
-3.00
(GMT-03.00) Greenland WGT
-3.00
(GMT-03.00) Georgetown ART
-3.00
(GMT-03.00) Buenos Aires ART
-3.00
(GMT-03.00) Brasilia BRT
-3.00
(GMT-02.00) Mid-Atlantic GMT-02.00
-2.00
(GMT-01.00) Cape Verde Is. CVT
-1.00
(GMT-01.00) Azores AZOT
-1.00
(GMT00.00) Casablanca GMT
0.00
(GMT00.00) Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London GMT
0.00
(GMT00.00) Monrovia, Reykjavik GMT
0.00
(GMT+01.00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna WET
1.00
(GMT+01.00) Belgrade, Bratislava, Budapest, Ljubljana, Prague CET
1.00
(GMT+01.00) Brussels, Copenhagen, Madrid, Paris CET
1.00
(GMT+01.00) Sarajevo, Skopje, Warsaw, Zagreb CET
1.00
(GMT+01.00) West Central Africa WAT
1.00
(GMT+02.00) Amman EET
2.00
(GMT+02.00) Athens, Bucharest, Istanbul EET
2.00
(GMT+02.00) Beirut EET
2.00
(GMT+02.00) Cairo EET
2.00
(GMT+02.00) Harare, Pretoria SAST
2.00
(GMT+02.00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius EET
2.00
(GMT+02.00) Jerusalem IST
2.00
(GMT+02.00) Minsk EET
2.00
(GMT+02.00) Windhoek WAT
2.00
(GMT+03.00) Baghdad AST
3.00
(GMT+03.00) Kuwait, Riyadh AST
3.00
(GMT+03.00) Moscow, St. Petersburg, Volgograd MSK
3.00
(GMT+03.00) Nairobi EAT
3.00
(GMT+03.00) Tbilisi GET
3.00
(GMT+03.00) Tehran IRST
3.00
(GMT+04.00) Abu Dhabi, Muscat GST
4.00
(GMT+04.00) Baku AZT
4.00
(GMT+04.00) Caucasus Standard Time GMT+04.00
4.00
(GMT+04.00) Port Louis MUT
4.00
(GMT+04.00) Yerevan AMT
4.00
(GMT+04.00) Kabul AFT
4.00
(GMT+05.00) Ekaterinburg SVX
5.00
(GMT+05.00) Islamabad, Karachi PKT
5.00
(GMT+05.00) Tashkent UZT
5.00
(GMT+05.30) Chennai, Kolkata, Mumbai, New Delhi IST
5.30
(GMT+05.30) Sri Jayawardenepura IST
5.30
(GMT+05.45) Kathmandu NPT
5.45
(GMT+06.00) Almaty, Novosibirsk NOVT
6.00
(GMT+06.00) Astana, Dhaka BST
6.00
(GMT+06.30) Yangon (Rangoon) MMT
6.30
(GMT+07.00) Bangkok, Hanoi, Jakarta WIB
7.00
(GMT+07.00) Krasnoyarsk KRAT
7.00
(GMT+08.00) Beijing, Chongqing, Hong Kong, Urumqi CST
8.00
(GMT+08.00) Irkutsk, Ulaan Bataar IRKT
8.00
(GMT+08.00) Kuala Lumpur, Singapore SGT
8.00
(GMT+08.00) Perth WST
8.00
(GMT+08.00) Taipei CST
8.00
(GMT+09.00) Osaka, Sapporo, Tokyo JST
9.00
(GMT+09.00) Seoul KST
9.00
(GMT+09.00) Yakutsk YAKT
9.00
(GMT+09.30) Adelaide CST
9.30
(GMT+09.30) Darwin CST
9.30
(GMT+10.00) Brisbane EST
10.00
(GMT+10.00) Canberra, Melbourne, Sydney EST
10.00
(GMT+10.00) Guam, Port Moresby PGT
10.00
(GMT+10.00) Hobart EST
10.00
(GMT+10.00) Vladivostok VLAT
10.00
(GMT+11.00) Magadan, Solomon Is., New Caledonia MAGT
11.00
(GMT+12.00) Auckland, Wellington NZST
12.00
(GMT+12.00) Fiji, Kamchatka, Marshall Is. FJT
12.00
(GMT+13.00) Nuku alofa TOT
13.00

Full Name	Short Name	Offset
(GMT-05.00) Eastern Time (US & Canada)	EST	-5.00
(GMT-06.00) Central Time (US & Canada)	CST	-6.00
(GMT-07.00) Mountain Time (US & Canada)	MST	-7.00
(GMT-08.00) Pacific Time (US & Canada)	PST	-8.00
(GMT-12.00) International Date Line West	IDLW	-12.00
(GMT-11.00) Midway Island, Samoa	SST	-11.00
(GMT-10.00) Hawaii	HST	-10.00
(GMT-09.00) Alaska	AKST	-9.00
(GMT-08.00) Tijuana, Baja California)	PST	-8.00
(GMT-07.00) Chihuahua, La Paz, Mazatlan - Old	MST	-7.00
(GMT-07.00) Chihuahua, La Paz, Mazatlan - New	MST	-7.00
(GMT-07.00) Arizona	MST	-7.00
(GMT-06.00) Saskatchewan	CST	-6.00
(GMT-06.00) Guadalajara, Mexico City, Monterrey - Old	CST	-6.00
(GMT-06.00) Guadalajara, Mexico City, Monterrey - New	CST	-6.00
(GMT-06.00) Central America	CST	-6.00
(GMT-05.00) Indiana (East)	EST	-5.00
(GMT-05.00) Bogota, Lima, Quito, Rio Branco	COT	-5.00
(GMT-04.30) Caracas	VET	-4.30
(GMT-04.00) Santiago	CLT	-4.00
(GMT-04.00) Manaus	AMT	-4.00
(GMT-04.00) La Paz	BOT	-4.00
(GMT-04.00) Atlantic Time (Canada)	AST	-4.00
(GMT-03.30) Newfoundland	NST	-3.30
(GMT-03.00) Montevideo	UYT	-3.00
(GMT-03.00) Greenland	WGT	-3.00
(GMT-03.00) Georgetown	ART	-3.00
(GMT-03.00) Buenos Aires	ART	-3.00
(GMT-03.00) Brasilia	BRT	-3.00
(GMT-02.00) Mid-Atlantic	GMT-02.00	-2.00
(GMT-01.00) Cape Verde Is.	CVT	-1.00
(GMT-01.00) Azores	AZOT	-1.00
(GMT00.00) Casablanca	GMT	0.00
(GMT00.00) Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London	GMT	0.00
(GMT00.00) Monrovia, Reykjavik	GMT	0.00
(GMT+01.00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna	WET	1.00
(GMT+01.00) Belgrade, Bratislava, Budapest, Ljubljana, Prague	CET	1.00
(GMT+01.00) Brussels, Copenhagen, Madrid, Paris	CET	1.00
(GMT+01.00) Sarajevo, Skopje, Warsaw, Zagreb	CET	1.00
(GMT+01.00) West Central Africa	WAT	1.00
(GMT+02.00) Amman	EET	2.00
(GMT+02.00) Athens, Bucharest, Istanbul	EET	2.00
(GMT+02.00) Beirut	EET	2.00
(GMT+02.00) Cairo	EET	2.00
(GMT+02.00) Harare, Pretoria	SAST	2.00
(GMT+02.00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius	EET	2.00
(GMT+02.00) Jerusalem	IST	2.00
(GMT+02.00) Minsk	EET	2.00
(GMT+02.00) Windhoek	WAT	2.00
(GMT+03.00) Baghdad	AST	3.00
(GMT+03.00) Kuwait, Riyadh	AST	3.00
(GMT+03.00) Moscow, St. Petersburg, Volgograd	MSK	3.00
(GMT+03.00) Nairobi	EAT	3.00
(GMT+03.00) Tbilisi	GET	3.00
(GMT+03.00) Tehran	IRST	3.00
(GMT+04.00) Abu Dhabi, Muscat	GST	4.00
(GMT+04.00) Baku	AZT	4.00
(GMT+04.00) Caucasus Standard Time	GMT+04.00	4.00
(GMT+04.00) Port Louis	MUT	4.00
(GMT+04.00) Yerevan	AMT	4.00
(GMT+04.00) Kabul	AFT	4.00
(GMT+05.00) Ekaterinburg	SVX	5.00
(GMT+05.00) Islamabad, Karachi	PKT	5.00
(GMT+05.00) Tashkent	UZT	5.00
(GMT+05.30) Chennai, Kolkata, Mumbai, New Delhi	IST	5.30
(GMT+05.30) Sri Jayawardenepura	IST	5.30
(GMT+05.45) Kathmandu	NPT	5.45
(GMT+06.00) Almaty, Novosibirsk	NOVT	6.00
(GMT+06.00) Astana, Dhaka	BST	6.00
(GMT+06.30) Yangon (Rangoon)	MMT	6.30
(GMT+07.00) Bangkok, Hanoi, Jakarta	WIB	7.00
(GMT+07.00) Krasnoyarsk	KRAT	7.00
(GMT+08.00) Beijing, Chongqing, Hong Kong, Urumqi	CST	8.00
(GMT+08.00) Irkutsk, Ulaan Bataar	IRKT	8.00
(GMT+08.00) Kuala Lumpur, Singapore	SGT	8.00
(GMT+08.00) Perth	WST	8.00
(GMT+08.00) Taipei	CST	8.00
(GMT+09.00) Osaka, Sapporo, Tokyo	JST	9.00
(GMT+09.00) Seoul	KST	9.00
(GMT+09.00) Yakutsk	YAKT	9.00
(GMT+09.30) Adelaide	CST	9.30
(GMT+09.30) Darwin	CST	9.30
(GMT+10.00) Brisbane	EST	10.00
(GMT+10.00) Canberra, Melbourne, Sydney	EST	10.00
(GMT+10.00) Guam, Port Moresby	PGT	10.00
(GMT+10.00) Hobart	EST	10.00
(GMT+10.00) Vladivostok	VLAT	10.00
(GMT+11.00) Magadan, Solomon Is., New Caledonia	MAGT	11.00
(GMT+12.00) Auckland, Wellington	NZST	12.00
(GMT+12.00) Fiji, Kamchatka, Marshall Is.	FJT	12.00
(GMT+13.00) Nuku alofa	TOT	13.00

Country

Here is the list of all the countries

Name Code
Afghanistan
AF
Albania
AL
Algeria DZ
American Samoa AS
Andorra AD
Angola AO
Anguilla AI
Antarctica AQ
Antigua and Barbuda AG
Argentina AR
Armenia AM
Aruba AW
Australia AU
Austria AT
Azerbaijan AZ
Bahamas BS
Bahrain BH
Bangladesh BD
Barbados BB
Belarus BY
Belgium BE
Belize BZ
Benin BJ
Bermuda BM
Bhutan BT
Bolivia BO
Bosnia and Herzegovina BA
Botswana BW
Brazil BR
British Indian Ocean Territory IO
British Virgin Islands VG
Brunei BN
Bulgaria BG
Burkina Faso BF
Burma (Myanmar) MM
Burundi BI
Cambodia KH
Cameroon CM
Canada CA
Cape Verde CV
Cayman Islands KY
Central African Republic CF
Chad TD
Chile CL
China CN
Christmas Island CX
Cocos (Keeling) Islands CC
Colombia CO
Comoros KM
Cook Islands CK
Costa Rica CR
Croatia HR
Cuba CU
Cyprus CY
Czech Republic CZ
Democratic Republic of the Congo CD
Denmark DK
Djibouti DJ
Dominica DM
Dominican Republic DO
Ecuador EC
Egypt EG
El Salvador SV
Equatorial Guinea GQ
Eritrea ER
Estonia EE
Ethiopia EI
Falkland Islands FK
Faroe Islands FO
Fiji FJ
Finland FI
France FR
French Polynesia PF
Gabon GA
Gambia GM
Georgia GE
Germany DE
Ghana GH
Gibraltar GI
Greece GR
Greenland GL
Grenada GD
Guam GU
Guatemala GT
Guinea GN
Guinea-Bissau GW
Guyana GY
Haiti HT
Holy See (Vatican City) VA
Honduras HN
Hong Kong HK
Hungary HU
Iceland IS
India IN
Indonesia ID
Iran IR
Iraq IQ
Ireland IE
Isle of Man IM
Israel IL
Italy IT
Ivory Coast CI
Jamaica JM
Japan JP
Jersey JE
Jordan JO
Kazakhstan KZ
Kenya KE
Kiribati KI
Kuwait KW
Kyrgyzstan KG
Laos LA
Latvia LV
Lebanon LB
Lesotho LS
Liberia LR
Libya LY
Liechtenstein LI
Lithuania LT
Luxembourg LU
Macau MO
Macedonia MK
Madagascar MG
Malawi MW
Malaysia MY
Maldives MV
Mali ML
Malta MT
Marshall Islands MH
Mauritania MR
Mauritius MU
Mayotte YT
Mexico MX
Micronesia FM
Moldova MD
Monaco MC
Mongolia MN
Montenegro ME
Montserrat MS
Morocco MA
Mozambique MZ
Namibia NA
Nauru NR
Nepal NP
Netherlands NL
Netherlands Antilles AN
New Caledonia NC
New Zealand NZ
Nicaragua NI
Niger NE
Nigeria NG
Niue NU
Norfolk Island NFK
North Korea KP
Northern Mariana Islands MP
Norway NO
Oman OM
Pakistan PK
Palau PW
Panama PA
Papua New Guinea PG
Paraguay PY
Peru PE
Philippines PH
Pitcairn Islands PN
Poland PL
Portugal PT
Puerto Rico PR
Qatar QA
Republic of the Congo CG
Romania RO
Russia RU
Rwanda RW
Saint Barthelemy BL
Saint Helena SH
Saint Kitts and Nevis KN
Saint Lucia LC
Saint Martin MF
Saint Pierre and Miquelon PM
Saint Vincent and the Grenadines VC
Samoa WS
San Marino SM
Sao Tome and Principe ST
Saudi Arabia SA
Senegal SN
Serbia RS
Seychelles SC
Sierra Leone SL
Singapore SG
Slovakia SK
Slovenia SI
Solomon Islands SB
Somalia SO
South Africa ZA
South Korea KR
Spain ES
Sri Lanka LK
Sudan SD
Suriname SR
Svalbard SJ
Swaziland SZ
Sweden SE
Switzerland CH
Syria SY
Taiwan TW
Tajikistan TJ
Tanzania TZ
Thailand TH
Timor-Leste TL
Togo TG
Tokelau TK
Tonga TO
Trinidad and Tobago TT
Tunisia TN
Turkey TR
Turkmenistan TM
Turks and Caicos Islands TC
Tuvalu TV
Uganda UG
Ukraine UA
United Arab Emirates AE
United Kingdom GB
United States US
Uruguay UY
US Virgin Islands VI
Uzbekistan UZ
Vanuatu VU
Venezuela VE
Vietnam VN
Wallis and Futuna WF
Western Sahara EH
Yemen YE
Zambia ZM
Zimbabwe ZW

Name	Code
Afghanistan	AF
Albania	AL
Algeria	DZ
American Samoa	AS
Andorra	AD
Angola	AO
Anguilla	AI
Antarctica	AQ
Antigua and Barbuda	AG
Argentina	AR
Armenia	AM
Aruba	AW
Australia	AU
Austria	AT
Azerbaijan	AZ
Bahamas	BS
Bahrain	BH
Bangladesh	BD
Barbados	BB
Belarus	BY
Belgium	BE
Belize	BZ
Benin	BJ
Bermuda	BM
Bhutan	BT
Bolivia	BO
Bosnia and Herzegovina	BA
Botswana	BW
Brazil	BR
British Indian Ocean Territory	IO
British Virgin Islands	VG
Brunei	BN
Bulgaria	BG
Burkina Faso	BF
Burma (Myanmar)	MM
Burundi	BI
Cambodia	KH
Cameroon	CM
Canada	CA
Cape Verde	CV
Cayman Islands	KY
Central African Republic	CF
Chad	TD
Chile	CL
China	CN
Christmas Island	CX
Cocos (Keeling) Islands	CC
Colombia	CO
Comoros	KM
Cook Islands	CK
Costa Rica	CR
Croatia	HR
Cuba	CU
Cyprus	CY
Czech Republic	CZ
Democratic Republic of the Congo	CD
Denmark	DK
Djibouti	DJ
Dominica	DM
Dominican Republic	DO
Ecuador	EC
Egypt	EG
El Salvador	SV
Equatorial Guinea	GQ
Eritrea	ER
Estonia	EE
Ethiopia	EI
Falkland Islands	FK
Faroe Islands	FO
Fiji	FJ
Finland	FI
France	FR
French Polynesia	PF
Gabon	GA
Gambia	GM
Georgia	GE
Germany	DE
Ghana	GH
Gibraltar	GI
Greece	GR
Greenland	GL
Grenada	GD
Guam	GU
Guatemala	GT
Guinea	GN
Guinea-Bissau	GW
Guyana	GY
Haiti	HT
Holy See (Vatican City)	VA
Honduras	HN
Hong Kong	HK
Hungary	HU
Iceland	IS
India	IN
Indonesia	ID
Iran	IR
Iraq	IQ
Ireland	IE
Isle of Man	IM
Israel	IL
Italy	IT
Ivory Coast	CI
Jamaica	JM
Japan	JP
Jersey	JE
Jordan	JO
Kazakhstan	KZ
Kenya	KE
Kiribati	KI
Kuwait	KW
Kyrgyzstan	KG
Laos	LA
Latvia	LV
Lebanon	LB
Lesotho	LS
Liberia	LR
Libya	LY
Liechtenstein	LI
Lithuania	LT
Luxembourg	LU
Macau	MO
Macedonia	MK
Madagascar	MG
Malawi	MW
Malaysia	MY
Maldives	MV
Mali	ML
Malta	MT
Marshall Islands	MH
Mauritania	MR
Mauritius	MU
Mayotte	YT
Mexico	MX
Micronesia	FM
Moldova	MD
Monaco	MC
Mongolia	MN
Montenegro	ME
Montserrat	MS
Morocco	MA
Mozambique	MZ
Namibia	NA
Nauru	NR
Nepal	NP
Netherlands	NL
Netherlands Antilles	AN
New Caledonia	NC
New Zealand	NZ
Nicaragua	NI
Niger	NE
Nigeria	NG
Niue	NU
Norfolk Island	NFK
North Korea	KP
Northern Mariana Islands	MP
Norway	NO
Oman	OM
Pakistan	PK
Palau	PW
Panama	PA
Papua New Guinea	PG
Paraguay	PY
Peru	PE
Philippines	PH
Pitcairn Islands	PN
Poland	PL
Portugal	PT
Puerto Rico	PR
Qatar	QA
Republic of the Congo	CG
Romania	RO
Russia	RU
Rwanda	RW
Saint Barthelemy	BL
Saint Helena	SH
Saint Kitts and Nevis	KN
Saint Lucia	LC
Saint Martin	MF
Saint Pierre and Miquelon	PM
Saint Vincent and the Grenadines	VC
Samoa	WS
San Marino	SM
Sao Tome and Principe	ST
Saudi Arabia	SA
Senegal	SN
Serbia	RS
Seychelles	SC
Sierra Leone	SL
Singapore	SG
Slovakia	SK
Slovenia	SI
Solomon Islands	SB
Somalia	SO
South Africa	ZA
South Korea	KR
Spain	ES
Sri Lanka	LK
Sudan	SD
Suriname	SR
Svalbard	SJ
Swaziland	SZ
Sweden	SE
Switzerland	CH
Syria	SY
Taiwan	TW
Tajikistan	TJ
Tanzania	TZ
Thailand	TH
Timor-Leste	TL
Togo	TG
Tokelau	TK
Tonga	TO
Trinidad and Tobago	TT
Tunisia	TN
Turkey	TR
Turkmenistan	TM
Turks and Caicos Islands	TC
Tuvalu	TV
Uganda	UG
Ukraine	UA
United Arab Emirates	AE
United Kingdom	GB
United States	US
Uruguay	UY
US Virgin Islands	VI
Uzbekistan	UZ
Vanuatu	VU
Venezuela	VE
Vietnam	VN
Wallis and Futuna	WF
Western Sahara	EH
Yemen	YE
Zambia	ZM
Zimbabwe	ZW

US - States

Here is the list of all the sates for USA

Name Code
Alabama
AL
Alaska
AK
American Samoa AS
Arizona AZ
Arkansas AR
California CA
Colorado CO
Connecticut CT
Delaware DE
District Of Columbia DC
Federated States Of Micronesia FM
Florida FL
Georgia GA
Guam GU
Hawaii HI
Idaho ID
Illinois IL
Indiana IN
Iowa IA
Kansas KS
Kentucky KY
Louisiana LA
Maine ME
Marshall Islands MH
Maryland MD
Massachusetts MA
Michigan MI
Minnesota MN
Mississippi MS
Missouri MO
Montana MT
Nebraska NE
Nevada NV
New Hampshire NH
New Jersey NJ
New Mexico NM
New York NY
North Carolina NC
North Dakota ND
Northern Mariana Islands MP
Ohio OH
Oklahoma OK
Oregon OR
Palau PW
Pennsylvania PA
Puerto Rico PR
Rhode Island RI
South Carolina SC
South Dakota SD
Tennessee TN
Texas TX
Utah UT
Vermont VT
Virgin Islands VI
Virginia VA
Washington WA
West Virginia WV
Wisconsin WI
Wyoming WY

Name	Code
Alabama	AL
Alaska	AK
American Samoa	AS
Arizona	AZ
Arkansas	AR
California	CA
Colorado	CO
Connecticut	CT
Delaware	DE
District Of Columbia	DC
Federated States Of Micronesia	FM
Florida	FL
Georgia	GA
Guam	GU
Hawaii	HI
Idaho	ID
Illinois	IL
Indiana	IN
Iowa	IA
Kansas	KS
Kentucky	KY
Louisiana	LA
Maine	ME
Marshall Islands	MH
Maryland	MD
Massachusetts	MA
Michigan	MI
Minnesota	MN
Mississippi	MS
Missouri	MO
Montana	MT
Nebraska	NE
Nevada	NV
New Hampshire	NH
New Jersey	NJ
New Mexico	NM
New York	NY
North Carolina	NC
North Dakota	ND
Northern Mariana Islands	MP
Ohio	OH
Oklahoma	OK
Oregon	OR
Palau	PW
Pennsylvania	PA
Puerto Rico	PR
Rhode Island	RI
South Carolina	SC
South Dakota	SD
Tennessee	TN
Texas	TX
Utah	UT
Vermont	VT
Virgin Islands	VI
Virginia	VA
Washington	WA
West Virginia	WV
Wisconsin	WI
Wyoming	WY

Canada - States (Provinces)

Here is the list of all the province codes for Canada. These codes will work in the "State" Field of the user profile.

Name Code
Alberta
AB
British Columbia
BC
Manitoba
MB
New Brunswick
NB
New Foundland
NF
Northwest Territories
NT
Nova Scotia
NS
Nunavut
NU
Ontario
ON
Prince Edward Island
PE
Quebec
PQ
Saskatchewan
SK
Yukon YT

Name	Code
Alberta	AB
British Columbia	BC
Manitoba	MB
New Brunswick	NB
New Foundland	NF
Northwest Territories	NT
Nova Scotia	NS
Nunavut	NU
Ontario	ON
Prince Edward Island	PE
Quebec	PQ
Saskatchewan	SK
Yukon	YT

Languages

Here is the list of all the languages available in iLMS. To know what languages are available for your organization, please go to "Settings > Languages" option in your organization account in iLMS.

Name Code Character Set
Brazilian Portuguese PT
iso-8859-1
Chinese ZH EUC-CN
Czech CS iso-8859-2
Dutch LN iso-8859-1
English en utf-8
English (UK) en utf-8
French fr iso-8859-1
French Canadian fr-CA iso-8859-1
German ge iso-8859-1
Greek gr iso-8859-7
Italian IT iso-8859-1
Japanese JA x-euc
Korean KO euc-kr
Latin American Spanish es-US iso-8859-1
Malay MS iso-8859-1
Portuguese PT iso-8859-1
Russian RU iso-8859-5
Slovakian SK iso-8859-2
Spanish sp iso-8859-1
Thai TH windows-874
Traditional Chinese TH-TW Big5
Turkish TR iso-8859-9

Name	Code	Character Set
Brazilian Portuguese	PT	iso-8859-1
Chinese	ZH	EUC-CN
Czech	CS	iso-8859-2
Dutch	LN	iso-8859-1
English	en	utf-8
English (UK)	en	utf-8
French	fr	iso-8859-1
French Canadian	fr-CA	iso-8859-1
German	ge	iso-8859-1
Greek	gr	iso-8859-7
Italian	IT	iso-8859-1
Japanese	JA	x-euc
Korean	KO	euc-kr
Latin American Spanish	es-US	iso-8859-1
Malay	MS	iso-8859-1
Portuguese	PT	iso-8859-1
Russian	RU	iso-8859-5
Slovakian	SK	iso-8859-2
Spanish	sp	iso-8859-1
Thai	TH	windows-874
Traditional Chinese	TH-TW	Big5
Turkish	TR	iso-8859-9

Pagination

Pagination is supported in few APIs which may return multiple items. By default pagination is set for 100 items. You can use following parameters to take advantage of pagination:
per_page: how many items you want in the page? It is basically the size of the page. If you skip this parameter, 100 items will be returned by default.
page: specify which page number's result you're looking for. If you skip this parameter, results will always start from page 1.
You should always check headers especially Link Headers, for the information to retrieve additional pages/items.
X-TOTAL-COUNT: It tells how many items are available for the given resource.
Link Header: It returns a set of ready-made links for navigation.Based on the current page location, you may see these following link headers-
first: Shows the URL of the first page of the results. It doesn't come when current page is the first page itself.
prev: Shows the URL of immediate previous page of the results. It doesn't come when current page is the first page itself.
next: Shows the URL of immediate next page of the results. It doesn't come when current page is the last page itself.
last: Shows the URL of the last page of the results. It doesn't come when current page is the last page itself.

Example: If your organization have 2000 users, and you are at page 5 with page size as 50, you will see header like this-

X-TOTAL-COUNT: 2000
first: https://api.inspiredlms.com/organizations/99999/users?per_page=50&page=1
prev: https://api.inspiredlms.com/organizations/99999/users?per_page=50&page=4
next: https://api.inspiredlms.com/organizations/99999/users?per_page=50&page=6
last: https://api.inspiredlms.com/organizations/99999/users?per_page=50&page=40

Sorting

You can use "sort" in query string to specify sorting order.
For example-
To sort results on name in ascending order, you can use it like: sort=name
If you want results in descending order, then use dash. i.e. sort=-name