LTO REST API: Organization Email (Get, Create, Update, Delete)

Organization Email-Domain API (Get, Create, Update & Delete)

Get organization- email domain:

Provides the details of organization- email domain 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 email domain associated with organizations –

GET https://api.viewcentral.com/api/organizations/{orgid}/email-domains

Response Codes:

HTTP Status	Description
200	Operation successful. Organization Email-Domain object returned in response
400	Operation not successful. Response contains error information
404	Operation not successful. Organization Email-Domain object not found

Response Example:

{
  "Success": true,
  "Error": null,
  "Data": [
    {
      "Active": "Bool [Optional]",
      "EmailDomain": "Required string [max length 50]",
      "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]"
      }
    }
  ]
}

2. Get single Organization email domain based on ID name of email domain –

Request URI : GET https://api.viewcentral.com//api/organizations/{org id}/email-domains?EmailDomain=

Request Filters : courseName = Name of the email domain.

Sl.No	Key	Value
1	EmailDomain	String [max length 50]

Response Codes:

HTTP Status	Description
200	Operation successful. Organization Email-Domain object returned in response
400	Operation not successful. Response contains error information
404	Operation not successful. Organization Email-Domain object not found

Create Email domain for Organization

Post/Assign Email Domain 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 Email Domain to organization object in request body. Assignment is based on organization id.

URI : POST https://api.viewcentral.com/api/organizations/{orgid} email-domains

Request Example :

{
  "Active": "Bool [Optional]",
  "EmailDomain": "Required string [max length 50]",
  "UpdateAll": "Bool [Optional]",
  "UpdateAttendeesWithNoOrganization": "Bool [Optional]",
  "DonotUpdate": "Bool [Optional]",
  "RemoveAll": "Bool [Optional]",
  "DonotRemove": "Bool [Optional]",
  "DonotRemoveGroupIfAttendeesExists": "Bool [Optional]"
}

Response :

Returns the organization Email domain details assigned object.

HTTP Status	Description
201	Operation successful. Organization Email-Domain object created. Newly created Organization Email-Domain object is returned in response
400	Operation not successful. Organization Email-Domain object not created. Response contains error information

Update Organization – Email domain:

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:

{
  "Active": "Bool [Optional]",
  "EmailDomain": "Required string [max length 50]",
  "UpdateAll": "Bool [Optional]",
  "UpdateAttendeesWithNoOrganization": "Bool [Optional]",
  "DonotUpdate": "Bool [Optional]",
  "RemoveAll": "Bool [Optional]",
  "DonotRemove": "Bool [Optional]",
  "DonotRemoveGroupIfAttendeesExists": "Bool [Optional]"
}

Response :

Returns the organization Email domain details assigned object.

HTTP Status	Description
201	Operation successful. Organization Email-Domain object created. Newly created Organization Email-Domain object is returned in response
400	Operation not successful. Organization Email-Domain object not created. Response contains error information

Response Example:

Click here to see Get Organization – email domain response details/format.

—

Delete Organization email domain:

remove email domain from organization 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 : Email domain name to be provided in endpoint.

URI : DEL https://api.viewcentral.com/api/organizations/{org id}/email-domains?emailDomain=

Request Filters : courseName = Name of the email domain.

Sl.No	Key	Value
1	EmailDomain	String [max length 50]

Response Codes:

HTTP Status	Description
200	Operation successful. Organization Email-Domain object returned in response
400	Operation not successful. Response contains error information
404	Operation not successful. Organization Email-Domain object not found

Litmos Training Operations Documentation

APIs

LTO REST API: Organization Email (Get, Create, Update, Delete)

Useful Links

In this article

Related articles