POST LpTank/PostTank

Create a Tank

Request Information

URI Parameters

Body Parameters

Name	Description	Type	Additional Information
CustID	Customer ID	string	Required Max length: 6
SN	Tank Serial Number	string	Required Max length: 20
Size	Tank Size (If not provided, will be 0)	decimal number
Desc	Tank Description	string	Max length: 30
LastFillDate	Tank Last Fill Date	date	Required
Owner	Tank Owner	string	Max length: 30
Route	Tank Route	string	Max length: 20
Region	Tank Region	string	Max length: 20
TankAddr	Tank Address	string	Max length: 40
TankCity	Tank City	string	Max length: 30
TankState	Tank State Abbreviation	string	Max length: 2
TankZip	Tank Zip Code	string	Max length: 10
PropaneProductDeptID	Propane Product Department ID	string	Max length: 6
PropaneProductProdID	Propane Product Product ID	string	Max length: 10
RentFeeProductDeptID	Rental Fee Product Department ID	string	Max length: 6
RentFeeProductProdID	Rental Fee Product Product ID	string	Max length: 10
DirectionsNotes	Directions and Notes	string
BillingComments	Billing Comments	string	Max length: 80
TankLat	Tank Latitude	decimal number	Max of 6 decimal places Range: inclusive between -90 and 90
TankLon	Tank Longitude	decimal number	Max of 6 decimal places Range: inclusive between -180 and 180
MaintDT1	User Defined Date Field #1	date
MaintDT2	User Defined Date Field #2	date
MaintDT3	User Defined Date Field #3	date
MaintDT4	User Defined Date Field #4	date
EQcycle	Equal Billing Cycle	string	Max length: 10
EQdeptId	Equal Billing Department Id	string	Max length: 6
EQProdId	Equal Billing Product Id	string	Max length: 10
EQAmount	Equal Billing Amount	decimal number
UdYn1	User Defined Checkbox Field #1	boolean
UdYn2	User Defined Checkbox Field #2	boolean
UdYn3	User Defined Checkbox Field #3	boolean
UdYn4	User Defined Checkbox Field #4	boolean
UdText1	User Defined Textbox Field #1	string	Max length: 30
UdText2	User Defined Textbox Field #2	string	Max length: 30
UdText3	User Defined Textbox Field #3	string	Max length: 30
UdText4	User Defined Textbox Field #4	string	Max length: 30
LastDelAmt	Last Delivery Amount	decimal number
LastDelGauge	Last Delivery Gauge	decimal number
LastTruckTick	Last Delivery Truck Ticket	string	Max length: 20
UseFactor2	Auxilary Usage Factor	decimal number
Location	Location	string	Required Max length: 6
Terms	Terms	string	Max length: 15
Driver	Delivery Driver	string	Max length: 6
RLType	Rent / Lease Type	string	Max length: 1
RLCycle	Rent / Lease Cycle	string	Max length: 10
RLAmount	Rent / Lease Amount	decimal number
RLTerms	Rent / Lease Terms	string	Max length: 15
RLBeginDate	Rent / Lease Begin Date	date
RLEndDate	Rent / Lease End Date	date
RLLeaseAmt	Rent / Lease Amount	decimal number
RLLeasePayments	Rent / Lease Payments	decimal number
RLNetLeaseBal	Rent / Lease Net Lease Balance	decimal number
RLBuyoutAmt	Rent / Lease Buyout Amount	decimal number
RLTankCost	Rent / Lease Tank Cost	decimal number
RLDepreciationAmt	Rent / Lease Depreciation Amount	decimal number
RLAccumDep	Rent / Lease Accumulated Depreciation	decimal number
RLTankValue	Rent / Lease Tank Value	decimal number
KFactor	K-Factor (If KFactor is non-null, then Tank Size must be non-null)	decimal number
UpdateKFactor	Update K Factor	boolean
StateTaxCode	State Tax Code	string	Max length: 15
AdjTaxCode	Adjusted Tax Code	string	Max length: 15
RLStateTaxCode	Rent / Lease State Tax Code	string	Max length: 15
RLAdjTaxCode	Rent / Lease Adjusted Tax Code	string	Max length: 15
MFSchedule	Motor Fuel Schedule	string	Max length: 25
MFTaxType	Motor Fuel Tax Type	string	Max length: 25
MFModeOfTrans	Motor Fuel Mode of Transportation	string	Max length: 10
MFDestCity	Motor Fuel Destination City	string	Max length: 25
MFDestState	Motor Fuel Destination State	string	Max length: 2
FWTaxGroup	FW Tax Group	string	Max length: 4
Inactive	Inactive	boolean
SalespersonID	Salesperson ID	string	Max length: 15
SiteID	Site ID	string	Max length: 3
RouteTopPriority	Route Optimization - First Stop	boolean
TankStatus	Tank Status - "ScheduledDelivery", "CalendarDays", or "WillCall" accepted	string
EnergyBillingSplits	List of Energy Billing Splits.	Collection of clsLpTankSp
RentalBillingSplits	List of Rental Billing Splits.	Collection of clsLPTankSpRent
TankAttributes	List of Tank Attributes.	Collection of clsLPTankAttributes
TankCalendarDays	List of Tank Calendar Days.	Collection of clsLPTankCalendarDays
TankClasses	List of Tank Classes.	Collection of clsLpTankClass

Request Formats

application/json, text/json

Sample:

{
  "CustID": "sample string 2",
  "SN": "sample string 3",
  "Size": 1.1,
  "Desc": "sample string 4",
  "LastFillDate": "2024-04-19T17:52:22.5010605+00:00",
  "Owner": "sample string 5",
  "Route": "sample string 6",
  "Region": "sample string 7",
  "TankAddr": "sample string 8",
  "TankCity": "sample string 9",
  "TankState": "sample string 10",
  "TankZip": "sample string 11",
  "PropaneProductDeptID": "sample string 12",
  "PropaneProductProdID": "sample string 13",
  "RentFeeProductDeptID": "sample string 14",
  "RentFeeProductProdID": "sample string 15",
  "DirectionsNotes": "sample string 16",
  "BillingComments": "sample string 17",
  "TankLat": 1.1,
  "TankLon": 1.1,
  "MaintDT1": "2024-04-19T17:52:22.5020603+00:00",
  "MaintDT2": "2024-04-19T17:52:22.5020603+00:00",
  "MaintDT3": "2024-04-19T17:52:22.5020603+00:00",
  "MaintDT4": "2024-04-19T17:52:22.5020603+00:00",
  "EQcycle": "sample string 18",
  "EQdeptId": "sample string 19",
  "EQProdId": "sample string 20",
  "EQAmount": 1.1,
  "UdYn1": true,
  "UdYn2": true,
  "UdYn3": true,
  "UdYn4": true,
  "UdText1": "sample string 21",
  "UdText2": "sample string 22",
  "UdText3": "sample string 23",
  "UdText4": "sample string 24",
  "LastDelAmt": 1.1,
  "LastDelGauge": 1.1,
  "LastTruckTick": "sample string 25",
  "UseFactor2": 1.1,
  "Location": "sample string 26",
  "Terms": "sample string 27",
  "Driver": "sample string 28",
  "RLType": "sample string 29",
  "RLCycle": "sample string 30",
  "RLAmount": 1.1,
  "RLTerms": "sample string 31",
  "RLBeginDate": "2024-04-19T17:52:22.5020603+00:00",
  "RLEndDate": "2024-04-19T17:52:22.5020603+00:00",
  "RLLeaseAmt": 1.1,
  "RLLeasePayments": 1.1,
  "RLNetLeaseBal": 1.1,
  "RLBuyoutAmt": 1.1,
  "RLTankCost": 1.1,
  "RLDepreciationAmt": 1.1,
  "RLAccumDep": 1.1,
  "RLTankValue": 1.1,
  "KFactor": 1.1,
  "UpdateKFactor": true,
  "StateTaxCode": "sample string 32",
  "AdjTaxCode": "sample string 33",
  "RLStateTaxCode": "sample string 34",
  "RLAdjTaxCode": "sample string 35",
  "MFSchedule": "sample string 36",
  "MFTaxType": "sample string 37",
  "MFModeOfTrans": "sample string 38",
  "MFDestCity": "sample string 39",
  "MFDestState": "sample string 40",
  "FWTaxGroup": "sample string 41",
  "Inactive": true,
  "SalespersonID": "sample string 42",
  "SiteID": "sample string 43",
  "RouteTopPriority": true,
  "TankStatus": "sample string 44",
  "EnergyBillingSplits": [
    {
      "Spcustid": "sample string 3",
      "Sppercent": 4.1
    },
    {
      "Spcustid": "sample string 3",
      "Sppercent": 4.1
    }
  ],
  "RentalBillingSplits": [
    {
      "SPCustID": "sample string 3",
      "SPPercent": "0"
    },
    {
      "SPCustID": "sample string 3",
      "SPPercent": "0"
    }
  ],
  "TankAttributes": [
    {
      "AttributeValue": "sample string 4",
      "CrossRef": "sample string 5"
    },
    {
      "AttributeValue": "sample string 4",
      "CrossRef": "sample string 5"
    }
  ],
  "TankCalendarDays": [
    {
      "StartMonth": "sample string 3",
      "StartDay": "sample string 4",
      "EndMonth": "sample string 5",
      "EndDay": "sample string 6",
      "DeliveryInterval": 7
    },
    {
      "StartMonth": "sample string 3",
      "StartDay": "sample string 4",
      "EndMonth": "sample string 5",
      "EndDay": "sample string 6",
      "DeliveryInterval": 7
    }
  ],
  "TankClasses": [
    {
      "ClassName": "sample string 4"
    },
    {
      "ClassName": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<clsLpTankAPIBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI">
  <AdjTaxCode>sample string 33</AdjTaxCode>
  <BillingComments>sample string 17</BillingComments>
  <CustID>sample string 2</CustID>
  <Desc>sample string 4</Desc>
  <DirectionsNotes>sample string 16</DirectionsNotes>
  <Driver>sample string 28</Driver>
  <EQAmount>1.1</EQAmount>
  <EQProdId>sample string 20</EQProdId>
  <EQcycle>sample string 18</EQcycle>
  <EQdeptId>sample string 19</EQdeptId>
  <EnergyBillingSplits xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.AR">
    <d2p1:clsLpTankSp>
      <d2p1:Spcustid>sample string 3</d2p1:Spcustid>
      <d2p1:Sppercent>4.1</d2p1:Sppercent>
    </d2p1:clsLpTankSp>
    <d2p1:clsLpTankSp>
      <d2p1:Spcustid>sample string 3</d2p1:Spcustid>
      <d2p1:Sppercent>4.1</d2p1:Sppercent>
    </d2p1:clsLpTankSp>
  </EnergyBillingSplits>
  <FWTaxGroup>sample string 41</FWTaxGroup>
  <Inactive>true</Inactive>
  <KFactor>1.1</KFactor>
  <LastDelAmt>1.1</LastDelAmt>
  <LastDelGauge>1.1</LastDelGauge>
  <LastFillDate>2024-04-19T17:52:22.5010605+00:00</LastFillDate>
  <LastTruckTick>sample string 25</LastTruckTick>
  <Location>sample string 26</Location>
  <MFDestCity>sample string 39</MFDestCity>
  <MFDestState>sample string 40</MFDestState>
  <MFModeOfTrans>sample string 38</MFModeOfTrans>
  <MFSchedule>sample string 36</MFSchedule>
  <MFTaxType>sample string 37</MFTaxType>
  <MaintDT1>2024-04-19T17:52:22.5020603+00:00</MaintDT1>
  <MaintDT2>2024-04-19T17:52:22.5020603+00:00</MaintDT2>
  <MaintDT3>2024-04-19T17:52:22.5020603+00:00</MaintDT3>
  <MaintDT4>2024-04-19T17:52:22.5020603+00:00</MaintDT4>
  <Owner>sample string 5</Owner>
  <PropaneProductDeptID>sample string 12</PropaneProductDeptID>
  <PropaneProductProdID>sample string 13</PropaneProductProdID>
  <RLAccumDep>1.1</RLAccumDep>
  <RLAdjTaxCode>sample string 35</RLAdjTaxCode>
  <RLAmount>1.1</RLAmount>
  <RLBeginDate>2024-04-19T17:52:22.5020603+00:00</RLBeginDate>
  <RLBuyoutAmt>1.1</RLBuyoutAmt>
  <RLCycle>sample string 30</RLCycle>
  <RLDepreciationAmt>1.1</RLDepreciationAmt>
  <RLEndDate>2024-04-19T17:52:22.5020603+00:00</RLEndDate>
  <RLLeaseAmt>1.1</RLLeaseAmt>
  <RLLeasePayments>1.1</RLLeasePayments>
  <RLNetLeaseBal>1.1</RLNetLeaseBal>
  <RLStateTaxCode>sample string 34</RLStateTaxCode>
  <RLTankCost>1.1</RLTankCost>
  <RLTankValue>1.1</RLTankValue>
  <RLTerms>sample string 31</RLTerms>
  <RLType>sample string 29</RLType>
  <Region>sample string 7</Region>
  <RentFeeProductDeptID>sample string 14</RentFeeProductDeptID>
  <RentFeeProductProdID>sample string 15</RentFeeProductProdID>
  <RentalBillingSplits xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.AR">
    <d2p1:clsLPTankSpRent>
      <d2p1:SPCustID>sample string 3</d2p1:SPCustID>
      <d2p1:SPPercent>0</d2p1:SPPercent>
    </d2p1:clsLPTankSpRent>
    <d2p1:clsLPTankSpRent>
      <d2p1:SPCustID>sample string 3</d2p1:SPCustID>
      <d2p1:SPPercent>0</d2p1:SPPercent>
    </d2p1:clsLPTankSpRent>
  </RentalBillingSplits>
  <Route>sample string 6</Route>
  <RouteTopPriority>true</RouteTopPriority>
  <SN>sample string 3</SN>
  <SalespersonID>sample string 42</SalespersonID>
  <SiteID>sample string 43</SiteID>
  <Size>1.1</Size>
  <StateTaxCode>sample string 32</StateTaxCode>
  <TankAddr>sample string 8</TankAddr>
  <TankAttributes xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.AR">
    <d2p1:clsLPTankAttributes>
      <d2p1:AttributeValue>sample string 4</d2p1:AttributeValue>
      <d2p1:CrossRef>sample string 5</d2p1:CrossRef>
    </d2p1:clsLPTankAttributes>
    <d2p1:clsLPTankAttributes>
      <d2p1:AttributeValue>sample string 4</d2p1:AttributeValue>
      <d2p1:CrossRef>sample string 5</d2p1:CrossRef>
    </d2p1:clsLPTankAttributes>
  </TankAttributes>
  <TankCalendarDays xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.AR">
    <d2p1:clsLPTankCalendarDays>
      <d2p1:DeliveryInterval>7</d2p1:DeliveryInterval>
      <d2p1:EndDay>sample string 6</d2p1:EndDay>
      <d2p1:EndMonth>sample string 5</d2p1:EndMonth>
      <d2p1:StartDay>sample string 4</d2p1:StartDay>
      <d2p1:StartMonth>sample string 3</d2p1:StartMonth>
    </d2p1:clsLPTankCalendarDays>
    <d2p1:clsLPTankCalendarDays>
      <d2p1:DeliveryInterval>7</d2p1:DeliveryInterval>
      <d2p1:EndDay>sample string 6</d2p1:EndDay>
      <d2p1:EndMonth>sample string 5</d2p1:EndMonth>
      <d2p1:StartDay>sample string 4</d2p1:StartDay>
      <d2p1:StartMonth>sample string 3</d2p1:StartMonth>
    </d2p1:clsLPTankCalendarDays>
  </TankCalendarDays>
  <TankCity>sample string 9</TankCity>
  <TankClasses xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.AR">
    <d2p1:clsLpTankClass>
      <d2p1:ClassName>sample string 4</d2p1:ClassName>
    </d2p1:clsLpTankClass>
    <d2p1:clsLpTankClass>
      <d2p1:ClassName>sample string 4</d2p1:ClassName>
    </d2p1:clsLpTankClass>
  </TankClasses>
  <TankLat>1.1</TankLat>
  <TankLon>1.1</TankLon>
  <TankState>sample string 10</TankState>
  <TankStatus>sample string 44</TankStatus>
  <TankZip>sample string 11</TankZip>
  <Terms>sample string 27</Terms>
  <UdText1>sample string 21</UdText1>
  <UdText2>sample string 22</UdText2>
  <UdText3>sample string 23</UdText3>
  <UdText4>sample string 24</UdText4>
  <UdYn1>true</UdYn1>
  <UdYn2>true</UdYn2>
  <UdYn3>true</UdYn3>
  <UdYn4>true</UdYn4>
  <UpdateKFactor>true</UpdateKFactor>
  <UseFactor2>1.1</UseFactor2>
</clsLpTankAPIBase>

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 'clsLpTankAPIBase'.

Response Information

Resource Description

Create a Tank

AgvLpTank

Name	Description	Type
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

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"
  ]
}

application/xml, text/xml

Sample:

<AgvLpTank 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>
  <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>
</AgvLpTank>