Organization Attendee group API (Get, Assign, update & Remove)
Get organization- attendee group:
Provides the details of organization- attendee group 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. Get list of details of organization attendee group assigned –
GET https://api.viewcentral.com/api/organizations/{orgid}/attendee-groups
Response Codes:
| HTTP Status | Description |
| 200 | Operation successful. Organization Attendee group object returned in response |
| 400 | Operation not successful. Response contains error information |
| 404 | Operation not successful. Organization Attendee group object not found |
Response Example:
{
"Success": true,
"Error": null,
"Data": [
{
"OrgAttendeeGroupID": "Int [max length 4]",
"GroupName": "string [max length 200]",
"Active": "Bool",
"StartDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
"EndDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
"UniqueID": "string [max length 50]",
"ApplyExpirationDate": "Bool",
"ApplyExpirationDateReplay": "Bool",
"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. Get single Organization attendee group based on ID –
GET https://api.viewcentral.com/api/organizations/{org id}/attendee-groups?groupname=
Request Filters : courseName = Name of the attendee group.
| Sl.No | Key | Value |
| 1 | groupname | String [max length 200] |
Response Codes:
| HTTP Status | Description |
| 200 | Operation successful. Organization Attendee group object returned in response |
| 400 | Operation not successful. Response contains error information |
| 404 | Operation not successful. Organization Attendee group object not found |
Response Example:
Click here to see Organization – Attendee group response example.
Post/Assign attendee group to organization via Litmos Commerce API. (Provide agreement company object in request body).
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: Provide assigned attendee groups to organization object in request body. Assignment is based on organization id.
URI: POST https://api.viewcentral.com/api/organizations/{orgid}/attendee-groups
Request Example :
{
"GroupName": "Required string [max length 200]",
"Active": "[True/false]",
"StartDate": "2018-04-12",
"EndDate": "2018-04-16",
"UniqueID": "string [max length 50]",
"ApplyExpirationDate": false,
"ApplyExpirationDateReplay": false
}
Response Codes:
Returns the organization attendee group details assigned object.
| HTTP Status | Description |
| 201 | Operation successful. Organization Attendee group object created. Newly created object is returned in response |
| 400 | Operation not successful. Organization Attendee group object not created. Response contains error information |
Response Example:
Click here to see Organization – Attendee group response example.
Update Organization – attendee group:
Update organization attendee group assignment based on OrgAttendeeGroupID 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 : Provide updated organization- attendee group object in request body.
URI: PUT https://api.viewcentral.com/api/organizations/{orgid}/attendee-groups?OrgAttendeeGroupID=
Request Filters : OrgAttendeeGroupID = id of the attendee group associated with org.
| Sl.No | Key | Value |
| 1 | OrgAttendeeGroupID | Int [max length 4] |
NOTE: this operation supports complete object update only – partial object update is NOT supported at this time. If the API request data does not supply ALL properties/fields with their intended values, the fields not supplied will be assigned the default value: NULL. If record previously had data in this field, the value will now be set to NULL. For example, an agreement company record is added with the Street2 set to “Suite 1”. With the API (PUT action) to update, if the organization.Street2 property is not supplied in the API request, the street2 value will be set to NULL
Request example:
{
"GroupName": "Required string [max length 200]",
"Active": "[True/false]",
"StartDate": "2018-04-12",
"EndDate": "2018-04-16",
"UniqueID": "string [max length 50]",
"ApplyExpirationDate": false,
"ApplyExpirationDateReplay": false
}
Response Codes:
Returns the organization attendee group details assigned object.
| HTTP Status | Description |
| 201 | Operation successful. Organization Attendee group object created. Newly created object is returned in response |
| 400 | Operation not successful. Organization Attendee group object not created. Response contains error information |
Delete Organization attendee group:
Un-assign attendee group from organization via company by org attendee group ID 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 : Organization-attendee group id to be provided in endpoint.
URI: DEL https://api.viewcentral.com/api/organizations/{orgid}/attendee-groups?OrgAttendeeGroupID=
Request Filters : OrgAttendeeGroupID = id of the attendee group associated with org.
| Sl.No | Key | Value |
| 1 | OrgAttendeeGroupID | Int [max length 4] |
Response Codes:
| HTTP Status | Description |
| 200 | Operation successful. Organization Attendee group object returned in response |
| 400 | Operation not successful. Response contains error information |
| 404 | Operation not successful. Organization Attendee group object not found |