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. |
|
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>5273c08f-f27d-4539-9652-ddf0f95b1ced</CompanyContractId> <CompanyId>fd95c242-b5a1-4768-bccb-fb8b9eecfc4a</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>ea6c59b5-aea9-4fbe-9ca8-99a5a9ef1cba</IdDriver> <IdRule>45f3c343-2f3f-4cb7-8929-fd4a43feb9ab</IdRule> <RuleName>sample string 2</RuleName> <RuleType>3</RuleType> </RuleDriverDto> <RuleDriverDto> <DriverCode>sample string 6</DriverCode> <DriverName>sample string 5</DriverName> <IdDriver>ea6c59b5-aea9-4fbe-9ca8-99a5a9ef1cba</IdDriver> <IdRule>45f3c343-2f3f-4cb7-8929-fd4a43feb9ab</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>7625663d-2a49-48ed-ab6c-0e9005e2eb78</IdFleet> <IdRule>73707032-7b1f-42b5-930f-8d13faec5990</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>7625663d-2a49-48ed-ab6c-0e9005e2eb78</IdFleet> <IdRule>73707032-7b1f-42b5-930f-8d13faec5990</IdRule> <RuleName>sample string 2</RuleName> <RuleType>3</RuleType> <RuleTypeDescription>sample string 4</RuleTypeDescription> </RuleFleetDto> </Fleets> <FuelGroups> <RuleFuelGroupDto> <FuelGroupId>b50f7515-ebc2-4b9a-8d78-cf67d3e6d537</FuelGroupId> <FuelGroupsCode>sample string 3</FuelGroupsCode> <FuelGroupsName>sample string 2</FuelGroupsName> </RuleFuelGroupDto> <RuleFuelGroupDto> <FuelGroupId>b50f7515-ebc2-4b9a-8d78-cf67d3e6d537</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>463d00d3-630d-4715-a42b-142a03cd5a41</d2p1:guid> <d2p1:guid>1ca82a10-8912-4c65-a268-4ff3fd01461e</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>2263dc35-3532-457c-9c45-332d4b2616aa</d2p1:IdFuel> <d2p1:IdRule>1268c378-da52-4ed5-9ab6-272cafab0be2</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>2263dc35-3532-457c-9c45-332d4b2616aa</d2p1:IdFuel> <d2p1:IdRule>1268c378-da52-4ed5-9ab6-272cafab0be2</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>38c98dcb-a305-44ab-9b9c-5ee9c622713c</d2p1:guid> <d2p1:guid>875c97a9-e3f2-469f-8823-c54ffc42994e</d2p1:guid> </FuelsIds> <Id>5949a17c-93e0-4edf-95e9-75db2d7ffc5b</Id> <MerchantId>405be031-3016-42bd-8cec-b3f6b66cfe67</MerchantId> <MerchantName>sample string 4</MerchantName> <Merchants> <RuleMerchantDto> <MerchantCode>sample string 3</MerchantCode> <MerchantId>57ca9b24-f9de-4a5e-97e7-4a4b3fbf8ace</MerchantId> <MerchantName>sample string 2</MerchantName> </RuleMerchantDto> <RuleMerchantDto> <MerchantCode>sample string 3</MerchantCode> <MerchantId>57ca9b24-f9de-4a5e-97e7-4a4b3fbf8ace</MerchantId> <MerchantName>sample string 2</MerchantName> </RuleMerchantDto> </Merchants> <MerchantsIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>d948f6f9-98eb-4e04-8b9a-ec1de374abcf</d2p1:guid> <d2p1:guid>951c31d1-75e1-4afa-ae62-9b5337448a35</d2p1:guid> </MerchantsIds> <MiscellaneousReprompt>true</MiscellaneousReprompt> <MoneyQuota>1</MoneyQuota> <NetworkId>9ce4099e-242b-4464-b12b-e826ec18665b</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>5e9c152f-bd8f-4000-baaf-52b581cefad0</ProgramId> <Retries>1</Retries> <RuleType>1</RuleType> <RuleTypeDescription>sample string 19</RuleTypeDescription> <RuleValues>sample string 20</RuleValues> <SKUCategoryDescription>sample string 26</SKUCategoryDescription> <SKUCategoryId>9630b30e-d9c4-4c96-9c18-355ce8037958</SKUCategoryId> <SecondaryTrack>true</SecondaryTrack> <SecondaryTrackReprompt>true</SecondaryTrackReprompt> <SecurityLimit>1</SecurityLimit> <Sites> <RuleSiteDto> <SiteCode>sample string 4</SiteCode> <SiteDescription>sample string 3</SiteDescription> <SiteId>4f34d619-5ca7-4f7b-94b3-9276de799bfd</SiteId> <SiteName>sample string 2</SiteName> </RuleSiteDto> <RuleSiteDto> <SiteCode>sample string 4</SiteCode> <SiteDescription>sample string 3</SiteDescription> <SiteId>4f34d619-5ca7-4f7b-94b3-9276de799bfd</SiteId> <SiteName>sample string 2</SiteName> </RuleSiteDto> </Sites> <SitesIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>ada0ee23-2d1c-456a-b526-1be055e7e855</d2p1:guid> <d2p1:guid>bb992287-f474-4a00-ba5e-038c960f20da</d2p1:guid> </SitesIds> <StartDayOfWeek>64</StartDayOfWeek> <TimeFrom>1</TimeFrom> <TimeTo>1</TimeTo> <TrailerNumberReprompt>true</TrailerNumberReprompt> <TransactionsQuantity>1</TransactionsQuantity> <TruckUnitNumberReprompt>true</TruckUnitNumberReprompt> <ValidityDateFrom>2025-04-25T16:21:01.1210198Z</ValidityDateFrom> <ValidityDateTo>2025-04-25T16:21:01.1210198Z</ValidityDateTo> <VehicleIdReprompt>true</VehicleIdReprompt> <VehiclePINReprompt>true</VehiclePINReprompt> <Vehicles> <RuleVehicleDto> <Description>sample string 8</Description> <IdRule>a6b2399d-47a3-4ffd-94df-ac7faba05c95</IdRule> <IdVehicle>ec2b28c4-0693-4d53-bda1-94404ab32ca3</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>a6b2399d-47a3-4ffd-94df-ac7faba05c95</IdRule> <IdVehicle>ec2b28c4-0693-4d53-bda1-94404ab32ca3</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>3e316532-219f-42e2-866d-3c3c0937398b</ZoneId> <ZoneName>sample string 2</ZoneName> </RuleZoneDto> <RuleZoneDto> <ZoneCode>sample string 3</ZoneCode> <ZoneId>3e316532-219f-42e2-866d-3c3c0937398b</ZoneId> <ZoneName>sample string 2</ZoneName> </RuleZoneDto> </Zones> <ZonesIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>7a5186a0-c8d5-430a-9b86-32b163253c7d</d2p1:guid> <d2p1:guid>12a85229-092a-4d28-bbe5-5ea05bd7041c</d2p1:guid> </ZonesIds> </RuleDto>