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": "93981821-513e-4480-abf3-2946e6c595c9",
"EstID": "99d37cb0-c568-4601-8653-c23d31d86d6d",
"idno": 1,
"idsub": 1,
"SurveyDate": "2026-10-28T05:47:24.4184825-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2026-10-28T05:47:24.4184825-04:00",
"ShipmentSurveyContainers": [
{
"ID": "f4c108a2-904c-44d8-b696-590ad9a8d6b9",
"SID": "3f4f9183-7b12-4b4a-931e-1df290263588",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "9a11bac3-8540-480b-86d0-1eebde2e8dba"
},
{
"ID": "f4c108a2-904c-44d8-b696-590ad9a8d6b9",
"SID": "3f4f9183-7b12-4b4a-931e-1df290263588",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "9a11bac3-8540-480b-86d0-1eebde2e8dba"
}
],
"ShipmentSurveyOthers": [
{
"ID": "2908c1b1-e82f-4e94-a2b3-5807d7e7e73f",
"SID": "3914e843-f9db-4f4a-abaa-58422751227f",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "2908c1b1-e82f-4e94-a2b3-5807d7e7e73f",
"SID": "3914e843-f9db-4f4a-abaa-58422751227f",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "e4b32616-b796-4253-801e-a37e46856a85",
"SID": "1e95be22-19c2-4cdb-80ff-72ed71c5f095",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "e4b32616-b796-4253-801e-a37e46856a85",
"SID": "1e95be22-19c2-4cdb-80ff-72ed71c5f095",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "dec245bc-0bd4-4196-aff1-36839eb8649c",
"SID": "da7253c0-7fa8-4e99-a2b2-c810cd8b89d1",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "b69881b8-ed5f-49b8-b45e-e6fd1a75cd13",
"CID": "efe57c27-357c-40a8-9248-f252611a522d",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "b69881b8-ed5f-49b8-b45e-e6fd1a75cd13",
"CID": "efe57c27-357c-40a8-9248-f252611a522d",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "dec245bc-0bd4-4196-aff1-36839eb8649c",
"SID": "da7253c0-7fa8-4e99-a2b2-c810cd8b89d1",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "b69881b8-ed5f-49b8-b45e-e6fd1a75cd13",
"CID": "efe57c27-357c-40a8-9248-f252611a522d",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "b69881b8-ed5f-49b8-b45e-e6fd1a75cd13",
"CID": "efe57c27-357c-40a8-9248-f252611a522d",
"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:47:24.4184825-04:00</Completed>
<EstID>99d37cb0-c568-4601-8653-c23d31d86d6d</EstID>
<ID>93981821-513e-4480-abf3-2946e6c595c9</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>dec245bc-0bd4-4196-aff1-36839eb8649c</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>da7253c0-7fa8-4e99-a2b2-c810cd8b89d1</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>efe57c27-357c-40a8-9248-f252611a522d</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>b69881b8-ed5f-49b8-b45e-e6fd1a75cd13</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>efe57c27-357c-40a8-9248-f252611a522d</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>b69881b8-ed5f-49b8-b45e-e6fd1a75cd13</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>dec245bc-0bd4-4196-aff1-36839eb8649c</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>da7253c0-7fa8-4e99-a2b2-c810cd8b89d1</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>efe57c27-357c-40a8-9248-f252611a522d</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>b69881b8-ed5f-49b8-b45e-e6fd1a75cd13</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>efe57c27-357c-40a8-9248-f252611a522d</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>b69881b8-ed5f-49b8-b45e-e6fd1a75cd13</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>9a11bac3-8540-480b-86d0-1eebde2e8dba</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>f4c108a2-904c-44d8-b696-590ad9a8d6b9</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>3f4f9183-7b12-4b4a-931e-1df290263588</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>9a11bac3-8540-480b-86d0-1eebde2e8dba</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>f4c108a2-904c-44d8-b696-590ad9a8d6b9</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>3f4f9183-7b12-4b4a-931e-1df290263588</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>2908c1b1-e82f-4e94-a2b3-5807d7e7e73f</ID>
<NotToShip>true</NotToShip>
<SID>3914e843-f9db-4f4a-abaa-58422751227f</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>2908c1b1-e82f-4e94-a2b3-5807d7e7e73f</ID>
<NotToShip>true</NotToShip>
<SID>3914e843-f9db-4f4a-abaa-58422751227f</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>e4b32616-b796-4253-801e-a37e46856a85</ID>
<Name>sample string 3</Name>
<SID>1e95be22-19c2-4cdb-80ff-72ed71c5f095</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>e4b32616-b796-4253-801e-a37e46856a85</ID>
<Name>sample string 3</Name>
<SID>1e95be22-19c2-4cdb-80ff-72ed71c5f095</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2026-10-28T05:47:24.4184825-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": "e15b378c-f1f9-4070-8737-8000fcc56ca9",
"EstID": "20065497-f395-4a82-9703-059dce74b73d",
"idno": 1,
"idsub": 1,
"SurveyDate": "2026-10-28T05:47:24.4478958-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2026-10-28T05:47:24.4478958-04:00",
"ShipmentSurveyContainers": [
{
"ID": "98990ddb-61f4-41dd-9fa4-aaf1becdf68c",
"SID": "8617f38a-0237-49fd-a9a1-88123471d885",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "2940a5b1-7cc6-4635-a5bb-f27683919067"
},
{
"ID": "98990ddb-61f4-41dd-9fa4-aaf1becdf68c",
"SID": "8617f38a-0237-49fd-a9a1-88123471d885",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "2940a5b1-7cc6-4635-a5bb-f27683919067"
}
],
"ShipmentSurveyOthers": [
{
"ID": "8868e305-c415-4398-a967-846668b0a79e",
"SID": "4503d6e7-9285-4e09-b397-d651d9d44fb9",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "8868e305-c415-4398-a967-846668b0a79e",
"SID": "4503d6e7-9285-4e09-b397-d651d9d44fb9",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "f443a877-4983-44ee-b3f7-8ea05e36d0e5",
"SID": "2fa2cbe0-2556-47e1-904b-545bd48e9e37",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "f443a877-4983-44ee-b3f7-8ea05e36d0e5",
"SID": "2fa2cbe0-2556-47e1-904b-545bd48e9e37",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "d067211f-d4ff-454a-afcb-80f00cbfb309",
"SID": "9afac281-52f0-4c8f-a3fd-4fc8f40a52f6",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "ebc25964-6c6f-4531-b93d-fe6e64b2bc6d",
"CID": "1d72be39-296a-4e92-905a-9be0b2784f52",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "ebc25964-6c6f-4531-b93d-fe6e64b2bc6d",
"CID": "1d72be39-296a-4e92-905a-9be0b2784f52",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "d067211f-d4ff-454a-afcb-80f00cbfb309",
"SID": "9afac281-52f0-4c8f-a3fd-4fc8f40a52f6",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "ebc25964-6c6f-4531-b93d-fe6e64b2bc6d",
"CID": "1d72be39-296a-4e92-905a-9be0b2784f52",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "ebc25964-6c6f-4531-b93d-fe6e64b2bc6d",
"CID": "1d72be39-296a-4e92-905a-9be0b2784f52",
"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:47:24.4478958-04:00</Completed>
<EstID>20065497-f395-4a82-9703-059dce74b73d</EstID>
<ID>e15b378c-f1f9-4070-8737-8000fcc56ca9</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>d067211f-d4ff-454a-afcb-80f00cbfb309</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>9afac281-52f0-4c8f-a3fd-4fc8f40a52f6</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>1d72be39-296a-4e92-905a-9be0b2784f52</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>ebc25964-6c6f-4531-b93d-fe6e64b2bc6d</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>1d72be39-296a-4e92-905a-9be0b2784f52</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>ebc25964-6c6f-4531-b93d-fe6e64b2bc6d</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>d067211f-d4ff-454a-afcb-80f00cbfb309</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>9afac281-52f0-4c8f-a3fd-4fc8f40a52f6</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>1d72be39-296a-4e92-905a-9be0b2784f52</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>ebc25964-6c6f-4531-b93d-fe6e64b2bc6d</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>1d72be39-296a-4e92-905a-9be0b2784f52</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>ebc25964-6c6f-4531-b93d-fe6e64b2bc6d</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>2940a5b1-7cc6-4635-a5bb-f27683919067</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>98990ddb-61f4-41dd-9fa4-aaf1becdf68c</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>8617f38a-0237-49fd-a9a1-88123471d885</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>2940a5b1-7cc6-4635-a5bb-f27683919067</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>98990ddb-61f4-41dd-9fa4-aaf1becdf68c</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>8617f38a-0237-49fd-a9a1-88123471d885</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>8868e305-c415-4398-a967-846668b0a79e</ID>
<NotToShip>true</NotToShip>
<SID>4503d6e7-9285-4e09-b397-d651d9d44fb9</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>8868e305-c415-4398-a967-846668b0a79e</ID>
<NotToShip>true</NotToShip>
<SID>4503d6e7-9285-4e09-b397-d651d9d44fb9</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>f443a877-4983-44ee-b3f7-8ea05e36d0e5</ID>
<Name>sample string 3</Name>
<SID>2fa2cbe0-2556-47e1-904b-545bd48e9e37</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>f443a877-4983-44ee-b3f7-8ea05e36d0e5</ID>
<Name>sample string 3</Name>
<SID>2fa2cbe0-2556-47e1-904b-545bd48e9e37</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2026-10-28T05:47:24.4478958-04:00</SurveyDate>
<UID>sample string 3</UID>
<Weight>1</Weight>
<idno>1</idno>
<idsub>1</idsub>
</ShipmentSurvey>