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": "44751172-96e3-4c53-83a3-4171731ba67e",
"EstID": "928c7a5f-edf6-4d69-b29b-377938b7dff8",
"idno": 1,
"idsub": 1,
"SurveyDate": "2025-10-30T18:02:53.4309227-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2025-10-30T18:02:53.4309227-04:00",
"ShipmentSurveyContainers": [
{
"ID": "0d5bb198-66bf-4dc3-b92a-e24b16b58b05",
"SID": "c8ec3894-592a-45b6-bfee-306e9fde3f95",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "c99dd6b8-ad28-4e1d-808a-f8cf7f02c7e3"
},
{
"ID": "0d5bb198-66bf-4dc3-b92a-e24b16b58b05",
"SID": "c8ec3894-592a-45b6-bfee-306e9fde3f95",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "c99dd6b8-ad28-4e1d-808a-f8cf7f02c7e3"
}
],
"ShipmentSurveyOthers": [
{
"ID": "f9a38324-c048-4fde-bd5b-09cec3f423d2",
"SID": "135485d4-82f3-4b95-a281-d7e5996b0f92",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "f9a38324-c048-4fde-bd5b-09cec3f423d2",
"SID": "135485d4-82f3-4b95-a281-d7e5996b0f92",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "bf6e0f45-83c6-488b-bff7-16ee0d8a213e",
"SID": "39c9a8b5-908d-4adc-939f-c45d1255c5c9",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "bf6e0f45-83c6-488b-bff7-16ee0d8a213e",
"SID": "39c9a8b5-908d-4adc-939f-c45d1255c5c9",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "f7e530e8-0073-4ce3-9cb1-df0edbfa4ceb",
"SID": "12b2b653-fa46-4ed6-8f07-77e063771845",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "3589cf73-a8a8-48a4-8df0-a0930977ffc4",
"CID": "52758db6-ca88-4ee4-bbbf-5912fcbe176b",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "3589cf73-a8a8-48a4-8df0-a0930977ffc4",
"CID": "52758db6-ca88-4ee4-bbbf-5912fcbe176b",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "f7e530e8-0073-4ce3-9cb1-df0edbfa4ceb",
"SID": "12b2b653-fa46-4ed6-8f07-77e063771845",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "3589cf73-a8a8-48a4-8df0-a0930977ffc4",
"CID": "52758db6-ca88-4ee4-bbbf-5912fcbe176b",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "3589cf73-a8a8-48a4-8df0-a0930977ffc4",
"CID": "52758db6-ca88-4ee4-bbbf-5912fcbe176b",
"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-10-30T18:02:53.4309227-04:00</Completed>
<EstID>928c7a5f-edf6-4d69-b29b-377938b7dff8</EstID>
<ID>44751172-96e3-4c53-83a3-4171731ba67e</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>f7e530e8-0073-4ce3-9cb1-df0edbfa4ceb</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>12b2b653-fa46-4ed6-8f07-77e063771845</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>52758db6-ca88-4ee4-bbbf-5912fcbe176b</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>3589cf73-a8a8-48a4-8df0-a0930977ffc4</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>52758db6-ca88-4ee4-bbbf-5912fcbe176b</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>3589cf73-a8a8-48a4-8df0-a0930977ffc4</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>f7e530e8-0073-4ce3-9cb1-df0edbfa4ceb</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>12b2b653-fa46-4ed6-8f07-77e063771845</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>52758db6-ca88-4ee4-bbbf-5912fcbe176b</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>3589cf73-a8a8-48a4-8df0-a0930977ffc4</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>52758db6-ca88-4ee4-bbbf-5912fcbe176b</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>3589cf73-a8a8-48a4-8df0-a0930977ffc4</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>c99dd6b8-ad28-4e1d-808a-f8cf7f02c7e3</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>0d5bb198-66bf-4dc3-b92a-e24b16b58b05</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>c8ec3894-592a-45b6-bfee-306e9fde3f95</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>c99dd6b8-ad28-4e1d-808a-f8cf7f02c7e3</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>0d5bb198-66bf-4dc3-b92a-e24b16b58b05</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>c8ec3894-592a-45b6-bfee-306e9fde3f95</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>f9a38324-c048-4fde-bd5b-09cec3f423d2</ID>
<NotToShip>true</NotToShip>
<SID>135485d4-82f3-4b95-a281-d7e5996b0f92</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>f9a38324-c048-4fde-bd5b-09cec3f423d2</ID>
<NotToShip>true</NotToShip>
<SID>135485d4-82f3-4b95-a281-d7e5996b0f92</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>bf6e0f45-83c6-488b-bff7-16ee0d8a213e</ID>
<Name>sample string 3</Name>
<SID>39c9a8b5-908d-4adc-939f-c45d1255c5c9</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>bf6e0f45-83c6-488b-bff7-16ee0d8a213e</ID>
<Name>sample string 3</Name>
<SID>39c9a8b5-908d-4adc-939f-c45d1255c5c9</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2025-10-30T18:02:53.4309227-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": "9de7327e-3ea4-4cc4-9428-6aec4e1a0f27",
"EstID": "30d3ec13-dd94-462a-8b8b-022effc3cee8",
"idno": 1,
"idsub": 1,
"SurveyDate": "2025-10-30T18:02:53.4465443-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2025-10-30T18:02:53.4465443-04:00",
"ShipmentSurveyContainers": [
{
"ID": "6b8460a2-807a-4043-be32-5aff6aa57bca",
"SID": "5c7a0dc8-06f3-456b-a3e7-a54f750f7887",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "fa78c856-4a40-4994-97d7-adf8ec2cdc84"
},
{
"ID": "6b8460a2-807a-4043-be32-5aff6aa57bca",
"SID": "5c7a0dc8-06f3-456b-a3e7-a54f750f7887",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "fa78c856-4a40-4994-97d7-adf8ec2cdc84"
}
],
"ShipmentSurveyOthers": [
{
"ID": "9e0aae5b-8d06-4b70-ba76-fffbb1cee442",
"SID": "f3c09945-0c14-48e0-976c-0eaabc0ad553",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "9e0aae5b-8d06-4b70-ba76-fffbb1cee442",
"SID": "f3c09945-0c14-48e0-976c-0eaabc0ad553",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "8fbc7a1f-552c-4046-ae81-feb072e7a945",
"SID": "c629b67e-1fdf-4dea-ac46-7efa7f7b83ae",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "8fbc7a1f-552c-4046-ae81-feb072e7a945",
"SID": "c629b67e-1fdf-4dea-ac46-7efa7f7b83ae",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "93529d14-5b90-4e5b-90bd-7ede52fbfd5d",
"SID": "999e145f-5f66-4486-aeb0-cb8431dfc4da",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "befe39df-a303-4c7c-a48a-757868296d2d",
"CID": "54d83416-9e9d-4193-9380-f99c955199c9",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "befe39df-a303-4c7c-a48a-757868296d2d",
"CID": "54d83416-9e9d-4193-9380-f99c955199c9",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "93529d14-5b90-4e5b-90bd-7ede52fbfd5d",
"SID": "999e145f-5f66-4486-aeb0-cb8431dfc4da",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "befe39df-a303-4c7c-a48a-757868296d2d",
"CID": "54d83416-9e9d-4193-9380-f99c955199c9",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "befe39df-a303-4c7c-a48a-757868296d2d",
"CID": "54d83416-9e9d-4193-9380-f99c955199c9",
"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-10-30T18:02:53.4465443-04:00</Completed>
<EstID>30d3ec13-dd94-462a-8b8b-022effc3cee8</EstID>
<ID>9de7327e-3ea4-4cc4-9428-6aec4e1a0f27</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>93529d14-5b90-4e5b-90bd-7ede52fbfd5d</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>999e145f-5f66-4486-aeb0-cb8431dfc4da</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>54d83416-9e9d-4193-9380-f99c955199c9</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>befe39df-a303-4c7c-a48a-757868296d2d</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>54d83416-9e9d-4193-9380-f99c955199c9</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>befe39df-a303-4c7c-a48a-757868296d2d</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>93529d14-5b90-4e5b-90bd-7ede52fbfd5d</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>999e145f-5f66-4486-aeb0-cb8431dfc4da</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>54d83416-9e9d-4193-9380-f99c955199c9</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>befe39df-a303-4c7c-a48a-757868296d2d</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>54d83416-9e9d-4193-9380-f99c955199c9</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>befe39df-a303-4c7c-a48a-757868296d2d</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>fa78c856-4a40-4994-97d7-adf8ec2cdc84</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>6b8460a2-807a-4043-be32-5aff6aa57bca</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>5c7a0dc8-06f3-456b-a3e7-a54f750f7887</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>fa78c856-4a40-4994-97d7-adf8ec2cdc84</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>6b8460a2-807a-4043-be32-5aff6aa57bca</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>5c7a0dc8-06f3-456b-a3e7-a54f750f7887</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>9e0aae5b-8d06-4b70-ba76-fffbb1cee442</ID>
<NotToShip>true</NotToShip>
<SID>f3c09945-0c14-48e0-976c-0eaabc0ad553</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>9e0aae5b-8d06-4b70-ba76-fffbb1cee442</ID>
<NotToShip>true</NotToShip>
<SID>f3c09945-0c14-48e0-976c-0eaabc0ad553</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>8fbc7a1f-552c-4046-ae81-feb072e7a945</ID>
<Name>sample string 3</Name>
<SID>c629b67e-1fdf-4dea-ac46-7efa7f7b83ae</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>8fbc7a1f-552c-4046-ae81-feb072e7a945</ID>
<Name>sample string 3</Name>
<SID>c629b67e-1fdf-4dea-ac46-7efa7f7b83ae</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2025-10-30T18:02:53.4465443-04:00</SurveyDate>
<UID>sample string 3</UID>
<Weight>1</Weight>
<idno>1</idno>
<idsub>1</idsub>
</ShipmentSurvey>