POST api/UnitConfig/RetrieveTripLogicWithSummary

Fetches TripLogic as per the request.

Request Information

Parameters

NameDescriptionAdditional information
req

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "UnitProfileId": 1,
  "IsSummaryDataIncluded": true,
  "IsTripLogicDataIncluded": true,
  "Token": "sample string 4",
  "FreeText": "sample string 5",
  "GroupIds": [
    1,
    2,
    3
  ],
  "FromIndex": 6,
  "ToIndex": 7,
  "IsWebCalling": true,
  "RequestMode": "sample string 9",
  "Client": "sample string 10",
  "AppVersion": "sample string 11",
  "AppOperatingSystem": "sample string 12",
  "AppName": "sample string 13",
  "MasterUserID": 14,
  "IsRecurringRequest": true
}

text/html

Sample:
{"UnitProfileId":1,"IsSummaryDataIncluded":true,"IsTripLogicDataIncluded":true,"Token":"sample string 4","FreeText":"sample string 5","GroupIds":[1,2,3],"FromIndex":6,"ToIndex":7,"IsWebCalling":true,"RequestMode":"sample string 9","Client":"sample string 10","AppVersion":"sample string 11","AppOperatingSystem":"sample string 12","AppName":"sample string 13","MasterUserID":14,"IsRecurringRequest":true}

application/xml, text/xml

Sample:
<APIRetrieveTripLogicRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Model.APIModels">
  <AppName xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 13</AppName>
  <AppOperatingSystem xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 12</AppOperatingSystem>
  <AppVersion xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 11</AppVersion>
  <Client xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 10</Client>
  <FreeText xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 5</FreeText>
  <FromIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">6</FromIndex>
  <GroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </GroupIds>
  <IsRecurringRequest xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">true</IsRecurringRequest>
  <IsWebCalling xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">true</IsWebCalling>
  <MasterUserID xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">14</MasterUserID>
  <RequestMode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 9</RequestMode>
  <ToIndex xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">7</ToIndex>
  <Token xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 4</Token>
  <IsSummaryDataIncluded>true</IsSummaryDataIncluded>
  <IsTripLogicDataIncluded>true</IsTripLogicDataIncluded>
  <UnitProfileId>1</UnitProfileId>
</APIRetrieveTripLogicRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "TripLogicData": [
    {
      "ID": 1,
      "Name": "sample string 2",
      "FieldTitle": "sample string 3",
      "FieldTooltip": "sample string 4",
      "Value": "sample string 5",
      "DataType": "sample string 6",
      "FieldType": "sample string 7",
      "FieldMetaData": "sample string 8",
      "DataLength": 9,
      "AccessRights": {
        "HasRetrieveAccess": true,
        "HasUpdateAccess": true,
        "HasDeleteAccess": true,
        "HasCreateAccess": true
      }
    },
    {
      "ID": 1,
      "Name": "sample string 2",
      "FieldTitle": "sample string 3",
      "FieldTooltip": "sample string 4",
      "Value": "sample string 5",
      "DataType": "sample string 6",
      "FieldType": "sample string 7",
      "FieldMetaData": "sample string 8",
      "DataLength": 9,
      "AccessRights": {
        "HasRetrieveAccess": true,
        "HasUpdateAccess": true,
        "HasDeleteAccess": true,
        "HasCreateAccess": true
      }
    },
    {
      "ID": 1,
      "Name": "sample string 2",
      "FieldTitle": "sample string 3",
      "FieldTooltip": "sample string 4",
      "Value": "sample string 5",
      "DataType": "sample string 6",
      "FieldType": "sample string 7",
      "FieldMetaData": "sample string 8",
      "DataLength": 9,
      "AccessRights": {
        "HasRetrieveAccess": true,
        "HasUpdateAccess": true,
        "HasDeleteAccess": true,
        "HasCreateAccess": true
      }
    }
  ],
  "SummaryData": {
    "TotalTriggers": 1,
    "TotalCommands": 2,
    "TotalUnits": 3,
    "ProfileName": "sample string 4",
    "Description": "sample string 5",
    "DeviceVendor": "sample string 6",
    "DeviceVendorID": 7
  },
  "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
  },
  "StatusCode": 3,
  "ComponentFilterIds": [
    1,
    2,
    3
  ]
}

text/html

Sample:
{"TripLogicData":[{"ID":1,"Name":"sample string 2","FieldTitle":"sample string 3","FieldTooltip":"sample string 4","Value":"sample string 5","DataType":"sample string 6","FieldType":"sample string 7","FieldMetaData":"sample string 8","DataLength":9,"AccessRights":{"HasRetrieveAccess":true,"HasUpdateAccess":true,"HasDeleteAccess":true,"HasCreateAccess":true}},{"ID":1,"Name":"sample string 2","FieldTitle":"sample string 3","FieldTooltip":"sample string 4","Value":"sample string 5","DataType":"sample string 6","FieldType":"sample string 7","FieldMetaData":"sample string 8","DataLength":9,"AccessRights":{"HasRetrieveAccess":true,"HasUpdateAccess":true,"HasDeleteAccess":true,"HasCreateAccess":true}},{"ID":1,"Name":"sample string 2","FieldTitle":"sample string 3","FieldTooltip":"sample string 4","Value":"sample string 5","DataType":"sample string 6","FieldType":"sample string 7","FieldMetaData":"sample string 8","DataLength":9,"AccessRights":{"HasRetrieveAccess":true,"HasUpdateAccess":true,"HasDeleteAccess":true,"HasCreateAccess":true}}],"SummaryData":{"TotalTriggers":1,"TotalCommands":2,"TotalUnits":3,"ProfileName":"sample string 4","Description":"sample string 5","DeviceVendor":"sample string 6","DeviceVendorID":7},"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},"StatusCode":3,"ComponentFilterIds":[1,2,3]}

application/xml, text/xml

Sample:
<APITripLogicWithSummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Model.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" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </ComponentFilterIds>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">sample string 2</ErrorMessage>
  <MenuAccessData xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
    <HasAccessToCommand>true</HasAccessToCommand>
    <HasAccessToContract>true</HasAccessToContract>
    <HasAccessToDashboard>true</HasAccessToDashboard>
    <HasAccessToDriver>true</HasAccessToDriver>
    <HasAccessToGroup>true</HasAccessToGroup>
    <HasAccessToLogBook>true</HasAccessToLogBook>
    <HasAccessToMap>true</HasAccessToMap>
    <HasAccessToPOI>true</HasAccessToPOI>
    <HasAccessToProfileTrigger>true</HasAccessToProfileTrigger>
    <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 xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">3</StatusCode>
  <Success xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">true</Success>
  <SummaryData>
    <Description>sample string 5</Description>
    <DeviceVendor>sample string 6</DeviceVendor>
    <DeviceVendorID>7</DeviceVendorID>
    <ProfileName>sample string 4</ProfileName>
    <TotalCommands>2</TotalCommands>
    <TotalTriggers>1</TotalTriggers>
    <TotalUnits>3</TotalUnits>
  </SummaryData>
  <TripLogicData>
    <APITripLogicWithSummaryData>
      <AccessRights xmlns:d4p1="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
        <d4p1:HasCreateAccess>true</d4p1:HasCreateAccess>
        <d4p1:HasDeleteAccess>true</d4p1:HasDeleteAccess>
        <d4p1:HasRetrieveAccess>true</d4p1:HasRetrieveAccess>
        <d4p1:HasUpdateAccess>true</d4p1:HasUpdateAccess>
      </AccessRights>
      <DataLength>9</DataLength>
      <DataType>sample string 6</DataType>
      <FieldMetaData>sample string 8</FieldMetaData>
      <FieldTitle>sample string 3</FieldTitle>
      <FieldTooltip>sample string 4</FieldTooltip>
      <FieldType>sample string 7</FieldType>
      <ID>1</ID>
      <Name>sample string 2</Name>
      <Value>sample string 5</Value>
    </APITripLogicWithSummaryData>
    <APITripLogicWithSummaryData>
      <AccessRights xmlns:d4p1="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
        <d4p1:HasCreateAccess>true</d4p1:HasCreateAccess>
        <d4p1:HasDeleteAccess>true</d4p1:HasDeleteAccess>
        <d4p1:HasRetrieveAccess>true</d4p1:HasRetrieveAccess>
        <d4p1:HasUpdateAccess>true</d4p1:HasUpdateAccess>
      </AccessRights>
      <DataLength>9</DataLength>
      <DataType>sample string 6</DataType>
      <FieldMetaData>sample string 8</FieldMetaData>
      <FieldTitle>sample string 3</FieldTitle>
      <FieldTooltip>sample string 4</FieldTooltip>
      <FieldType>sample string 7</FieldType>
      <ID>1</ID>
      <Name>sample string 2</Name>
      <Value>sample string 5</Value>
    </APITripLogicWithSummaryData>
    <APITripLogicWithSummaryData>
      <AccessRights xmlns:d4p1="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
        <d4p1:HasCreateAccess>true</d4p1:HasCreateAccess>
        <d4p1:HasDeleteAccess>true</d4p1:HasDeleteAccess>
        <d4p1:HasRetrieveAccess>true</d4p1:HasRetrieveAccess>
        <d4p1:HasUpdateAccess>true</d4p1:HasUpdateAccess>
      </AccessRights>
      <DataLength>9</DataLength>
      <DataType>sample string 6</DataType>
      <FieldMetaData>sample string 8</FieldMetaData>
      <FieldTitle>sample string 3</FieldTitle>
      <FieldTooltip>sample string 4</FieldTooltip>
      <FieldType>sample string 7</FieldType>
      <ID>1</ID>
      <Name>sample string 2</Name>
      <Value>sample string 5</Value>
    </APITripLogicWithSummaryData>
  </TripLogicData>
</APITripLogicWithSummaryResponse>