GET api/classe/vehiclecheckschema/{driverID}/{token}/{serviceID}
Get vehicle check schemas for a driver
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| driverID |
The driver id used for authentication |
unsigned integer |
Required |
| token |
The token used for authentication |
string |
Required |
| serviceID |
The id of the vehicle the check is being done against |
unsigned integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A VehicleCheckSchemaModel
VehicleCheckSchemaModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Schema |
The schema name |
string |
None. |
| VehicleCheckSections |
A list of the schema sections |
Collection of VehicleCheckSchemaSectionModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"Schema": "sample string 1",
"VehicleCheckSections": [
{
"Name": "sample string 1",
"Order": 2,
"VehicleCheckitems": [
{
"Name": "sample string 1",
"ControlType": "sample string 2",
"PossibleValues": [
"sample string 1",
"sample string 2"
],
"PhotoRequiredOnFault": true,
"ItemId": 4,
"Order": 5
},
{
"Name": "sample string 1",
"ControlType": "sample string 2",
"PossibleValues": [
"sample string 1",
"sample string 2"
],
"PhotoRequiredOnFault": true,
"ItemId": 4,
"Order": 5
}
],
"SectionId": 3,
"IconURL": "sample string 4"
},
{
"Name": "sample string 1",
"Order": 2,
"VehicleCheckitems": [
{
"Name": "sample string 1",
"ControlType": "sample string 2",
"PossibleValues": [
"sample string 1",
"sample string 2"
],
"PhotoRequiredOnFault": true,
"ItemId": 4,
"Order": 5
},
{
"Name": "sample string 1",
"ControlType": "sample string 2",
"PossibleValues": [
"sample string 1",
"sample string 2"
],
"PhotoRequiredOnFault": true,
"ItemId": 4,
"Order": 5
}
],
"SectionId": 3,
"IconURL": "sample string 4"
}
]
}
application/xml, text/xml
Sample:
<VehicleCheckSchemaModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Schema>sample string 1</Schema>
<VehicleCheckSections>
<VehicleCheckSchemaSectionModel>
<Name>sample string 1</Name>
<Order>2</Order>
<VehicleCheckitems>
<VehicleCheckSchemaItemsModel>
<Name>sample string 1</Name>
<ControlType>sample string 2</ControlType>
<PossibleValues>
<string>sample string 1</string>
<string>sample string 2</string>
</PossibleValues>
<PhotoRequiredOnFault>true</PhotoRequiredOnFault>
<ItemId>4</ItemId>
<Order>5</Order>
</VehicleCheckSchemaItemsModel>
<VehicleCheckSchemaItemsModel>
<Name>sample string 1</Name>
<ControlType>sample string 2</ControlType>
<PossibleValues>
<string>sample string 1</string>
<string>sample string 2</string>
</PossibleValues>
<PhotoRequiredOnFault>true</PhotoRequiredOnFault>
<ItemId>4</ItemId>
<Order>5</Order>
</VehicleCheckSchemaItemsModel>
</VehicleCheckitems>
<SectionId>3</SectionId>
<IconURL>sample string 4</IconURL>
</VehicleCheckSchemaSectionModel>
<VehicleCheckSchemaSectionModel>
<Name>sample string 1</Name>
<Order>2</Order>
<VehicleCheckitems>
<VehicleCheckSchemaItemsModel>
<Name>sample string 1</Name>
<ControlType>sample string 2</ControlType>
<PossibleValues>
<string>sample string 1</string>
<string>sample string 2</string>
</PossibleValues>
<PhotoRequiredOnFault>true</PhotoRequiredOnFault>
<ItemId>4</ItemId>
<Order>5</Order>
</VehicleCheckSchemaItemsModel>
<VehicleCheckSchemaItemsModel>
<Name>sample string 1</Name>
<ControlType>sample string 2</ControlType>
<PossibleValues>
<string>sample string 1</string>
<string>sample string 2</string>
</PossibleValues>
<PhotoRequiredOnFault>true</PhotoRequiredOnFault>
<ItemId>4</ItemId>
<Order>5</Order>
</VehicleCheckSchemaItemsModel>
</VehicleCheckitems>
<SectionId>3</SectionId>
<IconURL>sample string 4</IconURL>
</VehicleCheckSchemaSectionModel>
</VehicleCheckSections>
</VehicleCheckSchemaModel>