Get list of group customers
get
/PASService/rest/services/groupCustomers
Gets the latest 100 group customers
Request
Query Parameters
-
expand(optional): string
addresses,codes
-
q(optional): string
Search Parameter
Response
Supported Media Types
- application/json
Default Response
successful operation
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 "Accept: application/json" -u username:password "server:port/PASService/rest/services/groupCustomers"
Example Response Body
The following shows an example of the response body in JSON format:
"{ "count": 83, "offset": 0, "limit": 100, "groupCustomers": [ { "links": [ { "href": "http://server:port/PASService/rest/services/groupCustomers/D289E962-EB6E-4E21-A234-8BA0F2E44796", "rel": "self", "mediaType": "application/json", "method": "GET" }, { "href": "http://server:port/PASService/rest/services/groupCustomers/0A6910CC-CD45-4BD1-9D1E-FFF4CE9C5BCD/addresses", "rel": "addresses", "mediaType": "application/json", "method": "GET" }, { "href": "http://server:port/PASService/rest/services/codes?codeName=ClassGroupType&codeValue=02", "rel": "codes/enrollmentClassGroup", "mediaType": "application/json", "method": "GET" }, { "href": "http://server:port/PASService/rest/services/codes?codeName=ENTITYTYPE&codeValue=GROUPCUST", "rel": "codes/entityTypeCode", "mediaType": "application/json", "method": "GET" }, { "href": "http://server:port/PASService/rest/services/codes?codeName=PrimaryRelationshipType&codeValue=Employment", "rel": "codes/hierarchyRelationship", "mediaType": "application/json", "method": "GET" }, { "href": "http://server:port/PASService/rest/services/codes?codeName=PrimaryRelationshipType&codeValue=Employment", "rel": "codes/primaryEnrollmentRelationship", "mediaType": "application/json", "method": "GET" }, { "href": "http://server:port/PASService/rest/services/codes?codeName=ClientType&codeValue=20", "rel": "codes/type", "mediaType": "application/json", "method": "GET" } ], "multiFields": {}, "companyName": "TestCustNutral", "legalResidenceCountryCode": "CA", "entityTypeCode": "GROUPCUST", "customerNumber": "GC103305", "primaryEnrollmentRelationship": "Employment", "enrollmentClassGroup": "02", "allowedForCopy": "No", "hierarchyRelationship": "Employment", "clientId": "0A6910CC-CD45-4BD1-9D1E-FFF4CE9C5BCD", "taxId": "129056909", "type": "20", "groupCustomerId": "D289E962-EB6E-4E21-A234-8BA0F2E44796", "CancellationReason": { "textValue": "04", "optionText": "Reason 1" }, "TaxIDSource": { "textValue": "00", "optionText": "Application" }, "IndustryCode": { "textValue": "327910", "optionText": "Abrasive Product Manufacturing - 327910" }, "RadioTest": { "textValue": "01", "optionText": "Yes" }, "Corporation": { "textValue": "00", "optionText": "No" }, "ComboField": { "textValue": "01", "optionText": "Savings" }, "SitusState": { "textValue": "01", "optionText": "AL" }, "OriginalEffectiveDate": "2015-08-04T00:00:00Z", "CustomerStatus": { "textValue": "01", "optionText": "Incomplete" }, "ChangeEffectiveDate": "2015-08-04T00:00:00Z", "ReinstatementDate": null, "CustomerLegalName": "TestCustNutral", } "