GroupCustomers Resource

Returns Group Customers. It includes the below APIs:

• Get All Group Customers
• Get a Specific Group Customer
• Get Group Customer with Search Criteria

Get All Group Customers

Gets the list of Group Customers. The list will contain data from AsGroupCustomer and AsClient. Address Links will be provided similar to /clients search.

Data to be included from AsGroupCustomer table:

GroupCustomerGuid,ClientGuid,CustomerNumber,PrimaryEnrollmentRelationShip. 

All client details, fixed, dynamic and multivalue fields will also be returned for the clientguid.

Resource/Request URI

http://server:port/PASService/rest/services/groupCustomer

URI that allows to expand sub resources

http://server:port/PASService/rest/services/groupCustomer?expand=

Method

GET

Get a Specific GroupCustomer

Returns GroupCustomer details with given ID. The ID here is the Unique GUID in AsGroupCustomer. The response will include AsGroupcustomer fixed field data.

GroupCustomerGuid, ClientGuid, CustomerNumber, PrimaryEnrollmentRelationShip 

and associated Client fields such as client fixed fields, dynamic fields, and multi value fields will be returned.

Note: If the unique ID requested is not EntityTypeCode of GroupCustomer, HTTP error 405 will be thrown with message "Method Not Allowed and with Details "Not a Valid GroupCustomer identifier" will be thrown.

Resource/Request URI

http://server:port/PASService/rest/services/groupCustomer/{id}

Method

GET

Get Group Customer with Search Criteria

Returns group customer based on query parameter. Only fixed fields in AsGroupCustomer and AsClient are included in the q query.

Example

Example 1:.../groupCustomer?q=customerNumber eq "PLM1234"

Example 2:.../groupCustomer?q=clientId eq "CE22E7DF-EE42-4ADF-955C-6515107EC1A5"

Resource/Request URI

http://server:port/PASService/rest/services/groupCustomer?q=

Method

GET