POST - Subscription Updates
Modified on: Tue, Mar 23, 2021 at 3:37 PM
Description: Calls the Rest API to begin processing the update package for a specified set of products within a subscription. There are three parameters that need to be specified in the URL. {subscriptionId} needs to be set to the ID of the subscription you are wanting updates for. {changesSinceDate:YYYY-MM-DD} needs to be set to YYYY-MM-DD that you would like the updates since (Use 1900-01-01 to get all updates). productIds=<comma separated list of subscriptionProductIds> must contain at least one product that is within your subscription that you would like updates for. If you receive a response of NoUpdate, that means that are no new updates for your subscription since the changeSinceDate specified.
Limits: Be aware that you can only have two update packages being processed at a time. It is recommended that you get all subscription products you need in one request. If your limit has been reached the response data will say LIMIT_REACHED.
URL: https://api.altalis.com/altalis/acquisition_api/v1/subscriptionUpdates/{subscriptionId}/{changesSinceDate:YYYY-MM-DD}?productIds=<comma separated list of subscriptionProductIds>
Request Method: POST
Response Content Type: application/json
Response data:
{ status (string) = ['PACKAGED', 'NOUPDATE', 'LIMIT_REACHED'] : Status if the data has been updated since the given changesSinceDate, packageId (string, optional):<packageId> : Identifier of the package (if NoUpdate this will be null), }
Statuses:
Packaged: The system has created a package object with the packageId provided, and has begun the process of putting your data into that package.
NoUpdate: For the products requests if no updates have occurred since the date you specified it will return this message.
LIMIT_REACHED: All users can only have two Subscription Updates running at one time. You will receive this message if there are currently two package running.
C# Sample:
var client = new RestClient("https://api.altalis.com/altalis/acquisition_api/v1/subscriptionUpdates/##/2017-06-01?productIds=##"); var request = new RestRequest(Method.POST); request.AddHeader("accept", "application/json"); request.AddHeader("authorization", "Bearer <API_TOKEN>"); IRestResponse response = client.Execute(request);