vinCARRIER

ProxyDriver

The following routes are available for this service:
PUT	/api/vind2/openapi/drivers/{RemoteIdOrId}	Updates the driver of the specified RemoteId OR Id
GET	/api/vind2/openapi/drivers/{RemoteIdOrId}	Gets the driver of the specified RemoteId OR Id
POST	/api/vind2/openapi/drivers	Creates a driver resource on the authenticated fleet

**ProxyDriver** Parameters:
Name	Parameter	Data Type	Required	Description
RemoteIdOrId	path	string	No
IsMobileRole	body	bool?	No

**User** Parameters:
Name	Parameter	Data Type	Required
RemoteId	form	string	No
FirstName	form	string	No
LastName	form	string	No
Username	form	string	No
Password	form	string	No
Email	form	string	No
MobilePhone	form	string	No
LicenseNumber	form	string	No
HomeFleet	form	Fleet	No
ApiKey	form	Guid	No
Photo	form	string	No
Signature	form	string	No
LastPosition	form	Position	No
LastHeartbeatTime	form	DateTime?	No
LastHeartbeatRecency	form	HeartbeatRecency	No
LastLocationRecency	form	HeartbeatRecency	No
Tag	form	string	No
PrivacyPolicyAccepted	form	double?	No
LicenseIssuingState	form	string	No
LicenseIssuingCountry	form	string	No
ReceivePODMail	form	bool	No
TimeZone	form	string	No
IsActive	form	bool	No
FullName	form	string	No
ImportDisplayString	form	string	No

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

**Fleet** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Scac	form	string	No
DotNumber	form	string	No
MultiTransporters	form	int	No
IsBroker	form	bool	No
LogoUrl	form	string	No
PodNote	form	string	No
SupplierTermsUrl	form	string	No
CustomerTermsUrl	form	string	No
Contact	form	ContactDetails	No
Insurances	form	List<Insurance>	No
Documents	form	List<Document>	No

**ContactDetails** Parameters:
Name	Parameter	Data Type	Required
QuickCode	form	string	No
InternalQuickCode	form	string	No
LocationCode	form	string	No
Contact	form	string	No
Gender	form	Gender?	No
DateOfBirth	form	DateTime?	No
OrganisationName	form	string	No
OrganizationName	form	string	No
AddressLines	form	string	No
City	form	string	No
StateRegion	form	string	No
ZipPostCode	form	string	No
Latitude	form	double	No
Longitude	form	double	No
BestGeoLookupString	form	string	No
Email	form	string	No
Fax	form	string	No
Phone	form	string	No
MobilePhone	form	string	No
OtherPhone	form	string	No
Notes	form	string	No
OpeningHours	form	List<OpeningHours>	No
CountryCode	form	string	No
ImportDisplayString	form	string	No

**OpeningHours** Parameters:
Name	Parameter	Data Type	Required
Day	form	string	No
Open	form	string	No
Close	form	string	No
AllowAfterHours	form	bool	No

**Insurance** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Company	form	string	No
Amount	form	int	No
Expiry	form	DateTime?	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

**Position** Parameters:
Name	Parameter	Data Type	Required
Time	form	DateTime	No
Latitude	form	double	No
Longitude	form	double	No
Altitude	form	float	No
Heading	form	float	No
Speed	form	float	No

**ProxyDriver** Parameters:
Name	Parameter	Data Type	Required	Description
RemoteIdOrId	path	string	No
IsMobileRole	body	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/ProxyDriver HTTP/1.1 
Host: vincarrier.cardeliverynetwork.com 
Content-Type: text/jsv
Content-Length: length

{
	remoteIdOrId: String,
	isMobileRole: False,
	remoteId: String,
	firstName: String,
	lastName: String,
	username: String,
	password: String,
	email: String,
	mobilePhone: String,
	licenseNumber: String,
	homeFleet: 
	{
		name: String,
		scac: String,
		dotNumber: String,
		multiTransporters: 0,
		isBroker: False,
		logoUrl: String,
		podNote: String,
		supplierTermsUrl: String,
		customerTermsUrl: String,
		contact: 
		{
			quickCode: String,
			internalQuickCode: String,
			locationCode: String,
			contact: String,
			gender: Male,
			dateOfBirth: 0001-01-01,
			organisationName: String,
			organizationName: String,
			addressLines: String,
			city: String,
			stateRegion: String,
			zipPostCode: String,
			latitude: 0,
			longitude: 0,
			bestGeoLookupString: String,
			email: String,
			fax: String,
			phone: String,
			mobilePhone: String,
			otherPhone: String,
			notes: String,
			openingHours: 
			[
				{
					day: String,
					open: String,
					close: String,
					allowAfterHours: False
				}
			],
			countryCode: String,
			importDisplayString: "String, String, String, String",
			id: 0
		},
		insurances: 
		[
			{
				name: String,
				company: String,
				amount: 0,
				expiry: 0001-01-01
			}
		],
		documents: 
		[
			{
				url: String,
				type: Other,
				title: String,
				comment: String,
				friendlyType: Other
			}
		],
		id: 0
	},
	apiKey: 00000000000000000000000000000000,
	photo: String,
	signature: String,
	lastPosition: 
	{
		time: 0001-01-01,
		latitude: 0,
		longitude: 0,
		altitude: 0,
		heading: 0,
		speed: 0
	},
	lastHeartbeatTime: 0001-01-01,
	lastHeartbeatRecency: Hrs1,
	lastLocationRecency: Hrs1,
	tag: String,
	privacyPolicyAccepted: 0,
	licenseIssuingState: String,
	licenseIssuingCountry: String,
	receivePODMail: False,
	timeZone: String,
	isActive: False,
	fullName: String String,
	importDisplayString: String String,
	id: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	remoteIdOrId: String,
	isMobileRole: False,
	remoteId: String,
	firstName: String,
	lastName: String,
	username: String,
	password: String,
	email: String,
	mobilePhone: String,
	licenseNumber: String,
	homeFleet: 
	{
		name: String,
		scac: String,
		dotNumber: String,
		multiTransporters: 0,
		isBroker: False,
		logoUrl: String,
		podNote: String,
		supplierTermsUrl: String,
		customerTermsUrl: String,
		contact: 
		{
			quickCode: String,
			internalQuickCode: String,
			locationCode: String,
			contact: String,
			gender: Male,
			dateOfBirth: 0001-01-01,
			organisationName: String,
			organizationName: String,
			addressLines: String,
			city: String,
			stateRegion: String,
			zipPostCode: String,
			latitude: 0,
			longitude: 0,
			bestGeoLookupString: String,
			email: String,
			fax: String,
			phone: String,
			mobilePhone: String,
			otherPhone: String,
			notes: String,
			openingHours: 
			[
				{
					day: String,
					open: String,
					close: String,
					allowAfterHours: False
				}
			],
			countryCode: String,
			importDisplayString: "String, String, String, String",
			id: 0
		},
		insurances: 
		[
			{
				name: String,
				company: String,
				amount: 0,
				expiry: 0001-01-01
			}
		],
		documents: 
		[
			{
				url: String,
				type: Other,
				title: String,
				comment: String,
				friendlyType: Other
			}
		],
		id: 0
	},
	apiKey: 00000000000000000000000000000000,
	photo: String,
	signature: String,
	lastPosition: 
	{
		time: 0001-01-01,
		latitude: 0,
		longitude: 0,
		altitude: 0,
		heading: 0,
		speed: 0
	},
	lastHeartbeatTime: 0001-01-01,
	lastHeartbeatRecency: Hrs1,
	lastLocationRecency: Hrs1,
	tag: String,
	privacyPolicyAccepted: 0,
	licenseIssuingState: String,
	licenseIssuingCountry: String,
	receivePODMail: False,
	timeZone: String,
	isActive: False,
	fullName: String String,
	importDisplayString: String String,
	id: 0
}