POST api/DispatchApi/GetAppSettings

Request Information

URI Parameters

None.

Body Parameters

AppSettingList
NameDescriptionTypeAdditional information
DispatchAppVersion

string

None.

CompanyId

integer

None.

DriverId

integer

None.

DeviceId

string

None.

Request Formats

application/json, text/json

Sample:
{
  "DispatchAppVersion": "sample string 1",
  "CompanyId": 2,
  "DriverId": 3,
  "DeviceId": "sample string 4"
}

text/html

Sample:
{"DispatchAppVersion":"sample string 1","CompanyId":2,"DriverId":3,"DeviceId":"sample string 4"}

application/xml, text/xml

Sample:
<AppSettingList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Dispatch.Models">
  <CompanyId>0</CompanyId>
  <DeviceId>sample string 4</DeviceId>
  <DriverId>3</DriverId>
  <CompanyId>2</CompanyId>
  <DispatchAppVersion>sample string 1</DispatchAppVersion>
</AppSettingList>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AppSettingList'.

Response Information

Resource Description

ResultModelOfMobileSettings
NameDescriptionTypeAdditional information
Status

boolean

None.

Message

string

None.

UpdateApp

boolean

None.

IsSecureLoad

boolean

None.

IsPODMandatory

boolean

None.

GetPickupDeliveryNumberFromApp

boolean

None.

RestrictLocationChangesForApp

boolean

None.

RestrictDriversToOneActiveJobAtaTime

boolean

None.

ShowShipperConsigneeContactDetail

boolean

None.

HideMilesRateForDriverInapp

boolean

None.

ShowConsigneeInfoOnDriverApp

boolean

None.

model

MobileSettings

None.

lstModel

Collection of MobileSettings

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": true,
  "Message": "sample string 2",
  "UpdateApp": true,
  "IsSecureLoad": true,
  "IsPODMandatory": true,
  "GetPickupDeliveryNumberFromApp": true,
  "RestrictLocationChangesForApp": true,
  "RestrictDriversToOneActiveJobAtaTime": true,
  "ShowShipperConsigneeContactDetail": true,
  "HideMilesRateForDriverInapp": true,
  "ShowConsigneeInfoOnDriverApp": true,
  "model": {
    "KeyValue": "sample string 1",
    "KeyName": "sample string 2"
  },
  "lstModel": [
    {
      "KeyValue": "sample string 1",
      "KeyName": "sample string 2"
    },
    {
      "KeyValue": "sample string 1",
      "KeyName": "sample string 2"
    }
  ]
}

text/html

Sample:
{"Status":true,"Message":"sample string 2","UpdateApp":true,"IsSecureLoad":true,"IsPODMandatory":true,"GetPickupDeliveryNumberFromApp":true,"RestrictLocationChangesForApp":true,"RestrictDriversToOneActiveJobAtaTime":true,"ShowShipperConsigneeContactDetail":true,"HideMilesRateForDriverInapp":true,"ShowConsigneeInfoOnDriverApp":true,"model":{"KeyValue":"sample string 1","KeyName":"sample string 2"},"lstModel":[{"KeyValue":"sample string 1","KeyName":"sample string 2"},{"KeyValue":"sample string 1","KeyName":"sample string 2"}]}

application/xml, text/xml

Sample:
<ResultModelOfMobileSettingskdKmGoqn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Dispatch.Models">
  <GetPickupDeliveryNumberFromApp>true</GetPickupDeliveryNumberFromApp>
  <HideMilesRateForDriverInapp>true</HideMilesRateForDriverInapp>
  <IsPODMandatory>true</IsPODMandatory>
  <IsSecureLoad>true</IsSecureLoad>
  <Message>sample string 2</Message>
  <RestrictDriversToOneActiveJobAtaTime>true</RestrictDriversToOneActiveJobAtaTime>
  <RestrictLocationChangesForApp>true</RestrictLocationChangesForApp>
  <ShowConsigneeInfoOnDriverApp>true</ShowConsigneeInfoOnDriverApp>
  <ShowShipperConsigneeContactDetail>true</ShowShipperConsigneeContactDetail>
  <Status>true</Status>
  <UpdateApp>true</UpdateApp>
  <lstModel>
    <MobileSettings>
      <KeyName>sample string 2</KeyName>
      <KeyValue>sample string 1</KeyValue>
    </MobileSettings>
    <MobileSettings>
      <KeyName>sample string 2</KeyName>
      <KeyValue>sample string 1</KeyValue>
    </MobileSettings>
  </lstModel>
  <model>
    <KeyName>sample string 2</KeyName>
    <KeyValue>sample string 1</KeyValue>
  </model>
</ResultModelOfMobileSettingskdKmGoqn>