• Free Trial
  • Products
    • LMSThe world’s easiest-to-use learning management system.
    • Training ContentA robust library of off-the-shelf learning content.
  • Solutions
    • By Use Case
      • Employee Training
      • Sales Training
      • Customer Training
      • Partner Training
      • Compliance Training
      • View all
    • By Industry
      • Technology
      • Nonprofit
      • Retail
      • Hospitality
      • Healthcare
      • View all
  • Customers
    • Learn more about Litmos customer success stories.
      • Case Studies
      • Video Testimonials
      • I Love Litmos
      • Lenny Awards
    • Featured Customer
      • Sabre, a global travel technology provider, increases revenue by using Litmos to train their sales and technical teams.
  • Pricing
  • Resources
    • Ebooks & Infographics
    • Webinars & Podcasts
    • Events
    • Integrations
    • Blog
  • About
    • Company
    • Partners
    • Awards
    • Careers
    • Sustainability
  • Free Trial
Litmos
Log in
Contact us
Support
Search
  • Free Trial
  • Products
    • LMSThe world’s easiest-to-use learning management system.
    • Training ContentA robust library of off-the-shelf learning content.
  • Solutions
    • By Use Case
      • Employee Training
      • Sales Training
      • Customer Training
      • Partner Training
      • Compliance Training
      • View all
    • By Industry
      • Technology
      • Nonprofit
      • Retail
      • Hospitality
      • Healthcare
      • View all
  • Customers
    • Learn more about Litmos customer success stories.
      • Case Studies
      • Video Testimonials
      • I Love Litmos
      • Lenny Awards
    • Featured Customer
      • Sabre, a global travel technology provider, increases revenue by using Litmos to train their sales and technical teams.
  • Pricing
  • Resources
    • Ebooks & Infographics
    • Webinars & Podcasts
    • Events
    • Integrations
    • Blog
  • About
    • Company
    • Partners
    • Awards
    • Careers
    • Sustainability
  • Free Trial

Litmos Training Operations Documentation

APIs

Home › Litmos Training Operations Documentation › LTO REST API: Organization Attendee Group (Get, Assign, Update, Remove)

LTO REST API: Organization Attendee Group (Get, Assign, Update, Remove)

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

No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of Litmos.

The information contained herein may be changed without prior notice. Some software products marketed by Litmos and its distributors contain proprietary software components of other software vendors. National product specifications may vary.

These materials are provided by Litmos for informational purposes only, without representation or warranty of any kind, and Litmos or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for Litmos company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.

In particular Litmos or its affiliated companies have no obligation to pursue any course of business outlined in this document or any related presentation, or to develop or release any functionality mentioned therein. This document, or any related presentation, and Litmos or its affiliated companies’ strategy and possible future developments, products, and/or platform directions and functionality are all subject to change and may be changed by Litmos or its affiliated companies at any time for any reason without notice.

The information in this document is not a commitment, promise, or legal obligation to deliver any material, code, or functionality. All forward-looking statements are subject to various risks and uncertainties that could cause actual results to differ materially from expectations. Readers are cautioned not to place undue reliance on these forward-looking statements, and they should not be relied upon in making purchasing decisions.

© 2022 Litmos or a Litmos affiliate company. All rights reserved.

Litmos and other Litmos products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Litmos (or a Litmos affiliate company) in the United States and other countries. All other product and service names mentioned are the trademarks of their respective companies.

Match keywords.

Useful Links

  • Release Notes
  • Customer Portal

In this article

Related articles

  1. LTO REST API: Attendee (Get Create, Update, Delete)
  2. LTO REST API: Location (Get, Create, Update)
  3. LTO REST API: Vendor (Get, Create, Update)

Also of Interest

  • Online Training Courses
  • Enterprise Learning Strategy
  • Active Learning Online Courses
  • Corporate LMS
  • Enterprise Learning Management System
  • LMS Platform
  • eLearning Platform
  • What is a learning management system?
  • See Additional Resources

Solutions by Use Case

  • Employee Training
  • Customer Training
  • Compliance Training
  • Sales Training
  • Operations Training
  • Gig Worker Training
  • Contractor Training
  • Supplier Training

Solutions by Industry

  • Technology
  • Nonprofit
  • Retail
  • Hospitality
  • Healthcare

Contact Us

Contact
UK: +44 20 4551 1606
USA: +1 925 490 0401
AUS: +61 3 7066 4851
Email
Support
Address
Contact Us
Litmos Reviews Litmos Reviews
Litmos Careers Careers

© 2023 Litmos US, L.P. and affiliates. All rights reserved.

  • Privacy Statement
  • Terms & Conditions
  • Website Terms