vinCARRIER

<back to all web services

GetClaimFee

Requires Authentication
The following routes are available for this service:
GET/api/credit/claimfeeGet fee for claiming a jobQuote fee for claiming a job from a specified fleet
GetClaimFee Parameters:
NameParameterData TypeRequiredDescription
CustomerFleetIdmodelintegerYesId of the fleet the owns the job
TotalVehiclesmodelintegerNoNumber of vehicles on the job. Defaults to 1
IsClaimmodelintegerNoThe job is being claimed from vinDispatch. Defaults false
ApiResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformTNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetClaimFee HTTP/1.1 
Host: vincarrier.cardeliverynetwork.com 
Content-Type: application/xml
Content-Length: length

<GetClaimFee xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VinDeliver.ServiceModel.Model">
  <CustomerFleetId>0</CustomerFleetId>
  <TotalVehicles>0</TotalVehicles>
  <IsClaim>false</IsClaim>
</GetClaimFee>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ApiResponseOfCreditChangeDetails4LeyMRaI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VinDeliver.ServiceModel.Model">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <ActivityCost>0</ActivityCost>
    <HasCredit>false</HasCredit>
    <NetworkCredit>0</NetworkCredit>
    <RemainingCredit>0</RemainingCredit>
  </Result>
</ApiResponseOfCreditChangeDetails4LeyMRaI>