CatalogRequest
- Timothy Armstrong
Used to get a list of cards available for the program calling the API .
This method accepts an object of type CatalogRequest and sends back the object with the updated information in it. It will contain as many CatalogItem objects as needed to represent every card model that this client is authorized to sell.
Required Input Parameters
Field |
Data Type |
Required |
Description |
Security Code |
GUID |
Yes |
|
ProgramID |
INT |
Yes |
|
Output Parameters
Field |
DataType |
Required |
Description |
CategoryID |
INT |
Yes |
|
CategoryName |
VARCHAR(50) |
Yes |
|
CardName |
VARCHAR(50) |
Yes |
|
ScopeOfWork |
VARCHAR(MAX) |
Yes |
Description on the back of the card |
Disclaimers |
Array of |
Yes |
Items not included with card such as difficult vehicle |
CardModel |
VARCHAR(20) |
Yes |
|
UPC |
VARCHAR(20) |
Yes |
|
Cost |
MONEY or FLOAT |
Yes |
Cost to client |
Status |
BIT |
Yes |
1-Active / 0-Inactive |
Errors |
Class |
No |
If no errors were encountered, the class will include one message with error code of 0. |
Error.Code |
INT |
Yes |
Code that describes the error that occurred during processing |
Error.Message |
VARCHAR(100) |
Yes |
Message that corresponds to the code returned |