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": "b9d51fa9-16cd-4429-bbd8-eec186d733e6", "MerchantId": "0288e360-dc80-428f-9680-1548153aafea", "MerchantName": "sample string 3", "SiteId": "b6bff11c-65dd-4609-a4c0-a80f619b3049", "SiteShortName": "sample string 5", "TerminalTypeId": "2b21cbed-a6c3-44d5-a8ab-52b213bac598", "TerminalTypeName": "sample string 7", "TerminalTypeModelId": "93243075-56ac-4c4c-857b-79b4d394a4e1", "TerminalTypeModelDescription": "sample string 9", "ProtocolId": "6396d6f0-01da-4f66-9fda-b968d289ff68", "ProtocolName": "sample string 11", "Code": "sample string 12", "Description": "sample string 13", "TagReader": true, "DriverIdUsage": 64, "MaxVolumeCutOff": 1, "MaxAmountCutOff": 1, "FuelsMasterId": "d82a0646-7413-4650-9f96-b33b2db51031", "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": "d2026d9c-b089-4b08-b0c4-1c49c544c1f6", "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>d82a0646-7413-4650-9f96-b33b2db51031</FuelsMasterId> <Id>b9d51fa9-16cd-4429-bbd8-eec186d733e6</Id> <InvoiceNumberInContingencySequence>1</InvoiceNumberInContingencySequence> <LastTSN>1</LastTSN> <MaxAmountCutOff>1</MaxAmountCutOff> <MaxVolumeCutOff>1</MaxVolumeCutOff> <MerchantId>0288e360-dc80-428f-9680-1548153aafea</MerchantId> <MerchantName>sample string 3</MerchantName> <OperatingSystem>sample string 17</OperatingSystem> <ProtocolId>6396d6f0-01da-4f66-9fda-b968d289ff68</ProtocolId> <ProtocolName>sample string 11</ProtocolName> <SerialNumber>sample string 18</SerialNumber> <SiteId>b6bff11c-65dd-4609-a4c0-a80f619b3049</SiteId> <SiteShortName>sample string 5</SiteShortName> <TagReader>true</TagReader> <TerminalInventoryLocationDescription>sample string 21</TerminalInventoryLocationDescription> <TerminalInventoryLocationId>d2026d9c-b089-4b08-b0c4-1c49c544c1f6</TerminalInventoryLocationId> <TerminalTypeId>2b21cbed-a6c3-44d5-a8ab-52b213bac598</TerminalTypeId> <TerminalTypeModelDescription>sample string 9</TerminalTypeModelDescription> <TerminalTypeModelId>93243075-56ac-4c4c-857b-79b4d394a4e1</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": "2c94bd6d-9bb3-4f6b-b865-ba617d596cff", "MerchantId": "a0151213-2aba-4cc9-a953-aad262d5ad16", "MerchantName": "sample string 3", "SiteId": "95ae574a-2407-41e7-9558-0c9544d1ee6d", "SiteShortName": "sample string 5", "TerminalTypeId": "aa8abdfe-ba53-4dee-81a5-342383f14e37", "TerminalTypeName": "sample string 7", "TerminalTypeModelId": "0b2ae3a3-0310-4bb0-a05a-d5fb7fbae458", "TerminalTypeModelDescription": "sample string 9", "ProtocolId": "78c8c9ba-a202-4b77-adfe-6fdfc5988ff4", "ProtocolName": "sample string 11", "Code": "sample string 12", "Description": "sample string 13", "TagReader": true, "DriverIdUsage": 64, "MaxVolumeCutOff": 1, "MaxAmountCutOff": 1, "FuelsMasterId": "d55ad681-6921-45cd-ac49-b32d285a71d7", "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": "20256d5b-6eff-4379-9128-71af35219d90", "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>d55ad681-6921-45cd-ac49-b32d285a71d7</FuelsMasterId> <Id>2c94bd6d-9bb3-4f6b-b865-ba617d596cff</Id> <InvoiceNumberInContingencySequence>1</InvoiceNumberInContingencySequence> <LastTSN>1</LastTSN> <MaxAmountCutOff>1</MaxAmountCutOff> <MaxVolumeCutOff>1</MaxVolumeCutOff> <MerchantId>a0151213-2aba-4cc9-a953-aad262d5ad16</MerchantId> <MerchantName>sample string 3</MerchantName> <OperatingSystem>sample string 17</OperatingSystem> <ProtocolId>78c8c9ba-a202-4b77-adfe-6fdfc5988ff4</ProtocolId> <ProtocolName>sample string 11</ProtocolName> <SerialNumber>sample string 18</SerialNumber> <SiteId>95ae574a-2407-41e7-9558-0c9544d1ee6d</SiteId> <SiteShortName>sample string 5</SiteShortName> <TagReader>true</TagReader> <TerminalInventoryLocationDescription>sample string 21</TerminalInventoryLocationDescription> <TerminalInventoryLocationId>20256d5b-6eff-4379-9128-71af35219d90</TerminalInventoryLocationId> <TerminalTypeId>aa8abdfe-ba53-4dee-81a5-342383f14e37</TerminalTypeId> <TerminalTypeModelDescription>sample string 9</TerminalTypeModelDescription> <TerminalTypeModelId>0b2ae3a3-0310-4bb0-a05a-d5fb7fbae458</TerminalTypeModelId> <TerminalTypeName>sample string 7</TerminalTypeName> <VehicleIdUsage>64</VehicleIdUsage> </TerminalDto>