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": "ba6b0afa-b213-45f9-8c43-482f7d6c4b2a",
"EstID": "ee129548-a6ab-4eec-98a2-88aa50f9554c",
"idno": 1,
"idsub": 1,
"SurveyDate": "2026-09-13T00:41:30.1435793-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2026-09-13T00:41:30.1435793-04:00",
"ShipmentSurveyContainers": [
{
"ID": "1a17cc95-9b3e-449b-9439-7a1f02ff3184",
"SID": "17fa03ad-c665-452a-a4d0-8daaed4fd70d",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "536dc21d-8466-4bac-b8fe-78dd5c2f0c95"
},
{
"ID": "1a17cc95-9b3e-449b-9439-7a1f02ff3184",
"SID": "17fa03ad-c665-452a-a4d0-8daaed4fd70d",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "536dc21d-8466-4bac-b8fe-78dd5c2f0c95"
}
],
"ShipmentSurveyOthers": [
{
"ID": "5fa65a0c-a94d-4541-b4e0-2ae51974fd02",
"SID": "56709ecd-3bd5-4716-bfca-2d1e2925e7a2",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "5fa65a0c-a94d-4541-b4e0-2ae51974fd02",
"SID": "56709ecd-3bd5-4716-bfca-2d1e2925e7a2",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "b395a58d-b33e-4f2c-b630-edcf1c98a2eb",
"SID": "ae8de25a-2999-4404-b1b9-fd3603033fa2",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "b395a58d-b33e-4f2c-b630-edcf1c98a2eb",
"SID": "ae8de25a-2999-4404-b1b9-fd3603033fa2",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "bd704d96-c378-43f1-baab-2f5ee229a875",
"SID": "2f30d861-33f1-4e56-afdd-403516f005e0",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "c129fef2-125e-4380-bfc9-4a1723013d18",
"CID": "4a679ccf-8ade-48e1-bed7-5cff530c6aee",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "c129fef2-125e-4380-bfc9-4a1723013d18",
"CID": "4a679ccf-8ade-48e1-bed7-5cff530c6aee",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "bd704d96-c378-43f1-baab-2f5ee229a875",
"SID": "2f30d861-33f1-4e56-afdd-403516f005e0",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "c129fef2-125e-4380-bfc9-4a1723013d18",
"CID": "4a679ccf-8ade-48e1-bed7-5cff530c6aee",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "c129fef2-125e-4380-bfc9-4a1723013d18",
"CID": "4a679ccf-8ade-48e1-bed7-5cff530c6aee",
"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-09-13T00:41:30.1435793-04:00</Completed>
<EstID>ee129548-a6ab-4eec-98a2-88aa50f9554c</EstID>
<ID>ba6b0afa-b213-45f9-8c43-482f7d6c4b2a</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>bd704d96-c378-43f1-baab-2f5ee229a875</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>2f30d861-33f1-4e56-afdd-403516f005e0</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>4a679ccf-8ade-48e1-bed7-5cff530c6aee</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>c129fef2-125e-4380-bfc9-4a1723013d18</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>4a679ccf-8ade-48e1-bed7-5cff530c6aee</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>c129fef2-125e-4380-bfc9-4a1723013d18</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>bd704d96-c378-43f1-baab-2f5ee229a875</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>2f30d861-33f1-4e56-afdd-403516f005e0</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>4a679ccf-8ade-48e1-bed7-5cff530c6aee</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>c129fef2-125e-4380-bfc9-4a1723013d18</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>4a679ccf-8ade-48e1-bed7-5cff530c6aee</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>c129fef2-125e-4380-bfc9-4a1723013d18</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>536dc21d-8466-4bac-b8fe-78dd5c2f0c95</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>1a17cc95-9b3e-449b-9439-7a1f02ff3184</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>17fa03ad-c665-452a-a4d0-8daaed4fd70d</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>536dc21d-8466-4bac-b8fe-78dd5c2f0c95</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>1a17cc95-9b3e-449b-9439-7a1f02ff3184</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>17fa03ad-c665-452a-a4d0-8daaed4fd70d</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>5fa65a0c-a94d-4541-b4e0-2ae51974fd02</ID>
<NotToShip>true</NotToShip>
<SID>56709ecd-3bd5-4716-bfca-2d1e2925e7a2</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>5fa65a0c-a94d-4541-b4e0-2ae51974fd02</ID>
<NotToShip>true</NotToShip>
<SID>56709ecd-3bd5-4716-bfca-2d1e2925e7a2</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>b395a58d-b33e-4f2c-b630-edcf1c98a2eb</ID>
<Name>sample string 3</Name>
<SID>ae8de25a-2999-4404-b1b9-fd3603033fa2</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>b395a58d-b33e-4f2c-b630-edcf1c98a2eb</ID>
<Name>sample string 3</Name>
<SID>ae8de25a-2999-4404-b1b9-fd3603033fa2</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2026-09-13T00:41:30.1435793-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": "350528e9-df0d-4ce5-ade0-dad1d03b05ef",
"EstID": "fca8fabc-029f-4868-b5bb-022d71eb5d36",
"idno": 1,
"idsub": 1,
"SurveyDate": "2026-09-13T00:41:30.1748301-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2026-09-13T00:41:30.1748301-04:00",
"ShipmentSurveyContainers": [
{
"ID": "02310e2c-b315-42b3-8953-efe4af965687",
"SID": "63e53558-6203-4d3c-bdc7-2298d682cefa",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "39472395-86ea-4a93-b420-1a51206624d6"
},
{
"ID": "02310e2c-b315-42b3-8953-efe4af965687",
"SID": "63e53558-6203-4d3c-bdc7-2298d682cefa",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "39472395-86ea-4a93-b420-1a51206624d6"
}
],
"ShipmentSurveyOthers": [
{
"ID": "d7a9a056-6f25-4c24-8dd3-f6bce2dcf410",
"SID": "ed1f236e-8001-4dcb-97ac-57385b85d084",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "d7a9a056-6f25-4c24-8dd3-f6bce2dcf410",
"SID": "ed1f236e-8001-4dcb-97ac-57385b85d084",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "fc9043f5-e7b3-4607-b862-7a197493055e",
"SID": "3dad1119-1104-4fcd-bfec-206cac74ce29",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "fc9043f5-e7b3-4607-b862-7a197493055e",
"SID": "3dad1119-1104-4fcd-bfec-206cac74ce29",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "51968abc-93de-4f9c-ad95-6c3eab006c6f",
"SID": "812f08f3-d632-4fdc-b274-6f47d691f429",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "8e0af432-d422-4f63-92df-d88e3c773707",
"CID": "944eb42a-84d6-466a-8f24-a1c17228781c",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "8e0af432-d422-4f63-92df-d88e3c773707",
"CID": "944eb42a-84d6-466a-8f24-a1c17228781c",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "51968abc-93de-4f9c-ad95-6c3eab006c6f",
"SID": "812f08f3-d632-4fdc-b274-6f47d691f429",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "8e0af432-d422-4f63-92df-d88e3c773707",
"CID": "944eb42a-84d6-466a-8f24-a1c17228781c",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "8e0af432-d422-4f63-92df-d88e3c773707",
"CID": "944eb42a-84d6-466a-8f24-a1c17228781c",
"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-09-13T00:41:30.1748301-04:00</Completed>
<EstID>fca8fabc-029f-4868-b5bb-022d71eb5d36</EstID>
<ID>350528e9-df0d-4ce5-ade0-dad1d03b05ef</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>51968abc-93de-4f9c-ad95-6c3eab006c6f</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>812f08f3-d632-4fdc-b274-6f47d691f429</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>944eb42a-84d6-466a-8f24-a1c17228781c</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>8e0af432-d422-4f63-92df-d88e3c773707</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>944eb42a-84d6-466a-8f24-a1c17228781c</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>8e0af432-d422-4f63-92df-d88e3c773707</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>51968abc-93de-4f9c-ad95-6c3eab006c6f</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>812f08f3-d632-4fdc-b274-6f47d691f429</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>944eb42a-84d6-466a-8f24-a1c17228781c</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>8e0af432-d422-4f63-92df-d88e3c773707</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>944eb42a-84d6-466a-8f24-a1c17228781c</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>8e0af432-d422-4f63-92df-d88e3c773707</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>39472395-86ea-4a93-b420-1a51206624d6</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>02310e2c-b315-42b3-8953-efe4af965687</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>63e53558-6203-4d3c-bdc7-2298d682cefa</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>39472395-86ea-4a93-b420-1a51206624d6</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>02310e2c-b315-42b3-8953-efe4af965687</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>63e53558-6203-4d3c-bdc7-2298d682cefa</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>d7a9a056-6f25-4c24-8dd3-f6bce2dcf410</ID>
<NotToShip>true</NotToShip>
<SID>ed1f236e-8001-4dcb-97ac-57385b85d084</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>d7a9a056-6f25-4c24-8dd3-f6bce2dcf410</ID>
<NotToShip>true</NotToShip>
<SID>ed1f236e-8001-4dcb-97ac-57385b85d084</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>fc9043f5-e7b3-4607-b862-7a197493055e</ID>
<Name>sample string 3</Name>
<SID>3dad1119-1104-4fcd-bfec-206cac74ce29</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>fc9043f5-e7b3-4607-b862-7a197493055e</ID>
<Name>sample string 3</Name>
<SID>3dad1119-1104-4fcd-bfec-206cac74ce29</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2026-09-13T00:41:30.1748301-04:00</SurveyDate>
<UID>sample string 3</UID>
<Weight>1</Weight>
<idno>1</idno>
<idsub>1</idsub>
</ShipmentSurvey>