| GET | /api/credit/claimfee | Get fee for claiming a job | Quote fee for claiming a job from a specified fleet |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerFleetId | model | integer | Yes | Id of the fleet the owns the job |
| TotalVehicles | model | integer | No | Number of vehicles on the job. Defaults to 1 |
| IsClaim | model | integer | No | The job is being claimed from vinDispatch. Defaults false |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Result | form | T | 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.
POST /jsv/reply/GetClaimFee HTTP/1.1
Host: vincarrier.cardeliverynetwork.com
Content-Type: text/jsv
Content-Length: length
{
customerFleetId: 0,
totalVehicles: 0,
isClaim: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
result:
{
activityCost: 0,
hasCredit: False,
networkCredit: 0,
remainingCredit: 0
}
}