Previous Next JavaScript must be enabled to correctly display this content

## Get a specific phone for a specific client by client Id and phone Id

get

/PASService/rest/services/v1/clients/{clientId}/phones/{phoneId}

Gets a phone for a client based on the specified client Id and phone Id.

### Request

Path Parameters

- clientId(required): string(guid)
  Client Id
- phoneId(required): string
  Phone Id

There's no request body for this operation.

Back to Top

### Response

#### 200 Response

This operation fetches specific phone for a specific client by client Id and phone Id successfully.
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 "Content-Type: application/json" \
       -u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
       -L "http://server:port//PASService/rest/services/v1/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/v1/clients/695634AC-F8AF-4109-ABA7-E849D08C1049/phones/51838C90-97CC-4B3C-A42F-78E02848C763",
                    "rel": "self",
                    "mediaType": "application/json",
                    "method": "GET"
                },
                {
                    "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PhoneType&codeValue=01",
                    "rel": "codes/phoneType",
                    "mediaType": "application/json",
                    "method": "GET"
                },
                {
                    "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PhoneStatus&codeValue=01",
                    "rel": "codes/status",
                    "mediaType": "application/json",
                    "method": "GET"
                }
            ],
            "codes": [
                {
                    "codeName": "AsCodePhoneType",
                    "codeValue": "01",
                    "longDescription": "Home Phone Number",
                    "shortDescription": "Home"
                },
                {
                    "codeName": "AsCodePhoneStatus",
                    "codeValue": "01",
                    "longDescription": "Active Phone Number",
                    "shortDescription": "Active"
                }
            ],
            "countryCode": "US",
            "callingCode": "1",
            "phoneNumber": "3025558787",
            "extension": "43434",
            "preferred": "Y",
            "phoneType": "01",
            "phoneId": "51838C90-97CC-4B3C-A42F-78E02848C763",
            "status": "01",
            "type": "01"
        }
    }

Back to Top