POST api/shipmentsurvey
Request Information
URI Parameters
None.
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": "f0a89a69-87ce-4b24-b40f-164fc0db5073",
"EstID": "07ea4d61-d0f8-4f36-98f6-df3dee269246",
"idno": 1,
"idsub": 1,
"SurveyDate": "2025-09-13T18:39:19.744249-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2025-09-13T18:39:19.744249-04:00",
"ShipmentSurveyContainers": [
{
"ID": "b7714c0f-a3d2-4573-90b6-dbedf0e8be97",
"SID": "6790501a-1648-4dd2-b65a-3dc9f1198a54",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "d0d3042a-f501-4971-b78c-4bb4c0a45b96"
},
{
"ID": "b7714c0f-a3d2-4573-90b6-dbedf0e8be97",
"SID": "6790501a-1648-4dd2-b65a-3dc9f1198a54",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "d0d3042a-f501-4971-b78c-4bb4c0a45b96"
}
],
"ShipmentSurveyOthers": [
{
"ID": "921e97d8-6e52-4a5d-bb3c-2cbbc48be0fa",
"SID": "8f5a6ec9-2680-4314-b4c8-73bbc2003b7f",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "921e97d8-6e52-4a5d-bb3c-2cbbc48be0fa",
"SID": "8f5a6ec9-2680-4314-b4c8-73bbc2003b7f",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "bff1da61-c683-4b33-a429-1a483049f95f",
"SID": "641591eb-685f-4930-a2b4-c26ce92ef230",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "bff1da61-c683-4b33-a429-1a483049f95f",
"SID": "641591eb-685f-4930-a2b4-c26ce92ef230",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "3779f589-955c-4a88-9959-4951aabca57b",
"SID": "c57ae927-3a64-4802-8a46-7fcdcd6b36d0",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "d0fea6a3-1035-4c0b-b21d-c557ed10fc18",
"CID": "91fba485-348b-4bbe-85a5-445fa19d6450",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "d0fea6a3-1035-4c0b-b21d-c557ed10fc18",
"CID": "91fba485-348b-4bbe-85a5-445fa19d6450",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "3779f589-955c-4a88-9959-4951aabca57b",
"SID": "c57ae927-3a64-4802-8a46-7fcdcd6b36d0",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "d0fea6a3-1035-4c0b-b21d-c557ed10fc18",
"CID": "91fba485-348b-4bbe-85a5-445fa19d6450",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "d0fea6a3-1035-4c0b-b21d-c557ed10fc18",
"CID": "91fba485-348b-4bbe-85a5-445fa19d6450",
"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>2025-09-13T18:39:19.744249-04:00</Completed>
<EstID>07ea4d61-d0f8-4f36-98f6-df3dee269246</EstID>
<ID>f0a89a69-87ce-4b24-b40f-164fc0db5073</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>3779f589-955c-4a88-9959-4951aabca57b</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>c57ae927-3a64-4802-8a46-7fcdcd6b36d0</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>91fba485-348b-4bbe-85a5-445fa19d6450</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>d0fea6a3-1035-4c0b-b21d-c557ed10fc18</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>91fba485-348b-4bbe-85a5-445fa19d6450</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>d0fea6a3-1035-4c0b-b21d-c557ed10fc18</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>3779f589-955c-4a88-9959-4951aabca57b</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>c57ae927-3a64-4802-8a46-7fcdcd6b36d0</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>91fba485-348b-4bbe-85a5-445fa19d6450</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>d0fea6a3-1035-4c0b-b21d-c557ed10fc18</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>91fba485-348b-4bbe-85a5-445fa19d6450</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>d0fea6a3-1035-4c0b-b21d-c557ed10fc18</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>d0d3042a-f501-4971-b78c-4bb4c0a45b96</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>b7714c0f-a3d2-4573-90b6-dbedf0e8be97</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>6790501a-1648-4dd2-b65a-3dc9f1198a54</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>d0d3042a-f501-4971-b78c-4bb4c0a45b96</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>b7714c0f-a3d2-4573-90b6-dbedf0e8be97</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>6790501a-1648-4dd2-b65a-3dc9f1198a54</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>921e97d8-6e52-4a5d-bb3c-2cbbc48be0fa</ID>
<NotToShip>true</NotToShip>
<SID>8f5a6ec9-2680-4314-b4c8-73bbc2003b7f</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>921e97d8-6e52-4a5d-bb3c-2cbbc48be0fa</ID>
<NotToShip>true</NotToShip>
<SID>8f5a6ec9-2680-4314-b4c8-73bbc2003b7f</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>bff1da61-c683-4b33-a429-1a483049f95f</ID>
<Name>sample string 3</Name>
<SID>641591eb-685f-4930-a2b4-c26ce92ef230</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>bff1da61-c683-4b33-a429-1a483049f95f</ID>
<Name>sample string 3</Name>
<SID>641591eb-685f-4930-a2b4-c26ce92ef230</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2025-09-13T18:39:19.744249-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
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. |
Response Formats
application/json, text/json
Sample:
{
"ID": "53f4b2e9-eb83-40cf-929f-9808885f271d",
"EstID": "0ae03f1c-68cf-425d-b197-5daf3853493b",
"idno": 1,
"idsub": 1,
"SurveyDate": "2025-09-13T18:39:19.744249-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2025-09-13T18:39:19.744249-04:00",
"ShipmentSurveyContainers": [
{
"ID": "662da748-f811-4e65-8374-1444058c0fdd",
"SID": "e66f2706-d7bb-4266-a59e-3fde3ed10742",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "5969a85a-5286-49d9-b05e-1ecc68692ee1"
},
{
"ID": "662da748-f811-4e65-8374-1444058c0fdd",
"SID": "e66f2706-d7bb-4266-a59e-3fde3ed10742",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "5969a85a-5286-49d9-b05e-1ecc68692ee1"
}
],
"ShipmentSurveyOthers": [
{
"ID": "3f8c820f-7194-4e6b-bf28-c85d815ef2ef",
"SID": "ba27e6c0-32d8-4aa0-b5a6-9f6c671e5d39",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "3f8c820f-7194-4e6b-bf28-c85d815ef2ef",
"SID": "ba27e6c0-32d8-4aa0-b5a6-9f6c671e5d39",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "de19b1aa-c13d-4444-ad68-4b6102df127d",
"SID": "0659bbe7-06e5-457c-ba7a-48049a06551a",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "de19b1aa-c13d-4444-ad68-4b6102df127d",
"SID": "0659bbe7-06e5-457c-ba7a-48049a06551a",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "e446fc7b-f4a7-4d2a-b024-58ce791d595c",
"SID": "16e49b6b-3f22-4433-9b4e-06ed78e7821a",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "35a43f87-bed3-43cc-929e-6b3536d1194e",
"CID": "af9cc5a1-5160-438d-816d-327a8e0c5db8",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "35a43f87-bed3-43cc-929e-6b3536d1194e",
"CID": "af9cc5a1-5160-438d-816d-327a8e0c5db8",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "e446fc7b-f4a7-4d2a-b024-58ce791d595c",
"SID": "16e49b6b-3f22-4433-9b4e-06ed78e7821a",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "35a43f87-bed3-43cc-929e-6b3536d1194e",
"CID": "af9cc5a1-5160-438d-816d-327a8e0c5db8",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "35a43f87-bed3-43cc-929e-6b3536d1194e",
"CID": "af9cc5a1-5160-438d-816d-327a8e0c5db8",
"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>2025-09-13T18:39:19.744249-04:00</Completed>
<EstID>0ae03f1c-68cf-425d-b197-5daf3853493b</EstID>
<ID>53f4b2e9-eb83-40cf-929f-9808885f271d</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>e446fc7b-f4a7-4d2a-b024-58ce791d595c</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>16e49b6b-3f22-4433-9b4e-06ed78e7821a</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>af9cc5a1-5160-438d-816d-327a8e0c5db8</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>35a43f87-bed3-43cc-929e-6b3536d1194e</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>af9cc5a1-5160-438d-816d-327a8e0c5db8</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>35a43f87-bed3-43cc-929e-6b3536d1194e</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>e446fc7b-f4a7-4d2a-b024-58ce791d595c</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>16e49b6b-3f22-4433-9b4e-06ed78e7821a</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>af9cc5a1-5160-438d-816d-327a8e0c5db8</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>35a43f87-bed3-43cc-929e-6b3536d1194e</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>af9cc5a1-5160-438d-816d-327a8e0c5db8</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>35a43f87-bed3-43cc-929e-6b3536d1194e</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>5969a85a-5286-49d9-b05e-1ecc68692ee1</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>662da748-f811-4e65-8374-1444058c0fdd</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>e66f2706-d7bb-4266-a59e-3fde3ed10742</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>5969a85a-5286-49d9-b05e-1ecc68692ee1</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>662da748-f811-4e65-8374-1444058c0fdd</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>e66f2706-d7bb-4266-a59e-3fde3ed10742</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>3f8c820f-7194-4e6b-bf28-c85d815ef2ef</ID>
<NotToShip>true</NotToShip>
<SID>ba27e6c0-32d8-4aa0-b5a6-9f6c671e5d39</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>3f8c820f-7194-4e6b-bf28-c85d815ef2ef</ID>
<NotToShip>true</NotToShip>
<SID>ba27e6c0-32d8-4aa0-b5a6-9f6c671e5d39</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>de19b1aa-c13d-4444-ad68-4b6102df127d</ID>
<Name>sample string 3</Name>
<SID>0659bbe7-06e5-457c-ba7a-48049a06551a</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>de19b1aa-c13d-4444-ad68-4b6102df127d</ID>
<Name>sample string 3</Name>
<SID>0659bbe7-06e5-457c-ba7a-48049a06551a</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2025-09-13T18:39:19.744249-04:00</SurveyDate>
<UID>sample string 3</UID>
<Weight>1</Weight>
<idno>1</idno>
<idsub>1</idsub>
</ShipmentSurvey>