GET Api/PortalSetting/GetPortalSetting?clientID={clientID}

Request Information

URI Parameters

Name	Description	Type	Additional information
clientID		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

PortalSettingViewModel

Name	Type	Additional information
CompanyName	string	None.
TimeZone	string	None.
LandingPage	integer	None.
DateFormat	string	None.
TimeFormat	string	None.
OdometerUnit	OdometerUnit	None.
FuelUnit	FuelUnit	None.
TemperatureSensor1	string	None.
TemperatureSensor2	string	None.
TemperatureSensor3	string	None.
TemperatureSensor4	string	None.
DriverCallingType	DriverCallingType	None.
EnableDriverCalling	boolean	None.
MapClusterMode	MapClusterMode	None.
CurrencyID	string	None.
MapCenterLatitude	decimal number	None.
MapCenterLongitude	decimal number	None.
MapZoomLevel	integer	None.
EnabledFeatures	Collection of integer	None.
TelematicsMode	TelematicsMode	None.
DurationFormat	DurationFormat	None.
DriverConfiguration	DriverConfiguration	None.
DataPacketCollectionFrequency	integer	None.
DataPacketSendingFrequency	integer	None.
TaskConfiguration	TaskConfigurationViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "CompanyName": "sample string 1",
  "TimeZone": "sample string 2",
  "LandingPage": 3,
  "DateFormat": "sample string 4",
  "TimeFormat": "sample string 5",
  "OdometerUnit": 1,
  "FuelUnit": 1,
  "TemperatureSensor1": "sample string 6",
  "TemperatureSensor2": "sample string 7",
  "TemperatureSensor3": "sample string 8",
  "TemperatureSensor4": "sample string 9",
  "DriverCallingType": 0,
  "EnableDriverCalling": true,
  "MapClusterMode": 0,
  "CurrencyID": "sample string 11",
  "MapCenterLatitude": 12.1,
  "MapCenterLongitude": 13.1,
  "MapZoomLevel": 14,
  "EnabledFeatures": [
    1,
    2
  ],
  "TelematicsMode": 0,
  "DurationFormat": 0,
  "DriverConfiguration": {
    "DriverTripEndDetection": 0,
    "DriverTripStartDetection": 0,
    "MinTripTimeInMinutes": 1.1,
    "ResetDriverAssignment": 0,
    "IgnitionOffTimeInMinutes": 2.1
  },
  "DataPacketCollectionFrequency": 15,
  "DataPacketSendingFrequency": 16,
  "TaskConfiguration": {
    "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
      },
      "ItemWiseAttachment": {
        "SourceType": 0,
        "Enabled": true,
        "IsRequired": true,
        "VisibleToCustomer": true,
        "VisibleToMerchant": true
      },
      "ItemWiseSignature": {
        "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
      },
      "ItemWiseAttachment": {
        "SourceType": 0,
        "Enabled": true,
        "IsRequired": true,
        "VisibleToCustomer": true,
        "VisibleToMerchant": true
      },
      "ItemWiseSignature": {
        "Enabled": true,
        "IsRequired": true,
        "VisibleToCustomer": true,
        "VisibleToMerchant": true
      }
    },
    "MaxAttachmentAllowed": 1,
    "CurrencyCode": "sample string 2",
    "SLAInMinutes": 3,
    "IsPaymentModeDisabled": true,
    "IsPaymentModeHidden": true,
    "IsRiderToCustomerChatDisabled": true,
    "IsHeatMapInRiderAppEnabled": true,
    "DriverResponseTimeOut": 8,
    "AllowProfileUpdate": true,
    "IsWalletEnabled": true,
    "ProofOfDeliveryImageCompression": 11,
    "IsAllowMarkTaskFailedEnabled": true,
    "IsQRCodeEnabled": true,
    "IsPartialDeliveryEnabled": true,
    "IsPartialPickupEnabled": true,
    "IsEditItemEnabled": true,
    "ItemConfiguration": {
      "Item": {
        "ItemSelectionMode": 0,
        "Enabled": true,
        "IsRequired": true
      },
      "ItemCategory": {
        "Enabled": true,
        "IsRequired": true
      },
      "ItemCategoryQty": {
        "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,
    "IsPODPDFAttachmentsEnabled": true,
    "IsPODByItemEnabled": true,
    "EnableLoadVehicle": true,
    "EnableShippingCharges": true
  }
}

application/xml, text/xml

Sample:

<PortalSettingViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FleetrootDriver.Service.Models">
  <CompanyName>sample string 1</CompanyName>
  <CurrencyID>sample string 11</CurrencyID>
  <DataPacketCollectionFrequency>15</DataPacketCollectionFrequency>
  <DataPacketSendingFrequency>16</DataPacketSendingFrequency>
  <DateFormat>sample string 4</DateFormat>
  <DriverCallingType>SimMobileNo</DriverCallingType>
  <DriverConfiguration xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fleetroot.Entity">
    <d2p1:DriverTripEndDetection>IgnitionOff</d2p1:DriverTripEndDetection>
    <d2p1:DriverTripStartDetection>DriverPunch</d2p1:DriverTripStartDetection>
    <d2p1:IgnitionOffTimeInMinutes>2.1</d2p1:IgnitionOffTimeInMinutes>
    <d2p1:MinTripTimeInMinutes>1.1</d2p1:MinTripTimeInMinutes>
    <d2p1:ResetDriverAssignment>NextDriverPunch</d2p1:ResetDriverAssignment>
  </DriverConfiguration>
  <DurationFormat>Hrs_Min</DurationFormat>
  <EnableDriverCalling>true</EnableDriverCalling>
  <EnabledFeatures xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </EnabledFeatures>
  <FuelUnit>Ltrs</FuelUnit>
  <LandingPage>3</LandingPage>
  <MapCenterLatitude>12.1</MapCenterLatitude>
  <MapCenterLongitude>13.1</MapCenterLongitude>
  <MapClusterMode>On</MapClusterMode>
  <MapZoomLevel>14</MapZoomLevel>
  <OdometerUnit>Kms</OdometerUnit>
  <TaskConfiguration>
    <AllowProfileUpdate>true</AllowProfileUpdate>
    <CurrencyCode>sample string 2</CurrencyCode>
    <DeliveryProof xmlns:d3p1="http://schemas.datacontract.org/2004/07/Fleetroot.Entity.Tasks">
      <d3p1:DeliveryMode>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
        <d3p1:Mode>None</d3p1:Mode>
      </d3p1:DeliveryMode>
      <d3p1:DeliveryTimestamp>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
      </d3p1:DeliveryTimestamp>
      <d3p1:DriverLocation>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
      </d3p1:DriverLocation>
      <d3p1:ItemWiseAttachment>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
        <d3p1:SourceType>Both</d3p1:SourceType>
      </d3p1:ItemWiseAttachment>
      <d3p1:ItemWiseSignature>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
      </d3p1:ItemWiseSignature>
      <d3p1:Note>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
      </d3p1:Note>
      <d3p1:OTP>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
      </d3p1:OTP>
      <d3p1:Photo>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
        <d3p1:SourceType>Both</d3p1:SourceType>
      </d3p1:Photo>
      <d3p1:QRCodeNumber>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
        <d3p1:QRCodeCaptureOption>ManualOnly</d3p1:QRCodeCaptureOption>
      </d3p1:QRCodeNumber>
      <d3p1:ReferenceNumber>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
      </d3p1:ReferenceNumber>
      <d3p1:Signature>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
      </d3p1:Signature>
    </DeliveryProof>
    <DeliveryType>OnDemand</DeliveryType>
    <DriverDutyMode>None</DriverDutyMode>
    <DriverResponseTimeOut>8</DriverResponseTimeOut>
    <DriverTelematicType>IotDeviceBased</DriverTelematicType>
    <EnableLoadVehicle>true</EnableLoadVehicle>
    <EnableShippingCharges>true</EnableShippingCharges>
    <IsAllowMarkTaskFailedEnabled>true</IsAllowMarkTaskFailedEnabled>
    <IsDeliveryInstruction>true</IsDeliveryInstruction>
    <IsEditItemEnabled>true</IsEditItemEnabled>
    <IsHeatMapInRiderAppEnabled>true</IsHeatMapInRiderAppEnabled>
    <IsPODByItemEnabled>true</IsPODByItemEnabled>
    <IsPODPDFAttachmentsEnabled>true</IsPODPDFAttachmentsEnabled>
    <IsPartialDeliveryEnabled>true</IsPartialDeliveryEnabled>
    <IsPartialPickupEnabled>true</IsPartialPickupEnabled>
    <IsPaymentModeDisabled>true</IsPaymentModeDisabled>
    <IsPaymentModeHidden>true</IsPaymentModeHidden>
    <IsQRCodeEnabled>true</IsQRCodeEnabled>
    <IsRiderToCustomerChatDisabled>true</IsRiderToCustomerChatDisabled>
    <IsWalletEnabled>true</IsWalletEnabled>
    <ItemConfiguration xmlns:d3p1="http://schemas.datacontract.org/2004/07/Fleetroot.Entity.Tasks">
      <d3p1:Item>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:ItemSelectionMode>Dropdown</d3p1:ItemSelectionMode>
      </d3p1:Item>
      <d3p1:ItemCategory>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
      </d3p1:ItemCategory>
      <d3p1:ItemCategoryQty>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
      </d3p1:ItemCategoryQty>
      <d3p1:ItemClassification>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
      </d3p1:ItemClassification>
      <d3p1:Price>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
      </d3p1:Price>
      <d3p1:Quantity>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
      </d3p1:Quantity>
      <d3p1:TemperatureSensor>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
      </d3p1:TemperatureSensor>
      <d3p1:Total>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
      </d3p1:Total>
      <d3p1:VAT>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
      </d3p1:VAT>
    </ItemConfiguration>
    <ItemEditScreen>OneByOne</ItemEditScreen>
    <MaxAttachmentAllowed>1</MaxAttachmentAllowed>
    <PickupProof xmlns:d3p1="http://schemas.datacontract.org/2004/07/Fleetroot.Entity.Tasks">
      <d3p1:DeliveryMode>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
        <d3p1:Mode>None</d3p1:Mode>
      </d3p1:DeliveryMode>
      <d3p1:DeliveryTimestamp>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
      </d3p1:DeliveryTimestamp>
      <d3p1:DriverLocation>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
      </d3p1:DriverLocation>
      <d3p1:ItemWiseAttachment>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
        <d3p1:SourceType>Both</d3p1:SourceType>
      </d3p1:ItemWiseAttachment>
      <d3p1:ItemWiseSignature>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
      </d3p1:ItemWiseSignature>
      <d3p1:Note>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
      </d3p1:Note>
      <d3p1:OTP>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
      </d3p1:OTP>
      <d3p1:Photo>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
        <d3p1:SourceType>Both</d3p1:SourceType>
      </d3p1:Photo>
      <d3p1:QRCodeNumber>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
        <d3p1:QRCodeCaptureOption>ManualOnly</d3p1:QRCodeCaptureOption>
      </d3p1:QRCodeNumber>
      <d3p1:ReferenceNumber>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
      </d3p1:ReferenceNumber>
      <d3p1:Signature>
        <d3p1:Enabled>true</d3p1:Enabled>
        <d3p1:IsRequired>true</d3p1:IsRequired>
        <d3p1:VisibleToCustomer>true</d3p1:VisibleToCustomer>
        <d3p1:VisibleToMerchant>true</d3p1:VisibleToMerchant>
      </d3p1:Signature>
    </PickupProof>
    <ProofOfDeliveryImageCompression>11</ProofOfDeliveryImageCompression>
    <SLAInMinutes>3</SLAInMinutes>
  </TaskConfiguration>
  <TemperatureSensor1>sample string 6</TemperatureSensor1>
  <TemperatureSensor2>sample string 7</TemperatureSensor2>
  <TemperatureSensor3>sample string 8</TemperatureSensor3>
  <TemperatureSensor4>sample string 9</TemperatureSensor4>
  <TimeFormat>sample string 5</TimeFormat>
  <TimeZone>sample string 2</TimeZone>
</PortalSettingViewModel>

Api Documentation

GET Api/PortalSetting/GetPortalSetting?clientID={clientID}

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml