Download
Download Postman collection Download SwaggerAvailable endpoints
GET api/customers/{id}/subscriptions
200OK
systems
systemId string
status string
statusCode string
message string
subscriptionList
subscriptionId string
Unique system identifier for the SubsriptionsystemId string
Identifier for the system within which the Subscription livessubscriptionName string
Service the customer is subscribed tosubscriptionStatus string
Active,InactivesubscriptionDescription string
Description of the service the customer is subscribed tosubscriptionType string
Adhoc,RecurringsubscriptionLength string
Duration of the subscription the customer is subscribed toregistrationChannel string
Channel through which the customer subscribed to the servicestartDate string
Start date of the Subscription; full-date notation RFC 3339endDate string
End date of the Subscription; full-date notation RFC 3339email string
Email associated with the subcription{
"systems": {
"systemId": "string",
"status": "string",
"statusCode": "string",
"message": "string"
},
"subscriptionList": {
"subscriptionId": "string",
"systemId": "string",
"subscriptionName": "string",
"subscriptionStatus": "string",
"subscriptionDescription": "string",
"subscriptionType": "string",
"subscriptionLength": "string",
"registrationChannel": "string",
"startDate": "string",
"endDate": "string",
"email": "string"
}
}
206Partial Content
systems
systemId string
status string
statusCode string
message string
subscriptionList
subscriptionId string
Unique system identifier for the SubsriptionsystemId string
Identifier for the system within which the Subscription livessubscriptionName string
Service the customer is subscribed tosubscriptionStatus string
Active,InactivesubscriptionDescription string
Description of the service the customer is subscribed tosubscriptionType string
Adhoc,RecurringsubscriptionLength string
Duration of the subscription the customer is subscribed toregistrationChannel string
Channel through which the customer subscribed to the servicestartDate string
Start date of the Subscription; full-date notation RFC 3339endDate string
End date of the Subscription; full-date notation RFC 3339email string
Email associated with the subcription{
"systems": {
"systemId": "string",
"status": "string",
"statusCode": "string",
"message": "string"
},
"subscriptionList": {
"subscriptionId": "string",
"systemId": "string",
"subscriptionName": "string",
"subscriptionStatus": "string",
"subscriptionDescription": "string",
"subscriptionType": "string",
"subscriptionLength": "string",
"registrationChannel": "string",
"startDate": "string",
"endDate": "string",
"email": "string"
}
}
400Bad Request
responseCode string
Error response codereason string
Text explaining the reason for the errormessage string
More error details and corrective measures{
"responseCode": "string",
"reason": "string",
"message": "string"
}
403Forbidden
responseCode string
Error response codereason string
Text explaining the reason for the errormessage string
More error details and corrective measures{
"responseCode": "string",
"reason": "string",
"message": "string"
}
404Not Found
responseCode string
Error response codereason string
Text explaining the reason for the errormessage string
More error details and corrective measures{
"responseCode": "string",
"reason": "string",
"message": "string"
}
405Method Not Allowed
responseCode string
Error response codereason string
Text explaining the reason for the errormessage string
More error details and corrective measures{
"responseCode": "string",
"reason": "string",
"message": "string"
}
500Internal Server Error
responseCode string
Error response codereason string
Text explaining the reason for the errormessage string
More error details and corrective measures{
"responseCode": "string",
"reason": "string",
"message": "string"
}
GET api/customers/{id}/subscriptions/{subscriptionId}
200OK
subscriptionId string
Unique system identifier for the SubsriptionsystemId string
Identifier for the system within which the Subscription livessubscriptionName string
Service the customer is subscribed tosubscriptionStatus string
Active,InactivesubscriptionDescription string
Description of the service the customer is subscribed tosubscriptionType string
Adhoc,RecurringsubscriptionLength string
Duration of the subscription the customer is subscribed toregistrationChannel string
Channel through which the customer subscribed to the servicestartDate string
Start date of the Subscription; full-date notation RFC 3339endDate string
End date of the Subscription; full-date notation RFC 3339email string
Email associated with the subcription{
"subscriptionId": "string",
"systemId": "string",
"subscriptionName": "string",
"subscriptionStatus": "string",
"subscriptionDescription": "string",
"subscriptionType": "string",
"subscriptionLength": "string",
"registrationChannel": "string",
"startDate": "string",
"endDate": "string",
"email": "string"
}
400Bad Request
responseCode string
Error response codereason string
Text explaining the reason for the errormessage string
More error details and corrective measures{
"responseCode": "string",
"reason": "string",
"message": "string"
}
403Forbidden
responseCode string
Error response codereason string
Text explaining the reason for the errormessage string
More error details and corrective measures{
"responseCode": "string",
"reason": "string",
"message": "string"
}
404Not Found
responseCode string
Error response codereason string
Text explaining the reason for the errormessage string
More error details and corrective measures{
"responseCode": "string",
"reason": "string",
"message": "string"
}
405Method Not Allowed
responseCode string
Error response codereason string
Text explaining the reason for the errormessage string
More error details and corrective measures{
"responseCode": "string",
"reason": "string",
"message": "string"
}
500Internal Server Error
responseCode string
Error response codereason string
Text explaining the reason for the errormessage string
More error details and corrective measures{
"responseCode": "string",
"reason": "string",
"message": "string"
}
DELETE api/customers/{id}/subscriptions/{subscriptionId}
200OK
status string
Unsubscribe successful,Unsubscribe unsucccessfuldescription string
Details on result of the unsubscribe action{
"status": "string",
"description": "string"
}
400Bad Request
responseCode string
Error response codereason string
Text explaining the reason for the errormessage string
More error details and corrective measures{
"responseCode": "string",
"reason": "string",
"message": "string"
}
403Forbidden
responseCode string
Error response codereason string
Text explaining the reason for the errormessage string
More error details and corrective measures{
"responseCode": "string",
"reason": "string",
"message": "string"
}
404Not Found
responseCode string
Error response codereason string
Text explaining the reason for the errormessage string
More error details and corrective measures{
"responseCode": "string",
"reason": "string",
"message": "string"
}
405Method Not Allowed
responseCode string
Error response codereason string
Text explaining the reason for the errormessage string
More error details and corrective measures{
"responseCode": "string",
"reason": "string",
"message": "string"
}
500Internal Server Error
responseCode string
Error response codereason string
Text explaining the reason for the errormessage string
More error details and corrective measures{
"responseCode": "string",
"reason": "string",
"message": "string"
}