{ "info": { "name": "subscriptionAPI", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "List all Subscriptions", "description": "Get a Customer's Subscriptions given the Customer's id", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" } ] }, "method": "Get", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.mtn.com\/customers\/{id}\/subscriptions", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "api", "customers", "{id}", "subscriptions" ] } }, "response": [ { "code": 200, "status": "OK", "name": "List of customer's subscriptions", "schema": { "systems": { "systemId": { "type": "string" }, "status": { "type": "string", "enum": [ "Active", "Inactive" ] }, "statusCode": { "type": "string" }, "message": { "type": "string" } }, "subscriptionList": { "subscriptionId": { "type": "string", "default": "null", "description": "Unique system identifier for the Subsription" }, "systemId": { "type": "string", "default": "null", "description": "Identifier for the system within which the Subscription lives" }, "subscriptionName": { "type": "string", "default": "null", "description": "Service the customer is subscribed to" }, "subscriptionStatus": { "type": "string", "default": "", "description": "Active,Inactive" }, "subscriptionDescription": { "type": "string", "default": "null", "description": "Description of the service the customer is subscribed to" }, "subscriptionType": { "type": "string", "default": "", "description": "Adhoc,Recurring" }, "subscriptionLength": { "type": "string", "default": "null", "description": "Duration of the subscription the customer is subscribed to" }, "registrationChannel": { "type": "string", "default": "null", "description": "Channel through which the customer subscribed to the service" }, "startDate": { "type": "string", "format": "date", "default": "null", "description": "Start date of the Subscription; full-date notation RFC 3339" }, "endDate": { "type": "string", "format": "date", "default": "null", "description": "End date of the Subscription; full-date notation RFC 3339" }, "email": { "type": "string", "default": "null", "description": "Email associated with the subcription" } } }, "body": "{\"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\"}}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 206, "status": "Partial Content", "name": "Partial list of customer's subscriptions", "schema": { "systems": { "systemId": { "type": "string" }, "status": { "type": "string", "enum": [ "Active", "Inactive" ] }, "statusCode": { "type": "string" }, "message": { "type": "string" } }, "subscriptionList": { "subscriptionId": { "type": "string", "default": "null", "description": "Unique system identifier for the Subsription" }, "systemId": { "type": "string", "default": "null", "description": "Identifier for the system within which the Subscription lives" }, "subscriptionName": { "type": "string", "default": "null", "description": "Service the customer is subscribed to" }, "subscriptionStatus": { "type": "string", "default": "", "description": "Active,Inactive" }, "subscriptionDescription": { "type": "string", "default": "null", "description": "Description of the service the customer is subscribed to" }, "subscriptionType": { "type": "string", "default": "", "description": "Adhoc,Recurring" }, "subscriptionLength": { "type": "string", "default": "null", "description": "Duration of the subscription the customer is subscribed to" }, "registrationChannel": { "type": "string", "default": "null", "description": "Channel through which the customer subscribed to the service" }, "startDate": { "type": "string", "format": "date", "default": "null", "description": "Start date of the Subscription; full-date notation RFC 3339" }, "endDate": { "type": "string", "format": "date", "default": "null", "description": "End date of the Subscription; full-date notation RFC 3339" }, "email": { "type": "string", "default": "null", "description": "Email associated with the subcription" } } }, "body": "{\"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\"}}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": { "responseCode": { "type": "string", "description": "Error response code" }, "reason": { "type": "string", "description": "Text explaining the reason for the error" }, "message": { "type": "string", "description": "More error details and corrective measures" } }, "body": "{\"responseCode\":\"string\",\"reason\":\"string\",\"message\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": { "responseCode": { "type": "string", "description": "Error response code" }, "reason": { "type": "string", "description": "Text explaining the reason for the error" }, "message": { "type": "string", "description": "More error details and corrective measures" } }, "body": "{\"responseCode\":\"string\",\"reason\":\"string\",\"message\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Not Found", "schema": { "responseCode": { "type": "string", "description": "Error response code" }, "reason": { "type": "string", "description": "Text explaining the reason for the error" }, "message": { "type": "string", "description": "More error details and corrective measures" } }, "body": "{\"responseCode\":\"string\",\"reason\":\"string\",\"message\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "responseCode": { "type": "string", "description": "Error response code" }, "reason": { "type": "string", "description": "Text explaining the reason for the error" }, "message": { "type": "string", "description": "More error details and corrective measures" } }, "body": "{\"responseCode\":\"string\",\"reason\":\"string\",\"message\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "responseCode": { "type": "string", "description": "Error response code" }, "reason": { "type": "string", "description": "Text explaining the reason for the error" }, "message": { "type": "string", "description": "More error details and corrective measures" } }, "body": "{\"responseCode\":\"string\",\"reason\":\"string\",\"message\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "Retrieve Subscription details", "description": "Retrieve specific subscription details for a customer", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" } ] }, "method": "Get", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.mtn.com\/customers\/{id}\/subscriptions\/{subscriptionId}", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "api", "customers", "{id}", "subscriptions", "{subscriptionId}" ], "query": [ { "key": "systemId", "value": "", "required": true, "type": "string", "description": "Identify the system hosting the subscription" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "Subscription details", "schema": { "subscriptionId": { "type": "string", "default": "null", "description": "Unique system identifier for the Subsription" }, "systemId": { "type": "string", "default": "null", "description": "Identifier for the system within which the Subscription lives" }, "subscriptionName": { "type": "string", "default": "null", "description": "Service the customer is subscribed to" }, "subscriptionStatus": { "type": "string", "default": "", "description": "Active,Inactive" }, "subscriptionDescription": { "type": "string", "default": "null", "description": "Description of the service the customer is subscribed to" }, "subscriptionType": { "type": "string", "default": "", "description": "Adhoc,Recurring" }, "subscriptionLength": { "type": "string", "default": "null", "description": "Duration of the subscription the customer is subscribed to" }, "registrationChannel": { "type": "string", "default": "null", "description": "Channel through which the customer subscribed to the service" }, "startDate": { "type": "string", "format": "date", "default": "null", "description": "Start date of the Subscription; full-date notation RFC 3339" }, "endDate": { "type": "string", "format": "date", "default": "null", "description": "End date of the Subscription; full-date notation RFC 3339" }, "email": { "type": "string", "default": "null", "description": "Email associated with the subcription" } }, "body": "{\"subscriptionId\":\"string\",\"systemId\":\"string\",\"subscriptionName\":\"string\",\"subscriptionStatus\":\"string\",\"subscriptionDescription\":\"string\",\"subscriptionType\":\"string\",\"subscriptionLength\":\"string\",\"registrationChannel\":\"string\",\"startDate\":\"string\",\"endDate\":\"string\",\"email\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": { "responseCode": { "type": "string", "description": "Error response code" }, "reason": { "type": "string", "description": "Text explaining the reason for the error" }, "message": { "type": "string", "description": "More error details and corrective measures" } }, "body": "{\"responseCode\":\"string\",\"reason\":\"string\",\"message\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": { "responseCode": { "type": "string", "description": "Error response code" }, "reason": { "type": "string", "description": "Text explaining the reason for the error" }, "message": { "type": "string", "description": "More error details and corrective measures" } }, "body": "{\"responseCode\":\"string\",\"reason\":\"string\",\"message\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Not Found", "schema": { "responseCode": { "type": "string", "description": "Error response code" }, "reason": { "type": "string", "description": "Text explaining the reason for the error" }, "message": { "type": "string", "description": "More error details and corrective measures" } }, "body": "{\"responseCode\":\"string\",\"reason\":\"string\",\"message\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "responseCode": { "type": "string", "description": "Error response code" }, "reason": { "type": "string", "description": "Text explaining the reason for the error" }, "message": { "type": "string", "description": "More error details and corrective measures" } }, "body": "{\"responseCode\":\"string\",\"reason\":\"string\",\"message\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "responseCode": { "type": "string", "description": "Error response code" }, "reason": { "type": "string", "description": "Text explaining the reason for the error" }, "message": { "type": "string", "description": "More error details and corrective measures" } }, "body": "{\"responseCode\":\"string\",\"reason\":\"string\",\"message\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "Unsubscribe a customer from a subscription", "description": "Delete a specific subscription", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" } ] }, "method": "Delete", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.mtn.com\/customers\/{id}\/subscriptions\/{subscriptionId}", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "api", "customers", "{id}", "subscriptions", "{subscriptionId}" ], "query": [ { "key": "systemId", "value": "", "required": true, "type": "string", "description": "Identify the system hosting the subscription" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "Result of the unsubscribe action", "schema": { "status": { "type": "string", "default": "", "description": "Unsubscribe successful,Unsubscribe unsucccessful" }, "description": { "type": "string", "description": "Details on result of the unsubscribe action" } }, "body": "{\"status\":\"string\",\"description\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": { "responseCode": { "type": "string", "description": "Error response code" }, "reason": { "type": "string", "description": "Text explaining the reason for the error" }, "message": { "type": "string", "description": "More error details and corrective measures" } }, "body": "{\"responseCode\":\"string\",\"reason\":\"string\",\"message\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": { "responseCode": { "type": "string", "description": "Error response code" }, "reason": { "type": "string", "description": "Text explaining the reason for the error" }, "message": { "type": "string", "description": "More error details and corrective measures" } }, "body": "{\"responseCode\":\"string\",\"reason\":\"string\",\"message\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Not Found", "schema": { "responseCode": { "type": "string", "description": "Error response code" }, "reason": { "type": "string", "description": "Text explaining the reason for the error" }, "message": { "type": "string", "description": "More error details and corrective measures" } }, "body": "{\"responseCode\":\"string\",\"reason\":\"string\",\"message\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "responseCode": { "type": "string", "description": "Error response code" }, "reason": { "type": "string", "description": "Text explaining the reason for the error" }, "message": { "type": "string", "description": "More error details and corrective measures" } }, "body": "{\"responseCode\":\"string\",\"reason\":\"string\",\"message\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "responseCode": { "type": "string", "description": "Error response code" }, "reason": { "type": "string", "description": "Text explaining the reason for the error" }, "message": { "type": "string", "description": "More error details and corrective measures" } }, "body": "{\"responseCode\":\"string\",\"reason\":\"string\",\"message\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] } ] }