GET GiftCardPrograms/{id}

Gets a giftCardProgram by it's ID, represented as GiftCardProgramDto.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ID of the giftCardProgram.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

The giftCardProgram data.

GiftCardProgramDto

Name	Type	Additional information
Id	globally unique identifier	None.
NetworkId	globally unique identifier	None.
NetworkName	string	None.
Code	string	None.
Name	string	None.
Description	string	None.
SingleUse	boolean	None.
Rechargable	boolean	None.
CurrentAccountMode	byte	None.
CurrencyId	globally unique identifier	None.
CurrencyCode	string	None.
Periodicity	byte	None.
Duration	integer	None.
StartDate	string	None.
ValidateSites	boolean	None.
SupportsDryProducts	boolean	None.
ValidateExpirationDate	boolean	None.
UseCreationDateOnExpirationStrategy	boolean	None.
ActiveCards	boolean	None.
CardPeriodicity	byte	None.
CardDuration	integer	None.
BINRange	string	None.
Discounts	Collection of GiftCardProgramDiscountDto	None.
Fuels	Collection of GiftCardProgramFuelDto	None.
Sites	Collection of GiftCardProgramSiteDto	None.
Values	Collection of GiftCardProgramValueDto	None.
IdentificationsTypesModel	GiftCardProgramIdentificationTypeModelDto	None.
Rule	GiftCardProgramRuleDto	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "0a40c365-d9a0-448c-8618-25db60f1bbdc",
  "NetworkId": "859dbeac-5e75-4ccc-8ba5-ac0157f77097",
  "NetworkName": "sample string 3",
  "Code": "sample string 4",
  "Name": "sample string 5",
  "Description": "sample string 6",
  "SingleUse": true,
  "Rechargable": true,
  "CurrentAccountMode": 64,
  "CurrencyId": "a47e0e34-5df6-4f6b-ba8d-7a2971f9a7c0",
  "CurrencyCode": "sample string 11",
  "Periodicity": 64,
  "Duration": 13,
  "StartDate": "sample string 14",
  "ValidateSites": true,
  "SupportsDryProducts": true,
  "ValidateExpirationDate": true,
  "UseCreationDateOnExpirationStrategy": true,
  "ActiveCards": true,
  "CardPeriodicity": 64,
  "CardDuration": 1,
  "BINRange": "sample string 20",
  "Discounts": [
    {
      "Id": "e77b7702-63d5-4eef-af84-d5b8849e4656",
      "SiteId": "bb733c26-c9b3-43a0-b71e-633087efa86f",
      "SiteName": "sample string 2",
      "FuelId": "53bfe5af-9c08-4147-a08e-f20cf702cdef",
      "FuelName": "sample string 3",
      "Type": 64,
      "TypeName": "sample string 5",
      "Value": 6.0,
      "DateFrom": "sample string 7",
      "TimeFrom": "sample string 8",
      "DateTo": "sample string 9",
      "TimeTo": "sample string 10",
      "State": 64,
      "Description": "sample string 12"
    },
    {
      "Id": "e77b7702-63d5-4eef-af84-d5b8849e4656",
      "SiteId": "bb733c26-c9b3-43a0-b71e-633087efa86f",
      "SiteName": "sample string 2",
      "FuelId": "53bfe5af-9c08-4147-a08e-f20cf702cdef",
      "FuelName": "sample string 3",
      "Type": 64,
      "TypeName": "sample string 5",
      "Value": 6.0,
      "DateFrom": "sample string 7",
      "TimeFrom": "sample string 8",
      "DateTo": "sample string 9",
      "TimeTo": "sample string 10",
      "State": 64,
      "Description": "sample string 12"
    }
  ],
  "Fuels": [
    {
      "FuelMasterId": "6a330a5d-96e7-4162-bc8d-26b1bc6d80f7",
      "FuelMasterName": "sample string 2",
      "Price": 1.0
    },
    {
      "FuelMasterId": "6a330a5d-96e7-4162-bc8d-26b1bc6d80f7",
      "FuelMasterName": "sample string 2",
      "Price": 1.0
    }
  ],
  "Sites": [
    {
      "SiteId": "ee6349ba-fecf-405f-80e6-46c4b49c0987",
      "SiteName": "sample string 2",
      "SiteCode": "sample string 3",
      "Fuels": [
        {
          "FuelMasterId": "6a330a5d-96e7-4162-bc8d-26b1bc6d80f7",
          "FuelMasterName": "sample string 2",
          "Price": 1.0
        },
        {
          "FuelMasterId": "6a330a5d-96e7-4162-bc8d-26b1bc6d80f7",
          "FuelMasterName": "sample string 2",
          "Price": 1.0
        }
      ]
    },
    {
      "SiteId": "ee6349ba-fecf-405f-80e6-46c4b49c0987",
      "SiteName": "sample string 2",
      "SiteCode": "sample string 3",
      "Fuels": [
        {
          "FuelMasterId": "6a330a5d-96e7-4162-bc8d-26b1bc6d80f7",
          "FuelMasterName": "sample string 2",
          "Price": 1.0
        },
        {
          "FuelMasterId": "6a330a5d-96e7-4162-bc8d-26b1bc6d80f7",
          "FuelMasterName": "sample string 2",
          "Price": 1.0
        }
      ]
    }
  ],
  "Values": [
    {
      "Id": "a63560e8-379d-4eb7-8c8c-0e61b112310f",
      "GiftCardProgramId": "1bec9356-489f-493a-8b73-b2b2c2cc16a3",
      "Value": 3.0
    },
    {
      "Id": "a63560e8-379d-4eb7-8c8c-0e61b112310f",
      "GiftCardProgramId": "1bec9356-489f-493a-8b73-b2b2c2cc16a3",
      "Value": 3.0
    }
  ],
  "IdentificationsTypesModel": {
    "Id": "222cc986-23a3-4322-a44c-9fa9c2d004e5",
    "NetworkId": "9ca75164-c0de-4ef1-8614-7284163b500f",
    "IgnoreTerminalVehicleIdBehavior": true,
    "RequirePin": true,
    "PinDigits": 1,
    "RequiresPINChange": true,
    "NotSupportOffline": true
  },
  "Rule": {
    "Id": "d252a61b-a17a-4ff6-b5ea-2007e5236281",
    "NetworkId": "fcb3c2ce-2f01-47ca-935c-2c3558f430af",
    "NetworkName": "sample string 2",
    "Retries": 1,
    "VehiclePINReprompt": true,
    "SecondaryTrackReprompt": true,
    "MiscellaneousReprompt": true,
    "OdometerReprompt": true,
    "OdometerMinVariation": 1,
    "OdometerMaxVariation": 1,
    "EngineHoursReprompt": true,
    "EngineHoursMinVariation": 1,
    "EngineHoursMaxVariation": 1,
    "RuleType": 1,
    "Description": "sample string 8",
    "DriverIdReprompt": true,
    "DriverPINReprompt": true,
    "TruckUnitNumberReprompt": true,
    "TrailerNumberReprompt": true,
    "Owner": 64,
    "RuleTypeDescription": "sample string 14",
    "ProgramId": "7a498005-d8b8-4b35-b114-d9619d00fabe",
    "ProgramDescription": "sample string 15",
    "VehicleIdReprompt": true,
    "SecondaryTrack": true
  }
}

application/xml, text/xml

Sample:

<GiftCardProgramDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ationet.Model">
  <ActiveCards>true</ActiveCards>
  <BINRange>sample string 20</BINRange>
  <CardDuration>1</CardDuration>
  <CardPeriodicity>64</CardPeriodicity>
  <Code>sample string 4</Code>
  <CurrencyCode>sample string 11</CurrencyCode>
  <CurrencyId>a47e0e34-5df6-4f6b-ba8d-7a2971f9a7c0</CurrencyId>
  <CurrentAccountMode>64</CurrentAccountMode>
  <Description>sample string 6</Description>
  <Discounts>
    <GiftCardProgramDiscountDto>
      <DateFrom>sample string 7</DateFrom>
      <DateTo>sample string 9</DateTo>
      <Description>sample string 12</Description>
      <FuelId>53bfe5af-9c08-4147-a08e-f20cf702cdef</FuelId>
      <FuelName>sample string 3</FuelName>
      <Id>e77b7702-63d5-4eef-af84-d5b8849e4656</Id>
      <SiteId>bb733c26-c9b3-43a0-b71e-633087efa86f</SiteId>
      <SiteName>sample string 2</SiteName>
      <State>64</State>
      <TimeFrom>sample string 8</TimeFrom>
      <TimeTo>sample string 10</TimeTo>
      <Type>64</Type>
      <TypeName>sample string 5</TypeName>
      <Value>6</Value>
    </GiftCardProgramDiscountDto>
    <GiftCardProgramDiscountDto>
      <DateFrom>sample string 7</DateFrom>
      <DateTo>sample string 9</DateTo>
      <Description>sample string 12</Description>
      <FuelId>53bfe5af-9c08-4147-a08e-f20cf702cdef</FuelId>
      <FuelName>sample string 3</FuelName>
      <Id>e77b7702-63d5-4eef-af84-d5b8849e4656</Id>
      <SiteId>bb733c26-c9b3-43a0-b71e-633087efa86f</SiteId>
      <SiteName>sample string 2</SiteName>
      <State>64</State>
      <TimeFrom>sample string 8</TimeFrom>
      <TimeTo>sample string 10</TimeTo>
      <Type>64</Type>
      <TypeName>sample string 5</TypeName>
      <Value>6</Value>
    </GiftCardProgramDiscountDto>
  </Discounts>
  <Duration>13</Duration>
  <Fuels>
    <GiftCardProgramFuelDto>
      <FuelMasterId>6a330a5d-96e7-4162-bc8d-26b1bc6d80f7</FuelMasterId>
      <FuelMasterName>sample string 2</FuelMasterName>
      <Price>1</Price>
    </GiftCardProgramFuelDto>
    <GiftCardProgramFuelDto>
      <FuelMasterId>6a330a5d-96e7-4162-bc8d-26b1bc6d80f7</FuelMasterId>
      <FuelMasterName>sample string 2</FuelMasterName>
      <Price>1</Price>
    </GiftCardProgramFuelDto>
  </Fuels>
  <Id>0a40c365-d9a0-448c-8618-25db60f1bbdc</Id>
  <IdentificationsTypesModel>
    <Id>222cc986-23a3-4322-a44c-9fa9c2d004e5</Id>
    <IgnoreTerminalVehicleIdBehavior>true</IgnoreTerminalVehicleIdBehavior>
    <NetworkId>9ca75164-c0de-4ef1-8614-7284163b500f</NetworkId>
    <NotSupportOffline>true</NotSupportOffline>
    <PinDigits>1</PinDigits>
    <RequirePin>true</RequirePin>
    <RequiresPINChange>true</RequiresPINChange>
  </IdentificationsTypesModel>
  <Name>sample string 5</Name>
  <NetworkId>859dbeac-5e75-4ccc-8ba5-ac0157f77097</NetworkId>
  <NetworkName>sample string 3</NetworkName>
  <Periodicity>64</Periodicity>
  <Rechargable>true</Rechargable>
  <Rule>
    <Description>sample string 8</Description>
    <DriverIdReprompt>true</DriverIdReprompt>
    <DriverPINReprompt>true</DriverPINReprompt>
    <EngineHoursMaxVariation>1</EngineHoursMaxVariation>
    <EngineHoursMinVariation>1</EngineHoursMinVariation>
    <EngineHoursReprompt>true</EngineHoursReprompt>
    <Id>d252a61b-a17a-4ff6-b5ea-2007e5236281</Id>
    <MiscellaneousReprompt>true</MiscellaneousReprompt>
    <NetworkId>fcb3c2ce-2f01-47ca-935c-2c3558f430af</NetworkId>
    <NetworkName>sample string 2</NetworkName>
    <OdometerMaxVariation>1</OdometerMaxVariation>
    <OdometerMinVariation>1</OdometerMinVariation>
    <OdometerReprompt>true</OdometerReprompt>
    <Owner>64</Owner>
    <ProgramDescription>sample string 15</ProgramDescription>
    <ProgramId>7a498005-d8b8-4b35-b114-d9619d00fabe</ProgramId>
    <Retries>1</Retries>
    <RuleType>1</RuleType>
    <RuleTypeDescription>sample string 14</RuleTypeDescription>
    <SecondaryTrack>true</SecondaryTrack>
    <SecondaryTrackReprompt>true</SecondaryTrackReprompt>
    <TrailerNumberReprompt>true</TrailerNumberReprompt>
    <TruckUnitNumberReprompt>true</TruckUnitNumberReprompt>
    <VehicleIdReprompt>true</VehicleIdReprompt>
    <VehiclePINReprompt>true</VehiclePINReprompt>
  </Rule>
  <SingleUse>true</SingleUse>
  <Sites>
    <GiftCardProgramSiteDto>
      <Fuels>
        <GiftCardProgramFuelDto>
          <FuelMasterId>6a330a5d-96e7-4162-bc8d-26b1bc6d80f7</FuelMasterId>
          <FuelMasterName>sample string 2</FuelMasterName>
          <Price>1</Price>
        </GiftCardProgramFuelDto>
        <GiftCardProgramFuelDto>
          <FuelMasterId>6a330a5d-96e7-4162-bc8d-26b1bc6d80f7</FuelMasterId>
          <FuelMasterName>sample string 2</FuelMasterName>
          <Price>1</Price>
        </GiftCardProgramFuelDto>
      </Fuels>
      <SiteCode>sample string 3</SiteCode>
      <SiteId>ee6349ba-fecf-405f-80e6-46c4b49c0987</SiteId>
      <SiteName>sample string 2</SiteName>
    </GiftCardProgramSiteDto>
    <GiftCardProgramSiteDto>
      <Fuels>
        <GiftCardProgramFuelDto>
          <FuelMasterId>6a330a5d-96e7-4162-bc8d-26b1bc6d80f7</FuelMasterId>
          <FuelMasterName>sample string 2</FuelMasterName>
          <Price>1</Price>
        </GiftCardProgramFuelDto>
        <GiftCardProgramFuelDto>
          <FuelMasterId>6a330a5d-96e7-4162-bc8d-26b1bc6d80f7</FuelMasterId>
          <FuelMasterName>sample string 2</FuelMasterName>
          <Price>1</Price>
        </GiftCardProgramFuelDto>
      </Fuels>
      <SiteCode>sample string 3</SiteCode>
      <SiteId>ee6349ba-fecf-405f-80e6-46c4b49c0987</SiteId>
      <SiteName>sample string 2</SiteName>
    </GiftCardProgramSiteDto>
  </Sites>
  <StartDate>sample string 14</StartDate>
  <SupportsDryProducts>true</SupportsDryProducts>
  <UseCreationDateOnExpirationStrategy>true</UseCreationDateOnExpirationStrategy>
  <ValidateExpirationDate>true</ValidateExpirationDate>
  <ValidateSites>true</ValidateSites>
  <Values>
    <GiftCardProgramValueDto>
      <GiftCardProgramId>1bec9356-489f-493a-8b73-b2b2c2cc16a3</GiftCardProgramId>
      <Id>a63560e8-379d-4eb7-8c8c-0e61b112310f</Id>
      <Value>3</Value>
    </GiftCardProgramValueDto>
    <GiftCardProgramValueDto>
      <GiftCardProgramId>1bec9356-489f-493a-8b73-b2b2c2cc16a3</GiftCardProgramId>
      <Id>a63560e8-379d-4eb7-8c8c-0e61b112310f</Id>
      <Value>3</Value>
    </GiftCardProgramValueDto>
  </Values>
</GiftCardProgramDto>