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	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.
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">
  <CompanyContractId>c8d50805-cc4e-4e03-bcde-d2745fe56e69</CompanyContractId>
  <CompanyId>92b5059a-7d07-49b3-9823-c81ae9ff7290</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>efa33cec-a69a-4563-8dbc-b4382eed1983</IdDriver>
      <IdRule>40622ec0-bfc4-4be9-8e64-93973ff475de</IdRule>
      <RuleName>sample string 2</RuleName>
      <RuleType>3</RuleType>
    </RuleDriverDto>
    <RuleDriverDto>
      <DriverCode>sample string 6</DriverCode>
      <DriverName>sample string 5</DriverName>
      <IdDriver>efa33cec-a69a-4563-8dbc-b4382eed1983</IdDriver>
      <IdRule>40622ec0-bfc4-4be9-8e64-93973ff475de</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>a5035683-516f-481b-9da1-fff63a4b39b0</IdFleet>
      <IdRule>928d34f4-2180-4b5d-a21a-605af353b6f3</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>a5035683-516f-481b-9da1-fff63a4b39b0</IdFleet>
      <IdRule>928d34f4-2180-4b5d-a21a-605af353b6f3</IdRule>
      <RuleName>sample string 2</RuleName>
      <RuleType>3</RuleType>
      <RuleTypeDescription>sample string 4</RuleTypeDescription>
    </RuleFleetDto>
  </Fleets>
  <FuelGroups>
    <RuleFuelGroupDto>
      <FuelGroupId>d1f5bd04-a6eb-485e-99ef-7c47029e1763</FuelGroupId>
      <FuelGroupsCode>sample string 3</FuelGroupsCode>
      <FuelGroupsName>sample string 2</FuelGroupsName>
    </RuleFuelGroupDto>
    <RuleFuelGroupDto>
      <FuelGroupId>d1f5bd04-a6eb-485e-99ef-7c47029e1763</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>381b59f5-c701-489b-8a7f-2c34262719c4</d2p1:guid>
    <d2p1:guid>64e5e6cb-1e75-495e-a356-98641b0eaefa</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>a2495658-fe6c-4244-879e-8745b6884bf3</d2p1:IdFuel>
      <d2p1:IdRule>be00fc5d-449c-4a87-b1de-4eced36e3003</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>a2495658-fe6c-4244-879e-8745b6884bf3</d2p1:IdFuel>
      <d2p1:IdRule>be00fc5d-449c-4a87-b1de-4eced36e3003</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>fac08129-9d94-4644-8221-26c1d19f4f6d</d2p1:guid>
    <d2p1:guid>486de1ec-32ac-4135-aa0a-492687afb914</d2p1:guid>
  </FuelsIds>
  <Id>de4f23ff-5302-4cd6-b3a8-8f1794da15d4</Id>
  <MerchantId>5d4bd56f-ebc5-40a3-a2ee-063f4d7a133c</MerchantId>
  <MerchantName>sample string 4</MerchantName>
  <Merchants>
    <RuleMerchantDto>
      <MerchantCode>sample string 3</MerchantCode>
      <MerchantId>f6d5d5d2-33a7-40b8-b28a-776a546dd9f8</MerchantId>
      <MerchantName>sample string 2</MerchantName>
    </RuleMerchantDto>
    <RuleMerchantDto>
      <MerchantCode>sample string 3</MerchantCode>
      <MerchantId>f6d5d5d2-33a7-40b8-b28a-776a546dd9f8</MerchantId>
      <MerchantName>sample string 2</MerchantName>
    </RuleMerchantDto>
  </Merchants>
  <MerchantsIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>0c72217d-4851-4051-8b90-eb5c564e3761</d2p1:guid>
    <d2p1:guid>1be161f3-e114-49a6-a6e8-79766225666a</d2p1:guid>
  </MerchantsIds>
  <MiscellaneousReprompt>true</MiscellaneousReprompt>
  <MoneyQuota>1</MoneyQuota>
  <NetworkId>9e788035-1f57-4e0f-93ca-1df35dbed786</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>1f2a2ca9-e44c-448b-bd10-f83f789b9b53</ProgramId>
  <Retries>1</Retries>
  <RuleType>1</RuleType>
  <RuleTypeDescription>sample string 19</RuleTypeDescription>
  <RuleValues>sample string 20</RuleValues>
  <SKUCategoryDescription>sample string 26</SKUCategoryDescription>
  <SKUCategoryId>f8ff89cb-0073-43cb-aa89-749660a25638</SKUCategoryId>
  <SecondaryTrack>true</SecondaryTrack>
  <SecondaryTrackReprompt>true</SecondaryTrackReprompt>
  <SecurityLimit>1</SecurityLimit>
  <Sites>
    <RuleSiteDto>
      <SiteCode>sample string 4</SiteCode>
      <SiteDescription>sample string 3</SiteDescription>
      <SiteId>d86852d9-2a6a-4aed-8f42-1c030c17fdba</SiteId>
      <SiteName>sample string 2</SiteName>
    </RuleSiteDto>
    <RuleSiteDto>
      <SiteCode>sample string 4</SiteCode>
      <SiteDescription>sample string 3</SiteDescription>
      <SiteId>d86852d9-2a6a-4aed-8f42-1c030c17fdba</SiteId>
      <SiteName>sample string 2</SiteName>
    </RuleSiteDto>
  </Sites>
  <SitesIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>0a02d9a1-6d35-46ad-89c7-6e279134c2b5</d2p1:guid>
    <d2p1:guid>69dc7c88-0f04-4168-a6f2-f824d997810a</d2p1:guid>
  </SitesIds>
  <StartDayOfWeek>64</StartDayOfWeek>
  <TimeFrom>1</TimeFrom>
  <TimeTo>1</TimeTo>
  <TrailerNumberReprompt>true</TrailerNumberReprompt>
  <TransactionsQuantity>1</TransactionsQuantity>
  <TruckUnitNumberReprompt>true</TruckUnitNumberReprompt>
  <ValidityDateFrom>2025-06-12T08:00:32.4677857Z</ValidityDateFrom>
  <ValidityDateTo>2025-06-12T08:00:32.4677857Z</ValidityDateTo>
  <VehicleIdReprompt>true</VehicleIdReprompt>
  <VehiclePINReprompt>true</VehiclePINReprompt>
  <Vehicles>
    <RuleVehicleDto>
      <Description>sample string 8</Description>
      <IdRule>6186d448-2444-4b83-947c-5ef720f4883a</IdRule>
      <IdVehicle>522d84ca-c07f-46cb-a557-e202f03fdd3d</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>6186d448-2444-4b83-947c-5ef720f4883a</IdRule>
      <IdVehicle>522d84ca-c07f-46cb-a557-e202f03fdd3d</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>31c31db6-36ab-409f-93e3-42578ecd5f3b</ZoneId>
      <ZoneName>sample string 2</ZoneName>
    </RuleZoneDto>
    <RuleZoneDto>
      <ZoneCode>sample string 3</ZoneCode>
      <ZoneId>31c31db6-36ab-409f-93e3-42578ecd5f3b</ZoneId>
      <ZoneName>sample string 2</ZoneName>
    </RuleZoneDto>
  </Zones>
  <ZonesIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>c43b2d45-cb71-4f16-b319-f4bc3e1516d3</d2p1:guid>
    <d2p1:guid>b0858e8e-913c-4f43-b532-582c03ffae9a</d2p1:guid>
  </ZonesIds>
</RuleDto>