{ "info": { "name": "MTN Customer Locations API", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "View customer locations", "description": "Retrieves the Location details of an MTN 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\/{customerId}\/locations", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "v1", "customers", "{customerId}", "locations" ] } }, "response": [ { "code": 200, "status": "OK", "name": "Customer Locations object. For a successful request, the response will contain all the customers details. If the customer does not have any requested data, then those fields will be null. E.g. if the customer does not any location set, then Country and Operator will be null.", "schema": { "data": { "country": { "type": "string", "description": "The country that the customer MSISDN is currently located in, and could be roaming in. ISO 3166-1 short name format", "example": "South Africa" }, "homeNetwork": { "type": "string", "description": "The country that the customer MSISDN was provisioned in. ISO 3166-1 short name format", "example": "South Africa" }, "operator": { "type": "string", "description": "The network operator that the customer MSISDN is currently located in.", "enum": [ "MTN", "Other", "null" ], "example": "MTN" } }, "_link": { "self": { "href": { "type": "string", "description": "" } } } }, "body": "{\"data\":{\"country\":\"string\",\"homeNetwork\":\"string\",\"operator\":\"string\"},\"_link\":{\"self\":{\"href\":\"string\"}}}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": { "error": { "type": "string" }, "error_description": { "type": "string" } }, "body": "{\"error\":\"string\",\"error_description\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "error": { "type": "string" }, "error_description": { "type": "string" } }, "body": "{\"error\":\"string\",\"error_description\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": { "error": { "type": "string" }, "error_description": { "type": "string" } }, "body": "{\"error\":\"string\",\"error_description\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Customer not found", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"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": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] } ] }