POST api/subscriptions/stopSubscription

Stop Subscription

Request Information

URI Parameters

None.

Body Parameters

Request payload containing the subscription details

Name	Description	Type	Additional information
apiKey	Required API Key to access the service	string	None.
referenceType	Type of the reference: register-id , reference, response-shipment-number or subscription-id.	string	None.
referenceId	Identifier corresponding to the selected reference type.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "referenceType": "sample string 2",
  "referenceId": "sample string 3"
}

application/xml, text/xml

Sample:

<StopSubscriptionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalRestService.Models">
  <apiKey>sample string 1</apiKey>
  <referenceId>sample string 3</referenceId>
  <referenceType>sample string 2</referenceType>
</StopSubscriptionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Response indicating the result of the stop subscription operation

StopSubscriptionResponse

Name	Description	Type	Additional information
referenceType	Request payload ‘referenceType’ parameter.	string	None.
referenceId	Request payload ‘referenceId’ parameter.	string	None.
stopSubscriptionId	Trace identifier. Collection id of StopSubscriptionCall	string	None.

Response Formats

application/json, text/json

Sample:

{
  "referenceType": "sample string 1",
  "referenceId": "sample string 2",
  "stopSubscriptionId": "sample string 3"
}

application/xml, text/xml

Sample:

<StopSubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalRestService.Models">
  <referenceId>sample string 2</referenceId>
  <referenceType>sample string 1</referenceType>
  <stopSubscriptionId>sample string 3</stopSubscriptionId>
</StopSubscriptionResponse>