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": "284ef5d1-15b0-42bc-8005-e7eebca047b5", "NetworkId": "c6c27656-7ad2-4399-90e5-148008d94605", "NetworkName": "sample string 4", "CompanyId": "c8408857-8c5e-466a-9b4c-f342200a2d29", "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": "a5d2c299-f37c-4453-a603-2b9c7638e729", "NetworkId": "8e2599fa-859f-4dfb-aa26-de8d17a2ec43", "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": "d3960ddf-f061-4934-b387-e8533d5c7c13", "ProgramDescription": "sample string 15", "VehicleIdReprompt": true, "SecondaryTrack": true, "SitesIds": [ "bf1cef16-3295-43e2-8f7b-5e36b1006949", "9b407792-6b23-4aa3-b202-57222b379c3b" ], "ZonesIds": [ "197255af-0f05-476f-b409-410ed6846d35", "7fc1e208-94ed-4084-ae0e-a258f465ec55" ], "MerchantsIds": [ "fe034ff2-b283-4b9c-a0c8-8a246fdb9444", "57fee485-80fa-4bfc-91cf-883c489b61c9" ] }, "RuleLocation": { "Id": "a5d2c299-f37c-4453-a603-2b9c7638e729", "NetworkId": "8e2599fa-859f-4dfb-aa26-de8d17a2ec43", "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": "d3960ddf-f061-4934-b387-e8533d5c7c13", "ProgramDescription": "sample string 15", "VehicleIdReprompt": true, "SecondaryTrack": true, "SitesIds": [ "bf1cef16-3295-43e2-8f7b-5e36b1006949", "9b407792-6b23-4aa3-b202-57222b379c3b" ], "ZonesIds": [ "197255af-0f05-476f-b409-410ed6846d35", "7fc1e208-94ed-4084-ae0e-a258f465ec55" ], "MerchantsIds": [ "fe034ff2-b283-4b9c-a0c8-8a246fdb9444", "57fee485-80fa-4bfc-91cf-883c489b61c9" ] }, "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>c8408857-8c5e-466a-9b4c-f342200a2d29</CompanyId> <CompanyName>sample string 5</CompanyName> <Description>sample string 6</Description> <DriverIdUsage>64</DriverIdUsage> <Duration>1</Duration> <GiftCardAmount>1</GiftCardAmount> <Id>284ef5d1-15b0-42bc-8005-e7eebca047b5</Id> <InternalCode>sample string 2</InternalCode> <IsRechargeable>true</IsRechargeable> <NetworkId>c6c27656-7ad2-4399-90e5-148008d94605</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>a5d2c299-f37c-4453-a603-2b9c7638e729</Id> <MerchantsIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>fe034ff2-b283-4b9c-a0c8-8a246fdb9444</d3p1:guid> <d3p1:guid>57fee485-80fa-4bfc-91cf-883c489b61c9</d3p1:guid> </MerchantsIds> <MiscellaneousReprompt>true</MiscellaneousReprompt> <NetworkId>8e2599fa-859f-4dfb-aa26-de8d17a2ec43</NetworkId> <NetworkName>sample string 2</NetworkName> <OdometerMaxVariation>1</OdometerMaxVariation> <OdometerMinVariation>1</OdometerMinVariation> <OdometerReprompt>true</OdometerReprompt> <Owner>64</Owner> <ProgramDescription>sample string 15</ProgramDescription> <ProgramId>d3960ddf-f061-4934-b387-e8533d5c7c13</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>bf1cef16-3295-43e2-8f7b-5e36b1006949</d3p1:guid> <d3p1:guid>9b407792-6b23-4aa3-b202-57222b379c3b</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>197255af-0f05-476f-b409-410ed6846d35</d3p1:guid> <d3p1:guid>7fc1e208-94ed-4084-ae0e-a258f465ec55</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>a5d2c299-f37c-4453-a603-2b9c7638e729</Id> <MerchantsIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>fe034ff2-b283-4b9c-a0c8-8a246fdb9444</d3p1:guid> <d3p1:guid>57fee485-80fa-4bfc-91cf-883c489b61c9</d3p1:guid> </MerchantsIds> <MiscellaneousReprompt>true</MiscellaneousReprompt> <NetworkId>8e2599fa-859f-4dfb-aa26-de8d17a2ec43</NetworkId> <NetworkName>sample string 2</NetworkName> <OdometerMaxVariation>1</OdometerMaxVariation> <OdometerMinVariation>1</OdometerMinVariation> <OdometerReprompt>true</OdometerReprompt> <Owner>64</Owner> <ProgramDescription>sample string 15</ProgramDescription> <ProgramId>d3960ddf-f061-4934-b387-e8533d5c7c13</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>bf1cef16-3295-43e2-8f7b-5e36b1006949</d3p1:guid> <d3p1:guid>9b407792-6b23-4aa3-b202-57222b379c3b</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>197255af-0f05-476f-b409-410ed6846d35</d3p1:guid> <d3p1:guid>7fc1e208-94ed-4084-ae0e-a258f465ec55</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": "3e3b368c-b9de-4421-ac6c-5a61f9f3d14e", "NetworkId": "911aa1d3-8e38-4f88-b896-1698606feda7", "NetworkName": "sample string 4", "CompanyId": "360bda9d-8b33-451d-954e-3c97235d5f7d", "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": "e0bc79c8-2b00-47b8-a03f-a45149e861ea", "NetworkId": "e23883de-d786-4484-b601-3db44a5b02f3", "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": "49dcf2c1-fa59-4852-8b90-804f4d67203d", "ProgramDescription": "sample string 15", "VehicleIdReprompt": true, "SecondaryTrack": true, "SitesIds": [ "58aa3fc4-b109-4fee-a97b-04ee102aad76", "82273f6c-4586-40f6-906f-edcebbda0c2f" ], "ZonesIds": [ "9b3c95aa-a31d-4be8-b137-ef760756a8ff", "ffd9d48d-301f-4e44-856d-4c758bb3f4f4" ], "MerchantsIds": [ "bfddbcb7-f6d9-48dc-8c73-bbf1f86d20e2", "1d02b953-d6e7-46b2-9edc-48828917a7ec" ] }, "RuleLocation": { "Id": "e0bc79c8-2b00-47b8-a03f-a45149e861ea", "NetworkId": "e23883de-d786-4484-b601-3db44a5b02f3", "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": "49dcf2c1-fa59-4852-8b90-804f4d67203d", "ProgramDescription": "sample string 15", "VehicleIdReprompt": true, "SecondaryTrack": true, "SitesIds": [ "58aa3fc4-b109-4fee-a97b-04ee102aad76", "82273f6c-4586-40f6-906f-edcebbda0c2f" ], "ZonesIds": [ "9b3c95aa-a31d-4be8-b137-ef760756a8ff", "ffd9d48d-301f-4e44-856d-4c758bb3f4f4" ], "MerchantsIds": [ "bfddbcb7-f6d9-48dc-8c73-bbf1f86d20e2", "1d02b953-d6e7-46b2-9edc-48828917a7ec" ] }, "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>360bda9d-8b33-451d-954e-3c97235d5f7d</CompanyId> <CompanyName>sample string 5</CompanyName> <Description>sample string 6</Description> <DriverIdUsage>64</DriverIdUsage> <Duration>1</Duration> <GiftCardAmount>1</GiftCardAmount> <Id>3e3b368c-b9de-4421-ac6c-5a61f9f3d14e</Id> <InternalCode>sample string 2</InternalCode> <IsRechargeable>true</IsRechargeable> <NetworkId>911aa1d3-8e38-4f88-b896-1698606feda7</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>e0bc79c8-2b00-47b8-a03f-a45149e861ea</Id> <MerchantsIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>bfddbcb7-f6d9-48dc-8c73-bbf1f86d20e2</d3p1:guid> <d3p1:guid>1d02b953-d6e7-46b2-9edc-48828917a7ec</d3p1:guid> </MerchantsIds> <MiscellaneousReprompt>true</MiscellaneousReprompt> <NetworkId>e23883de-d786-4484-b601-3db44a5b02f3</NetworkId> <NetworkName>sample string 2</NetworkName> <OdometerMaxVariation>1</OdometerMaxVariation> <OdometerMinVariation>1</OdometerMinVariation> <OdometerReprompt>true</OdometerReprompt> <Owner>64</Owner> <ProgramDescription>sample string 15</ProgramDescription> <ProgramId>49dcf2c1-fa59-4852-8b90-804f4d67203d</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>58aa3fc4-b109-4fee-a97b-04ee102aad76</d3p1:guid> <d3p1:guid>82273f6c-4586-40f6-906f-edcebbda0c2f</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>9b3c95aa-a31d-4be8-b137-ef760756a8ff</d3p1:guid> <d3p1:guid>ffd9d48d-301f-4e44-856d-4c758bb3f4f4</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>e0bc79c8-2b00-47b8-a03f-a45149e861ea</Id> <MerchantsIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>bfddbcb7-f6d9-48dc-8c73-bbf1f86d20e2</d3p1:guid> <d3p1:guid>1d02b953-d6e7-46b2-9edc-48828917a7ec</d3p1:guid> </MerchantsIds> <MiscellaneousReprompt>true</MiscellaneousReprompt> <NetworkId>e23883de-d786-4484-b601-3db44a5b02f3</NetworkId> <NetworkName>sample string 2</NetworkName> <OdometerMaxVariation>1</OdometerMaxVariation> <OdometerMinVariation>1</OdometerMinVariation> <OdometerReprompt>true</OdometerReprompt> <Owner>64</Owner> <ProgramDescription>sample string 15</ProgramDescription> <ProgramId>49dcf2c1-fa59-4852-8b90-804f4d67203d</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>58aa3fc4-b109-4fee-a97b-04ee102aad76</d3p1:guid> <d3p1:guid>82273f6c-4586-40f6-906f-edcebbda0c2f</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>9b3c95aa-a31d-4be8-b137-ef760756a8ff</d3p1:guid> <d3p1:guid>ffd9d48d-301f-4e44-856d-4c758bb3f4f4</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>