GET Rules/{id}
Gets a rule by it's ID, represented as RuleDto.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The ID of the rule. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
The rule data.
RuleDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| NetworkId | globally unique identifier |
None. |
|
| NetworkName | string |
None. |
|
| CompanyId | globally unique identifier |
None. |
|
| CompanyName | string |
None. |
|
| MerchantId | globally unique identifier |
None. |
|
| MerchantName | string |
None. |
|
| CompanyContractId | globally unique identifier |
None. |
|
| ContractDescription | string |
None. |
|
| RuleType | integer |
None. |
|
| Description | string |
None. |
|
| Periodicity | byte |
None. |
|
| PeriodicityAmount | integer |
None. |
|
| MoneyQuota | decimal number |
None. |
|
| VolumeQuota | decimal number |
None. |
|
| TimeFrom | integer |
None. |
|
| TimeTo | integer |
None. |
|
| DateFrom | integer |
None. |
|
| DateTo | integer |
None. |
|
| SecurityLimit | decimal number |
None. |
|
| TransactionsQuantity | integer |
None. |
|
| Retries | integer |
None. |
|
| VehiclePINReprompt | boolean |
None. |
|
| SecondaryTrackReprompt | boolean |
None. |
|
| MiscellaneousReprompt | boolean |
None. |
|
| OdometerReprompt | boolean |
None. |
|
| OdometerMinVariation | integer |
None. |
|
| OdometerMaxVariation | integer |
None. |
|
| EngineHoursReprompt | boolean |
None. |
|
| EngineHoursMinVariation | integer |
None. |
|
| EngineHoursMaxVariation | integer |
None. |
|
| DriverIdReprompt | boolean |
None. |
|
| DriverPINReprompt | boolean |
None. |
|
| PINBlock | boolean |
None. |
|
| PINRetriesLimit | integer |
None. |
|
| TruckUnitNumberReprompt | boolean |
None. |
|
| TrailerNumberReprompt | boolean |
None. |
|
| ContingencyLimit | decimal number |
None. |
|
| OfflineLimit | decimal number |
None. |
|
| SitesIds | Collection of globally unique identifier |
None. |
|
| Owner | byte |
None. |
|
| OwnerDescription | string |
None. |
|
| DaysTimeRuleType | Collection of DaysTimeRuleTypeDto |
None. |
|
| DailyQuotasRuleType | Collection of DailyQuotasRuleTypeDto |
None. |
|
| RuleTypeDescription | string |
None. |
|
| RuleValues | string |
None. |
|
| ProgramId | globally unique identifier |
None. |
|
| ProgramDescription | string |
None. |
|
| ExactDateTime | boolean |
None. |
|
| VehicleIdReprompt | boolean |
None. |
|
| AtionetVisionVehicleIdReprompt | boolean |
None. |
|
| SecondaryTrack | boolean |
None. |
|
| FuelsIds | Collection of globally unique identifier |
None. |
|
| Fuels | Collection of RuleFuelDto |
None. |
|
| Drivers | Collection of RuleDriverDto |
None. |
|
| Vehicles | Collection of RuleVehicleDto |
None. |
|
| Fleets | Collection of RuleFleetDto |
None. |
|
| Zones | Collection of RuleZoneDto |
None. |
|
| FuelGroups | Collection of RuleFuelGroupDto |
None. |
|
| Sites | Collection of RuleSiteDto |
None. |
|
| Merchants | Collection of RuleMerchantDto |
None. |
|
| MerchantsIds | Collection of globally unique identifier |
None. |
|
| NonBlocking | boolean |
None. |
|
| FuelGroupsIds | Collection of globally unique identifier |
None. |
|
| ZonesIds | Collection of globally unique identifier |
None. |
|
| SKUCategoryId | globally unique identifier |
None. |
|
| SKUCategoryDescription | string |
None. |
|
| StartDayOfWeek | byte |
None. |
|
| ValidityDateFrom | date |
None. |
|
| ValidityDateTo | date |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml, text/xml
Sample:
<RuleDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ationet.Model">
<AtionetVisionVehicleIdReprompt>true</AtionetVisionVehicleIdReprompt>
<CompanyContractId>727755c5-9246-48d1-b84d-aea86ec75e41</CompanyContractId>
<CompanyId>ae855809-7c1c-45cc-9a91-2e7f32203f26</CompanyId>
<CompanyName>sample string 3</CompanyName>
<ContingencyLimit>1</ContingencyLimit>
<ContractDescription>sample string 5</ContractDescription>
<DailyQuotasRuleType xmlns:d2p1="http://schemas.datacontract.org/2004/07/Ationet.Model.Rule">
<d2p1:DailyQuotasRuleTypeDto>
<d2p1:Day>64</d2p1:Day>
<d2p1:MoneyQuota>1</d2p1:MoneyQuota>
<d2p1:TransactionsQuantity>1</d2p1:TransactionsQuantity>
<d2p1:VolumeQuota>1</d2p1:VolumeQuota>
</d2p1:DailyQuotasRuleTypeDto>
<d2p1:DailyQuotasRuleTypeDto>
<d2p1:Day>64</d2p1:Day>
<d2p1:MoneyQuota>1</d2p1:MoneyQuota>
<d2p1:TransactionsQuantity>1</d2p1:TransactionsQuantity>
<d2p1:VolumeQuota>1</d2p1:VolumeQuota>
</d2p1:DailyQuotasRuleTypeDto>
</DailyQuotasRuleType>
<DateFrom>1</DateFrom>
<DateTo>1</DateTo>
<DaysTimeRuleType xmlns:d2p1="http://schemas.datacontract.org/2004/07/Ationet.Model.Rule">
<d2p1:DaysTimeRuleTypeDto>
<d2p1:Day>64</d2p1:Day>
<d2p1:TimeRanges>
<d2p1:TimeRangesDto>
<d2p1:TimeFrom>sample string 1</d2p1:TimeFrom>
<d2p1:TimeTo>sample string 2</d2p1:TimeTo>
</d2p1:TimeRangesDto>
<d2p1:TimeRangesDto>
<d2p1:TimeFrom>sample string 1</d2p1:TimeFrom>
<d2p1:TimeTo>sample string 2</d2p1:TimeTo>
</d2p1:TimeRangesDto>
</d2p1:TimeRanges>
</d2p1:DaysTimeRuleTypeDto>
<d2p1:DaysTimeRuleTypeDto>
<d2p1:Day>64</d2p1:Day>
<d2p1:TimeRanges>
<d2p1:TimeRangesDto>
<d2p1:TimeFrom>sample string 1</d2p1:TimeFrom>
<d2p1:TimeTo>sample string 2</d2p1:TimeTo>
</d2p1:TimeRangesDto>
<d2p1:TimeRangesDto>
<d2p1:TimeFrom>sample string 1</d2p1:TimeFrom>
<d2p1:TimeTo>sample string 2</d2p1:TimeTo>
</d2p1:TimeRangesDto>
</d2p1:TimeRanges>
</d2p1:DaysTimeRuleTypeDto>
</DaysTimeRuleType>
<Description>sample string 6</Description>
<DriverIdReprompt>true</DriverIdReprompt>
<DriverPINReprompt>true</DriverPINReprompt>
<Drivers>
<RuleDriverDto>
<DriverCode>sample string 6</DriverCode>
<DriverName>sample string 5</DriverName>
<IdDriver>0e4f00b5-dbae-4c1e-884a-9010df649993</IdDriver>
<IdRule>a24263e3-7198-42ff-bbda-e060fa156d54</IdRule>
<RuleName>sample string 2</RuleName>
<RuleType>3</RuleType>
</RuleDriverDto>
<RuleDriverDto>
<DriverCode>sample string 6</DriverCode>
<DriverName>sample string 5</DriverName>
<IdDriver>0e4f00b5-dbae-4c1e-884a-9010df649993</IdDriver>
<IdRule>a24263e3-7198-42ff-bbda-e060fa156d54</IdRule>
<RuleName>sample string 2</RuleName>
<RuleType>3</RuleType>
</RuleDriverDto>
</Drivers>
<EngineHoursMaxVariation>1</EngineHoursMaxVariation>
<EngineHoursMinVariation>1</EngineHoursMinVariation>
<EngineHoursReprompt>true</EngineHoursReprompt>
<ExactDateTime>true</ExactDateTime>
<Fleets>
<RuleFleetDto>
<Description>sample string 8</Description>
<FleetCode>sample string 7</FleetCode>
<FleetName>sample string 6</FleetName>
<IdFleet>a6177d52-2466-4fb3-9815-6ac108a203e7</IdFleet>
<IdRule>a0f72b4a-b544-489d-b3be-15d20b19711c</IdRule>
<RuleName>sample string 2</RuleName>
<RuleType>3</RuleType>
<RuleTypeDescription>sample string 4</RuleTypeDescription>
</RuleFleetDto>
<RuleFleetDto>
<Description>sample string 8</Description>
<FleetCode>sample string 7</FleetCode>
<FleetName>sample string 6</FleetName>
<IdFleet>a6177d52-2466-4fb3-9815-6ac108a203e7</IdFleet>
<IdRule>a0f72b4a-b544-489d-b3be-15d20b19711c</IdRule>
<RuleName>sample string 2</RuleName>
<RuleType>3</RuleType>
<RuleTypeDescription>sample string 4</RuleTypeDescription>
</RuleFleetDto>
</Fleets>
<FuelGroups>
<RuleFuelGroupDto>
<FuelGroupId>ba41d518-a904-401d-96ec-91afc415eacf</FuelGroupId>
<FuelGroupsCode>sample string 3</FuelGroupsCode>
<FuelGroupsName>sample string 2</FuelGroupsName>
</RuleFuelGroupDto>
<RuleFuelGroupDto>
<FuelGroupId>ba41d518-a904-401d-96ec-91afc415eacf</FuelGroupId>
<FuelGroupsCode>sample string 3</FuelGroupsCode>
<FuelGroupsName>sample string 2</FuelGroupsName>
</RuleFuelGroupDto>
</FuelGroups>
<FuelGroupsIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>7406e7eb-47c9-4d77-9189-93f74f78bdaa</d2p1:guid>
<d2p1:guid>4cea88f8-8f71-44fd-88f4-8f704f38b6e3</d2p1:guid>
</FuelGroupsIds>
<Fuels xmlns:d2p1="http://schemas.datacontract.org/2004/07/Ationet.Model.Rule">
<d2p1:RuleFuelDto>
<d2p1:FuelCode>sample string 6</d2p1:FuelCode>
<d2p1:FuelName>sample string 5</d2p1:FuelName>
<d2p1:IdFuel>6cf4e338-f337-4607-b181-84ede70f116d</d2p1:IdFuel>
<d2p1:IdRule>58da6c3a-0380-4674-9394-51ddbee2abf0</d2p1:IdRule>
<d2p1:RuleName>sample string 2</d2p1:RuleName>
<d2p1:RuleType>3</d2p1:RuleType>
</d2p1:RuleFuelDto>
<d2p1:RuleFuelDto>
<d2p1:FuelCode>sample string 6</d2p1:FuelCode>
<d2p1:FuelName>sample string 5</d2p1:FuelName>
<d2p1:IdFuel>6cf4e338-f337-4607-b181-84ede70f116d</d2p1:IdFuel>
<d2p1:IdRule>58da6c3a-0380-4674-9394-51ddbee2abf0</d2p1:IdRule>
<d2p1:RuleName>sample string 2</d2p1:RuleName>
<d2p1:RuleType>3</d2p1:RuleType>
</d2p1:RuleFuelDto>
</Fuels>
<FuelsIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>41f70b34-fc2e-4490-b4f5-e5f9a527971a</d2p1:guid>
<d2p1:guid>06952c40-1982-421d-93e5-8fef77d77762</d2p1:guid>
</FuelsIds>
<Id>3d6b8f02-ae4b-4530-88ba-388b699139e3</Id>
<MerchantId>ca9e2e9f-4170-4e91-a573-98d4dbc46eaa</MerchantId>
<MerchantName>sample string 4</MerchantName>
<Merchants>
<RuleMerchantDto>
<MerchantCode>sample string 3</MerchantCode>
<MerchantId>4b3cbb7f-e48c-43dc-bd35-1dd420b31dbd</MerchantId>
<MerchantName>sample string 2</MerchantName>
</RuleMerchantDto>
<RuleMerchantDto>
<MerchantCode>sample string 3</MerchantCode>
<MerchantId>4b3cbb7f-e48c-43dc-bd35-1dd420b31dbd</MerchantId>
<MerchantName>sample string 2</MerchantName>
</RuleMerchantDto>
</Merchants>
<MerchantsIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>f40c2763-1611-42cb-8155-bfc72185f095</d2p1:guid>
<d2p1:guid>139424f8-c610-4670-8f09-90110232b03b</d2p1:guid>
</MerchantsIds>
<MiscellaneousReprompt>true</MiscellaneousReprompt>
<MoneyQuota>1</MoneyQuota>
<NetworkId>b1d0ae29-bd7e-4879-aa7a-caa260173b9d</NetworkId>
<NetworkName>sample string 2</NetworkName>
<NonBlocking>true</NonBlocking>
<OdometerMaxVariation>1</OdometerMaxVariation>
<OdometerMinVariation>1</OdometerMinVariation>
<OdometerReprompt>true</OdometerReprompt>
<OfflineLimit>1</OfflineLimit>
<Owner>64</Owner>
<OwnerDescription>sample string 18</OwnerDescription>
<PINBlock>true</PINBlock>
<PINRetriesLimit>1</PINRetriesLimit>
<Periodicity>64</Periodicity>
<PeriodicityAmount>1</PeriodicityAmount>
<ProgramDescription>sample string 21</ProgramDescription>
<ProgramId>7d1a2dbe-7056-4f9b-af1a-1ebc3426cf37</ProgramId>
<Retries>1</Retries>
<RuleType>1</RuleType>
<RuleTypeDescription>sample string 19</RuleTypeDescription>
<RuleValues>sample string 20</RuleValues>
<SKUCategoryDescription>sample string 27</SKUCategoryDescription>
<SKUCategoryId>8e75c5c6-a3fa-4c05-8b3e-37f30a31d3cb</SKUCategoryId>
<SecondaryTrack>true</SecondaryTrack>
<SecondaryTrackReprompt>true</SecondaryTrackReprompt>
<SecurityLimit>1</SecurityLimit>
<Sites>
<RuleSiteDto>
<SiteCode>sample string 4</SiteCode>
<SiteDescription>sample string 3</SiteDescription>
<SiteId>9aaef9b5-1a57-4ac5-9da0-d1195a2e0577</SiteId>
<SiteName>sample string 2</SiteName>
</RuleSiteDto>
<RuleSiteDto>
<SiteCode>sample string 4</SiteCode>
<SiteDescription>sample string 3</SiteDescription>
<SiteId>9aaef9b5-1a57-4ac5-9da0-d1195a2e0577</SiteId>
<SiteName>sample string 2</SiteName>
</RuleSiteDto>
</Sites>
<SitesIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>9ab2460b-bbdb-4230-82ca-60fa179448a4</d2p1:guid>
<d2p1:guid>9fcd2336-011b-4d01-9cc6-9aaaa6c2089c</d2p1:guid>
</SitesIds>
<StartDayOfWeek>64</StartDayOfWeek>
<TimeFrom>1</TimeFrom>
<TimeTo>1</TimeTo>
<TrailerNumberReprompt>true</TrailerNumberReprompt>
<TransactionsQuantity>1</TransactionsQuantity>
<TruckUnitNumberReprompt>true</TruckUnitNumberReprompt>
<ValidityDateFrom>2025-10-29T05:30:54.8620184Z</ValidityDateFrom>
<ValidityDateTo>2025-10-29T05:30:54.8620184Z</ValidityDateTo>
<VehicleIdReprompt>true</VehicleIdReprompt>
<VehiclePINReprompt>true</VehiclePINReprompt>
<Vehicles>
<RuleVehicleDto>
<Description>sample string 8</Description>
<IdRule>4f3d4bff-f5e4-47f9-be83-81742e05ddf6</IdRule>
<IdVehicle>660bc2aa-88bb-4fb6-acdc-07fd9dbd8e34</IdVehicle>
<RuleName>sample string 2</RuleName>
<RuleType>3</RuleType>
<RuleTypeDescription>sample string 4</RuleTypeDescription>
<VehicleCode>sample string 6</VehicleCode>
<VehiclePlate>sample string 7</VehiclePlate>
</RuleVehicleDto>
<RuleVehicleDto>
<Description>sample string 8</Description>
<IdRule>4f3d4bff-f5e4-47f9-be83-81742e05ddf6</IdRule>
<IdVehicle>660bc2aa-88bb-4fb6-acdc-07fd9dbd8e34</IdVehicle>
<RuleName>sample string 2</RuleName>
<RuleType>3</RuleType>
<RuleTypeDescription>sample string 4</RuleTypeDescription>
<VehicleCode>sample string 6</VehicleCode>
<VehiclePlate>sample string 7</VehiclePlate>
</RuleVehicleDto>
</Vehicles>
<VolumeQuota>1</VolumeQuota>
<Zones>
<RuleZoneDto>
<ZoneCode>sample string 3</ZoneCode>
<ZoneId>2617eca1-3c15-422b-9327-9cd627209cfa</ZoneId>
<ZoneName>sample string 2</ZoneName>
</RuleZoneDto>
<RuleZoneDto>
<ZoneCode>sample string 3</ZoneCode>
<ZoneId>2617eca1-3c15-422b-9327-9cd627209cfa</ZoneId>
<ZoneName>sample string 2</ZoneName>
</RuleZoneDto>
</Zones>
<ZonesIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>969d1716-dcc9-491e-a01c-b64658459b52</d2p1:guid>
<d2p1:guid>900ff195-fd28-4c82-983d-fa4a4d506850</d2p1:guid>
</ZonesIds>
</RuleDto>