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

Organization API (Get, Create, Update & Delete)

Returns a list of Organizations in your company including active and inactive organizations. By default, all the Organizations are returned. The list can be filtered on ID, Organization Key and External Organization ID.

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

Get organization list:

Returns a list of all Organizations in company

Request Uri: GET https://api.viewcentral.com/api/organizations

Response Codes:

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

Response Example:

{
  "Success": true,
  "Error": null,
  "Data": [
    {
      "Id": "Int [max length 4]",
      "Key": "string [max length 100]",
      "Name": "string [max length 210]",
      "Type": "string [max length 50]",
      "ExternalId": "string [max length 50]",
      "Active": "Bool",
      "City": "string [max length 200]",
      "Country": "string[max length 2, See Country list*]",
      "PostalCode": "string [max length 40]",
      "Street1": "string [max length 200]",
      "Street2": "string [max length 200]",
      "Phone": "string [max length 50]",
      "StateProvince": "string [max length 2, See State list*]",
      "AccountingCode": "string [max length 50]",
      "Comments": "string [max length 1024]",
      "CustomDetail1": "string [max length 200]",
      "CustomDetail2": "string [max length 200]",
      "CustomDetail3": "string [max length 200]",
      "CustomDetail4": "string [max length 200]",
      "CustomDetail5": "string [max length 200]",
      "CustomDetail6": "string [max length 200]",
      "CustomDetail7": "string [max length 200]",
      "CustomDetail8": "string [max length 200]",
      "TaxExemptId": "string [max length 50]",
      "IsTaxExempt": "Bool",
      "NotificationToSuperUser": "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]"
      },
      "Links": [
        {
          "Rel": "Self",
          "Href": "/organizations/{orgid}",
          "Method": "GET"
        },
        {
          "Rel": "AttendeeGroups",
          "Href": "/organizations/{orgid}/attendee_groups",
          "Method": "GET"
        },
        {
          "Rel": "EmailDomains",
          "Href": "/organizations/{orgid}/emaildomains",
          "Method": "GET"
        }
      ]
    }
  ]
}

* See country list.

* See state list.

Get single organization:

Returns a single organization details for the given organization Id.

Request Uri: GET https://api.viewcentral.com/api/organizations/{ID}

Response Codes:

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

Get organizations based on filters:

Returns a list of organizations based on selected filters.

Request Uri: GET https://api.viewcentral.com/api/organizations?key=&ExternalId=

Request Filters

Sl.No	Key	Value
1	key	string [max length 100]
2	ExternalId	string [max length 50]

Response Example:

Click here to see the single response of ‘Organization’

Create Organization:

Creates 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 created organization object in request body

URI : POST https://api.viewcentral.com/api/organizations

Request Example :

{
  "Key": " Required string [max length 100]",
  "Name": "Required string [max length 210]",
  "Type": "Optional string [max length 50]",
  "ExternalId": "Optional string [max length 50]",
  "Active": "Bool",
  "City": "Optional string [max length 200]",
  "Country": "Optional string [max length 2, See Country list*]",
  "PostalCode": "Optional string [max length 40]",
  "Street1": "Optional string [max length 200]",
  "Street2": "Optional string [max length 200]",
  "Phone": "Optional string [max length 50]",
  "StateProvince": "Optional string [max length 2, See State list*]",
  "AccountingCode": "Optional string [max length 50]",
  "Comments": "Optional string [max length 1024]",
  "CustomDetail1": "Optional string [max length 1024]",
  "CustomDetail2": "Optional string [max length 1024]",
  "CustomDetail3": "Optional string [max length 1024]",
  "CustomDetail4": "Optional string [max length 1024]",
  "CustomDetail5": "Optional string [max length 1024]",
  "CustomDetail6": "Optional string [max length 1024]",
  "CustomDetail7": "Optional string [max length 1024]",
  "CustomDetail8": "Optional string [max length 1024]",
  "TaxExemptId": "Optional string [max length 1024]",
  "IsTaxExempt": "Bool [Optional]",
  "NotificationToSuperUser": "Bool [Optional]"
}

* See country list.

* See state list.

Response Codes :

Returns the organization object created with organization id

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

Response Example:

Click here to see the single response of ‘Organization’

Update Organization :

Update organization by organization 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 : Provide updated organization object in request body.

URI : PUT https://api.viewcentral.com/api/organizations/{org ID}

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:

{
  "Key": " Required string [max length 100]",
  "Name": "Required string [max length 210]",
  "Type": "Optional string [max length 50]",
  "ExternalId": "Optional string [max length 50]",
  "Active": "Bool",
  "City": "Optional string [max length 200]",
  "Country": "Optional string [max length 2, See Country list*]",
  "PostalCode": "Optional string [max length 40]",
  "Street1": "Optional string [max length 200]",
  "Street2": "Optional string [max length 200]",
  "Phone": "Optional string [max length 50]",
  "StateProvince": "Optional string [max length 2, See State list*]",
  "AccountingCode": "Optional string [max length 50]",
  "Comments": "Optional string [max length 1024]",
  "CustomDetail1": "Optional string [max length 1024]",
  "CustomDetail2": "Optional string [max length 1024]",
  "CustomDetail3": "Optional string [max length 1024]",
  "CustomDetail4": "Optional string [max length 1024]",
  "CustomDetail5": "Optional string [max length 1024]",
  "CustomDetail6": "Optional string [max length 1024]",
  "CustomDetail7": "Optional string [max length 1024]",
  "CustomDetail8": "Optional string [max length 1024]",
  "TaxExemptId": "Optional string [max length 1024]",
  "IsTaxExempt": "Bool [Optional]",
  "NotificationToSuperUser": "Bool [Optional]"
}

* See country list.

* See state list.

Response Codes:

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

Response Example:

Check Get Organization API for response details/format.

Delete Organization :

Delete the organization by ID via Litmos Commerce API.

Note: All requests must be Authenticated.

Authentication and Authorization

nformation 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 ID to be deleted provided in endpoint

URI : DEL /api/organization/{Organization ID}

Response Codes:

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

Litmos Training Operations Documentation

APIs

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

Useful Links

In this article

Related articles