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": "c574fcb2-d636-4ef3-876f-a10763ee2818",
"EstID": "9c4c32cd-3eb5-4291-a4ce-cd648a978fb0",
"idno": 1,
"idsub": 1,
"SurveyDate": "2026-03-15T17:34:30.1775762-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2026-03-15T17:34:30.1775762-04:00",
"ShipmentSurveyContainers": [
{
"ID": "7ac415a6-7dc3-4c42-a2f6-dfd45ae64b02",
"SID": "5213db5f-27f3-4069-867e-771f94c40a48",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "da09ab5a-1036-42bf-8a13-9bcbd4c0d139"
},
{
"ID": "7ac415a6-7dc3-4c42-a2f6-dfd45ae64b02",
"SID": "5213db5f-27f3-4069-867e-771f94c40a48",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "da09ab5a-1036-42bf-8a13-9bcbd4c0d139"
}
],
"ShipmentSurveyOthers": [
{
"ID": "ac10b5dc-9e4b-4baa-83bd-99b51a439090",
"SID": "41083463-e2ae-4953-b09d-c989de051922",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "ac10b5dc-9e4b-4baa-83bd-99b51a439090",
"SID": "41083463-e2ae-4953-b09d-c989de051922",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "0a8b5283-cd10-46da-974f-af9fa49d83e5",
"SID": "2afca746-8361-4d2e-b155-1288a56fa932",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "0a8b5283-cd10-46da-974f-af9fa49d83e5",
"SID": "2afca746-8361-4d2e-b155-1288a56fa932",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "f3c5bd67-4e09-4ce5-9934-a9110276833a",
"SID": "b6b76988-d50d-4b2e-8e6b-744e89e48d01",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "31802704-c891-43e4-a4bc-f0ac8c1e4c2b",
"CID": "c017981f-e7cf-4f59-b67b-67f05b0ee2a7",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "31802704-c891-43e4-a4bc-f0ac8c1e4c2b",
"CID": "c017981f-e7cf-4f59-b67b-67f05b0ee2a7",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "f3c5bd67-4e09-4ce5-9934-a9110276833a",
"SID": "b6b76988-d50d-4b2e-8e6b-744e89e48d01",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "31802704-c891-43e4-a4bc-f0ac8c1e4c2b",
"CID": "c017981f-e7cf-4f59-b67b-67f05b0ee2a7",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "31802704-c891-43e4-a4bc-f0ac8c1e4c2b",
"CID": "c017981f-e7cf-4f59-b67b-67f05b0ee2a7",
"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-03-15T17:34:30.1775762-04:00</Completed>
<EstID>9c4c32cd-3eb5-4291-a4ce-cd648a978fb0</EstID>
<ID>c574fcb2-d636-4ef3-876f-a10763ee2818</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>f3c5bd67-4e09-4ce5-9934-a9110276833a</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>b6b76988-d50d-4b2e-8e6b-744e89e48d01</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>c017981f-e7cf-4f59-b67b-67f05b0ee2a7</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>31802704-c891-43e4-a4bc-f0ac8c1e4c2b</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>c017981f-e7cf-4f59-b67b-67f05b0ee2a7</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>31802704-c891-43e4-a4bc-f0ac8c1e4c2b</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>f3c5bd67-4e09-4ce5-9934-a9110276833a</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>b6b76988-d50d-4b2e-8e6b-744e89e48d01</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>c017981f-e7cf-4f59-b67b-67f05b0ee2a7</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>31802704-c891-43e4-a4bc-f0ac8c1e4c2b</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>c017981f-e7cf-4f59-b67b-67f05b0ee2a7</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>31802704-c891-43e4-a4bc-f0ac8c1e4c2b</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>da09ab5a-1036-42bf-8a13-9bcbd4c0d139</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>7ac415a6-7dc3-4c42-a2f6-dfd45ae64b02</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>5213db5f-27f3-4069-867e-771f94c40a48</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>da09ab5a-1036-42bf-8a13-9bcbd4c0d139</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>7ac415a6-7dc3-4c42-a2f6-dfd45ae64b02</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>5213db5f-27f3-4069-867e-771f94c40a48</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>ac10b5dc-9e4b-4baa-83bd-99b51a439090</ID>
<NotToShip>true</NotToShip>
<SID>41083463-e2ae-4953-b09d-c989de051922</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>ac10b5dc-9e4b-4baa-83bd-99b51a439090</ID>
<NotToShip>true</NotToShip>
<SID>41083463-e2ae-4953-b09d-c989de051922</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>0a8b5283-cd10-46da-974f-af9fa49d83e5</ID>
<Name>sample string 3</Name>
<SID>2afca746-8361-4d2e-b155-1288a56fa932</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>0a8b5283-cd10-46da-974f-af9fa49d83e5</ID>
<Name>sample string 3</Name>
<SID>2afca746-8361-4d2e-b155-1288a56fa932</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2026-03-15T17:34:30.1775762-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": "b02e8efd-0b91-461d-a341-a39bd2df7ad7",
"EstID": "e40a9840-20cc-46cc-baad-49427ab547ef",
"idno": 1,
"idsub": 1,
"SurveyDate": "2026-03-15T17:34:30.1775762-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2026-03-15T17:34:30.1775762-04:00",
"ShipmentSurveyContainers": [
{
"ID": "daac38e7-3615-44bf-bfd7-ed4e10db2129",
"SID": "ebc60789-253c-4a42-ae80-a0b713d0b5c0",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "5355899b-c216-429c-a592-d819a6782206"
},
{
"ID": "daac38e7-3615-44bf-bfd7-ed4e10db2129",
"SID": "ebc60789-253c-4a42-ae80-a0b713d0b5c0",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "5355899b-c216-429c-a592-d819a6782206"
}
],
"ShipmentSurveyOthers": [
{
"ID": "26d3e547-dbb8-4f55-81cc-562a7675b52c",
"SID": "47d4a14b-a690-4c2b-aac6-1d2f049c4dbe",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "26d3e547-dbb8-4f55-81cc-562a7675b52c",
"SID": "47d4a14b-a690-4c2b-aac6-1d2f049c4dbe",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "312478f0-0eb5-48d8-aeca-3666b078a673",
"SID": "91d346f7-3ccf-4749-8fbb-4f27e94e5a83",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "312478f0-0eb5-48d8-aeca-3666b078a673",
"SID": "91d346f7-3ccf-4749-8fbb-4f27e94e5a83",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "d9796443-4df7-419d-9a4d-77c567f04236",
"SID": "d9eaa831-0a75-426e-85fc-7554c04aaeb5",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "cb97b9c8-b750-4fad-9af7-cf92249ee302",
"CID": "1268f2ea-790c-4397-9c16-c76ee70346fb",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "cb97b9c8-b750-4fad-9af7-cf92249ee302",
"CID": "1268f2ea-790c-4397-9c16-c76ee70346fb",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "d9796443-4df7-419d-9a4d-77c567f04236",
"SID": "d9eaa831-0a75-426e-85fc-7554c04aaeb5",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "cb97b9c8-b750-4fad-9af7-cf92249ee302",
"CID": "1268f2ea-790c-4397-9c16-c76ee70346fb",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "cb97b9c8-b750-4fad-9af7-cf92249ee302",
"CID": "1268f2ea-790c-4397-9c16-c76ee70346fb",
"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-03-15T17:34:30.1775762-04:00</Completed>
<EstID>e40a9840-20cc-46cc-baad-49427ab547ef</EstID>
<ID>b02e8efd-0b91-461d-a341-a39bd2df7ad7</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>d9796443-4df7-419d-9a4d-77c567f04236</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>d9eaa831-0a75-426e-85fc-7554c04aaeb5</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>1268f2ea-790c-4397-9c16-c76ee70346fb</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>cb97b9c8-b750-4fad-9af7-cf92249ee302</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>1268f2ea-790c-4397-9c16-c76ee70346fb</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>cb97b9c8-b750-4fad-9af7-cf92249ee302</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>d9796443-4df7-419d-9a4d-77c567f04236</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>d9eaa831-0a75-426e-85fc-7554c04aaeb5</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>1268f2ea-790c-4397-9c16-c76ee70346fb</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>cb97b9c8-b750-4fad-9af7-cf92249ee302</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>1268f2ea-790c-4397-9c16-c76ee70346fb</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>cb97b9c8-b750-4fad-9af7-cf92249ee302</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>5355899b-c216-429c-a592-d819a6782206</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>daac38e7-3615-44bf-bfd7-ed4e10db2129</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>ebc60789-253c-4a42-ae80-a0b713d0b5c0</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>5355899b-c216-429c-a592-d819a6782206</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>daac38e7-3615-44bf-bfd7-ed4e10db2129</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>ebc60789-253c-4a42-ae80-a0b713d0b5c0</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>26d3e547-dbb8-4f55-81cc-562a7675b52c</ID>
<NotToShip>true</NotToShip>
<SID>47d4a14b-a690-4c2b-aac6-1d2f049c4dbe</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>26d3e547-dbb8-4f55-81cc-562a7675b52c</ID>
<NotToShip>true</NotToShip>
<SID>47d4a14b-a690-4c2b-aac6-1d2f049c4dbe</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>312478f0-0eb5-48d8-aeca-3666b078a673</ID>
<Name>sample string 3</Name>
<SID>91d346f7-3ccf-4749-8fbb-4f27e94e5a83</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>312478f0-0eb5-48d8-aeca-3666b078a673</ID>
<Name>sample string 3</Name>
<SID>91d346f7-3ccf-4749-8fbb-4f27e94e5a83</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2026-03-15T17:34:30.1775762-04:00</SurveyDate>
<UID>sample string 3</UID>
<Weight>1</Weight>
<idno>1</idno>
<idsub>1</idsub>
</ShipmentSurvey>