Schedule Price API (Get, Create and Update)

Get Schedule Pricing: Provides the details (all list) of Schedule Price 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 :

1. Get details of Schedule Price using Schedule id in Litmos commerce application (subscription package and bundle are excluded)  –

   GET https://api.viewcentral.com/api/Schedule/{ScheduleId}/price

   Response Codes:

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

   Response Example:

   {
     "Success": true,
     "Error": null,
     "Data": {
       "ScheduleId": "Int [auto generated]",
       "PriceRecord": [
         {
           "RowId": "Int [auto generated]",
           "PricingId": "Int [auto generated]",
           "PriceName": "String [max length 255]",
           "Description": "String [max length 255]",
           "IsListPrice": "Int [max length 1]",
           "AlwaysDisplay": "Int [max length 1]",
           "DisplayToAll": "Int [max length 1]",
           "IgnoreDiscountUplift": "Int [max length 1]",
           "DisplayOnly": "Int [max length 1]",
           "DisplayMultiCurrencies": "Int [max length 1]",
           "StartDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
           "ExpirationDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
           "OtherPrice": "String [max length 255]",
           "PriceType": "String [Numeric/AlphaNumeric]",
           "DeliveryMethod": "String [INSTRUCTOR]",
           "CountryCurrency": [
             {
               "CurrencyCountry": "String [max length 2]",
               "CurrencyCode": "String [max length 3]",
               "Price": "Int [max length 13]",
               "DefaultPrice": "Int [max length 1]",
               "ID": "Int [autogenerate]"
             }
           ],
           "AttendeeGroups": [
             {
               "GroupID": "Int [max length 4]",
               "GroupName": "String [max length 255]"
             }
           ],
           "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": "/schedule/{id}/price",
               "Method": "GET"
             }
           ]
         }
       ]
     }
   }

   2.Get details of schedule pricing using filter in Litmos commerce application (subscription listing and bundle are excluded) –

   GET https://apibeta.viewcentral.com/Api/schedule/821/price?PriceName=

   Request Filters : Name = Price name.

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

   Response Codes:

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

   Response Example:

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

2. Get details of Schedule Pricing using schedule pricing id in Litmos commerce application (subscription listing and bundle are excluded) –

GET https://apibeta.viewcentral.com/Api/schedule/{ScheduleID}/price?{Priceid}

Response :

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

Response Example:

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

—

Create SchedulePrice(ClassRoom only) :

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

URI: POST https://api.viewcentral.com/api/schedule/{ScheduleId}/price

Request Example :

{
  "PriceRecord": [
    {
      "PriceName": "Required String [max length 255]",
      "Description": "Optional String [max length 255]",
      "IsListPrice": "Optional Int [max length 1]",
      "AlwaysDisplay": "Optional Int [max length 1]",
      "DisplayToAll": "Optional Int [max length 1]",
      "IgnoreDiscountUplift": "Optional Int [max length 1]",
      "DisplayOnly": "Optional Int [max length 1]",
      "DisplayMultiCurrencies": "Optional Int [max length 1]",
      "StartDate": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]",
      "ExpirationDate": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]",
      "OtherPrice": "Optional String [max length 255]",
      "DeliveryMethod": "Required String [INSTRUCTOR]",
      "PriceType": "Required String [Numeric/AlphaNumeric]",
      "CountryCurrency": [
        {
          "CurrencyCountry": "Optional String [max length 2]",
          "CurrencyCode": "Required String [max length 3]",
          "Price": "Required Int [max length 13]",
          "DefaultPrice": "Required Int [max length 1]"
        }
      ],
      "AttendeeGroups": [
        {
          "GroupID": "Optional Int [max length 4]"
        }
      ]
    }
  ]
}

Response Codes:

HTTP Status	Description
201	Operation successful. Schedule Price object returned in response
400	Operation not successful. Response contains error information
404	Operation not successful. Schedule Price object not found

Response Example:

{
  "Success": true,
  "Error": null,
  "Data": {
    "ScheduleId": "Int [auto generated]",
    "PriceRecord": [
      {
        "RowId": "Int [auto generated]",
        "PricingId": "Int [auto generated]",
        "PriceName": "String [max length 255]",
        "Description": "String [max length 255]",
        "IsListPrice": "Int [max length 1]",
        "AlwaysDisplay": "Int [max length 1]",
        "DisplayToAll": "Int [max length 1]",
        "IgnoreDiscountUplift": "Int [max length 1]",
        "DisplayOnly": "Int [max length 1]",
        "DisplayMultiCurrencies": "Int [max length 1]",
        "StartDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
        "ExpirationDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
        "OtherPrice": "String [max length 255]",
        "PriceType": "String [Numeric/AlphaNumeric]",
        "DeliveryMethod": "String [INSTRUCTOR]",
        "CountryCurrency": [
          {
            "CurrencyCountry": "String [max length 2]",
            "CurrencyCode": "String [max length 3]",
            "Price": "Int [max length 13]",
            "DefaultPrice": "Int [max length 1]",
            "ID": "Int [autogenerate]"
          }
        ],
        "AttendeeGroups": [
          {
            "GroupID": "Int [max length 4]",
            "GroupName": "String [max length 255]"
          }
        ],
        "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": "/schedule/{id}/price",
            "Method": "GET"
          }
        ]
      }
    ]
  }
}

Update Schedule Price (ClassRoom only) :

Update Schedule Price via Litmos Commerce API. (Provide Schedule Price 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

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

Request : Provide updated Schedule Price object in request body.

URI: PUT https://api.viewcentral.com/api/Schedule/{ScheduleID}/price/row/{rowid}

Request example:

{
  "PriceRecord": [
    {
      "PriceName": "Required String [max length 255]",
      "Description": "Optional String [max length 255]",
      "IsListPrice": "Optional Int [max length 1]",
      "AlwaysDisplay": "Optional Int [max length 1]",
      "DisplayToAll": "Optional Int [max length 1]",
      "IgnoreDiscountUplift": "Optional Int [max length 1]",
      "DisplayOnly": "Optional Int [max length 1]",
      "DisplayMultiCurrencies": "Optional Int [max length 1]",
      "StartDate": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]",
      "ExpirationDate": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]",
      "OtherPrice": "Optional String [max length 255]",
      "DeliveryMethod": "Required String [INSTRUCTOR]",
      "PriceType": "Required String [Numeric/AlphaNumeric]",
      "CountryCurrency": [
        {
          "CurrencyCountry": "Optional String [max length 2]",
          "CurrencyCode": "Required String [max length 3]",
          "Price": "Required Int [max length 13]",
          "DefaultPrice": "Required Int [max length 1]"
        }
      ],
      "AttendeeGroups": [
        {
          "GroupID": "Optional Int [max length 4]"
        }
      ]
    }
  ]
}

Response Codes:

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

Response Example:

{
  "Success": true,
  "Error": null,
  "Data": {
    "ScheduleId": "Int [auto generated]",
    "PriceRecord": [
      {
        "RowId": "Int [auto generated]",
        "PricingId": "Int [auto generated]",
        "PriceName": "String [max length 255]",
        "Description": "String [max length 255]",
        "IsListPrice": "Int [max length 1]",
        "AlwaysDisplay": "Int [max length 1]",
        "DisplayToAll": "Int [max length 1]",
        "IgnoreDiscountUplift": "Int [max length 1]",
        "DisplayOnly": "Int [max length 1]",
        "DisplayMultiCurrencies": "Int [max length 1]",
        "StartDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
        "ExpirationDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
        "OtherPrice": "String [max length 255]",
        "PriceType": "String [Numeric/AlphaNumeric]",
        "DeliveryMethod": "String [INSTRUCTOR]",
        "CountryCurrency": [
          {
            "CurrencyCountry": "String [max length 2]",
            "CurrencyCode": "String [max length 3]",
            "Price": "Int [max length 13]",
            "DefaultPrice": "Int [max length 1]",
            "ID": "Int [autogenerate]"
          }
        ],
        "AttendeeGroups": [
          {
            "GroupID": "Int [max length 4]",
            "GroupName": "String [max length 255]"
          }
        ],
        "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": "/schedule/{id}/price",
            "Method": "GET"
          }
        ]
      }
    ]
  }
}