GET Offer/Category/Lookup/{client}/{channel}/{broker}?effectiveDate={effectiveDate}
This API is used to retrieve a category grouping code by Client, Channel, and Broker.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| client |
The client identification code. |
string |
Required |
| channel |
The code specifying the sales channel. This parameter is optional; the client's default channel code will be used if none is provided. |
string |
Default value is |
| broker |
The code specifying the broker. This parameter is optional; the channel's default broker code will be used if none is provided. |
string |
Default value is |
| effectiveDate |
The configuration effective date to be used for the lookup. This parameter is optional; it exists to allow retrieval of a category grouping configuration for a specific date, but in most cases it should be omitted. |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
A string specifying the Category Grouping code. The http Location header is also used to provide the url for the Category API call that corresponds to this Category Grouping code.
System.Net.Http.HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | System.Version |
None. |
|
| Content | System.Net.Http.HttpContent |
None. |
|
| StatusCode | System.Net.HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | System.Net.Http.HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |