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": "c402a218-add9-4f60-a127-e0c162598e2a",
"EstID": "ae51526a-6261-45d9-9349-0bea3d3833d8",
"idno": 1,
"idsub": 1,
"SurveyDate": "2026-07-29T17:45:59.4180664-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2026-07-29T17:45:59.4180664-04:00",
"ShipmentSurveyContainers": [
{
"ID": "863febca-5e52-46e7-b686-e6df033c708f",
"SID": "9f551094-cc8c-4b80-bf9a-4dd40c3d43e1",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "51e2cdb9-8dcb-4837-b521-f6c4619528da"
},
{
"ID": "863febca-5e52-46e7-b686-e6df033c708f",
"SID": "9f551094-cc8c-4b80-bf9a-4dd40c3d43e1",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "51e2cdb9-8dcb-4837-b521-f6c4619528da"
}
],
"ShipmentSurveyOthers": [
{
"ID": "9fb0ee4f-d936-487d-9912-b90009b36122",
"SID": "c4abd731-12b2-495c-9cdb-ac4a7793cdd3",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "9fb0ee4f-d936-487d-9912-b90009b36122",
"SID": "c4abd731-12b2-495c-9cdb-ac4a7793cdd3",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "deefc0b1-3068-4b24-8db3-723c348c8fd4",
"SID": "74fc18cf-d932-45bd-86e9-d5355e401a45",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "deefc0b1-3068-4b24-8db3-723c348c8fd4",
"SID": "74fc18cf-d932-45bd-86e9-d5355e401a45",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "9aa8e1fa-2d84-48f1-9aab-d0e87ffe51db",
"SID": "70d24cb7-a1a2-410c-9e05-595f8d416926",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "9b8d3b98-e4da-44cd-becf-dfa990764e5b",
"CID": "d08aba20-38ce-4553-a609-ed6b2bb2e0ba",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "9b8d3b98-e4da-44cd-becf-dfa990764e5b",
"CID": "d08aba20-38ce-4553-a609-ed6b2bb2e0ba",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "9aa8e1fa-2d84-48f1-9aab-d0e87ffe51db",
"SID": "70d24cb7-a1a2-410c-9e05-595f8d416926",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "9b8d3b98-e4da-44cd-becf-dfa990764e5b",
"CID": "d08aba20-38ce-4553-a609-ed6b2bb2e0ba",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "9b8d3b98-e4da-44cd-becf-dfa990764e5b",
"CID": "d08aba20-38ce-4553-a609-ed6b2bb2e0ba",
"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-07-29T17:45:59.4180664-04:00</Completed>
<EstID>ae51526a-6261-45d9-9349-0bea3d3833d8</EstID>
<ID>c402a218-add9-4f60-a127-e0c162598e2a</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>9aa8e1fa-2d84-48f1-9aab-d0e87ffe51db</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>70d24cb7-a1a2-410c-9e05-595f8d416926</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>d08aba20-38ce-4553-a609-ed6b2bb2e0ba</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>9b8d3b98-e4da-44cd-becf-dfa990764e5b</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>d08aba20-38ce-4553-a609-ed6b2bb2e0ba</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>9b8d3b98-e4da-44cd-becf-dfa990764e5b</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>9aa8e1fa-2d84-48f1-9aab-d0e87ffe51db</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>70d24cb7-a1a2-410c-9e05-595f8d416926</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>d08aba20-38ce-4553-a609-ed6b2bb2e0ba</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>9b8d3b98-e4da-44cd-becf-dfa990764e5b</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>d08aba20-38ce-4553-a609-ed6b2bb2e0ba</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>9b8d3b98-e4da-44cd-becf-dfa990764e5b</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>51e2cdb9-8dcb-4837-b521-f6c4619528da</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>863febca-5e52-46e7-b686-e6df033c708f</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>9f551094-cc8c-4b80-bf9a-4dd40c3d43e1</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>51e2cdb9-8dcb-4837-b521-f6c4619528da</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>863febca-5e52-46e7-b686-e6df033c708f</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>9f551094-cc8c-4b80-bf9a-4dd40c3d43e1</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>9fb0ee4f-d936-487d-9912-b90009b36122</ID>
<NotToShip>true</NotToShip>
<SID>c4abd731-12b2-495c-9cdb-ac4a7793cdd3</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>9fb0ee4f-d936-487d-9912-b90009b36122</ID>
<NotToShip>true</NotToShip>
<SID>c4abd731-12b2-495c-9cdb-ac4a7793cdd3</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>deefc0b1-3068-4b24-8db3-723c348c8fd4</ID>
<Name>sample string 3</Name>
<SID>74fc18cf-d932-45bd-86e9-d5355e401a45</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>deefc0b1-3068-4b24-8db3-723c348c8fd4</ID>
<Name>sample string 3</Name>
<SID>74fc18cf-d932-45bd-86e9-d5355e401a45</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2026-07-29T17:45:59.4180664-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": "349dbc4e-4eab-4c21-9f95-97948c17b857",
"EstID": "01b573f7-77d2-4a6c-b6ae-23fe2b1ae9bb",
"idno": 1,
"idsub": 1,
"SurveyDate": "2026-07-29T17:45:59.4180664-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2026-07-29T17:45:59.4180664-04:00",
"ShipmentSurveyContainers": [
{
"ID": "cda05ce7-8f48-4f7c-9b90-477e97ee3196",
"SID": "c1a514e8-f14e-4309-9577-f51180dfc774",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "24b5e9e3-69af-4585-880b-f6958239f56e"
},
{
"ID": "cda05ce7-8f48-4f7c-9b90-477e97ee3196",
"SID": "c1a514e8-f14e-4309-9577-f51180dfc774",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "24b5e9e3-69af-4585-880b-f6958239f56e"
}
],
"ShipmentSurveyOthers": [
{
"ID": "c1721173-c5f3-46c0-9ba5-de820ddfb5b3",
"SID": "0fccd67c-0c06-443a-b802-883ea9351ccf",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "c1721173-c5f3-46c0-9ba5-de820ddfb5b3",
"SID": "0fccd67c-0c06-443a-b802-883ea9351ccf",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "685c9bb4-e773-4f0b-893d-9124c52e7e50",
"SID": "6cf54d9f-d0dc-45e5-adcd-54314d0968dd",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "685c9bb4-e773-4f0b-893d-9124c52e7e50",
"SID": "6cf54d9f-d0dc-45e5-adcd-54314d0968dd",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "eb084c1a-0fe3-4242-ba1c-d2ba03c450e8",
"SID": "3500cc6b-9070-4eea-ba21-58c1b78178ad",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "d193b8ce-503e-4f34-b1da-3e0e1dc6a425",
"CID": "56cd5f83-ef3f-4980-855d-156d8dfb9ac6",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "d193b8ce-503e-4f34-b1da-3e0e1dc6a425",
"CID": "56cd5f83-ef3f-4980-855d-156d8dfb9ac6",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "eb084c1a-0fe3-4242-ba1c-d2ba03c450e8",
"SID": "3500cc6b-9070-4eea-ba21-58c1b78178ad",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "d193b8ce-503e-4f34-b1da-3e0e1dc6a425",
"CID": "56cd5f83-ef3f-4980-855d-156d8dfb9ac6",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "d193b8ce-503e-4f34-b1da-3e0e1dc6a425",
"CID": "56cd5f83-ef3f-4980-855d-156d8dfb9ac6",
"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-07-29T17:45:59.4180664-04:00</Completed>
<EstID>01b573f7-77d2-4a6c-b6ae-23fe2b1ae9bb</EstID>
<ID>349dbc4e-4eab-4c21-9f95-97948c17b857</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>eb084c1a-0fe3-4242-ba1c-d2ba03c450e8</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>3500cc6b-9070-4eea-ba21-58c1b78178ad</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>56cd5f83-ef3f-4980-855d-156d8dfb9ac6</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>d193b8ce-503e-4f34-b1da-3e0e1dc6a425</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>56cd5f83-ef3f-4980-855d-156d8dfb9ac6</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>d193b8ce-503e-4f34-b1da-3e0e1dc6a425</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>eb084c1a-0fe3-4242-ba1c-d2ba03c450e8</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>3500cc6b-9070-4eea-ba21-58c1b78178ad</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>56cd5f83-ef3f-4980-855d-156d8dfb9ac6</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>d193b8ce-503e-4f34-b1da-3e0e1dc6a425</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>56cd5f83-ef3f-4980-855d-156d8dfb9ac6</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>d193b8ce-503e-4f34-b1da-3e0e1dc6a425</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>24b5e9e3-69af-4585-880b-f6958239f56e</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>cda05ce7-8f48-4f7c-9b90-477e97ee3196</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>c1a514e8-f14e-4309-9577-f51180dfc774</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>24b5e9e3-69af-4585-880b-f6958239f56e</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>cda05ce7-8f48-4f7c-9b90-477e97ee3196</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>c1a514e8-f14e-4309-9577-f51180dfc774</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>c1721173-c5f3-46c0-9ba5-de820ddfb5b3</ID>
<NotToShip>true</NotToShip>
<SID>0fccd67c-0c06-443a-b802-883ea9351ccf</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>c1721173-c5f3-46c0-9ba5-de820ddfb5b3</ID>
<NotToShip>true</NotToShip>
<SID>0fccd67c-0c06-443a-b802-883ea9351ccf</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>685c9bb4-e773-4f0b-893d-9124c52e7e50</ID>
<Name>sample string 3</Name>
<SID>6cf54d9f-d0dc-45e5-adcd-54314d0968dd</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>685c9bb4-e773-4f0b-893d-9124c52e7e50</ID>
<Name>sample string 3</Name>
<SID>6cf54d9f-d0dc-45e5-adcd-54314d0968dd</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2026-07-29T17:45:59.4180664-04:00</SurveyDate>
<UID>sample string 3</UID>
<Weight>1</Weight>
<idno>1</idno>
<idsub>1</idsub>
</ShipmentSurvey>