POST ContainerActivity/PostContainerActivity

Creates a container activity record

Request Information

URI Parameters

Body Parameters

Model to use as the new container activity record

ClsContainerActivityAdd
NameDescriptionTypeAdditional Information
ContainerKey

Number representing a container

integer

Required

ActivityTypeEnum

Container activity performed

Activity

Required

ActivityDate

Date container activity was performed - Default is current date

string

Format must be MM/dd/yyyy

ActivityTime

Time container activity was performed - Default is current time

string

Must be valid time format

ActivityDoneBy

Name of person assigned to container activity

string

Max length: 50

FilledStatus

Filled status of the container - Filled or Not Filled

string

Required

Max length: 10

CurrentLocation

Location ID where the container is currently

string

Required

Max length: 6

FillDeptId

Department ID of the product in the container

string

Max length: 6

FillProdId

Product ID of the product in the container

string

Max length: 10

FillQty

Quantity of the product in the container

decimal number
TransferDeptId

Department ID of the product transferred during Fill or Unload activity

string

Max length: 6

TransferProdId

Product ID of the product transferred during Fill or Unload activity

string

Max length: 10

CustomerId

ID of the customer for a 'Send To Customer' or 'Receive From Customer' activity

string

Max length: 6

VendorId

ID of the vendor for a 'Send To Vendor' or 'Receive From Vendor' activity

string

Max length: 10

InspectionTestPass

Indicates the test passed or failed for an Inspection or Scheduled Test activity

boolean
ActivityNote

Comments of the activity performed

string

Max length: 256

TamperEvidentDeviceNumber

Identifying number for the tamper evident device

string

Max length: 60

Request Formats

application/json, text/json

Sample:
{
  "ContainerKey": 1,
  "ActivityTypeEnum": 0,
  "ActivityDate": "sample string 2",
  "ActivityTime": "sample string 3",
  "ActivityDoneBy": "sample string 4",
  "FilledStatus": "sample string 5",
  "CurrentLocation": "sample string 6",
  "FillDeptId": "sample string 7",
  "FillProdId": "sample string 8",
  "FillQty": 9.1,
  "TransferDeptId": "sample string 10",
  "TransferProdId": "sample string 11",
  "CustomerId": "sample string 12",
  "VendorId": "sample string 13",
  "InspectionTestPass": true,
  "ActivityNote": "sample string 15",
  "TamperEvidentDeviceNumber": "sample string 16"
}

application/xml, text/xml

Sample:
<ClsContainerActivity.ClsContainerActivityAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Inventory">
  <ActivityDate>sample string 2</ActivityDate>
  <ActivityDoneBy>sample string 4</ActivityDoneBy>
  <ActivityNote>sample string 15</ActivityNote>
  <ActivityTime>sample string 3</ActivityTime>
  <ActivityTypeEnum>Fill</ActivityTypeEnum>
  <ContainerKey>1</ContainerKey>
  <CurrentLocation>sample string 6</CurrentLocation>
  <CustomerId>sample string 12</CustomerId>
  <FillDeptId>sample string 7</FillDeptId>
  <FillProdId>sample string 8</FillProdId>
  <FillQty>9.1</FillQty>
  <FilledStatus>sample string 5</FilledStatus>
  <InspectionTestPass>true</InspectionTestPass>
  <TamperEvidentDeviceNumber>sample string 16</TamperEvidentDeviceNumber>
  <TransferDeptId>sample string 10</TransferDeptId>
  <TransferProdId>sample string 11</TransferProdId>
  <VendorId>sample string 13</VendorId>
</ClsContainerActivity.ClsContainerActivityAdd>

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

Response Information

Resource Description

Creates a container activity record

AgvContainerActivity
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 activities returned

string
ContainerActivities

List of properties and values returned for each container activity

Collection of ClsContainerActivity

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "ContainerActivities": [
    {
      "ActivityTypeEnum": 0,
      "ContainerKey": 1,
      "ActivityType": "sample string 3",
      "ActivityDate": "sample string 4",
      "ActivityTime": "sample string 5",
      "ActivityDoneBy": "sample string 6",
      "UserId": "sample string 7",
      "UserName": "sample string 8",
      "FilledStatus": "sample string 9",
      "CurrentLocation": "sample string 10",
      "CurrentLocationName": "sample string 11",
      "FillDeptId": "sample string 12",
      "FillProdId": "sample string 13",
      "FillProductName": "sample string 14",
      "FillQty": 15.1,
      "TransferDeptId": "sample string 16",
      "TransferProdId": "sample string 17",
      "TransferFromProductName": "sample string 18",
      "CustomerId": "sample string 19",
      "CustomerName": "sample string 20",
      "VendorId": "sample string 21",
      "VendorName": "sample string 22",
      "InspectionTestPass": true,
      "ActivityNote": "sample string 24",
      "CreatedByDocumentType": "sample string 25",
      "CreatedByDocumentKey1": "sample string 26",
      "CreatedByDocumentKey2": "sample string 27",
      "CreatedByDocumentKey3": "sample string 28",
      "CreatedByDocumentKey4": "sample string 29",
      "CreatedByDocumentKey5": "sample string 30",
      "RecordedDate": "sample string 31",
      "RecordedTime": "sample string 32"
    },
    {
      "ActivityTypeEnum": 0,
      "ContainerKey": 1,
      "ActivityType": "sample string 3",
      "ActivityDate": "sample string 4",
      "ActivityTime": "sample string 5",
      "ActivityDoneBy": "sample string 6",
      "UserId": "sample string 7",
      "UserName": "sample string 8",
      "FilledStatus": "sample string 9",
      "CurrentLocation": "sample string 10",
      "CurrentLocationName": "sample string 11",
      "FillDeptId": "sample string 12",
      "FillProdId": "sample string 13",
      "FillProductName": "sample string 14",
      "FillQty": 15.1,
      "TransferDeptId": "sample string 16",
      "TransferProdId": "sample string 17",
      "TransferFromProductName": "sample string 18",
      "CustomerId": "sample string 19",
      "CustomerName": "sample string 20",
      "VendorId": "sample string 21",
      "VendorName": "sample string 22",
      "InspectionTestPass": true,
      "ActivityNote": "sample string 24",
      "CreatedByDocumentType": "sample string 25",
      "CreatedByDocumentKey1": "sample string 26",
      "CreatedByDocumentKey2": "sample string 27",
      "CreatedByDocumentKey3": "sample string 28",
      "CreatedByDocumentKey4": "sample string 29",
      "CreatedByDocumentKey5": "sample string 30",
      "RecordedDate": "sample string 31",
      "RecordedTime": "sample string 32"
    }
  ]
}

application/xml, text/xml

Sample:
<AgvContainerActivity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Container">
  <ContainerActivities xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.Inventory">
    <d2p1:ContainerActivity>
      <d2p1:ActivityDate>sample string 4</d2p1:ActivityDate>
      <d2p1:ActivityDoneBy>sample string 6</d2p1:ActivityDoneBy>
      <d2p1:ActivityNote>sample string 24</d2p1:ActivityNote>
      <d2p1:ActivityTime>sample string 5</d2p1:ActivityTime>
      <d2p1:ActivityType>sample string 3</d2p1:ActivityType>
      <d2p1:ActivityTypeEnum>Fill</d2p1:ActivityTypeEnum>
      <d2p1:ContainerKey>1</d2p1:ContainerKey>
      <d2p1:CreatedByDocumentKey1>sample string 26</d2p1:CreatedByDocumentKey1>
      <d2p1:CreatedByDocumentKey2>sample string 27</d2p1:CreatedByDocumentKey2>
      <d2p1:CreatedByDocumentKey3>sample string 28</d2p1:CreatedByDocumentKey3>
      <d2p1:CreatedByDocumentKey4>sample string 29</d2p1:CreatedByDocumentKey4>
      <d2p1:CreatedByDocumentKey5>sample string 30</d2p1:CreatedByDocumentKey5>
      <d2p1:CreatedByDocumentType>sample string 25</d2p1:CreatedByDocumentType>
      <d2p1:CurrentLocation>sample string 10</d2p1:CurrentLocation>
      <d2p1:CurrentLocationName>sample string 11</d2p1:CurrentLocationName>
      <d2p1:CustomerId>sample string 19</d2p1:CustomerId>
      <d2p1:CustomerName>sample string 20</d2p1:CustomerName>
      <d2p1:FillDeptId>sample string 12</d2p1:FillDeptId>
      <d2p1:FillProdId>sample string 13</d2p1:FillProdId>
      <d2p1:FillProductName>sample string 14</d2p1:FillProductName>
      <d2p1:FillQty>15.1</d2p1:FillQty>
      <d2p1:FilledStatus>sample string 9</d2p1:FilledStatus>
      <d2p1:InspectionTestPass>true</d2p1:InspectionTestPass>
      <d2p1:RecordedDate>sample string 31</d2p1:RecordedDate>
      <d2p1:RecordedTime>sample string 32</d2p1:RecordedTime>
      <d2p1:TransferDeptId>sample string 16</d2p1:TransferDeptId>
      <d2p1:TransferFromProductName>sample string 18</d2p1:TransferFromProductName>
      <d2p1:TransferProdId>sample string 17</d2p1:TransferProdId>
      <d2p1:UserId>sample string 7</d2p1:UserId>
      <d2p1:UserName>sample string 8</d2p1:UserName>
      <d2p1:VendorId>sample string 21</d2p1:VendorId>
      <d2p1:VendorName>sample string 22</d2p1:VendorName>
    </d2p1:ContainerActivity>
    <d2p1:ContainerActivity>
      <d2p1:ActivityDate>sample string 4</d2p1:ActivityDate>
      <d2p1:ActivityDoneBy>sample string 6</d2p1:ActivityDoneBy>
      <d2p1:ActivityNote>sample string 24</d2p1:ActivityNote>
      <d2p1:ActivityTime>sample string 5</d2p1:ActivityTime>
      <d2p1:ActivityType>sample string 3</d2p1:ActivityType>
      <d2p1:ActivityTypeEnum>Fill</d2p1:ActivityTypeEnum>
      <d2p1:ContainerKey>1</d2p1:ContainerKey>
      <d2p1:CreatedByDocumentKey1>sample string 26</d2p1:CreatedByDocumentKey1>
      <d2p1:CreatedByDocumentKey2>sample string 27</d2p1:CreatedByDocumentKey2>
      <d2p1:CreatedByDocumentKey3>sample string 28</d2p1:CreatedByDocumentKey3>
      <d2p1:CreatedByDocumentKey4>sample string 29</d2p1:CreatedByDocumentKey4>
      <d2p1:CreatedByDocumentKey5>sample string 30</d2p1:CreatedByDocumentKey5>
      <d2p1:CreatedByDocumentType>sample string 25</d2p1:CreatedByDocumentType>
      <d2p1:CurrentLocation>sample string 10</d2p1:CurrentLocation>
      <d2p1:CurrentLocationName>sample string 11</d2p1:CurrentLocationName>
      <d2p1:CustomerId>sample string 19</d2p1:CustomerId>
      <d2p1:CustomerName>sample string 20</d2p1:CustomerName>
      <d2p1:FillDeptId>sample string 12</d2p1:FillDeptId>
      <d2p1:FillProdId>sample string 13</d2p1:FillProdId>
      <d2p1:FillProductName>sample string 14</d2p1:FillProductName>
      <d2p1:FillQty>15.1</d2p1:FillQty>
      <d2p1:FilledStatus>sample string 9</d2p1:FilledStatus>
      <d2p1:InspectionTestPass>true</d2p1:InspectionTestPass>
      <d2p1:RecordedDate>sample string 31</d2p1:RecordedDate>
      <d2p1:RecordedTime>sample string 32</d2p1:RecordedTime>
      <d2p1:TransferDeptId>sample string 16</d2p1:TransferDeptId>
      <d2p1:TransferFromProductName>sample string 18</d2p1:TransferFromProductName>
      <d2p1:TransferProdId>sample string 17</d2p1:TransferProdId>
      <d2p1:UserId>sample string 7</d2p1:UserId>
      <d2p1:UserName>sample string 8</d2p1:UserName>
      <d2p1:VendorId>sample string 21</d2p1:VendorId>
      <d2p1:VendorName>sample string 22</d2p1:VendorName>
    </d2p1:ContainerActivity>
  </ContainerActivities>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvContainerActivity>