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>6df6b84b-30cc-4a96-b54c-005105082260</CompanyContractId>
<CompanyId>dc7aa5cd-6db2-4ae1-a895-a894a0d1e1fa</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>25c2961a-3858-4baa-906c-129efa7adc05</IdDriver>
<IdRule>e457d224-5d03-4c77-a214-4f09456262ca</IdRule>
<RuleName>sample string 2</RuleName>
<RuleType>3</RuleType>
</RuleDriverDto>
<RuleDriverDto>
<DriverCode>sample string 6</DriverCode>
<DriverName>sample string 5</DriverName>
<IdDriver>25c2961a-3858-4baa-906c-129efa7adc05</IdDriver>
<IdRule>e457d224-5d03-4c77-a214-4f09456262ca</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>e5de10bd-c8bc-4943-bb35-01893c0daa9b</IdFleet>
<IdRule>de290fc4-e544-43d7-8a97-597d25203e8d</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>e5de10bd-c8bc-4943-bb35-01893c0daa9b</IdFleet>
<IdRule>de290fc4-e544-43d7-8a97-597d25203e8d</IdRule>
<RuleName>sample string 2</RuleName>
<RuleType>3</RuleType>
<RuleTypeDescription>sample string 4</RuleTypeDescription>
</RuleFleetDto>
</Fleets>
<FuelGroups>
<RuleFuelGroupDto>
<FuelGroupId>a06c2b7c-9adf-400e-98ba-b2dc27e271a7</FuelGroupId>
<FuelGroupsCode>sample string 3</FuelGroupsCode>
<FuelGroupsName>sample string 2</FuelGroupsName>
</RuleFuelGroupDto>
<RuleFuelGroupDto>
<FuelGroupId>a06c2b7c-9adf-400e-98ba-b2dc27e271a7</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>67072eef-6632-49e2-87e9-845a1f73c65b</d2p1:guid>
<d2p1:guid>723d0d18-73a0-4af4-bead-882a07c0a4ad</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>0ca8bfc1-9547-4ccf-ab74-726eb14cb94a</d2p1:IdFuel>
<d2p1:IdRule>34216090-b258-43e1-9969-0f9b4c8a6350</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>0ca8bfc1-9547-4ccf-ab74-726eb14cb94a</d2p1:IdFuel>
<d2p1:IdRule>34216090-b258-43e1-9969-0f9b4c8a6350</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>aa389176-5c08-420a-90e0-13a1bb3d7d60</d2p1:guid>
<d2p1:guid>eb378920-0ffc-4aa2-a99b-d343b3c2e5b4</d2p1:guid>
</FuelsIds>
<Id>f1652d80-57ee-48c8-9f38-3858a0b8bbe6</Id>
<MerchantId>abc6cffc-3520-4a4d-9f87-cf8eff284a8b</MerchantId>
<MerchantName>sample string 4</MerchantName>
<Merchants>
<RuleMerchantDto>
<MerchantCode>sample string 3</MerchantCode>
<MerchantId>b8a91fb8-791f-4353-a429-19f5ea10944e</MerchantId>
<MerchantName>sample string 2</MerchantName>
</RuleMerchantDto>
<RuleMerchantDto>
<MerchantCode>sample string 3</MerchantCode>
<MerchantId>b8a91fb8-791f-4353-a429-19f5ea10944e</MerchantId>
<MerchantName>sample string 2</MerchantName>
</RuleMerchantDto>
</Merchants>
<MerchantsIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>3f34a89d-c4b2-4765-8838-5e1109de818f</d2p1:guid>
<d2p1:guid>8c326838-70d3-4a1e-abfa-5485034a7ad5</d2p1:guid>
</MerchantsIds>
<MiscellaneousReprompt>true</MiscellaneousReprompt>
<MoneyQuota>1</MoneyQuota>
<NetworkId>b32a1c67-033c-49c2-b928-f7eac00255c8</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>5cd22282-721b-47b8-864a-b48f9ad3371d</ProgramId>
<Retries>1</Retries>
<RuleType>1</RuleType>
<RuleTypeDescription>sample string 19</RuleTypeDescription>
<RuleValues>sample string 20</RuleValues>
<SKUCategoryDescription>sample string 27</SKUCategoryDescription>
<SKUCategoryId>4d1ea06e-17b1-4505-b024-4c7b3449d8e6</SKUCategoryId>
<SecondaryTrack>true</SecondaryTrack>
<SecondaryTrackReprompt>true</SecondaryTrackReprompt>
<SecurityLimit>1</SecurityLimit>
<Sites>
<RuleSiteDto>
<SiteCode>sample string 4</SiteCode>
<SiteDescription>sample string 3</SiteDescription>
<SiteId>1b9abb2a-70b3-4a8b-ae8e-b1520f0a8885</SiteId>
<SiteName>sample string 2</SiteName>
</RuleSiteDto>
<RuleSiteDto>
<SiteCode>sample string 4</SiteCode>
<SiteDescription>sample string 3</SiteDescription>
<SiteId>1b9abb2a-70b3-4a8b-ae8e-b1520f0a8885</SiteId>
<SiteName>sample string 2</SiteName>
</RuleSiteDto>
</Sites>
<SitesIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>d6e07a9d-55cf-4b2b-93d2-61c0efdc03c0</d2p1:guid>
<d2p1:guid>cfb44f10-7714-418b-a683-d112eef0e551</d2p1:guid>
</SitesIds>
<StartDayOfWeek>64</StartDayOfWeek>
<TimeFrom>1</TimeFrom>
<TimeTo>1</TimeTo>
<TrailerNumberReprompt>true</TrailerNumberReprompt>
<TransactionsQuantity>1</TransactionsQuantity>
<TruckUnitNumberReprompt>true</TruckUnitNumberReprompt>
<ValidityDateFrom>2025-12-15T13:00:15.1601683Z</ValidityDateFrom>
<ValidityDateTo>2025-12-15T13:00:15.1601683Z</ValidityDateTo>
<VehicleIdReprompt>true</VehicleIdReprompt>
<VehiclePINReprompt>true</VehiclePINReprompt>
<Vehicles>
<RuleVehicleDto>
<Description>sample string 8</Description>
<IdRule>5db2bde9-1ae3-42a7-a3ec-0dee59b21d82</IdRule>
<IdVehicle>91ec76c3-ec1e-4b48-814e-a2ebbf7bc4d3</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>5db2bde9-1ae3-42a7-a3ec-0dee59b21d82</IdRule>
<IdVehicle>91ec76c3-ec1e-4b48-814e-a2ebbf7bc4d3</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>198bef36-c7e9-4882-b1d4-84fce0ee3111</ZoneId>
<ZoneName>sample string 2</ZoneName>
</RuleZoneDto>
<RuleZoneDto>
<ZoneCode>sample string 3</ZoneCode>
<ZoneId>198bef36-c7e9-4882-b1d4-84fce0ee3111</ZoneId>
<ZoneName>sample string 2</ZoneName>
</RuleZoneDto>
</Zones>
<ZonesIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>18ec49c9-ac53-41b3-a089-70ac2b333eb4</d2p1:guid>
<d2p1:guid>1df1ed18-8620-4f4f-a85e-752950fda8f3</d2p1:guid>
</ZonesIds>
</RuleDto>