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": "5c5848a3-7eae-41d4-a2b6-8d546a6bcba3",
"EstID": "8c9cc951-5eec-42de-9b78-54b8e2c97d2c",
"idno": 1,
"idsub": 1,
"SurveyDate": "2026-06-14T11:55:16.6917661-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2026-06-14T11:55:16.6917661-04:00",
"ShipmentSurveyContainers": [
{
"ID": "6137656e-a798-42a4-87a3-7e0369182c05",
"SID": "76057b07-89e6-4c48-8299-c202e532f3eb",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "d582f3bc-11ce-45b6-8bed-82b2e53e20ba"
},
{
"ID": "6137656e-a798-42a4-87a3-7e0369182c05",
"SID": "76057b07-89e6-4c48-8299-c202e532f3eb",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "d582f3bc-11ce-45b6-8bed-82b2e53e20ba"
}
],
"ShipmentSurveyOthers": [
{
"ID": "10652437-9abd-4895-9db9-9f8a1bbce5fd",
"SID": "2045be79-fa97-4473-a7d8-05cf8342ca8a",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "10652437-9abd-4895-9db9-9f8a1bbce5fd",
"SID": "2045be79-fa97-4473-a7d8-05cf8342ca8a",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "9877af93-75bd-4e74-8f62-f078ce24433e",
"SID": "b1eda5e9-5200-4afc-b5f5-97d5f94bcf45",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "9877af93-75bd-4e74-8f62-f078ce24433e",
"SID": "b1eda5e9-5200-4afc-b5f5-97d5f94bcf45",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "26ba91e7-3fa3-486e-8273-2eb46d5b7e35",
"SID": "5fceee17-4f9c-4a0a-8445-77581471fb47",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "bdc6e3ea-995d-4827-bf9a-db709b97374b",
"CID": "1069e6c8-8630-4a69-aa3d-af4d926f657c",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "bdc6e3ea-995d-4827-bf9a-db709b97374b",
"CID": "1069e6c8-8630-4a69-aa3d-af4d926f657c",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "26ba91e7-3fa3-486e-8273-2eb46d5b7e35",
"SID": "5fceee17-4f9c-4a0a-8445-77581471fb47",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "bdc6e3ea-995d-4827-bf9a-db709b97374b",
"CID": "1069e6c8-8630-4a69-aa3d-af4d926f657c",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "bdc6e3ea-995d-4827-bf9a-db709b97374b",
"CID": "1069e6c8-8630-4a69-aa3d-af4d926f657c",
"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-06-14T11:55:16.6917661-04:00</Completed>
<EstID>8c9cc951-5eec-42de-9b78-54b8e2c97d2c</EstID>
<ID>5c5848a3-7eae-41d4-a2b6-8d546a6bcba3</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>26ba91e7-3fa3-486e-8273-2eb46d5b7e35</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>5fceee17-4f9c-4a0a-8445-77581471fb47</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>1069e6c8-8630-4a69-aa3d-af4d926f657c</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>bdc6e3ea-995d-4827-bf9a-db709b97374b</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>1069e6c8-8630-4a69-aa3d-af4d926f657c</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>bdc6e3ea-995d-4827-bf9a-db709b97374b</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>26ba91e7-3fa3-486e-8273-2eb46d5b7e35</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>5fceee17-4f9c-4a0a-8445-77581471fb47</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>1069e6c8-8630-4a69-aa3d-af4d926f657c</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>bdc6e3ea-995d-4827-bf9a-db709b97374b</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>1069e6c8-8630-4a69-aa3d-af4d926f657c</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>bdc6e3ea-995d-4827-bf9a-db709b97374b</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>d582f3bc-11ce-45b6-8bed-82b2e53e20ba</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>6137656e-a798-42a4-87a3-7e0369182c05</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>76057b07-89e6-4c48-8299-c202e532f3eb</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>d582f3bc-11ce-45b6-8bed-82b2e53e20ba</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>6137656e-a798-42a4-87a3-7e0369182c05</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>76057b07-89e6-4c48-8299-c202e532f3eb</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>10652437-9abd-4895-9db9-9f8a1bbce5fd</ID>
<NotToShip>true</NotToShip>
<SID>2045be79-fa97-4473-a7d8-05cf8342ca8a</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>10652437-9abd-4895-9db9-9f8a1bbce5fd</ID>
<NotToShip>true</NotToShip>
<SID>2045be79-fa97-4473-a7d8-05cf8342ca8a</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>9877af93-75bd-4e74-8f62-f078ce24433e</ID>
<Name>sample string 3</Name>
<SID>b1eda5e9-5200-4afc-b5f5-97d5f94bcf45</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>9877af93-75bd-4e74-8f62-f078ce24433e</ID>
<Name>sample string 3</Name>
<SID>b1eda5e9-5200-4afc-b5f5-97d5f94bcf45</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2026-06-14T11:55:16.6917661-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": "fa8d376f-c963-4c10-bf22-f012cbe97b0a",
"EstID": "d8427214-8108-4acc-9bd2-ca9b4efc3b5a",
"idno": 1,
"idsub": 1,
"SurveyDate": "2026-06-14T11:55:16.7230132-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2026-06-14T11:55:16.7230132-04:00",
"ShipmentSurveyContainers": [
{
"ID": "b4c76873-b8b9-46a4-8ac8-c3ce9ef0dc7e",
"SID": "2451ab3f-7f33-4bf5-92d4-1a5adbeb9441",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "9f8a1913-2c4f-4ddf-ab63-103296a15310"
},
{
"ID": "b4c76873-b8b9-46a4-8ac8-c3ce9ef0dc7e",
"SID": "2451ab3f-7f33-4bf5-92d4-1a5adbeb9441",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "9f8a1913-2c4f-4ddf-ab63-103296a15310"
}
],
"ShipmentSurveyOthers": [
{
"ID": "af62e5fb-bdff-4446-b782-079f842667cd",
"SID": "121802b8-bf4e-4563-b269-b72a3933736d",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "af62e5fb-bdff-4446-b782-079f842667cd",
"SID": "121802b8-bf4e-4563-b269-b72a3933736d",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "bc0d4700-6fb8-4eec-aa37-c474a091fd09",
"SID": "a6dd6f15-5398-43e5-a8ff-5ff4b995d248",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "bc0d4700-6fb8-4eec-aa37-c474a091fd09",
"SID": "a6dd6f15-5398-43e5-a8ff-5ff4b995d248",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "7ea7effc-ccbd-4d4a-807b-b335ebae5ef6",
"SID": "6db7dd32-41e9-45c4-9261-d3d82cb654b5",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "07372d6f-9ccd-4d89-bc0c-a477f70bafab",
"CID": "7176fec3-a6e6-4f94-92ae-7ea04748fcf8",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "07372d6f-9ccd-4d89-bc0c-a477f70bafab",
"CID": "7176fec3-a6e6-4f94-92ae-7ea04748fcf8",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "7ea7effc-ccbd-4d4a-807b-b335ebae5ef6",
"SID": "6db7dd32-41e9-45c4-9261-d3d82cb654b5",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "07372d6f-9ccd-4d89-bc0c-a477f70bafab",
"CID": "7176fec3-a6e6-4f94-92ae-7ea04748fcf8",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "07372d6f-9ccd-4d89-bc0c-a477f70bafab",
"CID": "7176fec3-a6e6-4f94-92ae-7ea04748fcf8",
"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-06-14T11:55:16.7230132-04:00</Completed>
<EstID>d8427214-8108-4acc-9bd2-ca9b4efc3b5a</EstID>
<ID>fa8d376f-c963-4c10-bf22-f012cbe97b0a</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>7ea7effc-ccbd-4d4a-807b-b335ebae5ef6</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>6db7dd32-41e9-45c4-9261-d3d82cb654b5</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>7176fec3-a6e6-4f94-92ae-7ea04748fcf8</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>07372d6f-9ccd-4d89-bc0c-a477f70bafab</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>7176fec3-a6e6-4f94-92ae-7ea04748fcf8</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>07372d6f-9ccd-4d89-bc0c-a477f70bafab</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>7ea7effc-ccbd-4d4a-807b-b335ebae5ef6</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>6db7dd32-41e9-45c4-9261-d3d82cb654b5</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>7176fec3-a6e6-4f94-92ae-7ea04748fcf8</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>07372d6f-9ccd-4d89-bc0c-a477f70bafab</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>7176fec3-a6e6-4f94-92ae-7ea04748fcf8</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>07372d6f-9ccd-4d89-bc0c-a477f70bafab</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>9f8a1913-2c4f-4ddf-ab63-103296a15310</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>b4c76873-b8b9-46a4-8ac8-c3ce9ef0dc7e</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>2451ab3f-7f33-4bf5-92d4-1a5adbeb9441</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>9f8a1913-2c4f-4ddf-ab63-103296a15310</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>b4c76873-b8b9-46a4-8ac8-c3ce9ef0dc7e</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>2451ab3f-7f33-4bf5-92d4-1a5adbeb9441</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>af62e5fb-bdff-4446-b782-079f842667cd</ID>
<NotToShip>true</NotToShip>
<SID>121802b8-bf4e-4563-b269-b72a3933736d</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>af62e5fb-bdff-4446-b782-079f842667cd</ID>
<NotToShip>true</NotToShip>
<SID>121802b8-bf4e-4563-b269-b72a3933736d</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>bc0d4700-6fb8-4eec-aa37-c474a091fd09</ID>
<Name>sample string 3</Name>
<SID>a6dd6f15-5398-43e5-a8ff-5ff4b995d248</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>bc0d4700-6fb8-4eec-aa37-c474a091fd09</ID>
<Name>sample string 3</Name>
<SID>a6dd6f15-5398-43e5-a8ff-5ff4b995d248</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2026-06-14T11:55:16.7230132-04:00</SurveyDate>
<UID>sample string 3</UID>
<Weight>1</Weight>
<idno>1</idno>
<idsub>1</idsub>
</ShipmentSurvey>