vinCARRIER

<back to all web services

VehicleProxy

Requires Authentication
The following routes are available for this service:
POST/api/vind2/openapi/jobs/{JobIdOrLoadId}/vehicles
PUT/api/vind2/openapi/jobs/{JobIdOrLoadId}/vehicles/{VinOrVehicleId}
DELETE/api/vind2/openapi/jobs/{JobIdOrLoadId}/vehicles/{VinOrVehicleId}
GET/api/vind2/openapi/jobs/{jobIdOrLoadId}/vehicles/{VinOrVehicleId}
VehicleProxy Parameters:
NameParameterData TypeRequiredDescription
JobIdOrLoadIdpathstringNo
VinOrVehicleIdpathstringNo
Vehicle Parameters:
NameParameterData TypeRequiredDescription
RegistrationformstringNo
VinformstringNo
MakeformstringNo
ModelformstringNo
VariantformstringNo
ColorformstringNo
WeightformintNo
LoadDirectionformVehicleLoadDirectionNo
LoadLevelformVehicleLoadLevelNo
LoadPositionformintNo
LocationformstringNo
MovementNumberformstringNo
NotesformstringNo
SignedByformstringNo
SignoffCommentformstringNo
SignatureformstringNo
DamageClaimSignedByformstringNo
DamageClaimSignoffCommentformstringNo
DamageClaimSignatureformDocumentNo
DamageClaimDateformDateTime?No
StatusformVehicleStatusNo
NonCompletionReasonformstringNo
PrePickupDamageformList<DamageItem>No
DamageAtPickupformList<DamageItem>No
DamageAtDropoffformList<DamageItem>No
DamageClaimsformList<DamageClaim>No
DamageClaimExtrasformList<DamageClaim>No
PhotosformList<Document>No
DutyOfCareformDictionary<string, string>No
PaperworkformDictionary<string, string>No
CdxShipmentIdformint?No
SenderTripIdformstringNo
IsPickedUpformboolNo
IsDeliveredformboolNo
ApiEntityBase<T> Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
Document Parameters:
NameParameterData TypeRequiredDescription
UrlformstringNo
TypeformDocumentTypeNo
TitleformstringNo
CommentformstringNo
FriendlyTypeformstringNo
DamageItem Parameters:
NameParameterData TypeRequiredDescription
AreaformDamageAreaNo
TypeformDamageTypeNo
SeverityformDamageSeverityNo
DescriptionformstringNo
PhotoURLformList<string>No
AiagCodeformstringNo
DamageProperty Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
DescriptionformstringNo
DamageClaim Parameters:
NameParameterData TypeRequiredDescription
AreaformDamageAreaNo
TypeformDamageTypeNo
SeverityformDamageSeverityNo
DescriptionformstringNo
DocumentsformList<Document>No
DamageProperty Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
DescriptionformstringNo
Vehicle Parameters:
NameParameterData TypeRequiredDescription
RegistrationformstringNo
VinformstringNo
MakeformstringNo
ModelformstringNo
VariantformstringNo
ColorformstringNo
WeightformintNo
LoadDirectionformVehicleLoadDirectionNo
LoadLevelformVehicleLoadLevelNo
LoadPositionformintNo
LocationformstringNo
MovementNumberformstringNo
NotesformstringNo
SignedByformstringNo
SignoffCommentformstringNo
SignatureformstringNo
DamageClaimSignedByformstringNo
DamageClaimSignoffCommentformstringNo
DamageClaimSignatureformDocumentNo
DamageClaimDateformDateTime?No
StatusformVehicleStatusNo
NonCompletionReasonformstringNo
PrePickupDamageformList<DamageItem>No
DamageAtPickupformList<DamageItem>No
DamageAtDropoffformList<DamageItem>No
DamageClaimsformList<DamageClaim>No
DamageClaimExtrasformList<DamageClaim>No
PhotosformList<Document>No
DutyOfCareformDictionary<string, string>No
PaperworkformDictionary<string, string>No
CdxShipmentIdformint?No
SenderTripIdformstringNo
IsPickedUpformboolNo
IsDeliveredformboolNo

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

HTTP + CSV

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

POST /csv/reply/VehicleProxy HTTP/1.1 
Host: vincarrier.cardeliverynetwork.com 
Content-Type: text/csv
Content-Length: length

{"jobIdOrLoadId":"String","vinOrVehicleId":"String","registration":"String","vin":"String","make":"String","model":"String","variant":"String","color":"String","weight":0,"loadDirection":"NotRecorded","loadLevel":"NotRecorded","loadPosition":0,"location":"String","movementNumber":"String","notes":"String","signedBy":"String","signoffComment":"String","signature":"String","damageClaimSignedBy":"String","damageClaimSignoffComment":"String","damageClaimSignature":{"url":"String","type":"Other","title":"String","comment":"String","friendlyType":"Other"},"damageClaimDate":"\/Date(-62135596800000-0000)\/","status":"PrePickup","nonCompletionReason":"String","prePickupDamage":[{"area":{"code":"String","description":"String"},"type":{"code":"String","description":"String"},"severity":{"code":"String","description":"String"},"description":"String","photoURL":["String"],"aiagCode":"StringStringString","id":0}],"damageAtPickup":[{"area":{"code":"String","description":"String"},"type":{"code":"String","description":"String"},"severity":{"code":"String","description":"String"},"description":"String","photoURL":["String"],"aiagCode":"StringStringString","id":0}],"damageAtDropoff":[{"area":{"code":"String","description":"String"},"type":{"code":"String","description":"String"},"severity":{"code":"String","description":"String"},"description":"String","photoURL":["String"],"aiagCode":"StringStringString","id":0}],"damageClaims":[{"area":{"code":"String","description":"String"},"type":{"code":"String","description":"String"},"severity":{"code":"String","description":"String"},"description":"String","documents":[{"url":"String","type":"Other","title":"String","comment":"String","friendlyType":"Other"}],"id":0}],"damageClaimExtras":[{"area":{"code":"String","description":"String"},"type":{"code":"String","description":"String"},"severity":{"code":"String","description":"String"},"description":"String","documents":[{"url":"String","type":"Other","title":"String","comment":"String","friendlyType":"Other"}],"id":0}],"photos":[{"url":"String","type":"Other","title":"String","comment":"String","friendlyType":"Other"}],"dutyOfCare":{"String":"String"},"paperwork":{"String":"String"},"cdxShipmentId":0,"senderTripId":"String","isPickedUp":false,"isDelivered":false,"id":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"registration":"String","vin":"String","make":"String","model":"String","variant":"String","color":"String","weight":0,"loadDirection":"NotRecorded","loadLevel":"NotRecorded","loadPosition":0,"location":"String","movementNumber":"String","notes":"String","signedBy":"String","signoffComment":"String","signature":"String","damageClaimSignedBy":"String","damageClaimSignoffComment":"String","damageClaimSignature":{"url":"String","type":"Other","title":"String","comment":"String","friendlyType":"Other"},"damageClaimDate":"\/Date(-62135596800000-0000)\/","status":"PrePickup","nonCompletionReason":"String","prePickupDamage":[{"area":{"code":"String","description":"String"},"type":{"code":"String","description":"String"},"severity":{"code":"String","description":"String"},"description":"String","photoURL":["String"],"aiagCode":"StringStringString","id":0}],"damageAtPickup":[{"area":{"code":"String","description":"String"},"type":{"code":"String","description":"String"},"severity":{"code":"String","description":"String"},"description":"String","photoURL":["String"],"aiagCode":"StringStringString","id":0}],"damageAtDropoff":[{"area":{"code":"String","description":"String"},"type":{"code":"String","description":"String"},"severity":{"code":"String","description":"String"},"description":"String","photoURL":["String"],"aiagCode":"StringStringString","id":0}],"damageClaims":[{"area":{"code":"String","description":"String"},"type":{"code":"String","description":"String"},"severity":{"code":"String","description":"String"},"description":"String","documents":[{"url":"String","type":"Other","title":"String","comment":"String","friendlyType":"Other"}],"id":0}],"damageClaimExtras":[{"area":{"code":"String","description":"String"},"type":{"code":"String","description":"String"},"severity":{"code":"String","description":"String"},"description":"String","documents":[{"url":"String","type":"Other","title":"String","comment":"String","friendlyType":"Other"}],"id":0}],"photos":[{"url":"String","type":"Other","title":"String","comment":"String","friendlyType":"Other"}],"dutyOfCare":{"String":"String"},"paperwork":{"String":"String"},"cdxShipmentId":0,"senderTripId":"String","isPickedUp":false,"isDelivered":false,"id":0}