GET Api/TaskConfiguration/GetTaskConfiguration?clientID={clientID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientID | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
TaskConfigurationViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| DeliveryType | DeliveryType |
None. |
|
| DriverDutyMode | DriverDutyMode |
None. |
|
| DriverTelematicType | DriverTelematicType |
None. |
|
| DeliveryProof | DeliveryProof |
None. |
|
| PickupProof | DeliveryProof |
None. |
|
| MaxAttachmentAllowed | integer |
None. |
|
| CurrencyCode | string |
None. |
|
| SLAInMinutes | integer |
None. |
|
| IsPaymentModeDisabled | boolean |
None. |
|
| IsRiderToCustomerChatDisabled | boolean |
None. |
|
| IsHeatMapInRiderAppEnabled | boolean |
None. |
|
| DriverResponseTimeOut | integer |
None. |
|
| AllowProfileUpdate | boolean |
None. |
|
| IsWalletEnabled | boolean |
None. |
|
| ProofOfDeliveryImageCompression | integer |
None. |
|
| IsAllowMarkTaskFailedEnabled | boolean |
None. |
|
| IsQRCodeEnabled | boolean |
None. |
|
| IsPartialDeliveryEnabled | boolean |
None. |
|
| IsPartialPickupEnabled | boolean |
None. |
|
| IsEditItemEnabled | boolean |
None. |
|
| ItemConfiguration | ItemConfiguration |
None. |
|
| IsDeliveryInstruction | boolean |
None. |
|
| ItemEditScreen | ItemEditScreen |
None. |
Response Formats
application/json, text/json
Sample:
{
"DeliveryType": 0,
"DriverDutyMode": 0,
"DriverTelematicType": 0,
"DeliveryProof": {
"Signature": {
"Enabled": true,
"IsRequired": true,
"VisibleToCustomer": true,
"VisibleToMerchant": true
},
"Note": {
"Enabled": true,
"IsRequired": true,
"VisibleToCustomer": true,
"VisibleToMerchant": true
},
"DeliveryMode": {
"Mode": 0,
"Enabled": true,
"IsRequired": true,
"VisibleToCustomer": true,
"VisibleToMerchant": true
},
"Photo": {
"SourceType": 0,
"Enabled": true,
"IsRequired": true,
"VisibleToCustomer": true,
"VisibleToMerchant": true
},
"DriverLocation": {
"Enabled": true,
"IsRequired": true,
"VisibleToCustomer": true,
"VisibleToMerchant": true
},
"DeliveryTimestamp": {
"Enabled": true,
"IsRequired": true,
"VisibleToCustomer": true,
"VisibleToMerchant": true
},
"OTP": {
"Enabled": true,
"IsRequired": true,
"VisibleToCustomer": true,
"VisibleToMerchant": true
},
"QRCodeNumber": {
"QRCodeCaptureOption": 0,
"Enabled": true,
"IsRequired": true,
"VisibleToCustomer": true,
"VisibleToMerchant": true
},
"ReferenceNumber": {
"Enabled": true,
"IsRequired": true,
"VisibleToCustomer": true,
"VisibleToMerchant": true
}
},
"PickupProof": {
"Signature": {
"Enabled": true,
"IsRequired": true,
"VisibleToCustomer": true,
"VisibleToMerchant": true
},
"Note": {
"Enabled": true,
"IsRequired": true,
"VisibleToCustomer": true,
"VisibleToMerchant": true
},
"DeliveryMode": {
"Mode": 0,
"Enabled": true,
"IsRequired": true,
"VisibleToCustomer": true,
"VisibleToMerchant": true
},
"Photo": {
"SourceType": 0,
"Enabled": true,
"IsRequired": true,
"VisibleToCustomer": true,
"VisibleToMerchant": true
},
"DriverLocation": {
"Enabled": true,
"IsRequired": true,
"VisibleToCustomer": true,
"VisibleToMerchant": true
},
"DeliveryTimestamp": {
"Enabled": true,
"IsRequired": true,
"VisibleToCustomer": true,
"VisibleToMerchant": true
},
"OTP": {
"Enabled": true,
"IsRequired": true,
"VisibleToCustomer": true,
"VisibleToMerchant": true
},
"QRCodeNumber": {
"QRCodeCaptureOption": 0,
"Enabled": true,
"IsRequired": true,
"VisibleToCustomer": true,
"VisibleToMerchant": true
},
"ReferenceNumber": {
"Enabled": true,
"IsRequired": true,
"VisibleToCustomer": true,
"VisibleToMerchant": true
}
},
"MaxAttachmentAllowed": 1,
"CurrencyCode": "sample string 2",
"SLAInMinutes": 3,
"IsPaymentModeDisabled": true,
"IsRiderToCustomerChatDisabled": true,
"IsHeatMapInRiderAppEnabled": true,
"DriverResponseTimeOut": 7,
"AllowProfileUpdate": true,
"IsWalletEnabled": true,
"ProofOfDeliveryImageCompression": 10,
"IsAllowMarkTaskFailedEnabled": true,
"IsQRCodeEnabled": true,
"IsPartialDeliveryEnabled": true,
"IsPartialPickupEnabled": true,
"IsEditItemEnabled": true,
"ItemConfiguration": {
"Item": {
"ItemSelectionMode": 0,
"Enabled": true,
"IsRequired": true
},
"ItemCategory": {
"Enabled": true,
"IsRequired": true
},
"ItemClassification": {
"Enabled": true,
"IsRequired": true
},
"Price": {
"Enabled": true,
"IsRequired": true
},
"VAT": {
"Enabled": true,
"IsRequired": true
},
"Total": {
"Enabled": true,
"IsRequired": true
},
"Quantity": {
"Enabled": true,
"IsRequired": true
},
"TemperatureSensor": {
"Enabled": true,
"IsRequired": true
}
},
"IsDeliveryInstruction": true,
"ItemEditScreen": 0
}
application/xml, text/xml
Sample:
<TaskConfigurationViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FleetrootDriver.Service.Models">
<AllowProfileUpdate>true</AllowProfileUpdate>
<CurrencyCode>sample string 2</CurrencyCode>
<DeliveryProof xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fleetroot.Entity.Tasks">
<d2p1:DeliveryMode>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:VisibleToCustomer>true</d2p1:VisibleToCustomer>
<d2p1:VisibleToMerchant>true</d2p1:VisibleToMerchant>
<d2p1:Mode>None</d2p1:Mode>
</d2p1:DeliveryMode>
<d2p1:DeliveryTimestamp>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:VisibleToCustomer>true</d2p1:VisibleToCustomer>
<d2p1:VisibleToMerchant>true</d2p1:VisibleToMerchant>
</d2p1:DeliveryTimestamp>
<d2p1:DriverLocation>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:VisibleToCustomer>true</d2p1:VisibleToCustomer>
<d2p1:VisibleToMerchant>true</d2p1:VisibleToMerchant>
</d2p1:DriverLocation>
<d2p1:Note>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:VisibleToCustomer>true</d2p1:VisibleToCustomer>
<d2p1:VisibleToMerchant>true</d2p1:VisibleToMerchant>
</d2p1:Note>
<d2p1:OTP>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:VisibleToCustomer>true</d2p1:VisibleToCustomer>
<d2p1:VisibleToMerchant>true</d2p1:VisibleToMerchant>
</d2p1:OTP>
<d2p1:Photo>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:VisibleToCustomer>true</d2p1:VisibleToCustomer>
<d2p1:VisibleToMerchant>true</d2p1:VisibleToMerchant>
<d2p1:SourceType>Both</d2p1:SourceType>
</d2p1:Photo>
<d2p1:QRCodeNumber>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:VisibleToCustomer>true</d2p1:VisibleToCustomer>
<d2p1:VisibleToMerchant>true</d2p1:VisibleToMerchant>
<d2p1:QRCodeCaptureOption>ManualOnly</d2p1:QRCodeCaptureOption>
</d2p1:QRCodeNumber>
<d2p1:ReferenceNumber>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:VisibleToCustomer>true</d2p1:VisibleToCustomer>
<d2p1:VisibleToMerchant>true</d2p1:VisibleToMerchant>
</d2p1:ReferenceNumber>
<d2p1:Signature>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:VisibleToCustomer>true</d2p1:VisibleToCustomer>
<d2p1:VisibleToMerchant>true</d2p1:VisibleToMerchant>
</d2p1:Signature>
</DeliveryProof>
<DeliveryType>OnDemand</DeliveryType>
<DriverDutyMode>None</DriverDutyMode>
<DriverResponseTimeOut>7</DriverResponseTimeOut>
<DriverTelematicType>IotDeviceBased</DriverTelematicType>
<IsAllowMarkTaskFailedEnabled>true</IsAllowMarkTaskFailedEnabled>
<IsDeliveryInstruction>true</IsDeliveryInstruction>
<IsEditItemEnabled>true</IsEditItemEnabled>
<IsHeatMapInRiderAppEnabled>true</IsHeatMapInRiderAppEnabled>
<IsPartialDeliveryEnabled>true</IsPartialDeliveryEnabled>
<IsPartialPickupEnabled>true</IsPartialPickupEnabled>
<IsPaymentModeDisabled>true</IsPaymentModeDisabled>
<IsQRCodeEnabled>true</IsQRCodeEnabled>
<IsRiderToCustomerChatDisabled>true</IsRiderToCustomerChatDisabled>
<IsWalletEnabled>true</IsWalletEnabled>
<ItemConfiguration xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fleetroot.Entity.Tasks">
<d2p1:Item>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:ItemSelectionMode>Dropdown</d2p1:ItemSelectionMode>
</d2p1:Item>
<d2p1:ItemCategory>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
</d2p1:ItemCategory>
<d2p1:ItemClassification>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
</d2p1:ItemClassification>
<d2p1:Price>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
</d2p1:Price>
<d2p1:Quantity>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
</d2p1:Quantity>
<d2p1:TemperatureSensor>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
</d2p1:TemperatureSensor>
<d2p1:Total>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
</d2p1:Total>
<d2p1:VAT>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
</d2p1:VAT>
</ItemConfiguration>
<ItemEditScreen>OneByOne</ItemEditScreen>
<MaxAttachmentAllowed>1</MaxAttachmentAllowed>
<PickupProof xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fleetroot.Entity.Tasks">
<d2p1:DeliveryMode>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:VisibleToCustomer>true</d2p1:VisibleToCustomer>
<d2p1:VisibleToMerchant>true</d2p1:VisibleToMerchant>
<d2p1:Mode>None</d2p1:Mode>
</d2p1:DeliveryMode>
<d2p1:DeliveryTimestamp>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:VisibleToCustomer>true</d2p1:VisibleToCustomer>
<d2p1:VisibleToMerchant>true</d2p1:VisibleToMerchant>
</d2p1:DeliveryTimestamp>
<d2p1:DriverLocation>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:VisibleToCustomer>true</d2p1:VisibleToCustomer>
<d2p1:VisibleToMerchant>true</d2p1:VisibleToMerchant>
</d2p1:DriverLocation>
<d2p1:Note>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:VisibleToCustomer>true</d2p1:VisibleToCustomer>
<d2p1:VisibleToMerchant>true</d2p1:VisibleToMerchant>
</d2p1:Note>
<d2p1:OTP>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:VisibleToCustomer>true</d2p1:VisibleToCustomer>
<d2p1:VisibleToMerchant>true</d2p1:VisibleToMerchant>
</d2p1:OTP>
<d2p1:Photo>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:VisibleToCustomer>true</d2p1:VisibleToCustomer>
<d2p1:VisibleToMerchant>true</d2p1:VisibleToMerchant>
<d2p1:SourceType>Both</d2p1:SourceType>
</d2p1:Photo>
<d2p1:QRCodeNumber>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:VisibleToCustomer>true</d2p1:VisibleToCustomer>
<d2p1:VisibleToMerchant>true</d2p1:VisibleToMerchant>
<d2p1:QRCodeCaptureOption>ManualOnly</d2p1:QRCodeCaptureOption>
</d2p1:QRCodeNumber>
<d2p1:ReferenceNumber>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:VisibleToCustomer>true</d2p1:VisibleToCustomer>
<d2p1:VisibleToMerchant>true</d2p1:VisibleToMerchant>
</d2p1:ReferenceNumber>
<d2p1:Signature>
<d2p1:Enabled>true</d2p1:Enabled>
<d2p1:IsRequired>true</d2p1:IsRequired>
<d2p1:VisibleToCustomer>true</d2p1:VisibleToCustomer>
<d2p1:VisibleToMerchant>true</d2p1:VisibleToMerchant>
</d2p1:Signature>
</PickupProof>
<ProofOfDeliveryImageCompression>10</ProofOfDeliveryImageCompression>
<SLAInMinutes>3</SLAInMinutes>
</TaskConfigurationViewModel>