LTO REST API: Vendor (Get, Create, Update)

Vendor API (Get , Create and Update)

Get Vendor : Provides the details of Vendor 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 details of all Vendors in Litmos commerce application (Get Vendor is applicable only for ClassRoom) –

GET https://api.viewcentral.com/api/Vendors/

Response Codes:

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

Response Example:

{
  "Success": true,
  "Error": null,
  "Data": [
    {
      "ID": "Int [autogenerate]",
      "Name": "String [max length 50]",
      "ExternalVendorId": "String [max length 50]",
      "Active": "Bool",
      "VendorType": "String [max length 255]",
      "Street1": "String [max length 100]",
      "Street2": "String [max length 100]",
      "City": "String [max length 100]",
      "StateProvince": "String [max length 2]",
      "OtherState": "String [max length 100]",
      "PostalCode": "String [max length 20]",
      "Country": "String [max length 2]",
      "Phone1": "String [max length 50]",
      "Phone1Type": "String [max length 255]",
      "Phone2": "String [max length 50]",
      "Phone2Type": "String [max length 255]",
      "Phone3": "String [max length 50]",
      "Phone3Type": "String [max length 255]",
      "Phone4": "String [max length 50]",
      "Phone4Type": "String [max length 255]",
      "Fax": "String [max length 50]",
      "Website": "String [max length 255]",
      "CustomDetail1": "String [max length 255]",
      "CustomDetail2": "String [max length 255]",
      "CustomDetail3": "String [max length 255]",
      "CustomDetail4": "String [max length 255]",
      "AgreementNumber": "String [max length 100]",
      "AgreementDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "AgreementExpiry": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "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": "/vendors/{id}",
          "Method": "GET"
        },
        {
          "Rel": "Contacts",
          "Href": "/vendors/{id}/contacts",
          "Method": "GET"
        }
      ]
    }
  ]
}

2. Get details of vendors using filter in Litmos commerce application (Get Vendor is applicable only for ClassRoom) –

GET https://api.viewcentral.com/api/vendors?name=

Request Filters : Name = Vendor name.

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

Response Codes:

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

Response Example:

Please refer to the above response example found in point 1.

Get details of vendors using vendor id in Litmos commerce application (Get Vendor is applicable only for ClassRoom) –

GET https://api.viewcentral.com/api/Vendors/{ID}

Response :

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

Response Example:

Please refer to the above response example found in point 1.

Create Vendor (ClassRoom only) :

Create Vendor via Litmos Commerce API. (Provide vendor 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 create vendor object in request body

URI: POST https://apibeta.viewcentral.com/Api/vendors

Request Example :

{
  "Name": "Required String [max length 50]",
  "ExternalVendorId": "Optional String [max length 50]",
  "Active": "Required [true/false]",
  "VendorType": "Optional String [max length 255]",
  "Street1": "Optional String [max length 100]",
  "Street2": "Optional String [max length 100]",
  "City": "Optional String [max length 100]",
  "StateProvince": "Optional String [max length 2]",
  "OtherState": "Optional String [max length 100]",
  "PostalCode": "Optional String [max length 20]",
  "Country": "Optional String [max length 2]",
  "Phone1": "Optional String [max length 50]",
  "Phone1Type": "Optional String [max length 255]",
  "Phone2": "Optional String [max length 50]",
  "Phone2Type": "Optional String [max length 255]",
  "Phone3": "Optional String [max length 50]",
  "Phone3Type": "Optional String [max length 255]",
  "Phone4": "Optional String [max length 50]",
  "Phone4Type": "Optional String [max length 255]",
  "Fax": "Optional String [max length 50]",
  "Website": "Optional String [max length 255]",
  "CustomDetail1": "Optional String [max length 255]",
  "CustomDetail2": "Optional String [max length 255]",
  "CustomDetail3": "Optional String [max length 255]",
  "CustomDetail4": "Optional String [max length 255]",
  "AgreementNumber": "Optional String [max length 100]",
  "AgreementDate": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]",
  "AgreementExpiry": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]"
}

Response Codes:

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

Response Example:

{
  "Success": true,
  "Error": null,
  "Data": [
    {
      "ID": "Int [autogenerate]",
      "Name": "String [max length 50]",
      "ExternalVendorId": "String [max length 50]",
      "Active": "Bool",
      "VendorType": "String [max length 255]",
      "Street1": "String [max length 100]",
      "Street2": "String [max length 100]",
      "City": "String [max length 100]",
      "StateProvince": "String [max length 2]",
      "OtherState": "String [max length 100]",
      "PostalCode": "String [max length 20]",
      "Country": "String [max length 2]",
      "Phone1": "String [max length 50]",
      "Phone1Type": "String [max length 255]",
      "Phone2": "String [max length 50]",
      "Phone2Type": "String [max length 255]",
      "Phone3": "String [max length 50]",
      "Phone3Type": "String [max length 255]",
      "Phone4": "String [max length 50]",
      "Phone4Type": "String [max length 255]",
      "Fax": "String [max length 50]",
      "Website": "String [max length 255]",
      "CustomDetail1": "String [max length 255]",
      "CustomDetail2": "String [max length 255]",
      "CustomDetail3": "String [max length 255]",
      "CustomDetail4": "String [max length 255]",
      "AgreementNumber": "String [max length 100]",
      "AgreementDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "AgreementExpiry": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "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": "/vendors/{id}",
          "Method": "GET"
        }
      ]
    }
  ]
}

—

Update Vendor(ClassRoom only) :

Update vendor via Litmos Commerce API. (Provide vendor 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 updated Vendor object in request body.

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

NOTE: this operation supports complete object update as well as partial object update. 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 previous value. For example, vendor record is added with the ‘ExternalVendorId’ set to “EV123”. With the API (PUT action) to update, if the vendor ‘ExternalVendorId’ property is not supplied in the API request, the ‘ExternalVendorId’ value will not be changed means it has value of “EV123”.

Request example:

{
  "Name": "Required String [max length 50]",
  "ExternalVendorId": "Optional String [max length 50]",
  "Active": "Required [true/false]",
  "VendorType": "Optional String [max length 255]",
  "Street1": "Optional String [max length 100]",
  "Street2": "Optional String [max length 100]",
  "City": "Optional String [max length 100]",
  "StateProvince": "Optional String [max length 2]",
  "OtherState": "Optional String [max length 100]",
  "PostalCode": "Optional String [max length 20]",
  "Country": "Optional String [max length 2]",
  "Phone1": "Optional String [max length 50]",
  "Phone1Type": "Optional String [max length 255]",
  "Phone2": "Optional String [max length 50]",
  "Phone2Type": "Optional String [max length 255]",
  "Phone3": "Optional String [max length 50]",
  "Phone3Type": "Optional String [max length 255]",
  "Phone4": "Optional String [max length 50]",
  "Phone4Type": "Optional String [max length 255]",
  "Fax": "Optional String [max length 50]",
  "Website": "Optional String [max length 255]",
  "CustomDetail1": "Optional String [max length 255]",
  "CustomDetail2": "Optional String [max length 255]",
  "CustomDetail3": "Optional String [max length 255]",
  "CustomDetail4": "Optional String [max length 255]",
  "AgreementNumber": "Optional String [max length 100]",
  "AgreementDate": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]",
  "AgreementExpiry": "Optionaldatetime [yyyy-mm-ddThh:mm:ssZ]"
}

Response Codes:

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

Response Example:

{
  "Success": true,
  "Error": null,
  "Data": [
    {
      "ID": "Int [autogenerate]",
      "Name": "String [max length 50]",
      "ExternalVendorId": "String [max length 50]",
      "Active": "Bool",
      "VendorType": "String [max length 255]",
      "Street1": "String [max length 100]",
      "Street2": "String [max length 100]",
      "City": "String [max length 100]",
      "StateProvince": "String [max length 2]",
      "OtherState": "String [max length 100]",
      "PostalCode": "String [max length 20]",
      "Country": "String [max length 2]",
      "Phone1": "String [max length 50]",
      "Phone1Type": "String [max length 255]",
      "Phone2": "String [max length 50]",
      "Phone2Type": "String [max length 255]",
      "Phone3": "String [max length 50]",
      "Phone3Type": "String [max length 255]",
      "Phone4": "String [max length 50]",
      "Phone4Type": "String [max length 255]",
      "Fax": "String [max length 50]",
      "Website": "String [max length 255]",
      "CustomDetail1": "String [max length 255]",
      "CustomDetail2": "String [max length 255]",
      "CustomDetail3": "String [max length 255]",
      "CustomDetail4": "String [max length 255]",
      "AgreementNumber": "String [max length 100]",
      "AgreementDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "AgreementExpiry": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "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": "/vendors/{id}",
          "Method": "GET"
        }
      ]
    }
  ]
}

Litmos Training Operations Documentation

APIs

LTO REST API: Vendor (Get, Create, Update)

Useful Links

In this article

Related articles