GET api/Vehicle
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
VehicleApiResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Vehicles | Collection of VehicleApi |
None. |
|
| RequestStatus | RequestStatus |
None. |
Response Formats
application/json, text/json
Sample:
{
"Vehicles": [
{
"Id": 1,
"CallSign": "sample string 2",
"CarrierId": 3,
"Carrier": {
"Id": 1,
"Name": "sample string 2",
"CsvTemplateName": "sample string 3",
"EmailAddress": "sample string 4",
"Address1": "sample string 5",
"Address2": "sample string 6",
"ContactName": "sample string 7",
"ContactEmail": "sample string 8",
"IsAttachedPdfToEmail": true,
"IsSendDailyEmail": true,
"IsSendWeeklyEmail": true,
"IsSendMonthlyEmail": true,
"PostCode": "sample string 13",
"PhoneNo": "sample string 14",
"Status": true,
"TownOrCity": "sample string 16",
"DocketConfirmationInterfaceId": 1,
"DocketConfirmationInterface": {
"Id": 1,
"Description": "sample string 2",
"BaseUrl": "sample string 3",
"Status": true,
"IsServicePaused": true,
"InterfaceTypeCode": "sample string 6",
"CreatedBy": "sample string 7",
"CreatedOn": "2025-12-19T06:04:55.8848215-06:00",
"ModifiedBy": "sample string 8",
"ModifiedOn": "2025-12-19T06:04:55.8848215-06:00",
"RowVersion": "QEA="
},
"MessageUrl": "sample string 17",
"IsSendMessage": true,
"IsShowInKiosk": true,
"CarrierShortCode": "sample string 20",
"MasterId": 21,
"QuickCode": "sample string 22",
"SourceChannel": "sample string 23",
"CreatedBy": "sample string 24",
"CreatedOn": "2025-12-19T06:04:55.8848215-06:00",
"ModifiedBy": "sample string 25",
"ModifiedOn": "2025-12-19T06:04:55.8848215-06:00",
"RowVersion": "QEA="
},
"RegistrationNo": "sample string 4",
"Status": true,
"AllowAutoTareUpdate": true,
"VehicleConfigurationId": 1,
"VehicleConfiguration": {
"Id": 1,
"Code": "sample string 2",
"Description": "sample string 3",
"MasterId": 1,
"QuickCode": "sample string 4",
"SourceChannel": "sample string 5",
"CreatedBy": "sample string 6",
"CreatedOn": "2025-12-19T06:04:55.8848215-06:00",
"ModifiedBy": "sample string 7",
"ModifiedOn": "2025-12-19T06:04:55.8848215-06:00",
"RowVersion": "QEA="
},
"VehicleTag": "sample string 7",
"VehicleTypeId": 8,
"VehicleType": {
"Id": 1,
"Code": "sample string 2",
"Description": "sample string 3",
"IsMustUseTareWeight": true,
"IsSingleWeigh": true,
"AllowZeroTareWeight": true,
"MasterId": 1,
"IsTrailer": true,
"CreatedBy": "sample string 8",
"CreatedOn": "2025-12-19T06:04:55.8848215-06:00",
"ModifiedBy": "sample string 9",
"ModifiedOn": "2025-12-19T06:04:55.8848215-06:00",
"RowVersion": "QEA="
},
"TareWeight": 1,
"TareWeight2": 1,
"LastTareDate": "2025-12-19T06:04:55.8848215-06:00",
"VehicleName": "sample string 9",
"ParentVehicleId": 1,
"VinNumber": "sample string 10",
"SourceChannel": "sample string 11",
"CreatedBy": "sample string 12",
"CreatedOn": "2025-12-19T06:04:55.8848215-06:00",
"ModifiedBy": "sample string 13",
"ModifiedOn": "2025-12-19T06:04:55.8848215-06:00",
"RowVersion": "QEA=",
"MasterId": 1,
"CarrierXML": {
"MasterId": 1,
"Name": "sample string 2"
},
"VehicleTypeXML": {
"MasterId": 1,
"Description": "sample string 1"
},
"VehicleConfigurationXML": {
"MasterId": 1,
"Description": "sample string 1"
},
"ParentVehicleXML": {
"Name": "sample string 1",
"MasterId": 2
}
},
{
"Id": 1,
"CallSign": "sample string 2",
"CarrierId": 3,
"Carrier": {
"Id": 1,
"Name": "sample string 2",
"CsvTemplateName": "sample string 3",
"EmailAddress": "sample string 4",
"Address1": "sample string 5",
"Address2": "sample string 6",
"ContactName": "sample string 7",
"ContactEmail": "sample string 8",
"IsAttachedPdfToEmail": true,
"IsSendDailyEmail": true,
"IsSendWeeklyEmail": true,
"IsSendMonthlyEmail": true,
"PostCode": "sample string 13",
"PhoneNo": "sample string 14",
"Status": true,
"TownOrCity": "sample string 16",
"DocketConfirmationInterfaceId": 1,
"DocketConfirmationInterface": {
"Id": 1,
"Description": "sample string 2",
"BaseUrl": "sample string 3",
"Status": true,
"IsServicePaused": true,
"InterfaceTypeCode": "sample string 6",
"CreatedBy": "sample string 7",
"CreatedOn": "2025-12-19T06:04:55.8848215-06:00",
"ModifiedBy": "sample string 8",
"ModifiedOn": "2025-12-19T06:04:55.8848215-06:00",
"RowVersion": "QEA="
},
"MessageUrl": "sample string 17",
"IsSendMessage": true,
"IsShowInKiosk": true,
"CarrierShortCode": "sample string 20",
"MasterId": 21,
"QuickCode": "sample string 22",
"SourceChannel": "sample string 23",
"CreatedBy": "sample string 24",
"CreatedOn": "2025-12-19T06:04:55.8848215-06:00",
"ModifiedBy": "sample string 25",
"ModifiedOn": "2025-12-19T06:04:55.8848215-06:00",
"RowVersion": "QEA="
},
"RegistrationNo": "sample string 4",
"Status": true,
"AllowAutoTareUpdate": true,
"VehicleConfigurationId": 1,
"VehicleConfiguration": {
"Id": 1,
"Code": "sample string 2",
"Description": "sample string 3",
"MasterId": 1,
"QuickCode": "sample string 4",
"SourceChannel": "sample string 5",
"CreatedBy": "sample string 6",
"CreatedOn": "2025-12-19T06:04:55.8848215-06:00",
"ModifiedBy": "sample string 7",
"ModifiedOn": "2025-12-19T06:04:55.8848215-06:00",
"RowVersion": "QEA="
},
"VehicleTag": "sample string 7",
"VehicleTypeId": 8,
"VehicleType": {
"Id": 1,
"Code": "sample string 2",
"Description": "sample string 3",
"IsMustUseTareWeight": true,
"IsSingleWeigh": true,
"AllowZeroTareWeight": true,
"MasterId": 1,
"IsTrailer": true,
"CreatedBy": "sample string 8",
"CreatedOn": "2025-12-19T06:04:55.8848215-06:00",
"ModifiedBy": "sample string 9",
"ModifiedOn": "2025-12-19T06:04:55.8848215-06:00",
"RowVersion": "QEA="
},
"TareWeight": 1,
"TareWeight2": 1,
"LastTareDate": "2025-12-19T06:04:55.8848215-06:00",
"VehicleName": "sample string 9",
"ParentVehicleId": 1,
"VinNumber": "sample string 10",
"SourceChannel": "sample string 11",
"CreatedBy": "sample string 12",
"CreatedOn": "2025-12-19T06:04:55.8848215-06:00",
"ModifiedBy": "sample string 13",
"ModifiedOn": "2025-12-19T06:04:55.8848215-06:00",
"RowVersion": "QEA=",
"MasterId": 1,
"CarrierXML": {
"MasterId": 1,
"Name": "sample string 2"
},
"VehicleTypeXML": {
"MasterId": 1,
"Description": "sample string 1"
},
"VehicleConfigurationXML": {
"MasterId": 1,
"Description": "sample string 1"
},
"ParentVehicleXML": {
"Name": "sample string 1",
"MasterId": 2
}
}
],
"RequestStatus": {
"errormessage": "sample string 1",
"success": true,
"version": "sample string 3"
}
}
application/xml, text/xml
Sample:
<response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<RequestStatus>
<errormessage>sample string 1</errormessage>
<success>true</success>
<version>sample string 3</version>
</RequestStatus>
<vehicles>
<vehicle>
<CallSign>sample string 2</CallSign>
<RegistrationNo>sample string 4</RegistrationNo>
<Status>true</Status>
<AllowAutoTareUpdate>true</AllowAutoTareUpdate>
<VehicleTag>sample string 7</VehicleTag>
<TareWeight>1</TareWeight>
<TareWeight2>1</TareWeight2>
<LastTareDate>2025-12-19T06:04:55.8848215-06:00</LastTareDate>
<VehicleName>sample string 9</VehicleName>
<VinNumber>sample string 10</VinNumber>
<SourceChannel>sample string 11</SourceChannel>
<CreatedBy>sample string 12</CreatedBy>
<CreatedOn>2025-12-19T06:04:55.8848215-06:00</CreatedOn>
<ModifiedBy>sample string 13</ModifiedBy>
<ModifiedOn>2025-12-19T06:04:55.8848215-06:00</ModifiedOn>
<MasterId>1</MasterId>
<carrier>
<MasterId>1</MasterId>
<Name>sample string 2</Name>
</carrier>
<vehicletype>
<MasterId>1</MasterId>
<Description>sample string 1</Description>
</vehicletype>
<vehicleconfiguration>
<MasterId>1</MasterId>
<Description>sample string 1</Description>
</vehicleconfiguration>
<parentvehicle>
<Name>sample string 1</Name>
<Masterid>2</Masterid>
</parentvehicle>
</vehicle>
<vehicle>
<CallSign>sample string 2</CallSign>
<RegistrationNo>sample string 4</RegistrationNo>
<Status>true</Status>
<AllowAutoTareUpdate>true</AllowAutoTareUpdate>
<VehicleTag>sample string 7</VehicleTag>
<TareWeight>1</TareWeight>
<TareWeight2>1</TareWeight2>
<LastTareDate>2025-12-19T06:04:55.8848215-06:00</LastTareDate>
<VehicleName>sample string 9</VehicleName>
<VinNumber>sample string 10</VinNumber>
<SourceChannel>sample string 11</SourceChannel>
<CreatedBy>sample string 12</CreatedBy>
<CreatedOn>2025-12-19T06:04:55.8848215-06:00</CreatedOn>
<ModifiedBy>sample string 13</ModifiedBy>
<ModifiedOn>2025-12-19T06:04:55.8848215-06:00</ModifiedOn>
<MasterId>1</MasterId>
<carrier>
<MasterId>1</MasterId>
<Name>sample string 2</Name>
</carrier>
<vehicletype>
<MasterId>1</MasterId>
<Description>sample string 1</Description>
</vehicletype>
<vehicleconfiguration>
<MasterId>1</MasterId>
<Description>sample string 1</Description>
</vehicleconfiguration>
<parentvehicle>
<Name>sample string 1</Name>
<Masterid>2</Masterid>
</parentvehicle>
</vehicle>
</vehicles>
</response>