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": "d0b40797-f55b-491a-b146-a34d43f8e619", "MerchantId": "6667da76-13f7-4952-98ce-e83913dd1a52", "MerchantName": "sample string 3", "SiteId": "0cd177b0-d972-4556-a14f-5340c76c4cc0", "SiteShortName": "sample string 5", "TerminalTypeId": "fbc3346e-4ba5-4528-9f74-e1ca867a6d18", "TerminalTypeName": "sample string 7", "TerminalTypeModelId": "3e61c3dc-5268-4b89-8252-4411203af67c", "TerminalTypeModelDescription": "sample string 9", "ProtocolId": "270de40b-deaf-4c66-9c74-2fe691d608b7", "ProtocolName": "sample string 11", "Code": "sample string 12", "Description": "sample string 13", "TagReader": true, "DriverIdUsage": 64, "MaxVolumeCutOff": 1, "MaxAmountCutOff": 1, "FuelsMasterId": "cec0a7a7-79be-4a73-95a0-2d741e72c902", "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": "a1cbce5c-0380-444f-a64a-395ab6453e02", "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>cec0a7a7-79be-4a73-95a0-2d741e72c902</FuelsMasterId> <Id>d0b40797-f55b-491a-b146-a34d43f8e619</Id> <InvoiceNumberInContingencySequence>1</InvoiceNumberInContingencySequence> <LastTSN>1</LastTSN> <MaxAmountCutOff>1</MaxAmountCutOff> <MaxVolumeCutOff>1</MaxVolumeCutOff> <MerchantId>6667da76-13f7-4952-98ce-e83913dd1a52</MerchantId> <MerchantName>sample string 3</MerchantName> <OperatingSystem>sample string 17</OperatingSystem> <ProtocolId>270de40b-deaf-4c66-9c74-2fe691d608b7</ProtocolId> <ProtocolName>sample string 11</ProtocolName> <SerialNumber>sample string 18</SerialNumber> <SiteId>0cd177b0-d972-4556-a14f-5340c76c4cc0</SiteId> <SiteShortName>sample string 5</SiteShortName> <TagReader>true</TagReader> <TerminalInventoryLocationDescription>sample string 21</TerminalInventoryLocationDescription> <TerminalInventoryLocationId>a1cbce5c-0380-444f-a64a-395ab6453e02</TerminalInventoryLocationId> <TerminalTypeId>fbc3346e-4ba5-4528-9f74-e1ca867a6d18</TerminalTypeId> <TerminalTypeModelDescription>sample string 9</TerminalTypeModelDescription> <TerminalTypeModelId>3e61c3dc-5268-4b89-8252-4411203af67c</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": "af85d64b-7ccb-4bfc-b4c5-eca8110b11ff", "MerchantId": "01066733-cdb0-467a-b066-90b18d8a0e5e", "MerchantName": "sample string 3", "SiteId": "9e112ea6-56aa-4522-861d-40112311f68a", "SiteShortName": "sample string 5", "TerminalTypeId": "c2e68b1c-9cff-4874-9ee1-144709f87f81", "TerminalTypeName": "sample string 7", "TerminalTypeModelId": "98eab806-d35d-48c6-ac36-da8d8c4c59a9", "TerminalTypeModelDescription": "sample string 9", "ProtocolId": "35a415fe-9c1e-43e7-abce-03e25c1fbed0", "ProtocolName": "sample string 11", "Code": "sample string 12", "Description": "sample string 13", "TagReader": true, "DriverIdUsage": 64, "MaxVolumeCutOff": 1, "MaxAmountCutOff": 1, "FuelsMasterId": "8ed36421-c94d-47c4-8bbd-f31cb9cf42fa", "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": "b49097de-b220-45e3-9e93-0876df6b2cea", "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>8ed36421-c94d-47c4-8bbd-f31cb9cf42fa</FuelsMasterId> <Id>af85d64b-7ccb-4bfc-b4c5-eca8110b11ff</Id> <InvoiceNumberInContingencySequence>1</InvoiceNumberInContingencySequence> <LastTSN>1</LastTSN> <MaxAmountCutOff>1</MaxAmountCutOff> <MaxVolumeCutOff>1</MaxVolumeCutOff> <MerchantId>01066733-cdb0-467a-b066-90b18d8a0e5e</MerchantId> <MerchantName>sample string 3</MerchantName> <OperatingSystem>sample string 17</OperatingSystem> <ProtocolId>35a415fe-9c1e-43e7-abce-03e25c1fbed0</ProtocolId> <ProtocolName>sample string 11</ProtocolName> <SerialNumber>sample string 18</SerialNumber> <SiteId>9e112ea6-56aa-4522-861d-40112311f68a</SiteId> <SiteShortName>sample string 5</SiteShortName> <TagReader>true</TagReader> <TerminalInventoryLocationDescription>sample string 21</TerminalInventoryLocationDescription> <TerminalInventoryLocationId>b49097de-b220-45e3-9e93-0876df6b2cea</TerminalInventoryLocationId> <TerminalTypeId>c2e68b1c-9cff-4874-9ee1-144709f87f81</TerminalTypeId> <TerminalTypeModelDescription>sample string 9</TerminalTypeModelDescription> <TerminalTypeModelId>98eab806-d35d-48c6-ac36-da8d8c4c59a9</TerminalTypeModelId> <TerminalTypeName>sample string 7</TerminalTypeName> <VehicleIdUsage>64</VehicleIdUsage> </TerminalDto>