POST api/CVIS/AddCVISDocument

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
id	string	None.
Type	string	None.
Status	string	None.
TrailerId	string	None.
CVISId	integer	None.
FormattedCVISId	string	None.
ShipmentCount	integer	None.
ItemsReceived	integer	None.
ItemsAccepted	integer	None.
ItemsRejected	integer	None.
CreatedDate	date	None.
ModifiedDate	date	None.
CreatedBy	string	None.
ModifiedBy	string	None.
Shipments	Collection of CVISDocumentLine	None.
Errors	Collection of CVISDocumentLine	None.

Request Formats

application/json, text/json

Sample:

{
  "id": "sample string 1",
  "Type": "sample string 2",
  "Status": "sample string 3",
  "TrailerId": "sample string 4",
  "CVISId": 5,
  "FormattedCVISId": "sample string 6",
  "ShipmentCount": 7,
  "ItemsReceived": 8,
  "ItemsAccepted": 9,
  "ItemsRejected": 10,
  "CreatedDate": "2024-09-08T17:19:21.4994265+00:00",
  "ModifiedDate": "2024-09-08T17:19:21.4994265+00:00",
  "CreatedBy": "sample string 13",
  "ModifiedBy": "sample string 14",
  "Shipments": [
    {
      "FulfillmentNumber": "sample string 1",
      "TrackingNumbers": "sample string 2",
      "ShipDate": "2024-09-08T17:19:21.4994265+00:00"
    },
    {
      "FulfillmentNumber": "sample string 1",
      "TrackingNumbers": "sample string 2",
      "ShipDate": "2024-09-08T17:19:21.4994265+00:00"
    }
  ],
  "Errors": [
    {
      "FulfillmentNumber": "sample string 1",
      "TrackingNumbers": "sample string 2",
      "ShipDate": "2024-09-08T17:19:21.4994265+00:00"
    },
    {
      "FulfillmentNumber": "sample string 1",
      "TrackingNumbers": "sample string 2",
      "ShipDate": "2024-09-08T17:19:21.4994265+00:00"
    }
  ]
}

application/xml, text/xml

Sample:

<CVISDocument xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>sample string 1</Id>
  <Type>sample string 2</Type>
  <Status>sample string 3</Status>
  <TrailerId>sample string 4</TrailerId>
  <CVISId>5</CVISId>
  <FormattedCVISId>sample string 6</FormattedCVISId>
  <ShipmentCount>7</ShipmentCount>
  <ItemsReceived>8</ItemsReceived>
  <ItemsAccepted>9</ItemsAccepted>
  <ItemsRejected>10</ItemsRejected>
  <CreatedDate>2024-09-08T17:19:21.4994265+00:00</CreatedDate>
  <ModifiedDate>2024-09-08T17:19:21.4994265+00:00</ModifiedDate>
  <CreatedBy>sample string 13</CreatedBy>
  <ModifiedBy>sample string 14</ModifiedBy>
  <Shipments>
    <CVISDocumentLine>
      <FulfillmentNumber>sample string 1</FulfillmentNumber>
      <TrackingNumbers>sample string 2</TrackingNumbers>
      <ShipDate>2024-09-08T17:19:21.4994265+00:00</ShipDate>
    </CVISDocumentLine>
    <CVISDocumentLine>
      <FulfillmentNumber>sample string 1</FulfillmentNumber>
      <TrackingNumbers>sample string 2</TrackingNumbers>
      <ShipDate>2024-09-08T17:19:21.4994265+00:00</ShipDate>
    </CVISDocumentLine>
  </Shipments>
  <Errors>
    <CVISDocumentLine>
      <FulfillmentNumber>sample string 1</FulfillmentNumber>
      <TrackingNumbers>sample string 2</TrackingNumbers>
      <ShipDate>2024-09-08T17:19:21.4994265+00:00</ShipDate>
    </CVISDocumentLine>
    <CVISDocumentLine>
      <FulfillmentNumber>sample string 1</FulfillmentNumber>
      <TrackingNumbers>sample string 2</TrackingNumbers>
      <ShipDate>2024-09-08T17:19:21.4994265+00:00</ShipDate>
    </CVISDocumentLine>
  </Errors>
</CVISDocument>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.