POST LpTank/PostTankReading

Create a Tank Reading entry

Request Information

URI Parameters

Body Parameters

clsTankReading
NameDescriptionTypeAdditional Information
TankNumber

string

Required

Max length: 20

TransmitterID

string

Required

Max length: 50

ReadingDate

date

Required

TankPercentage

decimal number

Required

Max of 3 decimal places

InTank

decimal number

Required

Max of 3 decimal places

Request Formats

application/json, text/json

Sample:
{
  "TankNumber": "sample string 3",
  "TransmitterID": "sample string 4",
  "ReadingDate": "2022-12-08T03:31:59.446673+00:00",
  "TankPercentage": 6.1,
  "InTank": 7.1
}

application/xml, text/xml

Sample:
<clsTankReading xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI">
  <InTank>7.1</InTank>
  <ReadingDate>2022-12-08T03:31:59.446673+00:00</ReadingDate>
  <TankNumber>sample string 3</TankNumber>
  <TankPercentage>6.1</TankPercentage>
  <TransmitterID>sample string 4</TransmitterID>
</clsTankReading>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'clsTankReading'.

Response Information

Resource Description

Create a Tank Reading entry

AgvTankReading
NameDescriptionTypeAdditional Information
Status

0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.

string
Message

Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.

string
ErrorList

List of error messages of the API call.

Collection of string
WarningList

List of warning messages of the API call.

Collection of string
Count

Count of how many Tank Readings.

string
TankReadings

JSON dictionary of TankReadings.

Collection of clsTankReading

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "Count": "2",
  "TankReadings": [
    {
      "TankNumber": "sample string 3",
      "TransmitterID": "sample string 4",
      "ReadingDate": "2022-12-08T03:31:59.446673+00:00",
      "TankPercentage": 6.1,
      "InTank": 7.1
    },
    {
      "TankNumber": "sample string 3",
      "TransmitterID": "sample string 4",
      "ReadingDate": "2022-12-08T03:31:59.446673+00:00",
      "TankPercentage": 6.1,
      "InTank": 7.1
    }
  ]
}

application/xml, text/xml

Sample:
<AgvTankReading xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.LpTank">
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
  <TankReadings xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI">
    <d2p1:clsTankReading>
      <d2p1:InTank>7.1</d2p1:InTank>
      <d2p1:ReadingDate>2022-12-08T03:31:59.446673+00:00</d2p1:ReadingDate>
      <d2p1:TankNumber>sample string 3</d2p1:TankNumber>
      <d2p1:TankPercentage>6.1</d2p1:TankPercentage>
      <d2p1:TransmitterID>sample string 4</d2p1:TransmitterID>
    </d2p1:clsTankReading>
    <d2p1:clsTankReading>
      <d2p1:InTank>7.1</d2p1:InTank>
      <d2p1:ReadingDate>2022-12-08T03:31:59.446673+00:00</d2p1:ReadingDate>
      <d2p1:TankNumber>sample string 3</d2p1:TankNumber>
      <d2p1:TankPercentage>6.1</d2p1:TankPercentage>
      <d2p1:TransmitterID>sample string 4</d2p1:TransmitterID>
    </d2p1:clsTankReading>
  </TankReadings>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvTankReading>