Get a specific group customer
get
/PASService/rest/services/groupCustomers/{id}
Gets a group customer based on the specified group customer Id
Request
Path Parameters
-
id: string
Pattern:
\{?[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}\}?Group Customer Id
Response
Supported Media Types
- application/json
Default Response
successful operation
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 "Accept: application/json" -u username:password "server:port/PASService/rest/services/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/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": {},
"codes": [
{
"codeName": "AsCodeClassGroupType",
"codeValue": "02",
"longDescription": "Eligibility",
"shortDescription": "Eligibility"
},
{
"codeName": "ASCODEENTITYTYPE",
"codeValue": "GROUPCUST",
"longDescription": "GroupCustomer",
"shortDescription": "GroupCustomer"
},
{
"codeName": "AsCodePrimaryRelationshipType",
"codeValue": "Employment",
"longDescription": "Employment",
"shortDescription": "Employment"
},
{
"codeName": "AsCodePrimaryRelationshipType",
"codeValue": "Employment",
"longDescription": "Employment",
"shortDescription": "Employment"
},
{
"codeName": "AsCodeClientType",
"codeValue": "20",
"longDescription": "Group Customer",
"shortDescription": "Group Customer"
}
],
"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"
},
"IndustryCode": {
"textValue": "327910",
"optionText": "Abrasive Product Manufacturing - 327910"
},
"TaxIDSource": {
"textValue": "00",
"optionText": "Application"
},
"RadioTest": {
"textValue": "01",
"optionText": "Yes"
},
"ComboField": {
"textValue": "01",
"optionText": "Savings"
},
"Corporation": {
"textValue": "00",
"optionText": "No"
},
"SitusState": {
"textValue": "01",
"optionText": "AL"
},
"OriginalEffectiveDate": "2015-08-04T00:00:00Z",
"CustomerStatus": {
"textValue": "01",
"optionText": "Incomplete"
},
"ChangeEffectiveDate": "2015-08-04T00:00:00Z",
"CustomerLegalName": "TestCustNutral",
}
}
"