CommodityService
First available in SystemsLink: 2017.3.0
CommodityService provides methods for retrieving, creating, and searching commodities.
The commodity master file consists of profiles of each kind of cargo transported by your company. Commodity profiles are recorded in the Commodity Profile window.
Endpoint Address: [SystemsLinkRootUrl]/CommodityService.svc
Methods
| Method Name | Parameters | C# return type | Description | |
|---|---|---|---|---|
Name |
C# data type |
|||
Delete |
commodityId |
string |
void |
Delete the specified commodity. |
Get |
commodityId |
string |
Commodity |
Retrieve the specified commodity by commodity Id. |
GetActiveCommodities |
List<Commodity> |
Retrieve all active commodities. |
||
GetCommodityByName |
commodityName |
string |
Commodity |
Retrieve the specified commodity by commodity name. |
NewItem |
Commodity |
Create a new commodity. |
||
Save |
commodity |
Commodity |
Commodity |
Save a commodity. |
Search |
filter |
FilterObjectOfCommodity |
FilterObjectOfCommodity |
Retrieve a paged result of commodities, using parameters set in the filter object. |
Properties and column mapping
| Columns in Database column Name are from the commodity database table. |
| Property | Database column | Comments | ||
|---|---|---|---|---|
Name |
C# data type |
Name |
Data type |
|
AlternateId |
string |
cmd_cust_num |
varchar(20) |
|
CodeNum |
int? |
cmd_code_num |
int |
|
CommodityId |
string |
cmd_code |
varchar(8) |
|
ControlData |
string |
Not mapped to database. |
||
CreatedBy |
string |
cmd_createdby |
varchar(20) |
|
CreatedDateTime |
DateTime? |
cmd_createdate |
datetime |
|
DefaultHeight |
decimal |
cmd_default_height |
float |
|
DefaultLength |
decimal |
cmd_default_length |
float |
|
DefaultWeight |
decimal |
cmd_default_weight |
float |
|
DefaultWidth |
decimal |
cmd_default_width |
float |
|
IsActive |
bool? |
cmd_active |
char(1) |
|
IsHazardous |
bool? |
cmd_hazardous |
int |
|
Misc1 |
string |
cmd_misc1 |
varchar(254) |
|
Misc2 |
string |
cmd_misc2 |
varchar(254) |
|
Misc3 |
string |
cmd_misc3 |
varchar(254) |
|
Misc4 |
string |
cmd_misc4 |
varchar(254) |
|
Name |
string |
cmd_name |
varchar(60) |
|
NMFCClass |
string |
cmd_NMFC_Class |
varchar(6) |
|
RuleData |
List<ConcurrencyFieldRule?> |
Not mapped to database. |
||
TMWClass1 |
string |
cmd_class |
varchar(8) |
|
TMWClass2 |
string |
cmd_class2 |
varchar(8) |
|
UpdateDateTime |
DateTime? |
cmd_updateddate |
datetime |
|
UpdatedBy |
string |
cmd_updatedby |
varchar(20) |
|