POST Container/PostContainer

Creates a Container

Request Information

URI Parameters

Body Parameters

Object used to create a new Container in the database.

ClsContainerAdd
NameDescriptionTypeAdditional Information
ContainerId

ID assigned to the container

 string

Required

Max length: 60
AlternateContainerId

Alternate ID for the container (optional)

 string

Max length: 60
OwnersContainerId

Owner ID for the container (optional)

 string

Max length: 60
TankType

User defined

 string

Max length: 25
Manufacturer

Manufacturer of the container

 string

Max length: 50
DateOfManufacture

Date container was manufactured

 string

Data type: DateTime

Format must be MM/dd/yyyy
OwningLocation

Location ID assigned to the container

 string

Max length: 6
CurrentLocation

Location ID where the container is currently

 string

Max length: 6
Capacity

Holding capacity of the container

 decimal number

Max of 3 decimal places

Range: inclusive between 0 and 9999999
CapacityUnits

Unit of measure used for the capacity of the container

 CapacityUnitsEnum
Inactive

Status of the container - Active or Inactive

 boolean

Must be 0, 1, True, or False
FilledStatus

Fill status of the container - Filled or Not Filled

 FilledStatusEnum
OwnedBy

Type of entity that owns the container - Company, Customer, or Vendor

 OwnedByEnum
OwnedByCustomerId

ID of the customer selected if OwnedBy is set to Customer

 string

Max length: 6
OwnedByVendorId

ID of the vendor selected if OwnedBy is set to Vendor

 string

Max length: 10
ScheduledTestRequirement

Type of schedulted test required for the container - Not Required, Before Every Fill, Required Every # of Days or Months

 ScheduledTestRequirementsEnum
TestRequiredInterval

Number of days or months between tests for the container if ScheduledTestRequirement is set to Required Every # of Days or Months

 integer

Cannot be negative

Range: inclusive between 0 and 9999999
DaysOrMonths

Designates if the scheduled test interval is based on Days or Months

 DaysOrMonthsEnum
Note

Additional information regarding the container

 string

Max length: 256
ContainerConstructionKey

Number representing the construction material of the container

 integer

Cannot be negative
ContainerSealKey

Number representing the seal material for the container

 integer

Cannot be negative
TamperEvidentDeviceNumber

Number of the tamper evident device

 string

Max length: 60
ApprovedProducts

Any products that are allowed to be inside a container

 Collection of ClsContainerApprovedProductAdd

Request Formats

application/json, text/json

Sample: 
{
  "ContainerId": "sample string 4",
  "AlternateContainerId": "sample string 5",
  "OwnersContainerId": "sample string 6",
  "TankType": "sample string 7",
  "Manufacturer": "sample string 8",
  "DateOfManufacture": "sample string 9",
  "OwningLocation": "sample string 10",
  "CurrentLocation": "sample string 11",
  "Capacity": 12.1,
  "CapacityUnits": 0,
  "Inactive": true,
  "FilledStatus": 0,
  "OwnedBy": 0,
  "OwnedByCustomerId": "sample string 14",
  "OwnedByVendorId": "sample string 15",
  "ScheduledTestRequirement": 0,
  "TestRequiredInterval": 16,
  "DaysOrMonths": 0,
  "Note": "sample string 17",
  "ContainerConstructionKey": 18,
  "ContainerSealKey": 19,
  "TamperEvidentDeviceNumber": "sample string 20",
  "ApprovedProducts": [
    {
      "DeptId": "sample string 1",
      "ProdId": "sample string 2",
      "Required": true
    },
    {
      "DeptId": "sample string 1",
      "ProdId": "sample string 2",
      "Required": true
    }
  ]
}

application/xml, text/xml

Sample: 
<ClsContainerAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.Inv">
  <AlternateContainerId>sample string 5</AlternateContainerId>
  <ApprovedProducts>
    <ClsContainerApprovedProductAdd>
      <DeptId>sample string 1</DeptId>
      <ProdId>sample string 2</ProdId>
      <Required>true</Required>
    </ClsContainerApprovedProductAdd>
    <ClsContainerApprovedProductAdd>
      <DeptId>sample string 1</DeptId>
      <ProdId>sample string 2</ProdId>
      <Required>true</Required>
    </ClsContainerApprovedProductAdd>
  </ApprovedProducts>
  <Capacity>12.1</Capacity>
  <CapacityUnits>Gal</CapacityUnits>
  <ContainerConstructionKey>18</ContainerConstructionKey>
  <ContainerId>sample string 4</ContainerId>
  <ContainerSealKey>19</ContainerSealKey>
  <CurrentLocation>sample string 11</CurrentLocation>
  <DateOfManufacture>sample string 9</DateOfManufacture>
  <DaysOrMonths>Days</DaysOrMonths>
  <FilledStatus>Not_Filled</FilledStatus>
  <Inactive>true</Inactive>
  <Manufacturer>sample string 8</Manufacturer>
  <Note>sample string 17</Note>
  <OwnedBy>Company</OwnedBy>
  <OwnedByCustomerId>sample string 14</OwnedByCustomerId>
  <OwnedByVendorId>sample string 15</OwnedByVendorId>
  <OwnersContainerId>sample string 6</OwnersContainerId>
  <OwningLocation>sample string 10</OwningLocation>
  <ScheduledTestRequirement>Not_Required</ScheduledTestRequirement>
  <TamperEvidentDeviceNumber>sample string 20</TamperEvidentDeviceNumber>
  <TankType>sample string 7</TankType>
  <TestRequiredInterval>16</TestRequiredInterval>
</ClsContainerAdd>

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

Response Information

Resource Description

Creates a Container

AgvContainer
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
Count

Number of results returned

 string
ContainerRecords

List of properties and values returned for each container that matches the request

 Collection of Container

Response Formats

application/json, text/json

Sample: 
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "ContainerRecords": [
    {
      "ContainerSealKey": 1,
      "ContainerConstructionKey": 2,
      "ContainerApprovedProducts": [
        {
          "ContainerApprovedProductsKey": 1,
          "ContainerKey": 2,
          "LineItem": 3,
          "DeptID": "sample string 4",
          "ProdID": "sample string 5",
          "ProductName": "sample string 6"
        },
        {
          "ContainerApprovedProductsKey": 1,
          "ContainerKey": 2,
          "LineItem": 3,
          "DeptID": "sample string 4",
          "ProdID": "sample string 5",
          "ProductName": "sample string 6"
        }
      ],
      "ContainerKey": 3,
      "ContainerID": "sample string 4",
      "AlternateContainerID": "sample string 5",
      "OwnersContainerID": "sample string 6",
      "TankType": "sample string 7",
      "Manufacturer": "sample string 8",
      "DateOfManufacture": "sample string 9",
      "OwningLocation": "sample string 10",
      "CurrentLocation": "sample string 11",
      "FilledStatus": "sample string 12",
      "CurrentProdID": "sample string 13",
      "CurrentDeptID": "sample string 14",
      "CurrentProductName": "sample string 15",
      "Capacity": 16.1,
      "CapacityUnits": "sample string 17",
      "Inactive": true,
      "OwnedBy": "sample string 20",
      "CustomerID": "sample string 21",
      "VendorID": "sample string 22",
      "ScheduledTestRequirement": "sample string 23",
      "TestRequiredInterval": 24,
      "DaysOrMonths": "sample string 25",
      "Note": "sample string 26",
      "TamperEvidentDeviceNumber": "sample string 27"
    },
    {
      "ContainerSealKey": 1,
      "ContainerConstructionKey": 2,
      "ContainerApprovedProducts": [
        {
          "ContainerApprovedProductsKey": 1,
          "ContainerKey": 2,
          "LineItem": 3,
          "DeptID": "sample string 4",
          "ProdID": "sample string 5",
          "ProductName": "sample string 6"
        },
        {
          "ContainerApprovedProductsKey": 1,
          "ContainerKey": 2,
          "LineItem": 3,
          "DeptID": "sample string 4",
          "ProdID": "sample string 5",
          "ProductName": "sample string 6"
        }
      ],
      "ContainerKey": 3,
      "ContainerID": "sample string 4",
      "AlternateContainerID": "sample string 5",
      "OwnersContainerID": "sample string 6",
      "TankType": "sample string 7",
      "Manufacturer": "sample string 8",
      "DateOfManufacture": "sample string 9",
      "OwningLocation": "sample string 10",
      "CurrentLocation": "sample string 11",
      "FilledStatus": "sample string 12",
      "CurrentProdID": "sample string 13",
      "CurrentDeptID": "sample string 14",
      "CurrentProductName": "sample string 15",
      "Capacity": 16.1,
      "CapacityUnits": "sample string 17",
      "Inactive": true,
      "OwnedBy": "sample string 20",
      "CustomerID": "sample string 21",
      "VendorID": "sample string 22",
      "ScheduledTestRequirement": "sample string 23",
      "TestRequiredInterval": 24,
      "DaysOrMonths": "sample string 25",
      "Note": "sample string 26",
      "TamperEvidentDeviceNumber": "sample string 27"
    }
  ]
}

application/xml, text/xml

Sample: 
<AgvContainer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Container">
  <ContainerRecords xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.Inv">
    <d2p1:Container>
      <d2p1:AlternateContainerID>sample string 5</d2p1:AlternateContainerID>
      <d2p1:Capacity>16.1</d2p1:Capacity>
      <d2p1:CapacityUnits>sample string 17</d2p1:CapacityUnits>
      <d2p1:ContainerApprovedProducts>
        <d2p1:ContainerApprovedProduct>
          <d2p1:ContainerApprovedProductsKey>1</d2p1:ContainerApprovedProductsKey>
          <d2p1:ContainerKey>2</d2p1:ContainerKey>
          <d2p1:DeptID>sample string 4</d2p1:DeptID>
          <d2p1:LineItem>3</d2p1:LineItem>
          <d2p1:ProdID>sample string 5</d2p1:ProdID>
          <d2p1:ProductName>sample string 6</d2p1:ProductName>
        </d2p1:ContainerApprovedProduct>
        <d2p1:ContainerApprovedProduct>
          <d2p1:ContainerApprovedProductsKey>1</d2p1:ContainerApprovedProductsKey>
          <d2p1:ContainerKey>2</d2p1:ContainerKey>
          <d2p1:DeptID>sample string 4</d2p1:DeptID>
          <d2p1:LineItem>3</d2p1:LineItem>
          <d2p1:ProdID>sample string 5</d2p1:ProdID>
          <d2p1:ProductName>sample string 6</d2p1:ProductName>
        </d2p1:ContainerApprovedProduct>
      </d2p1:ContainerApprovedProducts>
      <d2p1:ContainerConstructionKey>2</d2p1:ContainerConstructionKey>
      <d2p1:ContainerID>sample string 4</d2p1:ContainerID>
      <d2p1:ContainerKey>3</d2p1:ContainerKey>
      <d2p1:ContainerSealKey>1</d2p1:ContainerSealKey>
      <d2p1:CurrentDeptID>sample string 14</d2p1:CurrentDeptID>
      <d2p1:CurrentLocation>sample string 11</d2p1:CurrentLocation>
      <d2p1:CurrentProdID>sample string 13</d2p1:CurrentProdID>
      <d2p1:CurrentProductName>sample string 15</d2p1:CurrentProductName>
      <d2p1:CustomerID>sample string 21</d2p1:CustomerID>
      <d2p1:DateOfManufacture>sample string 9</d2p1:DateOfManufacture>
      <d2p1:DaysOrMonths>sample string 25</d2p1:DaysOrMonths>
      <d2p1:FilledStatus>sample string 12</d2p1:FilledStatus>
      <d2p1:Inactive>true</d2p1:Inactive>
      <d2p1:Manufacturer>sample string 8</d2p1:Manufacturer>
      <d2p1:Note>sample string 26</d2p1:Note>
      <d2p1:OwnedBy>sample string 20</d2p1:OwnedBy>
      <d2p1:OwnersContainerID>sample string 6</d2p1:OwnersContainerID>
      <d2p1:OwningLocation>sample string 10</d2p1:OwningLocation>
      <d2p1:ScheduledTestRequirement>sample string 23</d2p1:ScheduledTestRequirement>
      <d2p1:TamperEvidentDeviceNumber>sample string 27</d2p1:TamperEvidentDeviceNumber>
      <d2p1:TankType>sample string 7</d2p1:TankType>
      <d2p1:TestRequiredInterval>24</d2p1:TestRequiredInterval>
      <d2p1:VendorID>sample string 22</d2p1:VendorID>
    </d2p1:Container>
    <d2p1:Container>
      <d2p1:AlternateContainerID>sample string 5</d2p1:AlternateContainerID>
      <d2p1:Capacity>16.1</d2p1:Capacity>
      <d2p1:CapacityUnits>sample string 17</d2p1:CapacityUnits>
      <d2p1:ContainerApprovedProducts>
        <d2p1:ContainerApprovedProduct>
          <d2p1:ContainerApprovedProductsKey>1</d2p1:ContainerApprovedProductsKey>
          <d2p1:ContainerKey>2</d2p1:ContainerKey>
          <d2p1:DeptID>sample string 4</d2p1:DeptID>
          <d2p1:LineItem>3</d2p1:LineItem>
          <d2p1:ProdID>sample string 5</d2p1:ProdID>
          <d2p1:ProductName>sample string 6</d2p1:ProductName>
        </d2p1:ContainerApprovedProduct>
        <d2p1:ContainerApprovedProduct>
          <d2p1:ContainerApprovedProductsKey>1</d2p1:ContainerApprovedProductsKey>
          <d2p1:ContainerKey>2</d2p1:ContainerKey>
          <d2p1:DeptID>sample string 4</d2p1:DeptID>
          <d2p1:LineItem>3</d2p1:LineItem>
          <d2p1:ProdID>sample string 5</d2p1:ProdID>
          <d2p1:ProductName>sample string 6</d2p1:ProductName>
        </d2p1:ContainerApprovedProduct>
      </d2p1:ContainerApprovedProducts>
      <d2p1:ContainerConstructionKey>2</d2p1:ContainerConstructionKey>
      <d2p1:ContainerID>sample string 4</d2p1:ContainerID>
      <d2p1:ContainerKey>3</d2p1:ContainerKey>
      <d2p1:ContainerSealKey>1</d2p1:ContainerSealKey>
      <d2p1:CurrentDeptID>sample string 14</d2p1:CurrentDeptID>
      <d2p1:CurrentLocation>sample string 11</d2p1:CurrentLocation>
      <d2p1:CurrentProdID>sample string 13</d2p1:CurrentProdID>
      <d2p1:CurrentProductName>sample string 15</d2p1:CurrentProductName>
      <d2p1:CustomerID>sample string 21</d2p1:CustomerID>
      <d2p1:DateOfManufacture>sample string 9</d2p1:DateOfManufacture>
      <d2p1:DaysOrMonths>sample string 25</d2p1:DaysOrMonths>
      <d2p1:FilledStatus>sample string 12</d2p1:FilledStatus>
      <d2p1:Inactive>true</d2p1:Inactive>
      <d2p1:Manufacturer>sample string 8</d2p1:Manufacturer>
      <d2p1:Note>sample string 26</d2p1:Note>
      <d2p1:OwnedBy>sample string 20</d2p1:OwnedBy>
      <d2p1:OwnersContainerID>sample string 6</d2p1:OwnersContainerID>
      <d2p1:OwningLocation>sample string 10</d2p1:OwningLocation>
      <d2p1:ScheduledTestRequirement>sample string 23</d2p1:ScheduledTestRequirement>
      <d2p1:TamperEvidentDeviceNumber>sample string 27</d2p1:TamperEvidentDeviceNumber>
      <d2p1:TankType>sample string 7</d2p1:TankType>
      <d2p1:TestRequiredInterval>24</d2p1:TestRequiredInterval>
      <d2p1:VendorID>sample string 22</d2p1:VendorID>
    </d2p1:Container>
  </ContainerRecords>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvContainer>