Previous Next JavaScript must be enabled to correctly display this content

## Get the list of groupCustomers

get

/PASService/rest/services/v1/groupCustomers

Gets the latest 100 groupCustomers. Address Links will be provided similar to the client's search. Data retreived will be: GroupCustomerGuid, ClientGuid, CustomerNumber, and PrimaryEnrollmentRelationShip. All client details, fixed, dynamic, and multivalue fields will also be returned for the ClientGuid.

### Request

Query Parameters

- expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "the name of the child resource". More than one child can be specified using comma as a separator. Example:?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers). More than one child can be specified using comma as a separator. For example: "?expand=Employees,Localizations". Nested children can also be provided following the format: "Child.NestedChild" For example:"?expand=Employees.Managers" If a nested child is provided (Example:Employees.Managers), the missing children will be processed implicitly i.e.,"?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers", which will expand both Employees and Managers.
- limit: integer(int32)
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
- offset: integer(int32)
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
- q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;loc!="NY.

There's no request body for this operation.

Back to Top

### Response

#### 200 Response

This operation fetches the list of groupCustomers successfully.
Back to Top

### Examples

This example describes how to get the latest 100 group customers.

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"

Example Response Body

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

    {
        "count": 7,
        "offset": 0,
        "limit": 100,
        "groupCustomers": [
            {
                "links": [
                    {
                        "href": "http://server:port/PASService/rest/services/v1/groupCustomers/1E905978-366E-4718-9EEE-7A1E41782557",
                        "rel": "self",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/groupCustomers/1E905978-366E-4718-9EEE-7A1E41782557/addresses",
                        "rel": "addresses",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClassGroupType&amp;codeValue=02",
                        "rel": "codes/enrollmentClassGroup",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClientEntityType&amp;codeValue=GROUPCUST",
                        "rel": "codes/entityTypeCode",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PrimaryRelationshipType&amp;codeValue=Employment",
                        "rel": "codes/hierarchyRelationship",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PrimaryRelationshipType&amp;codeValue=Employment",
                        "rel": "codes/primaryEnrollmentRelationship",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClientType&amp;codeValue=20",
                        "rel": "codes/type",
                        "mediaType": "application/json",
                        "method": "GET"
                    }
                ],
                "multiFields": {},
                "dateOfBirth": null,
                "dateOfDeath": null,
                "updatedGmt": "2023-09-20T10:55:58Z",
                "companyName": "Updated_Group_Customer",
                "email": "duplicate@email.com",
                "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": "GC170026",
                "primaryEnrollmentRelationship": "Employment",
                "enrollmentClassGroup": "02",
                "allowedForCopy": "Yes",
                "hierarchyRelationship": "Employment",
                "clientId": "0B7EADAE-8267-4860-B629-898DA8847507",
                "firstName": null,
                "lastName": null,
                "middleInitial": null,
                "taxId": "709831231",
                "type": "20",
                "taxIdType": null,
                "status": null,
                "companyId": null,
                "groupCustomerId": "1E905978-366E-4718-9EEE-7A1E41782557",
                "CancellationReason": {
                    "textValue": "04",
                    "optionText": "Reason 1"
                },
                "CancellationDate": null,
                "IndustryCode": {
                    "textValue": "327910",
                    "optionText": "Abrasive Product Manufacturing - 327910"
                },
                "TaxIDSource": {
                    "textValue": "00",
                    "optionText": "Application"
                },
                "Corporation": {
                    "textValue": "00",
                    "optionText": "No"
                },
                "AlternateFederalEmployerIDNumber": null,
                "SitusState": {
                    "textValue": "01",
                    "optionText": "AL"
                },
                "OriginalEffectiveDate": "2015-08-04T00:00:00Z",
                "CustomerStatus": {
                    "textValue": "01",
                    "optionText": "Incomplete"
                },
                "ReinstatementDate": null,
                "ChangeEffectiveDate": "2015-08-04T00:00:00Z",
                "CustomerLegalName": "Duplicate_Grp_Cust",
                "CancellationReasonDescription": null
            },
            {
                "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&amp;codeValue=03",
                        "rel": "codes/enrollmentClassGroup",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClientEntityType&amp;codeValue=GROUPCUST",
                        "rel": "codes/entityTypeCode",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PrimaryRelationshipType&amp;codeValue=AFFILIATES",
                        "rel": "codes/hierarchyRelationship",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PrimaryRelationshipType&amp;codeValue=AFFILIATES",
                        "rel": "codes/primaryEnrollmentRelationship",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClientType&amp;codeValue=20",
                        "rel": "codes/type",
                        "mediaType": "application/json",
                        "method": "GET"
                    }
                ],
                "multiFields": {},
                "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"
            },
            {
                "links": [
                    {
                        "href": "http://server:port/PASService/rest/services/v1/groupCustomers/702C6BD9-6DF9-48D2-B2B6-83C9A8632947",
                        "rel": "self",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/groupCustomers/702C6BD9-6DF9-48D2-B2B6-83C9A8632947/addresses",
                        "rel": "addresses",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClassGroupType&amp;codeValue=03",
                        "rel": "codes/enrollmentClassGroup",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClientEntityType&amp;codeValue=GROUPCUST",
                        "rel": "codes/entityTypeCode",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PrimaryRelationshipType&amp;codeValue=AFFILIATES",
                        "rel": "codes/hierarchyRelationship",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PrimaryRelationshipType&amp;codeValue=AFFILIATES",
                        "rel": "codes/primaryEnrollmentRelationship",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClientType&amp;codeValue=20",
                        "rel": "codes/type",
                        "mediaType": "application/json",
                        "method": "GET"
                    }
                ],
                "multiFields": {},
                "dateOfBirth": null,
                "dateOfDeath": null,
                "updatedGmt": "2023-02-07T07:48:11Z",
                "companyName": "Group-TC-001",
                "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": "Group-TC-001",
                "primaryEnrollmentRelationship": "AFFILIATES",
                "enrollmentClassGroup": "03",
                "allowedForCopy": "Yes",
                "hierarchyRelationship": "AFFILIATES",
                "clientId": "58CED371-B77F-4135-A4D9-D368FB025636",
                "firstName": null,
                "lastName": null,
                "middleInitial": null,
                "taxId": "987654321",
                "type": "20",
                "taxIdType": null,
                "status": null,
                "companyId": null,
                "groupCustomerId": "702C6BD9-6DF9-48D2-B2B6-83C9A8632947",
                "CancellationReason": {
                    "textValue": "04",
                    "optionText": "Reason 1"
                },
                "Prototype": null,
                "CancellationDate": null,
                "TaxIDSource": {
                    "textValue": "00",
                    "optionText": "Application"
                },
                "IndustryCode": {
                    "textValue": "32791",
                    "optionText": "Abrasive Product Manufacturing - 32791"
                },
                "Corporation": {
                    "textValue": "00",
                    "optionText": "No"
                },
                "AlternateFederalEmployerIDNumber": null,
                "SitusState": {
                    "textValue": "01",
                    "optionText": "AL"
                },
                "OriginalEffectiveDate": "2020-06-15T00:00:00Z",
                "CustomerStatus": {
                    "textValue": "02",
                    "optionText": "Active"
                },
                "ChangeEffectiveDate": "2020-06-15T00:00:00Z",
                "ReinstatementDate": null,
                "CustomerLegalName": "Group-TC-001",
                "CancellationReasonDescription": null
            },
            {
                "links": [
                    {
                        "href": "http://server:port/PASService/rest/services/v1/groupCustomers/81F53F22-9DF5-4B75-BC2B-CC40AC73B516",
                        "rel": "self",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/groupCustomers/81F53F22-9DF5-4B75-BC2B-CC40AC73B516/addresses",
                        "rel": "addresses",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClassGroupType&amp;codeValue=02",
                        "rel": "codes/enrollmentClassGroup",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClientEntityType&amp;codeValue=GROUPCUST",
                        "rel": "codes/entityTypeCode",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PrimaryRelationshipType&amp;codeValue=Employment",
                        "rel": "codes/hierarchyRelationship",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PrimaryRelationshipType&amp;codeValue=Employment",
                        "rel": "codes/primaryEnrollmentRelationship",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClientType&amp;codeValue=20",
                        "rel": "codes/type",
                        "mediaType": "application/json",
                        "method": "GET"
                    }
                ],
                "multiFields": {},
                "dateOfBirth": null,
                "dateOfDeath": null,
                "updatedGmt": "2023-02-01T08:40:15Z",
                "companyName": "Group-GC-001",
                "email": null,
                "prefix": null,
                "sex": null,
                "suffix": null,
                "legalResidenceCountryCode": "US",
                "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": "Group-GC-001",
                "primaryEnrollmentRelationship": "Employment",
                "enrollmentClassGroup": "02",
                "allowedForCopy": "Yes",
                "hierarchyRelationship": "Employment",
                "clientId": "2A58D1FB-A74B-4B59-9DF8-44699B78CA1A",
                "firstName": null,
                "lastName": null,
                "middleInitial": null,
                "taxId": "987654321",
                "type": "20",
                "taxIdType": null,
                "status": null,
                "companyId": null,
                "groupCustomerId": "81F53F22-9DF5-4B75-BC2B-CC40AC73B516",
                "CancellationReason": {
                    "textValue": "04",
                    "optionText": "Reason 1"
                },
                "CancellationDate": null,
                "Prototype": null,
                "TaxIDSource": {
                    "textValue": "00",
                    "optionText": "Application"
                },
                "IndustryCode": {
                    "textValue": "32791",
                    "optionText": "Abrasive Product Manufacturing - 32791"
                },
                "Corporation": {
                    "textValue": "00",
                    "optionText": "No"
                },
                "SitusState": {
                    "textValue": "01",
                    "optionText": "AL"
                },
                "AlternateFederalEmployerIDNumber": null,
                "OriginalEffectiveDate": "2020-06-15T00:00:00Z",
                "CustomerStatus": {
                    "textValue": "02",
                    "optionText": "Active"
                },
                "ChangeEffectiveDate": "2020-06-15T00:00:00Z",
                "ReinstatementDate": null,
                "CustomerLegalName": "Group-GC-001",
                "CancellationReasonDescription": null
            },
            {
                "links": [
                    {
                        "href": "http://server:port/PASService/rest/services/v1/groupCustomers/9619F7E5-6E37-41E5-B5DA-FBD37B4A2C5F",
                        "rel": "self",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/groupCustomers/9619F7E5-6E37-41E5-B5DA-FBD37B4A2C5F/addresses",
                        "rel": "addresses",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClassGroupType&amp;codeValue=03",
                        "rel": "codes/enrollmentClassGroup",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClientEntityType&amp;codeValue=GROUPCUST",
                        "rel": "codes/entityTypeCode",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PrimaryRelationshipType&amp;codeValue=AFFILIATES",
                        "rel": "codes/hierarchyRelationship",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PrimaryRelationshipType&amp;codeValue=AFFILIATES",
                        "rel": "codes/primaryEnrollmentRelationship",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClientType&amp;codeValue=20",
                        "rel": "codes/type",
                        "mediaType": "application/json",
                        "method": "GET"
                    }
                ],
                "multiFields": {},
                "dateOfBirth": null,
                "dateOfDeath": null,
                "updatedGmt": "2021-09-18T14:25:31Z",
                "companyName": "testing client address",
                "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": [
                    {
                        "links": [
                            {
                                "href": "http://server:port/PASService/rest/services/v1/groupCustomers/12E40400-030C-4934-8831-6AFAE84C4FFC/addresses/E59D44A5-3545-45BA-82E7-9174D2B596CA",
                                "rel": "self",
                                "mediaType": "application/json",
                                "method": "GET"
                            }
                        ]
                    }
                ],
                "customerNumber": "testing client address",
                "primaryEnrollmentRelationship": "AFFILIATES",
                "enrollmentClassGroup": "03",
                "allowedForCopy": "Yes",
                "hierarchyRelationship": "AFFILIATES",
                "clientId": "12E40400-030C-4934-8831-6AFAE84C4FFC",
                "firstName": null,
                "lastName": null,
                "middleInitial": null,
                "taxId": null,
                "type": "20",
                "taxIdType": null,
                "status": null,
                "companyId": null,
                "groupCustomerId": "9619F7E5-6E37-41E5-B5DA-FBD37B4A2C5F",
                "CancellationReason": {
                    "textValue": "04",
                    "optionText": "Reason 1"
                },
                "Prototype": null,
                "CancellationDate": null,
                "IndustryCode": {
                    "textValue": "32791",
                    "optionText": "Abrasive Product Manufacturing - 32791"
                },
                "TaxIDSource": {
                    "textValue": "00",
                    "optionText": "Application"
                },
                "Corporation": {
                    "textValue": "00",
                    "optionText": "No"
                },
                "AlternateFederalEmployerIDNumber": null,
                "SitusState": {
                    "textValue": "01",
                    "optionText": "AL"
                },
                "OriginalEffectiveDate": "2020-06-15T00:00:00Z",
                "CustomerStatus": {
                    "textValue": "01",
                    "optionText": "Incomplete"
                },
                "ReinstatementDate": null,
                "ChangeEffectiveDate": "2020-06-15T00:00:00Z",
                "CustomerLegalName": "testing client address",
                "CancellationReasonDescription": null
            },
            {
                "links": [
                    {
                        "href": "http://server:port/PASService/rest/services/v1/groupCustomers/00756D2A-A767-4391-A6E6-7AE15B812B6D",
                        "rel": "self",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/groupCustomers/00756D2A-A767-4391-A6E6-7AE15B812B6D/addresses",
                        "rel": "addresses",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClassGroupType&amp;codeValue=02",
                        "rel": "codes/enrollmentClassGroup",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClientEntityType&amp;codeValue=GROUPCUST",
                        "rel": "codes/entityTypeCode",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PrimaryRelationshipType&amp;codeValue=Employment",
                        "rel": "codes/hierarchyRelationship",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PrimaryRelationshipType&amp;codeValue=Employment",
                        "rel": "codes/primaryEnrollmentRelationship",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClientType&amp;codeValue=20",
                        "rel": "codes/type",
                        "mediaType": "application/json",
                        "method": "GET"
                    }
                ],
                "multiFields": {},
                "dateOfBirth": null,
                "dateOfDeath": null,
                "updatedGmt": "2021-09-13T13:39:30Z",
                "companyName": "SS_Test_01",
                "email": null,
                "prefix": null,
                "sex": null,
                "suffix": null,
                "legalResidenceCountryCode": "US",
                "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": [
                    {
                        "links": [
                            {
                                "href": "http://server:port/PASService/rest/services/v1/groupCustomers/F6D92EBA-2FAE-4104-9964-6F350E57EF8E/addresses/A16A784F-095A-4402-9371-1DC2EA5176E6",
                                "rel": "self",
                                "mediaType": "application/json",
                                "method": "GET"
                            }
                        ]
                    },
                    {
                        "links": [
                            {
                                "href": "http://server:port/PASService/rest/services/v1/groupCustomers/F6D92EBA-2FAE-4104-9964-6F350E57EF8E/addresses/5BD3F858-74E8-4832-91A9-8F86080F0742",
                                "rel": "self",
                                "mediaType": "application/json",
                                "method": "GET"
                            }
                        ]
                    }
                ],
                "customerNumber": "SS_Test_01",
                "primaryEnrollmentRelationship": "Employment",
                "enrollmentClassGroup": "02",
                "allowedForCopy": "Yes",
                "hierarchyRelationship": "Employment",
                "clientId": "F6D92EBA-2FAE-4104-9964-6F350E57EF8E",
                "firstName": null,
                "lastName": null,
                "middleInitial": null,
                "taxId": "987567456",
                "type": "20",
                "taxIdType": null,
                "status": null,
                "companyId": null,
                "groupCustomerId": "00756D2A-A767-4391-A6E6-7AE15B812B6D",
                "CancellationReason": {
                    "textValue": "04",
                    "optionText": "Reason 1"
                },
                "CancellationDate": null,
                "Prototype": null,
                "IndustryCode": {
                    "textValue": "32791",
                    "optionText": "Abrasive Product Manufacturing - 32791"
                },
                "TaxIDSource": {
                    "textValue": "00",
                    "optionText": "Application"
                },
                "Corporation": {
                    "textValue": "00",
                    "optionText": "No"
                },
                "SitusState": {
                    "textValue": "01",
                    "optionText": "AL"
                },
                "AlternateFederalEmployerIDNumber": null,
                "OriginalEffectiveDate": "2010-01-01T00:00:00Z",
                "CustomerStatus": {
                    "textValue": "02",
                    "optionText": "Active"
                },
                "ChangeEffectiveDate": "2010-01-01T00:00:00Z",
                "ReinstatementDate": null,
                "CustomerLegalName": "SS_Test_01",
                "CancellationReasonDescription": null
            },
            {
                "links": [
                    {
                        "href": "http://server:port/PASService/rest/services/v1/groupCustomers/2CA405D6-C687-4716-B338-FE991C75778D",
                        "rel": "self",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/groupCustomers/2CA405D6-C687-4716-B338-FE991C75778D/addresses",
                        "rel": "addresses",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClassGroupType&amp;codeValue=03",
                        "rel": "codes/enrollmentClassGroup",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClientEntityType&amp;codeValue=GROUPCUST",
                        "rel": "codes/entityTypeCode",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PrimaryRelationshipType&amp;codeValue=AFFILIATES",
                        "rel": "codes/hierarchyRelationship",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=PrimaryRelationshipType&amp;codeValue=AFFILIATES",
                        "rel": "codes/primaryEnrollmentRelationship",
                        "mediaType": "application/json",
                        "method": "GET"
                    },
                    {
                        "href": "http://server:port/PASService/rest/services/v1/codes?codeName=ClientType&amp;codeValue=20",
                        "rel": "codes/type",
                        "mediaType": "application/json",
                        "method": "GET"
                    }
                ],
                "multiFields": {},
                "dateOfBirth": null,
                "dateOfDeath": null,
                "updatedGmt": "2021-09-08T15:46:28Z",
                "companyName": "SS_Hist_02",
                "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": [
                    {
                        "links": [
                            {
                                "href": "http://server:port/PASService/rest/services/v1/groupCustomers/7F08C9B1-A2DB-4FF8-ADE6-26138B159455/addresses/EEFD8202-3EC8-4B07-A64B-8E7C4343BCDE",
                                "rel": "self",
                                "mediaType": "application/json",
                                "method": "GET"
                            }
                        ]
                    }
                ],
                "customerNumber": "SS_Hist_02",
                "primaryEnrollmentRelationship": "AFFILIATES",
                "enrollmentClassGroup": "03",
                "allowedForCopy": "No",
                "hierarchyRelationship": "AFFILIATES",
                "clientId": "7F08C9B1-A2DB-4FF8-ADE6-26138B159455",
                "firstName": null,
                "lastName": null,
                "middleInitial": null,
                "taxId": "34523423",
                "type": "20",
                "taxIdType": null,
                "status": null,
                "companyId": null,
                "groupCustomerId": "2CA405D6-C687-4716-B338-FE991C75778D",
                "CancellationReason": {
                    "textValue": "04",
                    "optionText": "Reason 1"
                },
                "CancellationDate": null,
                "Prototype": null,
                "IndustryCode": {
                    "textValue": "32791",
                    "optionText": "Abrasive Product Manufacturing - 32791"
                },
                "TaxIDSource": {
                    "textValue": "00",
                    "optionText": "Application"
                },
                "Corporation": {
                    "textValue": "01",
                    "optionText": "Yes"
                },
                "SitusState": {
                    "textValue": "01",
                    "optionText": "AL"
                },
                "AlternateFederalEmployerIDNumber": null,
                "OriginalEffectiveDate": "2020-06-15T00:00:00Z",
                "CustomerStatus": {
                    "textValue": "02",
                    "optionText": "Active"
                },
                "ChangeEffectiveDate": "2020-06-15T00:00:00Z",
                "ReinstatementDate": null,
                "CustomerLegalName": "SS_Hist_02",
                "CancellationReasonDescription": null
            }
        ]
    }

Back to Top