--- swagger: "2.0" info: description: "The mobile info API provides network related data." version: "0.1" title: Mobile Customer Information API host: api.host.com schemes: - https consumes: - application/json produces: - application/json securityDefinitions: OAuth2: type: oauth2 flow: application tokenUrl: "https://staging.api.chenosis.io/client-credentials/accesstoken?grant_type=client_credentials" scopes: GET-LOCATION-DATA: Grants read access for carrier location data. security: - OAuth2: [] paths: /mobile/subscriber/{phoneNumber}/home-location: get: tags: - Customer Mobile Carrier Data summary: "Retrieve basic network properties." description: "Retrieve network related information of subscriber as identified by phoneNumber. " parameters: - name: phoneNumber in: path description: "ID of the subscriber is the MSISDN of the subscriber represented as International ITU-T E.164." required: true type: string x-example: "27123456789" responses: 200: description: Success schema: $ref: "#/definitions/mobileInfoBasicResponse" 400: description: Bad Request schema: $ref: "#/definitions/Error" 401: description: Unauthorized schema: $ref: "#/definitions/Error" 403: description: Forbidden schema: $ref: "#/definitions/Error" 404: description: Not Found schema: $ref: "#/definitions/Error" 405: description: Method No Allowed schema: $ref: "#/definitions/Error" 406: description: Not acceptable schema: $ref: "#/definitions/Error" 500: description: Internal Server Error schema: $ref: "#/definitions/Error" definitions: booleanObjectValue: type: "string" description: "Holds the value of the status result. \nIf positive the value is \"TRUE\" \nIf negative the value is \"FALSE\"\nIf the value cannot be determined (the phoneNumber does not exist) the value is \"NONE\"." example: "TRUE" enum: - "TRUE" - "FALSE" - "NONE" mobileInfoBasicResponse: type: object required: - statusCode - statusMessage - phoneNumber - data properties: statusCode: type: string description: HTTP error code extension example: 0 statusMessage: type: string description: Message. example: "Successful" phoneNumber: type: string example: 27123456789 description: phoneNumber provided in the input data: $ref: "#/definitions/basicData" transactionId: type: string description: transaction ID for tracing. basicData: type: object properties: country: type: string example: Zambia description: Country of origin of the phoneNumber provided. mobileNetwork: type: string example: MTN description: Mobile Network Operator of the phoneNumber provided. subscriberIsActive: $ref: "#/definitions/booleanObjectValue" simIsPorted: $ref: "#/definitions/booleanObjectValue" roamingIsEnabled: $ref: "#/definitions/booleanObjectValue" Error: type: object properties: statusCode: type: integer description: HTTP error code extension statusMessage: type: string description: More details and corrective actions related to the error which can be shown to a client. SupportMessage: type: string description: Support Message