Skip to main content

Get person mobile number

GET /api/v1/PersonNumber/get

Description​

This endpoint is used to retrieve a person mobile number by its unique identifier (PersonId).

Tags: PersonNumber

URL:
/api/v{version}/PersonNumber/get

ApiKey:
No API key required

Content-Type:
None

Query Parameters:
PersonId: string, required (format: uuid)
version: string, required
Accept-Language: header, optional, change the default response message language from English(en) to French(fr) or English(en)

Request Body:
None

Response:
Success, returns the person mobile number as a StringResponse object.
400: Bad Request
404: Not Found

Example:

/api/v1/PersonNumber/get?PersonId=<uuid>

Headers​

Content-TypeValue
Accept-Language

Headers​

Content-TypeValue
Accepttext/plain

Query Params​

Paramvalue
PersonId<uuid>

Response: 200​

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}

Response: 400​

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}

Response: 404​

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /api/v1/PersonNumber/get \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!