GET api/Party/Search?SearchText={SearchText}&SearchByPartyIdOnly={SearchByPartyIdOnly}&RepDID={RepDID}&CustomerDID={CustomerDID}
Search open parties to determine which to associate an online order with
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| SearchText |
The text to search within some subset of PartyID, Party Description, and Host Name (based on configuration) |
string |
None. |
| SearchByPartyIdOnly |
Should the results be matched only on exact match of PartyID |
boolean |
None. |
| RepDID |
The Rep # that the order is currently associated with. May be used to restrict which parties can be returned, as there may be restrictions configured. |
string |
None. |
| CustomerDID |
If checking for an existing customer, this will be their Customer #. Unneeded if checking for someone who hasn't logged in. Whether this is set or not could impact which parties are returned, as there may be restrictions configured. |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
A list of Party models
Collection of IPartyInfoViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| PartyGUID | string |
None. |
|
| HostCustomerName | string |
None. |
|
| RepDID | string |
None. |
|
| RepDisplayName | string |
None. |
|
| PartyDate | date |
None. |
|
| PartyInfo | string |
None. |
|
| IsClosed | boolean |
None. |
|
| IsVoided | boolean |
None. |
|
| IsPartyPersisted | boolean |
None. |
|
| ProjectedAutoCloseDate | date |
None. |
Response Formats
application/xml, text/xml, application/json, text/json
Sample not available.