Get a specific group customer by groupCustomerId

get

/PASService/rest/services/v1/groupCustomers/{groupCustomerId}

Gets a group customer based on the specified groupCustomer Id. The response will include GroupCustomerGuid, ClientGuid, CustomerNumber, PrimaryEnrollmentRelationShip, and associated Client fields such as client fixed fields, dynamic fields, and multi-value fields will be returned.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

200 Response

This operation fetches a specific group customer by groupCustomer Id successfully.
Back to Top

Examples

This example describes how to get a group customer based on the specified group customer 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/groupCustomers/D289E962-EB6E-4E21-A234-8BA0F2E44796"

Example Response Body

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

{
    "groupCustomer": {
        "links": [
            {
                "href": "http://server:port/PASService/rest/services/v1/groupCustomers/7E8C5E71-F8D5-4E82-8D87-D08B8548A4B6",
                "rel": "self",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/v1/groupCustomers/7E8C5E71-F8D5-4E82-8D87-D08B8548A4B6/addresses",
                "rel": "addresses",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClassGroupType&codeValue=03",
                "rel": "codes/enrollmentClassGroup",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClientEntityType&codeValue=GROUPCUST",
                "rel": "codes/entityTypeCode",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PrimaryRelationshipType&codeValue=AFFILIATES",
                "rel": "codes/hierarchyRelationship",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PrimaryRelationshipType&codeValue=AFFILIATES",
                "rel": "codes/primaryEnrollmentRelationship",
                "mediaType": "application/json",
                "method": "GET"
            },
            {
                "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClientType&codeValue=20",
                "rel": "codes/type",
                "mediaType": "application/json",
                "method": "GET"
            }
        ],
        "multiFields": {},
        "codes": [
            {
                "codeName": "AsCodeClassGroupType",
                "codeValue": "03",
                "longDescription": "Banking",
                "shortDescription": "Banking"
            },
            {
                "codeName": "AsCodeClientEntityType",
                "codeValue": "GROUPCUST",
                "longDescription": "GroupCustomer",
                "shortDescription": "GroupCustomer"
            },
            {
                "codeName": "AsCodePrimaryRelationshipType",
                "codeValue": "AFFILIATES",
                "longDescription": "Affiliated Companies",
                "shortDescription": "Affiliates"
            },
            {
                "codeName": "AsCodePrimaryRelationshipType",
                "codeValue": "AFFILIATES",
                "longDescription": "Affiliated Companies",
                "shortDescription": "Affiliates"
            },
            {
                "codeName": "AsCodeClientType",
                "codeValue": "20",
                "longDescription": "Group Customer",
                "shortDescription": "Group Customer"
            }
        ],
        "dateOfBirth": null,
        "dateOfDeath": null,
        "updatedGmt": "2023-09-20T10:55:03Z",
        "companyName": "Test_24Feb_POST",
        "email": null,
        "prefix": null,
        "sex": null,
        "suffix": null,
        "legalResidenceCountryCode": "CA",
        "additionalPrefix": null,
        "additionalSuffix": null,
        "title": null,
        "maritalStatus": null,
        "birthCountryCode": null,
        "citizenshipCountryCode": null,
        "birthRegionCode": null,
        "primaryPhone": null,
        "textField1": null,
        "textField2": null,
        "checkBox1": null,
        "checkBox2": null,
        "radio1": null,
        "radio2": null,
        "combo1": null,
        "combo2": null,
        "entityTypeCode": "GROUPCUST",
        "date1": null,
        "date2": null,
        "addresses": null,
        "customerNumber": "Test_24Nov_POST",
        "primaryEnrollmentRelationship": "AFFILIATES",
        "enrollmentClassGroup": "03",
        "allowedForCopy": "Yes",
        "hierarchyRelationship": "AFFILIATES",
        "clientId": "592BCAB5-2F4E-44A5-8FFC-5EC8F3D34453",
        "firstName": null,
        "lastName": null,
        "middleInitial": null,
        "taxId": null,
        "type": "20",
        "taxIdType": null,
        "status": null,
        "companyId": null,
        "groupCustomerId": "7E8C5E71-F8D5-4E82-8D87-D08B8548A4B6",
        "SitusState": {
            "textValue": "01",
            "optionText": "AL"
        },
        "OriginalEffectiveDate": "2015-08-04T00:00:00Z",
        "CustomerStatus": {
            "textValue": "01",
            "optionText": "Incomplete"
        },
        "ChangeEffectiveDate": "2015-08-04T00:00:00Z",
        "CustomerLegalName": "Test_24Feb_POST"
    }
}

Back to Top