Attendee – Attendee group (Get, Assign & Delete)

Attendee- Attendee group API

Post/Assign attendee group to Attendees via Litmos Commerce API. (Provide attendee group 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 attendee object in request body. Assignment is based on attendee id.

URI : POST http://api.viewcentral.com/api/attendees/{id}/attendee-groups

Request Example :

[
  {
    "Name": "String [max length 255]"
  }
]

Response Codes:

Returns the attendee’s attendee group assigned object with org id

HTTP Status	Description
201	Operation successful. Attendee -attendee group object created. Newly created agreement company object is returned in response
400	Operation not successful. Attendee -attendee group object not created. Response contains error information

Get Attendees – attendee group:

Provides the details of attendee’s- 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 attendee group assigned –

GET http://api.viewcentral.com/api/attendees/{attendeeId}/attendee-groups

Response Codes:

HTTP Status	Description
200	Operation successful. Attendee – Attendee group object returned in response
400	Operation not successful. Response contains error information
404	Operation not successful. Attendee – 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 255]",
      "CustomDetail2": "String [max length 255]",
      "CustomDetail3": "String [max length 255]",
      "Active": "Bool",
      "Key": "Int [max length 4]",
      "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 Attendee’s attendee group based on filter –

GET http://api.viewcentral.com/api/attendees/{id}/attendee-groups?name=

Request Filters : Name = Name of the attendee group.

Sl.No	Key	Value
1	name	String [max length 200]

Response Codes:

HTTP Status	Description
200	Operation successful. Attendee – Attendee group object returned in response
400	Operation not successful. Response contains error information
404	Operation not successful. Attendee – Attendee group object not found

Delete Attendee’s attendee group:

Remove attendee group from attendees 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 LTO account management)
ProductId	Product Id. 1=Learning Management, 2=Event Management
Username	User account username
Password	User account password

Request : .

URI : DEL http://api.viewcentral.com/api/attendees/{id}/attendee-groups

Request example :

[
  {
    "Name": "snail"
  },
  {
    "Name": "Leopard"
  }
]

Response Codes:

HTTP Status	Description
200	Operation successful. Attendee – Attendee group object returned in response
400	Operation not successful. Response contains error information
404	Operation not successful. Attendee – Attendee group object not found