Course Attendee Group API (Get)
Course Attendee Groups API
Get Course attendee-groups: Provides the list of attendee-groups associated with course via Litmos Commerce API.
Note: All requests must be Authenticated.
Authentication and Authorization
Information used for API authentication and authorization is submitted in the request header. The following header name/values are required with each request.
Header | Description |
CompanyLoginId | Company Login Id (provisioned by ViewCentral account management) |
ProductId | Product Id. 1=Learning Management, 2=Event Management |
Username | User account username |
Password | User account password |
Request URI :
1. For the list of all attendee group Where {Id} is course id.
GET https://api.viewcentral.com/api/courses/{ID}/attendee-groups
Response Codes:
HTTP Status | Description |
200 | Operation successful. Course Attendee Group object returned in response |
400 | Operation not successful. Response contains error information |
404 | Operation not successful. Course Attendee Group object not found |
Response Example:
{ "Success": true, "Error": null, "Data": [ { "Id": "Int [max length 4]", "Name": "String [max length 255]", "CustomDetail1": "String [max length 2048]", "CustomDetail2": "String [max length 2048]", "CustomDetail3": "String [max length 2048]", "Active": "Bool", "Key": "String [max length 255]", "Modified": { "CreatedBy": "string [max length 50]", "CreatedDate": "datetime [yyyy-mm-ddThh:mm:ssZ]", "UpdatedBy": "string [max length 50]", "UpdatedDate": "datetime [yyyy-mm-ddThh:mm:ssZ]" } } ] }
Request URI :
2. For the list of all attendee group using filtersWhere {Id} is course id
GET https://api.viewcentral.com/api/courses/{id}/attendee-groups?name=
Request Filters : Name = Course name.
Sl.No | Key | Value |
1 | name | String [max length 255] |
Response Codes:
HTTP Status | Description |
200 | Operation successful. Course Attendee Group object returned in response |
400 | Operation not successful. Response contains error information |
404 | Operation not successful. Course Attendee Group object not found |