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.
RuleDtoName | 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>92545d54-718b-477e-9213-2843268e42a8</CompanyContractId> <CompanyId>2fe9735e-b486-4646-a9ca-3c73a4556617</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>7114c64d-451c-4174-b29c-1ae68be1700a</IdDriver> <IdRule>dcef101e-3ed6-4d46-af09-c3fab4a60843</IdRule> <RuleName>sample string 2</RuleName> <RuleType>3</RuleType> </RuleDriverDto> <RuleDriverDto> <DriverCode>sample string 6</DriverCode> <DriverName>sample string 5</DriverName> <IdDriver>7114c64d-451c-4174-b29c-1ae68be1700a</IdDriver> <IdRule>dcef101e-3ed6-4d46-af09-c3fab4a60843</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>063aa83e-b5e7-4280-aa74-43247ff42775</IdFleet> <IdRule>aeffcec1-dc2a-4deb-943f-2299dd7c6d95</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>063aa83e-b5e7-4280-aa74-43247ff42775</IdFleet> <IdRule>aeffcec1-dc2a-4deb-943f-2299dd7c6d95</IdRule> <RuleName>sample string 2</RuleName> <RuleType>3</RuleType> <RuleTypeDescription>sample string 4</RuleTypeDescription> </RuleFleetDto> </Fleets> <FuelGroups> <RuleFuelGroupDto> <FuelGroupId>ddd46481-0d97-461d-b621-22a29e5028b7</FuelGroupId> <FuelGroupsCode>sample string 3</FuelGroupsCode> <FuelGroupsName>sample string 2</FuelGroupsName> </RuleFuelGroupDto> <RuleFuelGroupDto> <FuelGroupId>ddd46481-0d97-461d-b621-22a29e5028b7</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>cade6cdc-fed8-4c53-b9dd-21a3b24731c4</d2p1:guid> <d2p1:guid>315b3bb5-3f79-4489-bf4c-3ce06b4738cf</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>59c4887e-75ae-4529-af1b-a364cc3c393d</d2p1:IdFuel> <d2p1:IdRule>b06059ae-a23c-446d-a32b-bf5beff25632</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>59c4887e-75ae-4529-af1b-a364cc3c393d</d2p1:IdFuel> <d2p1:IdRule>b06059ae-a23c-446d-a32b-bf5beff25632</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>303f1a86-383b-4486-a43f-5dd660b7faf5</d2p1:guid> <d2p1:guid>90031827-8769-41f2-9201-ec7a625711fd</d2p1:guid> </FuelsIds> <Id>353b105b-9609-4090-af1d-8d4d3b4b20c0</Id> <MerchantId>64eadb7a-f5a0-4a0c-9272-b29d8c190470</MerchantId> <MerchantName>sample string 4</MerchantName> <Merchants> <RuleMerchantDto> <MerchantCode>sample string 3</MerchantCode> <MerchantId>c20b9558-548d-44b1-bc8d-c18d211f81f2</MerchantId> <MerchantName>sample string 2</MerchantName> </RuleMerchantDto> <RuleMerchantDto> <MerchantCode>sample string 3</MerchantCode> <MerchantId>c20b9558-548d-44b1-bc8d-c18d211f81f2</MerchantId> <MerchantName>sample string 2</MerchantName> </RuleMerchantDto> </Merchants> <MerchantsIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>e328c80c-ed4f-42e9-a677-4172e2d14ac6</d2p1:guid> <d2p1:guid>21539da4-c901-4093-8f47-918d907747b4</d2p1:guid> </MerchantsIds> <MiscellaneousReprompt>true</MiscellaneousReprompt> <MoneyQuota>1</MoneyQuota> <NetworkId>f5dfec4c-fd68-4d06-b1e7-c959e55fe5b0</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>0c070028-20f0-43ac-b22c-9ccf937d5670</ProgramId> <Retries>1</Retries> <RuleType>1</RuleType> <RuleTypeDescription>sample string 19</RuleTypeDescription> <RuleValues>sample string 20</RuleValues> <SKUCategoryDescription>sample string 27</SKUCategoryDescription> <SKUCategoryId>de5221a8-014a-4b50-b21f-05490ee68c9d</SKUCategoryId> <SecondaryTrack>true</SecondaryTrack> <SecondaryTrackReprompt>true</SecondaryTrackReprompt> <SecurityLimit>1</SecurityLimit> <Sites> <RuleSiteDto> <SiteCode>sample string 4</SiteCode> <SiteDescription>sample string 3</SiteDescription> <SiteId>2f63b54a-ba00-4eb0-839a-26b83cd77da4</SiteId> <SiteName>sample string 2</SiteName> </RuleSiteDto> <RuleSiteDto> <SiteCode>sample string 4</SiteCode> <SiteDescription>sample string 3</SiteDescription> <SiteId>2f63b54a-ba00-4eb0-839a-26b83cd77da4</SiteId> <SiteName>sample string 2</SiteName> </RuleSiteDto> </Sites> <SitesIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>31c4f049-b3fb-4eb6-b359-fd9703ca2dd3</d2p1:guid> <d2p1:guid>f0c40ab3-7bd5-4fc1-8455-edf0ad57fd29</d2p1:guid> </SitesIds> <StartDayOfWeek>64</StartDayOfWeek> <TimeFrom>1</TimeFrom> <TimeTo>1</TimeTo> <TrailerNumberReprompt>true</TrailerNumberReprompt> <TransactionsQuantity>1</TransactionsQuantity> <TruckUnitNumberReprompt>true</TruckUnitNumberReprompt> <ValidityDateFrom>2025-09-13T07:57:19.4019732Z</ValidityDateFrom> <ValidityDateTo>2025-09-13T07:57:19.4019732Z</ValidityDateTo> <VehicleIdReprompt>true</VehicleIdReprompt> <VehiclePINReprompt>true</VehiclePINReprompt> <Vehicles> <RuleVehicleDto> <Description>sample string 8</Description> <IdRule>c33ab357-114e-4775-a7c7-cbed28cc29a3</IdRule> <IdVehicle>83d12f12-530f-4968-a53c-0df6b4a050db</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>c33ab357-114e-4775-a7c7-cbed28cc29a3</IdRule> <IdVehicle>83d12f12-530f-4968-a53c-0df6b4a050db</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>83cc57ca-2c1c-43fd-b382-3dadb861911b</ZoneId> <ZoneName>sample string 2</ZoneName> </RuleZoneDto> <RuleZoneDto> <ZoneCode>sample string 3</ZoneCode> <ZoneId>83cc57ca-2c1c-43fd-b382-3dadb861911b</ZoneId> <ZoneName>sample string 2</ZoneName> </RuleZoneDto> </Zones> <ZonesIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>413f333f-deae-493b-9e49-fc5d17c9a4e3</d2p1:guid> <d2p1:guid>96d3f2ab-a7c6-4dc5-aa6f-f109041d0b6b</d2p1:guid> </ZonesIds> </RuleDto>