POST Programs
Creates a new program.
Request Information
URI Parameters
None.
Body Parameters
The data of the program.
ProgramDtoName | 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. |
|
Description | string |
None. |
|
Type | byte |
None. |
|
BalanceMode | byte |
None. |
|
ApplyContractsSites | byte |
None. |
|
SupportsContingency | byte |
None. |
|
SupportsOffline | byte |
None. |
|
SupportsOfflineOperation | boolean |
None. |
|
IsRechargeable | boolean |
None. |
|
GiftCardAmount | decimal number |
None. |
|
BINRange | string |
None. |
|
SupportsDryProducts | boolean |
None. |
|
ValidateExpDate | boolean |
None. |
|
ReturnsBalance | boolean |
None. |
|
Periodicity | byte |
None. |
|
Duration | integer |
None. |
|
VoucherAmounts | string |
None. |
|
Rule | ProgramRuleDto |
None. |
|
RuleLocation | ProgramRuleDto |
None. |
|
DriverIdUsage | byte |
None. |
|
VehicleIdUsage | byte |
None. |
|
Code | string |
None. |
|
TermsAndConditions | string |
None. |
|
RequireHologram | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "Id": "4c595953-837b-4a9b-b999-d95fd02d9a54", "NetworkId": "4d57c2aa-427c-4dfc-9ded-fd4b9e39b810", "NetworkName": "sample string 4", "CompanyId": "fc5754a2-e87a-4691-8dca-cdaf589f4e10", "CompanyName": "sample string 5", "Description": "sample string 6", "Type": 64, "BalanceMode": 64, "ApplyContractsSites": 64, "SupportsContingency": 64, "SupportsOffline": 64, "SupportsOfflineOperation": true, "IsRechargeable": true, "GiftCardAmount": 1.0, "BINRange": "sample string 14", "SupportsDryProducts": true, "ValidateExpDate": true, "ReturnsBalance": true, "Periodicity": 64, "Duration": 1, "VoucherAmounts": "sample string 18", "Rule": { "Id": "a514d04e-2c6b-476d-bd6e-3360cd3d4427", "NetworkId": "112893c3-2937-48a9-a664-652d144ec78e", "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": "0364fca2-1a1b-4abd-a739-e6af06c97e5c", "ProgramDescription": "sample string 15", "VehicleIdReprompt": true, "SecondaryTrack": true, "SitesIds": [ "4076e0cc-86b4-40c2-b0f6-e206c9dfc9a5", "bc246f86-7fea-4e20-8840-853a8a8a9ffc" ], "ZonesIds": [ "52c75b4c-c1af-4f40-b376-7f88ac4797a9", "0a2dbab8-01ae-4785-afdc-fdb05be929e1" ], "MerchantsIds": [ "3dac1567-6a0b-4c42-8aed-0094d08aa678", "7771ed30-9789-491d-b617-dc4baaa59aff" ] }, "RuleLocation": { "Id": "a514d04e-2c6b-476d-bd6e-3360cd3d4427", "NetworkId": "112893c3-2937-48a9-a664-652d144ec78e", "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": "0364fca2-1a1b-4abd-a739-e6af06c97e5c", "ProgramDescription": "sample string 15", "VehicleIdReprompt": true, "SecondaryTrack": true, "SitesIds": [ "4076e0cc-86b4-40c2-b0f6-e206c9dfc9a5", "bc246f86-7fea-4e20-8840-853a8a8a9ffc" ], "ZonesIds": [ "52c75b4c-c1af-4f40-b376-7f88ac4797a9", "0a2dbab8-01ae-4785-afdc-fdb05be929e1" ], "MerchantsIds": [ "3dac1567-6a0b-4c42-8aed-0094d08aa678", "7771ed30-9789-491d-b617-dc4baaa59aff" ] }, "DriverIdUsage": 64, "VehicleIdUsage": 64, "Code": "sample string 19", "TermsAndConditions": "sample string 20", "RequireHologram": true }
application/xml, text/xml
Sample:
<ProgramDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ationet.Model"> <ApplyContractsSites>64</ApplyContractsSites> <BINRange>sample string 14</BINRange> <BalanceMode>64</BalanceMode> <Code>sample string 19</Code> <CompanyId>fc5754a2-e87a-4691-8dca-cdaf589f4e10</CompanyId> <CompanyName>sample string 5</CompanyName> <Description>sample string 6</Description> <DriverIdUsage>64</DriverIdUsage> <Duration>1</Duration> <GiftCardAmount>1</GiftCardAmount> <Id>4c595953-837b-4a9b-b999-d95fd02d9a54</Id> <InternalCode>sample string 2</InternalCode> <IsRechargeable>true</IsRechargeable> <NetworkId>4d57c2aa-427c-4dfc-9ded-fd4b9e39b810</NetworkId> <NetworkName>sample string 4</NetworkName> <Periodicity>64</Periodicity> <RequireHologram>true</RequireHologram> <ReturnsBalance>true</ReturnsBalance> <Rule> <Description>sample string 8</Description> <DriverIdReprompt>true</DriverIdReprompt> <DriverPINReprompt>true</DriverPINReprompt> <EngineHoursMaxVariation>1</EngineHoursMaxVariation> <EngineHoursMinVariation>1</EngineHoursMinVariation> <EngineHoursReprompt>true</EngineHoursReprompt> <Id>a514d04e-2c6b-476d-bd6e-3360cd3d4427</Id> <MerchantsIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>3dac1567-6a0b-4c42-8aed-0094d08aa678</d3p1:guid> <d3p1:guid>7771ed30-9789-491d-b617-dc4baaa59aff</d3p1:guid> </MerchantsIds> <MiscellaneousReprompt>true</MiscellaneousReprompt> <NetworkId>112893c3-2937-48a9-a664-652d144ec78e</NetworkId> <NetworkName>sample string 2</NetworkName> <OdometerMaxVariation>1</OdometerMaxVariation> <OdometerMinVariation>1</OdometerMinVariation> <OdometerReprompt>true</OdometerReprompt> <Owner>64</Owner> <ProgramDescription>sample string 15</ProgramDescription> <ProgramId>0364fca2-1a1b-4abd-a739-e6af06c97e5c</ProgramId> <Retries>1</Retries> <RuleType>1</RuleType> <RuleTypeDescription>sample string 14</RuleTypeDescription> <SecondaryTrack>true</SecondaryTrack> <SecondaryTrackReprompt>true</SecondaryTrackReprompt> <SitesIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>4076e0cc-86b4-40c2-b0f6-e206c9dfc9a5</d3p1:guid> <d3p1:guid>bc246f86-7fea-4e20-8840-853a8a8a9ffc</d3p1:guid> </SitesIds> <TrailerNumberReprompt>true</TrailerNumberReprompt> <TruckUnitNumberReprompt>true</TruckUnitNumberReprompt> <VehicleIdReprompt>true</VehicleIdReprompt> <VehiclePINReprompt>true</VehiclePINReprompt> <ZonesIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>52c75b4c-c1af-4f40-b376-7f88ac4797a9</d3p1:guid> <d3p1:guid>0a2dbab8-01ae-4785-afdc-fdb05be929e1</d3p1:guid> </ZonesIds> </Rule> <RuleLocation> <Description>sample string 8</Description> <DriverIdReprompt>true</DriverIdReprompt> <DriverPINReprompt>true</DriverPINReprompt> <EngineHoursMaxVariation>1</EngineHoursMaxVariation> <EngineHoursMinVariation>1</EngineHoursMinVariation> <EngineHoursReprompt>true</EngineHoursReprompt> <Id>a514d04e-2c6b-476d-bd6e-3360cd3d4427</Id> <MerchantsIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>3dac1567-6a0b-4c42-8aed-0094d08aa678</d3p1:guid> <d3p1:guid>7771ed30-9789-491d-b617-dc4baaa59aff</d3p1:guid> </MerchantsIds> <MiscellaneousReprompt>true</MiscellaneousReprompt> <NetworkId>112893c3-2937-48a9-a664-652d144ec78e</NetworkId> <NetworkName>sample string 2</NetworkName> <OdometerMaxVariation>1</OdometerMaxVariation> <OdometerMinVariation>1</OdometerMinVariation> <OdometerReprompt>true</OdometerReprompt> <Owner>64</Owner> <ProgramDescription>sample string 15</ProgramDescription> <ProgramId>0364fca2-1a1b-4abd-a739-e6af06c97e5c</ProgramId> <Retries>1</Retries> <RuleType>1</RuleType> <RuleTypeDescription>sample string 14</RuleTypeDescription> <SecondaryTrack>true</SecondaryTrack> <SecondaryTrackReprompt>true</SecondaryTrackReprompt> <SitesIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>4076e0cc-86b4-40c2-b0f6-e206c9dfc9a5</d3p1:guid> <d3p1:guid>bc246f86-7fea-4e20-8840-853a8a8a9ffc</d3p1:guid> </SitesIds> <TrailerNumberReprompt>true</TrailerNumberReprompt> <TruckUnitNumberReprompt>true</TruckUnitNumberReprompt> <VehicleIdReprompt>true</VehicleIdReprompt> <VehiclePINReprompt>true</VehiclePINReprompt> <ZonesIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>52c75b4c-c1af-4f40-b376-7f88ac4797a9</d3p1:guid> <d3p1:guid>0a2dbab8-01ae-4785-afdc-fdb05be929e1</d3p1:guid> </ZonesIds> </RuleLocation> <SupportsContingency>64</SupportsContingency> <SupportsDryProducts>true</SupportsDryProducts> <SupportsOffline>64</SupportsOffline> <SupportsOfflineOperation>true</SupportsOfflineOperation> <TermsAndConditions>sample string 20</TermsAndConditions> <Type>64</Type> <ValidateExpDate>true</ValidateExpDate> <VehicleIdUsage>64</VehicleIdUsage> <VoucherAmounts>sample string 18</VoucherAmounts> </ProgramDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
State of the action, and if created returns the contract as ProgramDto and the link to de contract.
ProgramDtoName | 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. |
|
Description | string |
None. |
|
Type | byte |
None. |
|
BalanceMode | byte |
None. |
|
ApplyContractsSites | byte |
None. |
|
SupportsContingency | byte |
None. |
|
SupportsOffline | byte |
None. |
|
SupportsOfflineOperation | boolean |
None. |
|
IsRechargeable | boolean |
None. |
|
GiftCardAmount | decimal number |
None. |
|
BINRange | string |
None. |
|
SupportsDryProducts | boolean |
None. |
|
ValidateExpDate | boolean |
None. |
|
ReturnsBalance | boolean |
None. |
|
Periodicity | byte |
None. |
|
Duration | integer |
None. |
|
VoucherAmounts | string |
None. |
|
Rule | ProgramRuleDto |
None. |
|
RuleLocation | ProgramRuleDto |
None. |
|
DriverIdUsage | byte |
None. |
|
VehicleIdUsage | byte |
None. |
|
Code | string |
None. |
|
TermsAndConditions | string |
None. |
|
RequireHologram | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": "8e874114-4b0f-47d5-9382-a5faafa0db13", "NetworkId": "ea1dca91-7de6-4eaf-91f3-7e3d41379492", "NetworkName": "sample string 4", "CompanyId": "ab33a37c-5851-43d3-89fc-066490a8955f", "CompanyName": "sample string 5", "Description": "sample string 6", "Type": 64, "BalanceMode": 64, "ApplyContractsSites": 64, "SupportsContingency": 64, "SupportsOffline": 64, "SupportsOfflineOperation": true, "IsRechargeable": true, "GiftCardAmount": 1.0, "BINRange": "sample string 14", "SupportsDryProducts": true, "ValidateExpDate": true, "ReturnsBalance": true, "Periodicity": 64, "Duration": 1, "VoucherAmounts": "sample string 18", "Rule": { "Id": "d7c4dadc-8461-45ff-a5a1-85f6c46df15a", "NetworkId": "0ac06856-fdd2-4ddf-a97e-cac903725108", "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": "627d4822-984f-4520-ba3a-a3c6ed4ed0a8", "ProgramDescription": "sample string 15", "VehicleIdReprompt": true, "SecondaryTrack": true, "SitesIds": [ "68dcb388-b6ea-4a60-9a3e-105fb7b8a185", "a06f2158-65f0-4daf-8125-1bbe7361d149" ], "ZonesIds": [ "a328a0f5-7332-4ad3-a48e-24de08a4b780", "9c6e1d12-d1f0-4b9d-9f90-22eaa14f0c91" ], "MerchantsIds": [ "0ad662eb-dc53-4bdc-a3e8-68606165bbfa", "55fdc2eb-da6b-415a-83e0-e186eefc9156" ] }, "RuleLocation": { "Id": "d7c4dadc-8461-45ff-a5a1-85f6c46df15a", "NetworkId": "0ac06856-fdd2-4ddf-a97e-cac903725108", "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": "627d4822-984f-4520-ba3a-a3c6ed4ed0a8", "ProgramDescription": "sample string 15", "VehicleIdReprompt": true, "SecondaryTrack": true, "SitesIds": [ "68dcb388-b6ea-4a60-9a3e-105fb7b8a185", "a06f2158-65f0-4daf-8125-1bbe7361d149" ], "ZonesIds": [ "a328a0f5-7332-4ad3-a48e-24de08a4b780", "9c6e1d12-d1f0-4b9d-9f90-22eaa14f0c91" ], "MerchantsIds": [ "0ad662eb-dc53-4bdc-a3e8-68606165bbfa", "55fdc2eb-da6b-415a-83e0-e186eefc9156" ] }, "DriverIdUsage": 64, "VehicleIdUsage": 64, "Code": "sample string 19", "TermsAndConditions": "sample string 20", "RequireHologram": true }
application/xml, text/xml
Sample:
<ProgramDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ationet.Model"> <ApplyContractsSites>64</ApplyContractsSites> <BINRange>sample string 14</BINRange> <BalanceMode>64</BalanceMode> <Code>sample string 19</Code> <CompanyId>ab33a37c-5851-43d3-89fc-066490a8955f</CompanyId> <CompanyName>sample string 5</CompanyName> <Description>sample string 6</Description> <DriverIdUsage>64</DriverIdUsage> <Duration>1</Duration> <GiftCardAmount>1</GiftCardAmount> <Id>8e874114-4b0f-47d5-9382-a5faafa0db13</Id> <InternalCode>sample string 2</InternalCode> <IsRechargeable>true</IsRechargeable> <NetworkId>ea1dca91-7de6-4eaf-91f3-7e3d41379492</NetworkId> <NetworkName>sample string 4</NetworkName> <Periodicity>64</Periodicity> <RequireHologram>true</RequireHologram> <ReturnsBalance>true</ReturnsBalance> <Rule> <Description>sample string 8</Description> <DriverIdReprompt>true</DriverIdReprompt> <DriverPINReprompt>true</DriverPINReprompt> <EngineHoursMaxVariation>1</EngineHoursMaxVariation> <EngineHoursMinVariation>1</EngineHoursMinVariation> <EngineHoursReprompt>true</EngineHoursReprompt> <Id>d7c4dadc-8461-45ff-a5a1-85f6c46df15a</Id> <MerchantsIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>0ad662eb-dc53-4bdc-a3e8-68606165bbfa</d3p1:guid> <d3p1:guid>55fdc2eb-da6b-415a-83e0-e186eefc9156</d3p1:guid> </MerchantsIds> <MiscellaneousReprompt>true</MiscellaneousReprompt> <NetworkId>0ac06856-fdd2-4ddf-a97e-cac903725108</NetworkId> <NetworkName>sample string 2</NetworkName> <OdometerMaxVariation>1</OdometerMaxVariation> <OdometerMinVariation>1</OdometerMinVariation> <OdometerReprompt>true</OdometerReprompt> <Owner>64</Owner> <ProgramDescription>sample string 15</ProgramDescription> <ProgramId>627d4822-984f-4520-ba3a-a3c6ed4ed0a8</ProgramId> <Retries>1</Retries> <RuleType>1</RuleType> <RuleTypeDescription>sample string 14</RuleTypeDescription> <SecondaryTrack>true</SecondaryTrack> <SecondaryTrackReprompt>true</SecondaryTrackReprompt> <SitesIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>68dcb388-b6ea-4a60-9a3e-105fb7b8a185</d3p1:guid> <d3p1:guid>a06f2158-65f0-4daf-8125-1bbe7361d149</d3p1:guid> </SitesIds> <TrailerNumberReprompt>true</TrailerNumberReprompt> <TruckUnitNumberReprompt>true</TruckUnitNumberReprompt> <VehicleIdReprompt>true</VehicleIdReprompt> <VehiclePINReprompt>true</VehiclePINReprompt> <ZonesIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>a328a0f5-7332-4ad3-a48e-24de08a4b780</d3p1:guid> <d3p1:guid>9c6e1d12-d1f0-4b9d-9f90-22eaa14f0c91</d3p1:guid> </ZonesIds> </Rule> <RuleLocation> <Description>sample string 8</Description> <DriverIdReprompt>true</DriverIdReprompt> <DriverPINReprompt>true</DriverPINReprompt> <EngineHoursMaxVariation>1</EngineHoursMaxVariation> <EngineHoursMinVariation>1</EngineHoursMinVariation> <EngineHoursReprompt>true</EngineHoursReprompt> <Id>d7c4dadc-8461-45ff-a5a1-85f6c46df15a</Id> <MerchantsIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>0ad662eb-dc53-4bdc-a3e8-68606165bbfa</d3p1:guid> <d3p1:guid>55fdc2eb-da6b-415a-83e0-e186eefc9156</d3p1:guid> </MerchantsIds> <MiscellaneousReprompt>true</MiscellaneousReprompt> <NetworkId>0ac06856-fdd2-4ddf-a97e-cac903725108</NetworkId> <NetworkName>sample string 2</NetworkName> <OdometerMaxVariation>1</OdometerMaxVariation> <OdometerMinVariation>1</OdometerMinVariation> <OdometerReprompt>true</OdometerReprompt> <Owner>64</Owner> <ProgramDescription>sample string 15</ProgramDescription> <ProgramId>627d4822-984f-4520-ba3a-a3c6ed4ed0a8</ProgramId> <Retries>1</Retries> <RuleType>1</RuleType> <RuleTypeDescription>sample string 14</RuleTypeDescription> <SecondaryTrack>true</SecondaryTrack> <SecondaryTrackReprompt>true</SecondaryTrackReprompt> <SitesIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>68dcb388-b6ea-4a60-9a3e-105fb7b8a185</d3p1:guid> <d3p1:guid>a06f2158-65f0-4daf-8125-1bbe7361d149</d3p1:guid> </SitesIds> <TrailerNumberReprompt>true</TrailerNumberReprompt> <TruckUnitNumberReprompt>true</TruckUnitNumberReprompt> <VehicleIdReprompt>true</VehicleIdReprompt> <VehiclePINReprompt>true</VehiclePINReprompt> <ZonesIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>a328a0f5-7332-4ad3-a48e-24de08a4b780</d3p1:guid> <d3p1:guid>9c6e1d12-d1f0-4b9d-9f90-22eaa14f0c91</d3p1:guid> </ZonesIds> </RuleLocation> <SupportsContingency>64</SupportsContingency> <SupportsDryProducts>true</SupportsDryProducts> <SupportsOffline>64</SupportsOffline> <SupportsOfflineOperation>true</SupportsOfflineOperation> <TermsAndConditions>sample string 20</TermsAndConditions> <Type>64</Type> <ValidateExpDate>true</ValidateExpDate> <VehicleIdUsage>64</VehicleIdUsage> <VoucherAmounts>sample string 18</VoucherAmounts> </ProgramDto>