PUT api/shipmentsurvey/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters
ShipmentSurvey| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | globally unique identifier |
None. |
|
| EstID | globally unique identifier |
None. |
|
| idno | integer |
None. |
|
| idsub | integer |
None. |
|
| SurveyDate | date |
None. |
|
| Note | string |
None. |
|
| Weight | integer |
None. |
|
| Area | integer |
None. |
|
| UID | string |
None. |
|
| Completed | date |
None. |
|
| ShipmentSurveyContainers | Collection of ShipmentSurveyContainer |
None. |
|
| ShipmentSurveyOthers | Collection of ShipmentSurveyOther |
None. |
|
| ShipmentSurveyQuestions | Collection of ShipmentSurveyQuestion |
None. |
|
| ShipmentSurveyCategories | Collection of ShipmentSurveyCategory |
None. |
Request Formats
application/json, text/json
Sample:
{
"ID": "f3bddd45-c756-44a7-ad42-a277395646c5",
"EstID": "1b627789-ff5b-4ae4-b105-31af9ee4f6ea",
"idno": 1,
"idsub": 1,
"SurveyDate": "2026-10-28T05:48:32.9410092-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2026-10-28T05:48:32.9410092-04:00",
"ShipmentSurveyContainers": [
{
"ID": "3af1a5eb-a583-4113-985b-455313531499",
"SID": "452e3ba5-fa4a-43a9-9ecf-3a458469fc6c",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "334784ad-be04-47f3-b25e-7aa03f2b5eda"
},
{
"ID": "3af1a5eb-a583-4113-985b-455313531499",
"SID": "452e3ba5-fa4a-43a9-9ecf-3a458469fc6c",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "334784ad-be04-47f3-b25e-7aa03f2b5eda"
}
],
"ShipmentSurveyOthers": [
{
"ID": "5c07de33-2985-4622-9348-1ec2b9ff858b",
"SID": "034382f7-9d63-446b-80e3-6d9a4f7ec9d8",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "5c07de33-2985-4622-9348-1ec2b9ff858b",
"SID": "034382f7-9d63-446b-80e3-6d9a4f7ec9d8",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "655256f9-2c54-43c8-a4b1-e0b4f3994f8d",
"SID": "ed62fd6d-f3ed-47f8-a3e3-6a3e8a74b183",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "655256f9-2c54-43c8-a4b1-e0b4f3994f8d",
"SID": "ed62fd6d-f3ed-47f8-a3e3-6a3e8a74b183",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "9ae986c7-a37a-403e-92b1-317aa6175a86",
"SID": "df082f94-5f7c-48a7-a352-42a7c0adcb35",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "a3082986-51d4-4ed1-aa43-33bffd793283",
"CID": "ec941f2a-1cd0-48c5-a93c-251a159773af",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "a3082986-51d4-4ed1-aa43-33bffd793283",
"CID": "ec941f2a-1cd0-48c5-a93c-251a159773af",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "9ae986c7-a37a-403e-92b1-317aa6175a86",
"SID": "df082f94-5f7c-48a7-a352-42a7c0adcb35",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "a3082986-51d4-4ed1-aa43-33bffd793283",
"CID": "ec941f2a-1cd0-48c5-a93c-251a159773af",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "a3082986-51d4-4ed1-aa43-33bffd793283",
"CID": "ec941f2a-1cd0-48c5-a93c-251a159773af",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
}
]
}
application/xml, text/xml
Sample:
<ShipmentSurvey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Estimate.Models">
<Area>1</Area>
<Completed>2026-10-28T05:48:32.9410092-04:00</Completed>
<EstID>1b627789-ff5b-4ae4-b105-31af9ee4f6ea</EstID>
<ID>f3bddd45-c756-44a7-ad42-a277395646c5</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>9ae986c7-a37a-403e-92b1-317aa6175a86</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>df082f94-5f7c-48a7-a352-42a7c0adcb35</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>ec941f2a-1cd0-48c5-a93c-251a159773af</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>a3082986-51d4-4ed1-aa43-33bffd793283</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>ec941f2a-1cd0-48c5-a93c-251a159773af</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>a3082986-51d4-4ed1-aa43-33bffd793283</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
</ShipmentSurveyItems>
<Weight>1</Weight>
</ShipmentSurveyCategory>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>9ae986c7-a37a-403e-92b1-317aa6175a86</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>df082f94-5f7c-48a7-a352-42a7c0adcb35</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>ec941f2a-1cd0-48c5-a93c-251a159773af</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>a3082986-51d4-4ed1-aa43-33bffd793283</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>ec941f2a-1cd0-48c5-a93c-251a159773af</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>a3082986-51d4-4ed1-aa43-33bffd793283</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
</ShipmentSurveyItems>
<Weight>1</Weight>
</ShipmentSurveyCategory>
</ShipmentSurveyCategories>
<ShipmentSurveyContainers>
<ShipmentSurveyContainer>
<CID>334784ad-be04-47f3-b25e-7aa03f2b5eda</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>3af1a5eb-a583-4113-985b-455313531499</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>452e3ba5-fa4a-43a9-9ecf-3a458469fc6c</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>334784ad-be04-47f3-b25e-7aa03f2b5eda</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>3af1a5eb-a583-4113-985b-455313531499</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>452e3ba5-fa4a-43a9-9ecf-3a458469fc6c</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>5c07de33-2985-4622-9348-1ec2b9ff858b</ID>
<NotToShip>true</NotToShip>
<SID>034382f7-9d63-446b-80e3-6d9a4f7ec9d8</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>5c07de33-2985-4622-9348-1ec2b9ff858b</ID>
<NotToShip>true</NotToShip>
<SID>034382f7-9d63-446b-80e3-6d9a4f7ec9d8</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>655256f9-2c54-43c8-a4b1-e0b4f3994f8d</ID>
<Name>sample string 3</Name>
<SID>ed62fd6d-f3ed-47f8-a3e3-6a3e8a74b183</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>655256f9-2c54-43c8-a4b1-e0b4f3994f8d</ID>
<Name>sample string 3</Name>
<SID>ed62fd6d-f3ed-47f8-a3e3-6a3e8a74b183</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2026-10-28T05:48:32.9410092-04:00</SurveyDate>
<UID>sample string 3</UID>
<Weight>1</Weight>
<idno>1</idno>
<idsub>1</idsub>
</ShipmentSurvey>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.