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>740feec2-44f3-4420-abb5-95ed231d717d</CompanyContractId>
<CompanyId>3ced3d82-6a77-4b3d-8acb-fd8c285f950d</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>c7e57e7c-367b-4ecf-aa80-c9ed707e38d7</IdDriver>
<IdRule>1e782dce-3fed-4a4e-8ec5-c7b01ffd1db0</IdRule>
<RuleName>sample string 2</RuleName>
<RuleType>3</RuleType>
</RuleDriverDto>
<RuleDriverDto>
<DriverCode>sample string 6</DriverCode>
<DriverName>sample string 5</DriverName>
<IdDriver>c7e57e7c-367b-4ecf-aa80-c9ed707e38d7</IdDriver>
<IdRule>1e782dce-3fed-4a4e-8ec5-c7b01ffd1db0</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>289caea8-e1a6-4a73-83df-fc6c12acc910</IdFleet>
<IdRule>d1205a7d-3d30-4929-a366-df7250900ac9</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>289caea8-e1a6-4a73-83df-fc6c12acc910</IdFleet>
<IdRule>d1205a7d-3d30-4929-a366-df7250900ac9</IdRule>
<RuleName>sample string 2</RuleName>
<RuleType>3</RuleType>
<RuleTypeDescription>sample string 4</RuleTypeDescription>
</RuleFleetDto>
</Fleets>
<FuelGroups>
<RuleFuelGroupDto>
<FuelGroupId>be7171a0-6661-40c1-af1f-094d681c6781</FuelGroupId>
<FuelGroupsCode>sample string 3</FuelGroupsCode>
<FuelGroupsName>sample string 2</FuelGroupsName>
</RuleFuelGroupDto>
<RuleFuelGroupDto>
<FuelGroupId>be7171a0-6661-40c1-af1f-094d681c6781</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>9793962c-d534-45fd-9468-3a03113fc6b8</d2p1:guid>
<d2p1:guid>6fb072b7-f207-4286-8808-2d1fa1568565</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>45953124-4298-4943-b479-6e2af095ed17</d2p1:IdFuel>
<d2p1:IdRule>aac9f71a-ef06-473e-9950-d3a1c6a0a43b</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>45953124-4298-4943-b479-6e2af095ed17</d2p1:IdFuel>
<d2p1:IdRule>aac9f71a-ef06-473e-9950-d3a1c6a0a43b</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>db1ff062-6330-4c51-8f63-2f1ed89d6d17</d2p1:guid>
<d2p1:guid>6e654848-173c-4186-9eae-388df6ba0b2e</d2p1:guid>
</FuelsIds>
<Id>6a16db55-90b0-4798-8bc0-94e93c4db7d6</Id>
<MerchantId>84b6cf4d-60bc-4a71-8008-860cc208270f</MerchantId>
<MerchantName>sample string 4</MerchantName>
<Merchants>
<RuleMerchantDto>
<MerchantCode>sample string 3</MerchantCode>
<MerchantId>6441f378-679e-4477-9b03-b6aa6d1b11ba</MerchantId>
<MerchantName>sample string 2</MerchantName>
</RuleMerchantDto>
<RuleMerchantDto>
<MerchantCode>sample string 3</MerchantCode>
<MerchantId>6441f378-679e-4477-9b03-b6aa6d1b11ba</MerchantId>
<MerchantName>sample string 2</MerchantName>
</RuleMerchantDto>
</Merchants>
<MerchantsIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>bf733034-dc9a-4e31-80bf-16ef688aebae</d2p1:guid>
<d2p1:guid>c5c5614e-7a3f-4f81-9b99-9170ae547065</d2p1:guid>
</MerchantsIds>
<MiscellaneousReprompt>true</MiscellaneousReprompt>
<MoneyQuota>1</MoneyQuota>
<NetworkId>a0dc76d8-18b4-4dd8-b0fc-35335446e793</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>62324bae-ce5a-43fe-aafb-a81b826bfa55</ProgramId>
<Retries>1</Retries>
<RuleType>1</RuleType>
<RuleTypeDescription>sample string 19</RuleTypeDescription>
<RuleValues>sample string 20</RuleValues>
<SKUCategoryDescription>sample string 27</SKUCategoryDescription>
<SKUCategoryId>88fe7aed-5f5c-40e2-883f-6c2e9b74a3c7</SKUCategoryId>
<SecondaryTrack>true</SecondaryTrack>
<SecondaryTrackReprompt>true</SecondaryTrackReprompt>
<SecurityLimit>1</SecurityLimit>
<Sites>
<RuleSiteDto>
<SiteCode>sample string 4</SiteCode>
<SiteDescription>sample string 3</SiteDescription>
<SiteId>9c85b295-5b63-41c1-8bb2-c309b7adca5d</SiteId>
<SiteName>sample string 2</SiteName>
</RuleSiteDto>
<RuleSiteDto>
<SiteCode>sample string 4</SiteCode>
<SiteDescription>sample string 3</SiteDescription>
<SiteId>9c85b295-5b63-41c1-8bb2-c309b7adca5d</SiteId>
<SiteName>sample string 2</SiteName>
</RuleSiteDto>
</Sites>
<SitesIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>c0ef17f6-b5a2-497a-bdac-0e9b53e34910</d2p1:guid>
<d2p1:guid>2afeb649-1986-4d00-b2da-2bcec0b3578a</d2p1:guid>
</SitesIds>
<StartDayOfWeek>64</StartDayOfWeek>
<TimeFrom>1</TimeFrom>
<TimeTo>1</TimeTo>
<TrailerNumberReprompt>true</TrailerNumberReprompt>
<TransactionsQuantity>1</TransactionsQuantity>
<TruckUnitNumberReprompt>true</TruckUnitNumberReprompt>
<ValidityDateFrom>2026-03-13T12:26:07.4400323Z</ValidityDateFrom>
<ValidityDateTo>2026-03-13T12:26:07.4400323Z</ValidityDateTo>
<VehicleIdReprompt>true</VehicleIdReprompt>
<VehiclePINReprompt>true</VehiclePINReprompt>
<Vehicles>
<RuleVehicleDto>
<Description>sample string 8</Description>
<IdRule>a219eb3c-08e7-4a09-9522-ca55829c833e</IdRule>
<IdVehicle>56e59cb5-2006-49b2-860c-9fc8a60e4402</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>a219eb3c-08e7-4a09-9522-ca55829c833e</IdRule>
<IdVehicle>56e59cb5-2006-49b2-860c-9fc8a60e4402</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>5bf8e43f-2bef-4171-9f70-b2f72212e2b7</ZoneId>
<ZoneName>sample string 2</ZoneName>
</RuleZoneDto>
<RuleZoneDto>
<ZoneCode>sample string 3</ZoneCode>
<ZoneId>5bf8e43f-2bef-4171-9f70-b2f72212e2b7</ZoneId>
<ZoneName>sample string 2</ZoneName>
</RuleZoneDto>
</Zones>
<ZonesIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>f6423a65-b56e-4f9a-b577-baafca3ce74b</d2p1:guid>
<d2p1:guid>1971216d-de0b-4572-bc31-66e6b5d2eddf</d2p1:guid>
</ZonesIds>
</RuleDto>