| PUT,OPTIONS | /v1/dispatch/rates/zone |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Zone | body | DispatchZoneRateView | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Zone | form | string | No | |
| DispatchZoneRateID | form | int? | No | |
| Base | form | decimal? | No | |
| PerBag | form | decimal? | No | |
| PremiumUpliftPct | form | decimal? | No | |
| Drivers | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Config | form | DispatchRateConfigView | No | |
| Lanes | form | List<DispatchLaneRateView> | No | |
| Zones | form | List<DispatchZoneRateView> | No | |
| Plans | form | List<DispatchPayPlanView> | No | |
| Repriced | form | int? | No | |
| StillNoRevenue | form | int? | No | |
| StillNoPay | form | int? | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FuelSurchargePct | form | decimal | No | |
| TransportPerMile | form | decimal | No | |
| TransportJobMin | form | decimal | No | |
| TransportEnclosedUpliftPct | form | decimal | No | |
| OdBase | form | decimal | No | |
| OdPerBag | form | decimal | No | |
| OdPremiumUpliftPct | form | decimal | No | |
| HaulBasis | form | string | No | |
| Facility | form | string | No | |
| Unit | form | string | No | |
| LoadQty | form | decimal | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DispatchSiteID | form | int? | No | |
| DispatchSupplierID | form | int? | No | |
| SourceLabel | form | string | No | |
| SupplierName | form | string | No | |
| DispatchLaneRateID | form | int? | No | |
| Miles | form | decimal? | No | |
| RatePerTon | form | decimal? | No | |
| RatePerLoad | form | decimal? | No | |
| RatePerTonMile | form | decimal? | No | |
| RatePerHour | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DispatchPayPlanID | form | int | No | |
| Name | form | string | No | |
| Basis | form | string | No | |
| Rate | form | decimal | No | |
| Rate2 | form | decimal? | No | |
| EffectiveDate | form | DateTime? | No | |
| IsActive | form | bool | No | |
| Drivers | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /v1/dispatch/rates/zone HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Zone:
{
Zone: String,
DispatchZoneRateID: 0,
Base: 0,
PerBag: 0,
PremiumUpliftPct: 0,
Drivers: 0
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Config:
{
FuelSurchargePct: 0,
TransportPerMile: 0,
TransportJobMin: 0,
TransportEnclosedUpliftPct: 0,
OdBase: 0,
OdPerBag: 0,
OdPremiumUpliftPct: 0,
HaulBasis: String,
Facility: String,
Unit: String,
LoadQty: 0
},
Lanes:
[
{
DispatchSiteID: 0,
DispatchSupplierID: 0,
SourceLabel: String,
SupplierName: String,
DispatchLaneRateID: 0,
Miles: 0,
RatePerTon: 0,
RatePerLoad: 0,
RatePerTonMile: 0,
RatePerHour: 0
}
],
Zones:
[
{
Zone: String,
DispatchZoneRateID: 0,
Base: 0,
PerBag: 0,
PremiumUpliftPct: 0,
Drivers: 0
}
],
Plans:
[
{
DispatchPayPlanID: 0,
Name: String,
Basis: String,
Rate: 0,
Rate2: 0,
EffectiveDate: 0001-01-01,
IsActive: False,
Drivers: 0
}
],
Repriced: 0,
StillNoRevenue: 0,
StillNoPay: 0,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}