Jump to

• Request
• Response
• Examples

Get specific phone for a specific client

get

/PASService/rest/services/clients/{id}/phones/{phoneId}

Get a phone for a client based on the specified client Id and phone Id

Request

Path Parameters

• id: string
  Pattern: \{?[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}\}?

  Client Id
• phoneId: string
  Pattern: \{?[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}\}?

  Phone Id

Back to Top

Response

Supported Media Types

• application/json

Default Response

successful operation

Back to Top

Examples

This example describes how to get a phone for a client based on the specified client Id and phone Id.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -X GET -H "Accept: application/json" -u username:password "server:port/PASService/rest/services/clients/E374F857-9A81-45F5-9A11-8186E04863BA/phones"

Example Response Body

The following shows an example of the response body in JSON format:

"{
    "phone": {
        "links": [
            {
                "href": "http://server:port/PASService/rest/services/clients/E374F857-9A81-45F5-9A11-8186E04863BA/phones/8BFA7382-DD6F-40F3-BC40-53239A5317ED",
                "rel": "self",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/codes?codeName=PhoneType&codeValue=02",
                "rel": "codes/phoneType",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/codes?codeName=PhoneStatus&codeValue=01",
                "rel": "codes/status",
                "mediaType": "application/json",
                "method": "GET"
            }
        ],
        "codes": [
            {
                "codeName": "AsCodePhoneType",
                "codeValue": "02",
                "longDescription": "Mobile Phone Number",
                "shortDescription": "Mobile"
            },
            {
                "codeName": "AsCodePhoneStatus",
                "codeValue": "01",
                "longDescription": "Active Phone Number",
                "shortDescription": "Active"
            }
        ],
        "countryCode": "US",
        "callingCode": "1",
        "phoneNumber": "5474456677",
        "preferred": "Y",
        "phoneType": "02",
        "phoneId": "8BFA7382-DD6F-40F3-BC40-53239A5317ED",
        "status": "01",
        "type": "01"
    }
}
"

Back to Top