Jump to

• Request
• Response
• Examples

Get a specific address for a specific group customer

get

/PASService/rest/services/groupCustomers/{id}/addresses/{addressId}

Gets the address for a group customer based on the specified client Id and address Id

Request

Path Parameters

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

Back to Top

Response

Supported Media Types

• application/json

Default Response

successful operation

Back to Top

Examples

This example describes how to get the address for a group customer based on the specified client Id and address 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/groupCustomers/9B6E4F84-CD02-4D78-AD5B-239EA7A32AFC/addresses/ABDA1F51-441A-4FB0-8AE9-01850184C237"

Example Response Body

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

"{
    "address": {
        "links": [
            {
                "href": "http://server:port/PASService/rest/services/groupCustomers/9B6E4F84-CD02-4D78-AD5B-239EA7A32AFC/addresses/ABDA1F51-441A-4FB0-8AE9-01850184C237",
                "rel": "self",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/codes?codeName=AddressRole&codeValue=04",
                "rel": "codes/addressType",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/codes?codeName=State&codeValue=01",
                "rel": "codes/state",
                "mediaType": "application/json",
                "method": "GET"
            }
        ],
        "multiFields": {},
        "codes": [
            {
                "codeName": "AsCodeAddressRole",
                "codeValue": "04",
                "longDescription": "Billing",
                "shortDescription": "Billing"
            },
            {
                "codeName": "AsCodeState",
                "codeValue": "01",
                "longDescription": "Alabama",
                "shortDescription": "AL"
            }
        ],
        "effectiveDate": "2015-08-04T00:00:00Z",
        "addressLine1": "fegREF",
        "city": "EWFWF",
        "postalID": "4354135",
        "addressType": "04",
        "clientId": "9B6E4F84-CD02-4D78-AD5B-239EA7A32AFC",
        "addressId": "ABDA1F51-441A-4FB0-8AE9-01850184C237",
        "state": "01",
        "country": "CA",
        "ReturnMailIndicator": "CHECKED",
        "SystemDateGSM": "2015-08-04T00:00:00Z",
        "CostOfStamp": {
            "value": 0,
            "currency": "USD"
        },
        "TestInteger": 0,
        "ClientGUID": {
            "textValue": "9B6E4F84-CD02-4D78-AD5B-239EA7A32AFC",
            "optionText": " "
        },
        "TestDecimal": 0
    }
}
"

Back to Top