vinCARRIER

<back to all web services

ProxyDriver

Requires Authentication
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/driversCreates a driver resource on the authenticated fleet
ProxyDriver Parameters:
NameParameterData TypeRequiredDescription
RemoteIdOrIdpathstringNo
IsMobileRolebodybool?No
User Parameters:
NameParameterData TypeRequiredDescription
RemoteIdformstringNo
FirstNameformstringNo
LastNameformstringNo
UsernameformstringNo
PasswordformstringNo
EmailformstringNo
MobilePhoneformstringNo
LicenseNumberformstringNo
HomeFleetformFleetNo
ApiKeyformGuidNo
PhotoformstringNo
SignatureformstringNo
LastPositionformPositionNo
LastHeartbeatTimeformDateTime?No
LastHeartbeatRecencyformHeartbeatRecencyNo
LastLocationRecencyformHeartbeatRecencyNo
TagformstringNo
PrivacyPolicyAcceptedformdouble?No
LicenseIssuingStateformstringNo
LicenseIssuingCountryformstringNo
ReceivePODMailformboolNo
TimeZoneformstringNo
IsActiveformboolNo
FullNameformstringNo
ImportDisplayStringformstringNo
ApiEntityBase<T> Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
Fleet Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ScacformstringNo
DotNumberformstringNo
MultiTransportersformintNo
IsBrokerformboolNo
LogoUrlformstringNo
PodNoteformstringNo
SupplierTermsUrlformstringNo
CustomerTermsUrlformstringNo
ContactformContactDetailsNo
InsurancesformList<Insurance>No
DocumentsformList<Document>No
ContactDetails Parameters:
NameParameterData TypeRequiredDescription
QuickCodeformstringNo
InternalQuickCodeformstringNo
LocationCodeformstringNo
ContactformstringNo
GenderformGender?No
DateOfBirthformDateTime?No
OrganisationNameformstringNo
OrganizationNameformstringNo
AddressLinesformstringNo
CityformstringNo
StateRegionformstringNo
ZipPostCodeformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
BestGeoLookupStringformstringNo
EmailformstringNo
FaxformstringNo
PhoneformstringNo
MobilePhoneformstringNo
OtherPhoneformstringNo
NotesformstringNo
OpeningHoursformList<OpeningHours>No
CountryCodeformstringNo
ImportDisplayStringformstringNo
OpeningHours Parameters:
NameParameterData TypeRequiredDescription
DayformstringNo
OpenformstringNo
CloseformstringNo
AllowAfterHoursformboolNo
Insurance Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
CompanyformstringNo
AmountformintNo
ExpiryformDateTime?No
Document Parameters:
NameParameterData TypeRequiredDescription
UrlformstringNo
TypeformDocumentTypeNo
TitleformstringNo
CommentformstringNo
FriendlyTypeformstringNo
Position Parameters:
NameParameterData TypeRequiredDescription
TimeformDateTimeNo
LatitudeformdoubleNo
LongitudeformdoubleNo
AltitudeformfloatNo
HeadingformfloatNo
SpeedformfloatNo
ProxyDriver Parameters:
NameParameterData TypeRequiredDescription
RemoteIdOrIdpathstringNo
IsMobileRolebodybool?No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/ProxyDriver HTTP/1.1 
Host: vincarrier.cardeliverynetwork.com 
Content-Type: application/json
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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/"}],"documents":[{"url":"String","type":"Other","title":"String","comment":"String","friendlyType":"Other"}],"id":0},"apiKey":"00000000000000000000000000000000","photo":"String","signature":"String","lastPosition":{"time":"\/Date(-62135596800000-0000)\/","latitude":0,"longitude":0,"altitude":0,"heading":0,"speed":0},"lastHeartbeatTime":"\/Date(-62135596800000-0000)\/","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: application/json
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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/"}],"documents":[{"url":"String","type":"Other","title":"String","comment":"String","friendlyType":"Other"}],"id":0},"apiKey":"00000000000000000000000000000000","photo":"String","signature":"String","lastPosition":{"time":"\/Date(-62135596800000-0000)\/","latitude":0,"longitude":0,"altitude":0,"heading":0,"speed":0},"lastHeartbeatTime":"\/Date(-62135596800000-0000)\/","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}