vinCARRIER

VehicleProxy

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:
Name	Parameter	Data Type	Required	Description
JobIdOrLoadId	path	string	No
VinOrVehicleId	path	string	No

**Vehicle** Parameters:
Name	Parameter	Data Type	Required
Registration	form	string	No
Vin	form	string	No
Make	form	string	No
Model	form	string	No
Variant	form	string	No
Color	form	string	No
Weight	form	int	No
LoadDirection	form	VehicleLoadDirection	No
LoadLevel	form	VehicleLoadLevel	No
LoadPosition	form	int	No
Location	form	string	No
MovementNumber	form	string	No
Notes	form	string	No
SignedBy	form	string	No
SignoffComment	form	string	No
Signature	form	string	No
DamageClaimSignedBy	form	string	No
DamageClaimSignoffComment	form	string	No
DamageClaimSignature	form	Document	No
DamageClaimDate	form	DateTime?	No
Status	form	VehicleStatus	No
NonCompletionReason	form	string	No
PrePickupDamage	form	List<DamageItem>	No
DamageAtPickup	form	List<DamageItem>	No
DamageAtDropoff	form	List<DamageItem>	No
DamageClaims	form	List<DamageClaim>	No
DamageClaimExtras	form	List<DamageClaim>	No
Photos	form	List<Document>	No
DutyOfCare	form	Dictionary<string, string>	No
Paperwork	form	Dictionary<string, string>	No
CdxShipmentId	form	int?	No
SenderTripId	form	string	No
IsPickedUp	form	bool	No
IsDelivered	form	bool	No

**ApiEntityBase<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No

**Document** Parameters:
Name	Parameter	Data Type	Required
Url	form	string	No
Type	form	DocumentType	No
Title	form	string	No
Comment	form	string	No
FriendlyType	form	string	No

**DamageItem** Parameters:
Name	Parameter	Data Type	Required
Area	form	DamageArea	No
Type	form	DamageType	No
Severity	form	DamageSeverity	No
Description	form	string	No
PhotoURL	form	List<string>	No
AiagCode	form	string	No

**DamageProperty** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	No
Description	form	string	No

**DamageClaim** Parameters:
Name	Parameter	Data Type	Required
Area	form	DamageArea	No
Type	form	DamageType	No
Severity	form	DamageSeverity	No
Description	form	string	No
Documents	form	List<Document>	No

**DamageProperty** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	No
Description	form	string	No

**Vehicle** Parameters:
Name	Parameter	Data Type	Required
Registration	form	string	No
Vin	form	string	No
Make	form	string	No
Model	form	string	No
Variant	form	string	No
Color	form	string	No
Weight	form	int	No
LoadDirection	form	VehicleLoadDirection	No
LoadLevel	form	VehicleLoadLevel	No
LoadPosition	form	int	No
Location	form	string	No
MovementNumber	form	string	No
Notes	form	string	No
SignedBy	form	string	No
SignoffComment	form	string	No
Signature	form	string	No
DamageClaimSignedBy	form	string	No
DamageClaimSignoffComment	form	string	No
DamageClaimSignature	form	Document	No
DamageClaimDate	form	DateTime?	No
Status	form	VehicleStatus	No
NonCompletionReason	form	string	No
PrePickupDamage	form	List<DamageItem>	No
DamageAtPickup	form	List<DamageItem>	No
DamageAtDropoff	form	List<DamageItem>	No
DamageClaims	form	List<DamageClaim>	No
DamageClaimExtras	form	List<DamageClaim>	No
Photos	form	List<Document>	No
DutyOfCare	form	Dictionary<string, string>	No
Paperwork	form	Dictionary<string, string>	No
CdxShipmentId	form	int?	No
SenderTripId	form	string	No
IsPickedUp	form	bool	No
IsDelivered	form	bool	No

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

HTTP + JSV

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

POST /jsv/reply/VehicleProxy HTTP/1.1 
Host: vincarrier.cardeliverynetwork.com 
Content-Type: text/jsv
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: 0001-01-01,
	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/jsv
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: 0001-01-01,
	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
}