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": "1b290a37-bffa-42f4-8302-4adfdd1bf798", "NetworkId": "5c71f2f7-6bef-46ae-acc5-b0e328923c4a", "NetworkName": "sample string 4", "CompanyId": "f52d9648-52ef-4a99-932b-03529e07ac73", "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": "78cc7281-b300-4349-88ff-3d08cb77cf9f", "NetworkId": "ce9cd96b-7274-48fc-a156-826de46a9373", "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": "f8870e78-0d01-42dc-a54e-f3053d9f60a7", "ProgramDescription": "sample string 15", "VehicleIdReprompt": true, "SecondaryTrack": true, "SitesIds": [ "1549ed83-7d1e-43c9-b23f-d52b04b1a119", "d22d9b24-9aae-44a7-9e33-679d214b286e" ], "ZonesIds": [ "50f1a33d-0fa6-47eb-b7c9-20f8cda1afc5", "b4596f41-8618-45f8-8969-aba5d6b1871e" ], "MerchantsIds": [ "c203da56-1833-470a-a7e8-ae0fe6ae5baa", "6a16bc34-eda2-4d0d-b02e-5bf103221c8a" ] }, "RuleLocation": { "Id": "78cc7281-b300-4349-88ff-3d08cb77cf9f", "NetworkId": "ce9cd96b-7274-48fc-a156-826de46a9373", "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": "f8870e78-0d01-42dc-a54e-f3053d9f60a7", "ProgramDescription": "sample string 15", "VehicleIdReprompt": true, "SecondaryTrack": true, "SitesIds": [ "1549ed83-7d1e-43c9-b23f-d52b04b1a119", "d22d9b24-9aae-44a7-9e33-679d214b286e" ], "ZonesIds": [ "50f1a33d-0fa6-47eb-b7c9-20f8cda1afc5", "b4596f41-8618-45f8-8969-aba5d6b1871e" ], "MerchantsIds": [ "c203da56-1833-470a-a7e8-ae0fe6ae5baa", "6a16bc34-eda2-4d0d-b02e-5bf103221c8a" ] }, "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>f52d9648-52ef-4a99-932b-03529e07ac73</CompanyId> <CompanyName>sample string 5</CompanyName> <Description>sample string 6</Description> <DriverIdUsage>64</DriverIdUsage> <Duration>1</Duration> <GiftCardAmount>1</GiftCardAmount> <Id>1b290a37-bffa-42f4-8302-4adfdd1bf798</Id> <InternalCode>sample string 2</InternalCode> <IsRechargeable>true</IsRechargeable> <NetworkId>5c71f2f7-6bef-46ae-acc5-b0e328923c4a</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>78cc7281-b300-4349-88ff-3d08cb77cf9f</Id> <MerchantsIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>c203da56-1833-470a-a7e8-ae0fe6ae5baa</d3p1:guid> <d3p1:guid>6a16bc34-eda2-4d0d-b02e-5bf103221c8a</d3p1:guid> </MerchantsIds> <MiscellaneousReprompt>true</MiscellaneousReprompt> <NetworkId>ce9cd96b-7274-48fc-a156-826de46a9373</NetworkId> <NetworkName>sample string 2</NetworkName> <OdometerMaxVariation>1</OdometerMaxVariation> <OdometerMinVariation>1</OdometerMinVariation> <OdometerReprompt>true</OdometerReprompt> <Owner>64</Owner> <ProgramDescription>sample string 15</ProgramDescription> <ProgramId>f8870e78-0d01-42dc-a54e-f3053d9f60a7</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>1549ed83-7d1e-43c9-b23f-d52b04b1a119</d3p1:guid> <d3p1:guid>d22d9b24-9aae-44a7-9e33-679d214b286e</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>50f1a33d-0fa6-47eb-b7c9-20f8cda1afc5</d3p1:guid> <d3p1:guid>b4596f41-8618-45f8-8969-aba5d6b1871e</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>78cc7281-b300-4349-88ff-3d08cb77cf9f</Id> <MerchantsIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>c203da56-1833-470a-a7e8-ae0fe6ae5baa</d3p1:guid> <d3p1:guid>6a16bc34-eda2-4d0d-b02e-5bf103221c8a</d3p1:guid> </MerchantsIds> <MiscellaneousReprompt>true</MiscellaneousReprompt> <NetworkId>ce9cd96b-7274-48fc-a156-826de46a9373</NetworkId> <NetworkName>sample string 2</NetworkName> <OdometerMaxVariation>1</OdometerMaxVariation> <OdometerMinVariation>1</OdometerMinVariation> <OdometerReprompt>true</OdometerReprompt> <Owner>64</Owner> <ProgramDescription>sample string 15</ProgramDescription> <ProgramId>f8870e78-0d01-42dc-a54e-f3053d9f60a7</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>1549ed83-7d1e-43c9-b23f-d52b04b1a119</d3p1:guid> <d3p1:guid>d22d9b24-9aae-44a7-9e33-679d214b286e</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>50f1a33d-0fa6-47eb-b7c9-20f8cda1afc5</d3p1:guid> <d3p1:guid>b4596f41-8618-45f8-8969-aba5d6b1871e</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": "0d75002a-d764-4080-b76c-ed43ec2e9e7c", "NetworkId": "b988f654-224a-4727-8cbb-44ea2992f5f9", "NetworkName": "sample string 4", "CompanyId": "c525156d-6411-4c1e-8710-154336262b8a", "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": "0e48dddb-3314-461e-81de-5abff5411eec", "NetworkId": "8d9c78d4-051d-44e6-a4fd-7b340c507fd0", "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": "48ad4490-d365-4561-a13c-052a90bff5cc", "ProgramDescription": "sample string 15", "VehicleIdReprompt": true, "SecondaryTrack": true, "SitesIds": [ "89a466d8-1b03-4b6f-b1ec-3366ffd6828a", "52ca2db8-6b2c-447e-91e0-797abd84f0bc" ], "ZonesIds": [ "56c29934-7211-4341-9ca5-ff81a2085ba9", "2c47fa9f-7370-45d0-803f-2dfa8e7f1e91" ], "MerchantsIds": [ "d9f500f8-0865-47d6-836a-e0c6b2307e50", "82931a00-bda4-4cf5-8092-2300eb614ecb" ] }, "RuleLocation": { "Id": "0e48dddb-3314-461e-81de-5abff5411eec", "NetworkId": "8d9c78d4-051d-44e6-a4fd-7b340c507fd0", "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": "48ad4490-d365-4561-a13c-052a90bff5cc", "ProgramDescription": "sample string 15", "VehicleIdReprompt": true, "SecondaryTrack": true, "SitesIds": [ "89a466d8-1b03-4b6f-b1ec-3366ffd6828a", "52ca2db8-6b2c-447e-91e0-797abd84f0bc" ], "ZonesIds": [ "56c29934-7211-4341-9ca5-ff81a2085ba9", "2c47fa9f-7370-45d0-803f-2dfa8e7f1e91" ], "MerchantsIds": [ "d9f500f8-0865-47d6-836a-e0c6b2307e50", "82931a00-bda4-4cf5-8092-2300eb614ecb" ] }, "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>c525156d-6411-4c1e-8710-154336262b8a</CompanyId> <CompanyName>sample string 5</CompanyName> <Description>sample string 6</Description> <DriverIdUsage>64</DriverIdUsage> <Duration>1</Duration> <GiftCardAmount>1</GiftCardAmount> <Id>0d75002a-d764-4080-b76c-ed43ec2e9e7c</Id> <InternalCode>sample string 2</InternalCode> <IsRechargeable>true</IsRechargeable> <NetworkId>b988f654-224a-4727-8cbb-44ea2992f5f9</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>0e48dddb-3314-461e-81de-5abff5411eec</Id> <MerchantsIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>d9f500f8-0865-47d6-836a-e0c6b2307e50</d3p1:guid> <d3p1:guid>82931a00-bda4-4cf5-8092-2300eb614ecb</d3p1:guid> </MerchantsIds> <MiscellaneousReprompt>true</MiscellaneousReprompt> <NetworkId>8d9c78d4-051d-44e6-a4fd-7b340c507fd0</NetworkId> <NetworkName>sample string 2</NetworkName> <OdometerMaxVariation>1</OdometerMaxVariation> <OdometerMinVariation>1</OdometerMinVariation> <OdometerReprompt>true</OdometerReprompt> <Owner>64</Owner> <ProgramDescription>sample string 15</ProgramDescription> <ProgramId>48ad4490-d365-4561-a13c-052a90bff5cc</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>89a466d8-1b03-4b6f-b1ec-3366ffd6828a</d3p1:guid> <d3p1:guid>52ca2db8-6b2c-447e-91e0-797abd84f0bc</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>56c29934-7211-4341-9ca5-ff81a2085ba9</d3p1:guid> <d3p1:guid>2c47fa9f-7370-45d0-803f-2dfa8e7f1e91</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>0e48dddb-3314-461e-81de-5abff5411eec</Id> <MerchantsIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>d9f500f8-0865-47d6-836a-e0c6b2307e50</d3p1:guid> <d3p1:guid>82931a00-bda4-4cf5-8092-2300eb614ecb</d3p1:guid> </MerchantsIds> <MiscellaneousReprompt>true</MiscellaneousReprompt> <NetworkId>8d9c78d4-051d-44e6-a4fd-7b340c507fd0</NetworkId> <NetworkName>sample string 2</NetworkName> <OdometerMaxVariation>1</OdometerMaxVariation> <OdometerMinVariation>1</OdometerMinVariation> <OdometerReprompt>true</OdometerReprompt> <Owner>64</Owner> <ProgramDescription>sample string 15</ProgramDescription> <ProgramId>48ad4490-d365-4561-a13c-052a90bff5cc</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>89a466d8-1b03-4b6f-b1ec-3366ffd6828a</d3p1:guid> <d3p1:guid>52ca2db8-6b2c-447e-91e0-797abd84f0bc</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>56c29934-7211-4341-9ca5-ff81a2085ba9</d3p1:guid> <d3p1:guid>2c47fa9f-7370-45d0-803f-2dfa8e7f1e91</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>