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": "e5949812-0090-4ce1-a8b7-67b98a109d9c",
"EstID": "5ca44641-21c1-4dba-ba9d-fbd4bd96759a",
"idno": 1,
"idsub": 1,
"SurveyDate": "2026-04-30T09:59:19.0286195-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2026-04-30T09:59:19.0286195-04:00",
"ShipmentSurveyContainers": [
{
"ID": "cfeead24-8d75-4832-84d3-f4251ccd1dd6",
"SID": "d078235b-b55a-4aaf-bd89-fcc0ba789ba1",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "c92a1b95-a7a7-4a84-9cc4-c8a3655e3c0d"
},
{
"ID": "cfeead24-8d75-4832-84d3-f4251ccd1dd6",
"SID": "d078235b-b55a-4aaf-bd89-fcc0ba789ba1",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "c92a1b95-a7a7-4a84-9cc4-c8a3655e3c0d"
}
],
"ShipmentSurveyOthers": [
{
"ID": "26fa828f-e166-4001-8983-a991653173f3",
"SID": "1ff9eb4c-e0e6-4d91-b0c0-ee81fbf3ecf9",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "26fa828f-e166-4001-8983-a991653173f3",
"SID": "1ff9eb4c-e0e6-4d91-b0c0-ee81fbf3ecf9",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "6d4dbc1a-deeb-44d1-a8e3-d27aa2cb113b",
"SID": "58d2144a-458c-4440-8a4a-a044c04e4903",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "6d4dbc1a-deeb-44d1-a8e3-d27aa2cb113b",
"SID": "58d2144a-458c-4440-8a4a-a044c04e4903",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "6a10afc6-2475-4606-90ac-cd1141b2b3e3",
"SID": "6e2e4d89-9abc-4d8b-bb09-05362756f199",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "c1e1ceed-ec16-41d4-9e72-748ea00f8f97",
"CID": "fb237ae3-b97f-4c88-8e0c-03372f9d9688",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "c1e1ceed-ec16-41d4-9e72-748ea00f8f97",
"CID": "fb237ae3-b97f-4c88-8e0c-03372f9d9688",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "6a10afc6-2475-4606-90ac-cd1141b2b3e3",
"SID": "6e2e4d89-9abc-4d8b-bb09-05362756f199",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "c1e1ceed-ec16-41d4-9e72-748ea00f8f97",
"CID": "fb237ae3-b97f-4c88-8e0c-03372f9d9688",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "c1e1ceed-ec16-41d4-9e72-748ea00f8f97",
"CID": "fb237ae3-b97f-4c88-8e0c-03372f9d9688",
"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-04-30T09:59:19.0286195-04:00</Completed>
<EstID>5ca44641-21c1-4dba-ba9d-fbd4bd96759a</EstID>
<ID>e5949812-0090-4ce1-a8b7-67b98a109d9c</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>6a10afc6-2475-4606-90ac-cd1141b2b3e3</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>6e2e4d89-9abc-4d8b-bb09-05362756f199</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>fb237ae3-b97f-4c88-8e0c-03372f9d9688</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>c1e1ceed-ec16-41d4-9e72-748ea00f8f97</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>fb237ae3-b97f-4c88-8e0c-03372f9d9688</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>c1e1ceed-ec16-41d4-9e72-748ea00f8f97</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>6a10afc6-2475-4606-90ac-cd1141b2b3e3</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>6e2e4d89-9abc-4d8b-bb09-05362756f199</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>fb237ae3-b97f-4c88-8e0c-03372f9d9688</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>c1e1ceed-ec16-41d4-9e72-748ea00f8f97</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>fb237ae3-b97f-4c88-8e0c-03372f9d9688</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>c1e1ceed-ec16-41d4-9e72-748ea00f8f97</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>c92a1b95-a7a7-4a84-9cc4-c8a3655e3c0d</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>cfeead24-8d75-4832-84d3-f4251ccd1dd6</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>d078235b-b55a-4aaf-bd89-fcc0ba789ba1</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>c92a1b95-a7a7-4a84-9cc4-c8a3655e3c0d</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>cfeead24-8d75-4832-84d3-f4251ccd1dd6</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>d078235b-b55a-4aaf-bd89-fcc0ba789ba1</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>26fa828f-e166-4001-8983-a991653173f3</ID>
<NotToShip>true</NotToShip>
<SID>1ff9eb4c-e0e6-4d91-b0c0-ee81fbf3ecf9</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>26fa828f-e166-4001-8983-a991653173f3</ID>
<NotToShip>true</NotToShip>
<SID>1ff9eb4c-e0e6-4d91-b0c0-ee81fbf3ecf9</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>6d4dbc1a-deeb-44d1-a8e3-d27aa2cb113b</ID>
<Name>sample string 3</Name>
<SID>58d2144a-458c-4440-8a4a-a044c04e4903</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>6d4dbc1a-deeb-44d1-a8e3-d27aa2cb113b</ID>
<Name>sample string 3</Name>
<SID>58d2144a-458c-4440-8a4a-a044c04e4903</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2026-04-30T09:59:19.0286195-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": "610ca3f3-7062-4ae1-a7d3-614353406a1a",
"EstID": "a38383f2-6591-490f-bdae-1c890dc4c9d5",
"idno": 1,
"idsub": 1,
"SurveyDate": "2026-04-30T09:59:19.0286195-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2026-04-30T09:59:19.0286195-04:00",
"ShipmentSurveyContainers": [
{
"ID": "21c862fe-c0a8-409e-87eb-7e45dc8c6ba4",
"SID": "9b30a19f-9768-4166-b86c-1bee620aee29",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "ebf331a1-403b-4f1e-b78d-6d08498953f2"
},
{
"ID": "21c862fe-c0a8-409e-87eb-7e45dc8c6ba4",
"SID": "9b30a19f-9768-4166-b86c-1bee620aee29",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "ebf331a1-403b-4f1e-b78d-6d08498953f2"
}
],
"ShipmentSurveyOthers": [
{
"ID": "50620bdb-9bb9-4d27-9233-2045615460e7",
"SID": "9cc6e97d-7187-49a4-8ec3-28f84eba876f",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "50620bdb-9bb9-4d27-9233-2045615460e7",
"SID": "9cc6e97d-7187-49a4-8ec3-28f84eba876f",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "384dc8a8-eab5-4266-a3de-663a8cea4973",
"SID": "74af5f4f-1c4a-4aad-8a6d-dbc7e965506a",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "384dc8a8-eab5-4266-a3de-663a8cea4973",
"SID": "74af5f4f-1c4a-4aad-8a6d-dbc7e965506a",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "8b98aa1c-58fc-4519-9a36-a6e0137fd687",
"SID": "6918a206-5f8b-4379-91ec-a67fa4b32692",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "cb6bf1a7-5c31-4b93-9ac4-66bc8164a867",
"CID": "88c59e58-e588-46d3-899e-63abc68c79d7",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "cb6bf1a7-5c31-4b93-9ac4-66bc8164a867",
"CID": "88c59e58-e588-46d3-899e-63abc68c79d7",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "8b98aa1c-58fc-4519-9a36-a6e0137fd687",
"SID": "6918a206-5f8b-4379-91ec-a67fa4b32692",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "cb6bf1a7-5c31-4b93-9ac4-66bc8164a867",
"CID": "88c59e58-e588-46d3-899e-63abc68c79d7",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "cb6bf1a7-5c31-4b93-9ac4-66bc8164a867",
"CID": "88c59e58-e588-46d3-899e-63abc68c79d7",
"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-04-30T09:59:19.0286195-04:00</Completed>
<EstID>a38383f2-6591-490f-bdae-1c890dc4c9d5</EstID>
<ID>610ca3f3-7062-4ae1-a7d3-614353406a1a</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>8b98aa1c-58fc-4519-9a36-a6e0137fd687</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>6918a206-5f8b-4379-91ec-a67fa4b32692</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>88c59e58-e588-46d3-899e-63abc68c79d7</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>cb6bf1a7-5c31-4b93-9ac4-66bc8164a867</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>88c59e58-e588-46d3-899e-63abc68c79d7</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>cb6bf1a7-5c31-4b93-9ac4-66bc8164a867</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>8b98aa1c-58fc-4519-9a36-a6e0137fd687</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>6918a206-5f8b-4379-91ec-a67fa4b32692</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>88c59e58-e588-46d3-899e-63abc68c79d7</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>cb6bf1a7-5c31-4b93-9ac4-66bc8164a867</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>88c59e58-e588-46d3-899e-63abc68c79d7</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>cb6bf1a7-5c31-4b93-9ac4-66bc8164a867</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>ebf331a1-403b-4f1e-b78d-6d08498953f2</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>21c862fe-c0a8-409e-87eb-7e45dc8c6ba4</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>9b30a19f-9768-4166-b86c-1bee620aee29</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>ebf331a1-403b-4f1e-b78d-6d08498953f2</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>21c862fe-c0a8-409e-87eb-7e45dc8c6ba4</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>9b30a19f-9768-4166-b86c-1bee620aee29</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>50620bdb-9bb9-4d27-9233-2045615460e7</ID>
<NotToShip>true</NotToShip>
<SID>9cc6e97d-7187-49a4-8ec3-28f84eba876f</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>50620bdb-9bb9-4d27-9233-2045615460e7</ID>
<NotToShip>true</NotToShip>
<SID>9cc6e97d-7187-49a4-8ec3-28f84eba876f</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>384dc8a8-eab5-4266-a3de-663a8cea4973</ID>
<Name>sample string 3</Name>
<SID>74af5f4f-1c4a-4aad-8a6d-dbc7e965506a</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>384dc8a8-eab5-4266-a3de-663a8cea4973</ID>
<Name>sample string 3</Name>
<SID>74af5f4f-1c4a-4aad-8a6d-dbc7e965506a</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2026-04-30T09:59:19.0286195-04:00</SurveyDate>
<UID>sample string 3</UID>
<Weight>1</Weight>
<idno>1</idno>
<idsub>1</idsub>
</ShipmentSurvey>