POST api/Setting/RetrieveAllCountries

Retrieves a list of available countries in the system.

Request Information

Parameters

Name	Description	Additional information
request		Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "ComponentId": 1,
  "SubComponentId": 1,
  "SecurableId": "sample string 2",
  "DefualtLanguageCode": "sample string 3",
  "DisplayViewId": 4,
  "EntityId": 1,
  "GroupId": 1,
  "TimeZoneValue": 5,
  "MapPreferenceMode": 1,
  "DefaultGroupIds": [
    1,
    2,
    3
  ],
  "CountryCodeId": 1,
  "DashboardID": 1,
  "MapFlagTypeId": 1,
  "showUnitsOnMap": 1,
  "ShowFlagAtZoomLevel": 1,
  "ShowFlagWhenUnitCount": 1,
  "DisableClusteringAtZoomLevel": 1,
  "MapTileProviderId": 6,
  "UnitOfMeasureID": 1,
  "Token": "sample string 7",
  "FreeText": "sample string 8",
  "GroupIds": [
    1,
    2,
    3
  ],
  "FromIndex": 9,
  "ToIndex": 10,
  "IsWebCalling": true,
  "RequestMode": "sample string 12",
  "Client": "sample string 13",
  "AppVersion": "sample string 14",
  "AppOperatingSystem": "sample string 15",
  "AppName": "sample string 16",
  "MasterUserID": 17,
  "IsRecurringRequest": true
}

text/html

Sample:

{"ComponentId":1,"SubComponentId":1,"SecurableId":"sample string 2","DefualtLanguageCode":"sample string 3","DisplayViewId":4,"EntityId":1,"GroupId":1,"TimeZoneValue":5,"MapPreferenceMode":1,"DefaultGroupIds":[1,2,3],"CountryCodeId":1,"DashboardID":1,"MapFlagTypeId":1,"showUnitsOnMap":1,"ShowFlagAtZoomLevel":1,"ShowFlagWhenUnitCount":1,"DisableClusteringAtZoomLevel":1,"MapTileProviderId":6,"UnitOfMeasureID":1,"Token":"sample string 7","FreeText":"sample string 8","GroupIds":[1,2,3],"FromIndex":9,"ToIndex":10,"IsWebCalling":true,"RequestMode":"sample string 12","Client":"sample string 13","AppVersion":"sample string 14","AppOperatingSystem":"sample string 15","AppName":"sample string 16","MasterUserID":17,"IsRecurringRequest":true}

application/xml, text/xml

Sample:

<APIGeneralSettingsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
  <AppName>sample string 16</AppName>
  <AppOperatingSystem>sample string 15</AppOperatingSystem>
  <AppVersion>sample string 14</AppVersion>
  <Client>sample string 13</Client>
  <FreeText>sample string 8</FreeText>
  <FromIndex>9</FromIndex>
  <GroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </GroupIds>
  <IsRecurringRequest>true</IsRecurringRequest>
  <IsWebCalling>true</IsWebCalling>
  <MasterUserID>17</MasterUserID>
  <RequestMode>sample string 12</RequestMode>
  <ToIndex>10</ToIndex>
  <Token>sample string 7</Token>
  <ComponentId>1</ComponentId>
  <CountryCodeId>1</CountryCodeId>
  <DashboardID>1</DashboardID>
  <DefaultGroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </DefaultGroupIds>
  <DefualtLanguageCode>sample string 3</DefualtLanguageCode>
  <DisableClusteringAtZoomLevel>1</DisableClusteringAtZoomLevel>
  <DisplayViewId>4</DisplayViewId>
  <EntityId>1</EntityId>
  <GroupId>1</GroupId>
  <MapFlagTypeId>1</MapFlagTypeId>
  <MapPreferenceMode>1</MapPreferenceMode>
  <MapTileProviderId>6</MapTileProviderId>
  <SecurableId>sample string 2</SecurableId>
  <ShowFlagAtZoomLevel>1</ShowFlagAtZoomLevel>
  <ShowFlagWhenUnitCount>1</ShowFlagWhenUnitCount>
  <SubComponentId>1</SubComponentId>
  <TimeZoneValue>5</TimeZoneValue>
  <UnitOfMeasureID>1</UnitOfMeasureID>
  <showUnitsOnMap>1</showUnitsOnMap>
</APIGeneralSettingsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "APIDdlBindDataModel": [
    {
      "ID": 1,
      "Name": "sample string 2"
    },
    {
      "ID": 1,
      "Name": "sample string 2"
    },
    {
      "ID": 1,
      "Name": "sample string 2"
    }
  ],
  "Success": true,
  "ErrorMessage": "sample string 2",
  "MenuAccessData": {
    "HasAccessToMap": true,
    "HasAccessToVehicle": true,
    "HasAccessToVehicleAdministration": true,
    "HasAccessToDriver": true,
    "HasAccessToPOI": true,
    "HasAccessToReports": true,
    "HasAccessToSettings": true,
    "HasAccessToTrips": true,
    "HasAccessToTranslations": true,
    "HasAccessToDashboard": true,
    "HasAccessToLogBook": true,
    "HasAccessToGroup": true,
    "HasAccessToTemplate": true,
    "HasAccessToUnit": true,
    "HasAccessToUser": true,
    "HasAccessToTicket": true,
    "HasAccessToContract": true,
    "HasAccessToSIM": true,
    "HasAccessToCommand": true,
    "HasAccessToUnitProfile": true,
    "HasAccessToProfileTrigger": true,
    "HasAccessToScript": true,
    "HasAccessToTriggerSchedule": true,
    "HasAccessToMetaBaseReport": true,
    "HasAccessToMetaBaseUserDashboard": true,
    "HasAccessToRecoveryMode": true
  },
  "StatusCode": 3,
  "ComponentFilterIds": [
    1,
    2,
    3
  ]
}

text/html

Sample:

{"APIDdlBindDataModel":[{"ID":1,"Name":"sample string 2"},{"ID":1,"Name":"sample string 2"},{"ID":1,"Name":"sample string 2"}],"Success":true,"ErrorMessage":"sample string 2","MenuAccessData":{"HasAccessToMap":true,"HasAccessToVehicle":true,"HasAccessToVehicleAdministration":true,"HasAccessToDriver":true,"HasAccessToPOI":true,"HasAccessToReports":true,"HasAccessToSettings":true,"HasAccessToTrips":true,"HasAccessToTranslations":true,"HasAccessToDashboard":true,"HasAccessToLogBook":true,"HasAccessToGroup":true,"HasAccessToTemplate":true,"HasAccessToUnit":true,"HasAccessToUser":true,"HasAccessToTicket":true,"HasAccessToContract":true,"HasAccessToSIM":true,"HasAccessToCommand":true,"HasAccessToUnitProfile":true,"HasAccessToProfileTrigger":true,"HasAccessToScript":true,"HasAccessToTriggerSchedule":true,"HasAccessToMetaBaseReport":true,"HasAccessToMetaBaseUserDashboard":true,"HasAccessToRecoveryMode":true},"StatusCode":3,"ComponentFilterIds":[1,2,3]}

application/xml, text/xml

Sample:

<APIDdlBindResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Model.Transport">Success</ResponseCode>
  <ComponentFilterIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </ComponentFilterIds>
  <ErrorMessage>sample string 2</ErrorMessage>
  <MenuAccessData>
    <HasAccessToCommand>true</HasAccessToCommand>
    <HasAccessToContract>true</HasAccessToContract>
    <HasAccessToDashboard>true</HasAccessToDashboard>
    <HasAccessToDriver>true</HasAccessToDriver>
    <HasAccessToGroup>true</HasAccessToGroup>
    <HasAccessToLogBook>true</HasAccessToLogBook>
    <HasAccessToMap>true</HasAccessToMap>
    <HasAccessToMetaBaseReport>true</HasAccessToMetaBaseReport>
    <HasAccessToMetaBaseUserDashboard>true</HasAccessToMetaBaseUserDashboard>
    <HasAccessToPOI>true</HasAccessToPOI>
    <HasAccessToProfileTrigger>true</HasAccessToProfileTrigger>
    <HasAccessToRecoveryMode>true</HasAccessToRecoveryMode>
    <HasAccessToReports>true</HasAccessToReports>
    <HasAccessToSIM>true</HasAccessToSIM>
    <HasAccessToScript>true</HasAccessToScript>
    <HasAccessToSettings>true</HasAccessToSettings>
    <HasAccessToTemplate>true</HasAccessToTemplate>
    <HasAccessToTicket>true</HasAccessToTicket>
    <HasAccessToTranslations>true</HasAccessToTranslations>
    <HasAccessToTriggerSchedule>true</HasAccessToTriggerSchedule>
    <HasAccessToTrips>true</HasAccessToTrips>
    <HasAccessToUnit>true</HasAccessToUnit>
    <HasAccessToUnitProfile>true</HasAccessToUnitProfile>
    <HasAccessToUser>true</HasAccessToUser>
    <HasAccessToVehicle>true</HasAccessToVehicle>
    <HasAccessToVehicleAdministration>true</HasAccessToVehicleAdministration>
  </MenuAccessData>
  <StatusCode>3</StatusCode>
  <Success>true</Success>
  <APIDdlBindDataModel>
    <APIDdlBindData>
      <ID>1</ID>
      <Name>sample string 2</Name>
    </APIDdlBindData>
    <APIDdlBindData>
      <ID>1</ID>
      <Name>sample string 2</Name>
    </APIDdlBindData>
    <APIDdlBindData>
      <ID>1</ID>
      <Name>sample string 2</Name>
    </APIDdlBindData>
  </APIDdlBindDataModel>
</APIDdlBindResponse>