POST api/Terminals/RegisterTerminal

Request Information

URI Parameters

None.

Body Parameters

TerinalRegistrationRequest
NameDescriptionTypeAdditional information
TerminalData

TerminalRegistrationModel

None.

Request Formats

application/json, text/json

Sample:
{
  "TerminalData": {
    "UHN": "sample string 1",
    "TerminalName": "sample string 2",
    "TerminalLocation": "sample string 3",
    "ProjectName": "sample string 4",
    "SerialNumber": "sample string 5",
    "CreatorName": "sample string 6",
    "CreatorEmail": "sample string 7",
    "ApplicationVersion": "sample string 8"
  }
}

application/xml, text/xml

Sample:
<TerinalRegistrationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Luhmann.SmartGrid.Models.Rest">
  <TerminalData xmlns:d2p1="http://schemas.datacontract.org/2004/07/Luhmann.SmartGrid.Models">
    <d2p1:ApplicationVersion>sample string 8</d2p1:ApplicationVersion>
    <d2p1:CreatorEmail>sample string 7</d2p1:CreatorEmail>
    <d2p1:CreatorName>sample string 6</d2p1:CreatorName>
    <d2p1:ProjectName>sample string 4</d2p1:ProjectName>
    <d2p1:SerialNumber>sample string 5</d2p1:SerialNumber>
    <d2p1:TerminalLocation>sample string 3</d2p1:TerminalLocation>
    <d2p1:TerminalName>sample string 2</d2p1:TerminalName>
    <d2p1:UHN>sample string 1</d2p1:UHN>
  </TerminalData>
</TerinalRegistrationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BaseApiResponse
NameDescriptionTypeAdditional information
Success

boolean

None.

Status

integer

None.

StatusDesc

string

None.

StatusEx

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Status": 2,
  "StatusDesc": "sample string 3",
  "StatusEx": "sample string 4"
}

application/xml, text/xml

Sample:
<BaseApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Luhmann.SmartGrid.Models.Rest">
  <Status>2</Status>
  <StatusDesc>sample string 3</StatusDesc>
  <StatusEx>sample string 4</StatusEx>
  <Success>true</Success>
</BaseApiResponse>