POST Terminals
Creates a new terminal.
Request Information
URI Parameters
None.
Body Parameters
The data of the terminal.
TerminalDtoName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
MerchantId | globally unique identifier |
None. |
|
MerchantName | string |
None. |
|
SiteId | globally unique identifier |
None. |
|
SiteShortName | string |
None. |
|
TerminalTypeId | globally unique identifier |
None. |
|
TerminalTypeName | string |
None. |
|
TerminalTypeModelId | globally unique identifier |
None. |
|
TerminalTypeModelDescription | string |
None. |
|
ProtocolId | globally unique identifier |
None. |
|
ProtocolName | string |
None. |
|
Code | string |
None. |
|
Description | string |
None. |
|
TagReader | boolean |
None. |
|
DriverIdUsage | byte |
None. |
|
MaxVolumeCutOff | integer |
None. |
|
MaxAmountCutOff | integer |
None. |
|
FuelsMasterId | globally unique identifier |
None. |
|
FuelsMasterDescription | string |
None. |
|
OperatingSystem | string |
None. |
|
SerialNumber | string |
None. |
|
LastTSN | integer |
None. |
|
VehicleIdUsage | byte |
None. |
|
Active | boolean |
None. |
|
InvoiceNumberInContingencySequence | integer |
None. |
|
Configurations | Collection of TerminalConfigurationDto |
None. |
|
TerminalInventoryLocationId | globally unique identifier |
None. |
|
TerminalInventoryLocationDescription | string |
None. |
|
EncryptionType | byte |
None. |
Request Formats
application/json, text/json
Sample:
{ "Id": "396e24bb-453f-4569-9427-09ebe18701e1", "MerchantId": "e173add4-818b-4750-b4c7-b7c73cb85cd7", "MerchantName": "sample string 3", "SiteId": "74dae97c-eee7-4505-9236-9b833b5a0873", "SiteShortName": "sample string 5", "TerminalTypeId": "5947546d-de0d-4595-ac61-c738f247ccf5", "TerminalTypeName": "sample string 7", "TerminalTypeModelId": "2f05e94f-c1c3-4b4e-8530-a730cbdb8d4f", "TerminalTypeModelDescription": "sample string 9", "ProtocolId": "15335c7a-596d-4971-adef-772eee263608", "ProtocolName": "sample string 11", "Code": "sample string 12", "Description": "sample string 13", "TagReader": true, "DriverIdUsage": 64, "MaxVolumeCutOff": 1, "MaxAmountCutOff": 1, "FuelsMasterId": "2e226d3e-e1fc-435c-a67f-f4c6b0df573f", "FuelsMasterDescription": "sample string 16", "OperatingSystem": "sample string 17", "SerialNumber": "sample string 18", "LastTSN": 1, "VehicleIdUsage": 64, "Active": true, "InvoiceNumberInContingencySequence": 1, "Configurations": [ { "MessageType": 0, "TransactionType": 0, "AuthorizerPropertiesConfigurations": [ { "AuthorizerProperty": 0, "FactorConfiguration": { "MoveDecimal": 1 }, "ModifierConfiguration": { "ModifierOperation": 0, "DecimalPlaces": 1 } }, { "AuthorizerProperty": 0, "FactorConfiguration": { "MoveDecimal": 1 }, "ModifierConfiguration": { "ModifierOperation": 0, "DecimalPlaces": 1 } } ] }, { "MessageType": 0, "TransactionType": 0, "AuthorizerPropertiesConfigurations": [ { "AuthorizerProperty": 0, "FactorConfiguration": { "MoveDecimal": 1 }, "ModifierConfiguration": { "ModifierOperation": 0, "DecimalPlaces": 1 } }, { "AuthorizerProperty": 0, "FactorConfiguration": { "MoveDecimal": 1 }, "ModifierConfiguration": { "ModifierOperation": 0, "DecimalPlaces": 1 } } ] } ], "TerminalInventoryLocationId": "3d84bac9-06f8-48f3-813c-9fcc3380dd0d", "TerminalInventoryLocationDescription": "sample string 21", "EncryptionType": 64 }
application/xml, text/xml
Sample:
<TerminalDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ationet.Model"> <Active>true</Active> <Code>sample string 12</Code> <Configurations> <TerminalConfigurationDto> <AuthorizerPropertiesConfigurations> <AuthorizerPropertiesConfigurationDto> <AuthorizerProperty>ProductAmount</AuthorizerProperty> <FactorConfiguration> <MoveDecimal>1</MoveDecimal> </FactorConfiguration> <ModifierConfiguration> <DecimalPlaces>1</DecimalPlaces> <ModifierOperation>Rounding</ModifierOperation> </ModifierConfiguration> </AuthorizerPropertiesConfigurationDto> <AuthorizerPropertiesConfigurationDto> <AuthorizerProperty>ProductAmount</AuthorizerProperty> <FactorConfiguration> <MoveDecimal>1</MoveDecimal> </FactorConfiguration> <ModifierConfiguration> <DecimalPlaces>1</DecimalPlaces> <ModifierOperation>Rounding</ModifierOperation> </ModifierConfiguration> </AuthorizerPropertiesConfigurationDto> </AuthorizerPropertiesConfigurations> <MessageType>Request</MessageType> <TransactionType>PreAuthorization</TransactionType> </TerminalConfigurationDto> <TerminalConfigurationDto> <AuthorizerPropertiesConfigurations> <AuthorizerPropertiesConfigurationDto> <AuthorizerProperty>ProductAmount</AuthorizerProperty> <FactorConfiguration> <MoveDecimal>1</MoveDecimal> </FactorConfiguration> <ModifierConfiguration> <DecimalPlaces>1</DecimalPlaces> <ModifierOperation>Rounding</ModifierOperation> </ModifierConfiguration> </AuthorizerPropertiesConfigurationDto> <AuthorizerPropertiesConfigurationDto> <AuthorizerProperty>ProductAmount</AuthorizerProperty> <FactorConfiguration> <MoveDecimal>1</MoveDecimal> </FactorConfiguration> <ModifierConfiguration> <DecimalPlaces>1</DecimalPlaces> <ModifierOperation>Rounding</ModifierOperation> </ModifierConfiguration> </AuthorizerPropertiesConfigurationDto> </AuthorizerPropertiesConfigurations> <MessageType>Request</MessageType> <TransactionType>PreAuthorization</TransactionType> </TerminalConfigurationDto> </Configurations> <Description>sample string 13</Description> <DriverIdUsage>64</DriverIdUsage> <EncryptionType>64</EncryptionType> <FuelsMasterDescription>sample string 16</FuelsMasterDescription> <FuelsMasterId>2e226d3e-e1fc-435c-a67f-f4c6b0df573f</FuelsMasterId> <Id>396e24bb-453f-4569-9427-09ebe18701e1</Id> <InvoiceNumberInContingencySequence>1</InvoiceNumberInContingencySequence> <LastTSN>1</LastTSN> <MaxAmountCutOff>1</MaxAmountCutOff> <MaxVolumeCutOff>1</MaxVolumeCutOff> <MerchantId>e173add4-818b-4750-b4c7-b7c73cb85cd7</MerchantId> <MerchantName>sample string 3</MerchantName> <OperatingSystem>sample string 17</OperatingSystem> <ProtocolId>15335c7a-596d-4971-adef-772eee263608</ProtocolId> <ProtocolName>sample string 11</ProtocolName> <SerialNumber>sample string 18</SerialNumber> <SiteId>74dae97c-eee7-4505-9236-9b833b5a0873</SiteId> <SiteShortName>sample string 5</SiteShortName> <TagReader>true</TagReader> <TerminalInventoryLocationDescription>sample string 21</TerminalInventoryLocationDescription> <TerminalInventoryLocationId>3d84bac9-06f8-48f3-813c-9fcc3380dd0d</TerminalInventoryLocationId> <TerminalTypeId>5947546d-de0d-4595-ac61-c738f247ccf5</TerminalTypeId> <TerminalTypeModelDescription>sample string 9</TerminalTypeModelDescription> <TerminalTypeModelId>2f05e94f-c1c3-4b4e-8530-a730cbdb8d4f</TerminalTypeModelId> <TerminalTypeName>sample string 7</TerminalTypeName> <VehicleIdUsage>64</VehicleIdUsage> </TerminalDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
State of the action, and if created returns the terminal as TerminalDto and the link to de terminal.
TerminalDtoName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
MerchantId | globally unique identifier |
None. |
|
MerchantName | string |
None. |
|
SiteId | globally unique identifier |
None. |
|
SiteShortName | string |
None. |
|
TerminalTypeId | globally unique identifier |
None. |
|
TerminalTypeName | string |
None. |
|
TerminalTypeModelId | globally unique identifier |
None. |
|
TerminalTypeModelDescription | string |
None. |
|
ProtocolId | globally unique identifier |
None. |
|
ProtocolName | string |
None. |
|
Code | string |
None. |
|
Description | string |
None. |
|
TagReader | boolean |
None. |
|
DriverIdUsage | byte |
None. |
|
MaxVolumeCutOff | integer |
None. |
|
MaxAmountCutOff | integer |
None. |
|
FuelsMasterId | globally unique identifier |
None. |
|
FuelsMasterDescription | string |
None. |
|
OperatingSystem | string |
None. |
|
SerialNumber | string |
None. |
|
LastTSN | integer |
None. |
|
VehicleIdUsage | byte |
None. |
|
Active | boolean |
None. |
|
InvoiceNumberInContingencySequence | integer |
None. |
|
Configurations | Collection of TerminalConfigurationDto |
None. |
|
TerminalInventoryLocationId | globally unique identifier |
None. |
|
TerminalInventoryLocationDescription | string |
None. |
|
EncryptionType | byte |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": "29b28e7c-c6ef-4170-b041-b85c43fdca49", "MerchantId": "f9fd6efe-630f-4384-af00-b0c989027133", "MerchantName": "sample string 3", "SiteId": "6a7041e6-2083-4c73-9b18-1b8574a1f5df", "SiteShortName": "sample string 5", "TerminalTypeId": "71badc85-3adf-4142-9a8a-b3fbfdc2b436", "TerminalTypeName": "sample string 7", "TerminalTypeModelId": "57051ff7-5cbc-4a44-80c8-8da0713fb9f9", "TerminalTypeModelDescription": "sample string 9", "ProtocolId": "e46113dd-19bd-42e2-b42d-ed00348ae565", "ProtocolName": "sample string 11", "Code": "sample string 12", "Description": "sample string 13", "TagReader": true, "DriverIdUsage": 64, "MaxVolumeCutOff": 1, "MaxAmountCutOff": 1, "FuelsMasterId": "8b66aa95-9ccb-48a3-9b07-1c963f9232b2", "FuelsMasterDescription": "sample string 16", "OperatingSystem": "sample string 17", "SerialNumber": "sample string 18", "LastTSN": 1, "VehicleIdUsage": 64, "Active": true, "InvoiceNumberInContingencySequence": 1, "Configurations": [ { "MessageType": 0, "TransactionType": 0, "AuthorizerPropertiesConfigurations": [ { "AuthorizerProperty": 0, "FactorConfiguration": { "MoveDecimal": 1 }, "ModifierConfiguration": { "ModifierOperation": 0, "DecimalPlaces": 1 } }, { "AuthorizerProperty": 0, "FactorConfiguration": { "MoveDecimal": 1 }, "ModifierConfiguration": { "ModifierOperation": 0, "DecimalPlaces": 1 } } ] }, { "MessageType": 0, "TransactionType": 0, "AuthorizerPropertiesConfigurations": [ { "AuthorizerProperty": 0, "FactorConfiguration": { "MoveDecimal": 1 }, "ModifierConfiguration": { "ModifierOperation": 0, "DecimalPlaces": 1 } }, { "AuthorizerProperty": 0, "FactorConfiguration": { "MoveDecimal": 1 }, "ModifierConfiguration": { "ModifierOperation": 0, "DecimalPlaces": 1 } } ] } ], "TerminalInventoryLocationId": "ee557bef-1d88-4d93-b924-c950978e9649", "TerminalInventoryLocationDescription": "sample string 21", "EncryptionType": 64 }
application/xml, text/xml
Sample:
<TerminalDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ationet.Model"> <Active>true</Active> <Code>sample string 12</Code> <Configurations> <TerminalConfigurationDto> <AuthorizerPropertiesConfigurations> <AuthorizerPropertiesConfigurationDto> <AuthorizerProperty>ProductAmount</AuthorizerProperty> <FactorConfiguration> <MoveDecimal>1</MoveDecimal> </FactorConfiguration> <ModifierConfiguration> <DecimalPlaces>1</DecimalPlaces> <ModifierOperation>Rounding</ModifierOperation> </ModifierConfiguration> </AuthorizerPropertiesConfigurationDto> <AuthorizerPropertiesConfigurationDto> <AuthorizerProperty>ProductAmount</AuthorizerProperty> <FactorConfiguration> <MoveDecimal>1</MoveDecimal> </FactorConfiguration> <ModifierConfiguration> <DecimalPlaces>1</DecimalPlaces> <ModifierOperation>Rounding</ModifierOperation> </ModifierConfiguration> </AuthorizerPropertiesConfigurationDto> </AuthorizerPropertiesConfigurations> <MessageType>Request</MessageType> <TransactionType>PreAuthorization</TransactionType> </TerminalConfigurationDto> <TerminalConfigurationDto> <AuthorizerPropertiesConfigurations> <AuthorizerPropertiesConfigurationDto> <AuthorizerProperty>ProductAmount</AuthorizerProperty> <FactorConfiguration> <MoveDecimal>1</MoveDecimal> </FactorConfiguration> <ModifierConfiguration> <DecimalPlaces>1</DecimalPlaces> <ModifierOperation>Rounding</ModifierOperation> </ModifierConfiguration> </AuthorizerPropertiesConfigurationDto> <AuthorizerPropertiesConfigurationDto> <AuthorizerProperty>ProductAmount</AuthorizerProperty> <FactorConfiguration> <MoveDecimal>1</MoveDecimal> </FactorConfiguration> <ModifierConfiguration> <DecimalPlaces>1</DecimalPlaces> <ModifierOperation>Rounding</ModifierOperation> </ModifierConfiguration> </AuthorizerPropertiesConfigurationDto> </AuthorizerPropertiesConfigurations> <MessageType>Request</MessageType> <TransactionType>PreAuthorization</TransactionType> </TerminalConfigurationDto> </Configurations> <Description>sample string 13</Description> <DriverIdUsage>64</DriverIdUsage> <EncryptionType>64</EncryptionType> <FuelsMasterDescription>sample string 16</FuelsMasterDescription> <FuelsMasterId>8b66aa95-9ccb-48a3-9b07-1c963f9232b2</FuelsMasterId> <Id>29b28e7c-c6ef-4170-b041-b85c43fdca49</Id> <InvoiceNumberInContingencySequence>1</InvoiceNumberInContingencySequence> <LastTSN>1</LastTSN> <MaxAmountCutOff>1</MaxAmountCutOff> <MaxVolumeCutOff>1</MaxVolumeCutOff> <MerchantId>f9fd6efe-630f-4384-af00-b0c989027133</MerchantId> <MerchantName>sample string 3</MerchantName> <OperatingSystem>sample string 17</OperatingSystem> <ProtocolId>e46113dd-19bd-42e2-b42d-ed00348ae565</ProtocolId> <ProtocolName>sample string 11</ProtocolName> <SerialNumber>sample string 18</SerialNumber> <SiteId>6a7041e6-2083-4c73-9b18-1b8574a1f5df</SiteId> <SiteShortName>sample string 5</SiteShortName> <TagReader>true</TagReader> <TerminalInventoryLocationDescription>sample string 21</TerminalInventoryLocationDescription> <TerminalInventoryLocationId>ee557bef-1d88-4d93-b924-c950978e9649</TerminalInventoryLocationId> <TerminalTypeId>71badc85-3adf-4142-9a8a-b3fbfdc2b436</TerminalTypeId> <TerminalTypeModelDescription>sample string 9</TerminalTypeModelDescription> <TerminalTypeModelId>57051ff7-5cbc-4a44-80c8-8da0713fb9f9</TerminalTypeModelId> <TerminalTypeName>sample string 7</TerminalTypeName> <VehicleIdUsage>64</VehicleIdUsage> </TerminalDto>