GET api/shipmentsurvey/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters
None.
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": "b659e1e2-7836-4ab1-9faf-0bf1eb6f33d0",
"EstID": "15f85552-b4ab-4173-a9df-ed6f6b6982ae",
"idno": 1,
"idsub": 1,
"SurveyDate": "2026-09-13T00:42:45.1763525-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2026-09-13T00:42:45.1763525-04:00",
"ShipmentSurveyContainers": [
{
"ID": "224ff9f6-b49a-41e8-992c-af5e8dc50f77",
"SID": "36d23127-9212-4e64-8397-c607d1f2211a",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "24e1f856-27f6-4ec7-a88f-36563e1f090d"
},
{
"ID": "224ff9f6-b49a-41e8-992c-af5e8dc50f77",
"SID": "36d23127-9212-4e64-8397-c607d1f2211a",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "24e1f856-27f6-4ec7-a88f-36563e1f090d"
}
],
"ShipmentSurveyOthers": [
{
"ID": "1f8a0e60-c5ae-4b56-8517-877f9dafd5f2",
"SID": "215fed8b-7fee-44c4-924f-b3613a44ce51",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "1f8a0e60-c5ae-4b56-8517-877f9dafd5f2",
"SID": "215fed8b-7fee-44c4-924f-b3613a44ce51",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "b847a9ac-f7ac-43ed-82ff-7f5b17cd1325",
"SID": "963aa0cd-6409-46d1-b7b8-3298eef11f65",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "b847a9ac-f7ac-43ed-82ff-7f5b17cd1325",
"SID": "963aa0cd-6409-46d1-b7b8-3298eef11f65",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "b8c2abd9-429f-4e0c-be76-08c51432069c",
"SID": "cf8bf229-a94f-4d8a-b947-7922d992b06f",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "5cb40b9d-0700-4cab-af81-82dba2488291",
"CID": "0b61a4b6-d0c4-426f-ade7-c3a0b7b4164b",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "5cb40b9d-0700-4cab-af81-82dba2488291",
"CID": "0b61a4b6-d0c4-426f-ade7-c3a0b7b4164b",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "b8c2abd9-429f-4e0c-be76-08c51432069c",
"SID": "cf8bf229-a94f-4d8a-b947-7922d992b06f",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "5cb40b9d-0700-4cab-af81-82dba2488291",
"CID": "0b61a4b6-d0c4-426f-ade7-c3a0b7b4164b",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "5cb40b9d-0700-4cab-af81-82dba2488291",
"CID": "0b61a4b6-d0c4-426f-ade7-c3a0b7b4164b",
"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:42:45.1763525-04:00</Completed>
<EstID>15f85552-b4ab-4173-a9df-ed6f6b6982ae</EstID>
<ID>b659e1e2-7836-4ab1-9faf-0bf1eb6f33d0</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>b8c2abd9-429f-4e0c-be76-08c51432069c</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>cf8bf229-a94f-4d8a-b947-7922d992b06f</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>0b61a4b6-d0c4-426f-ade7-c3a0b7b4164b</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>5cb40b9d-0700-4cab-af81-82dba2488291</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>0b61a4b6-d0c4-426f-ade7-c3a0b7b4164b</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>5cb40b9d-0700-4cab-af81-82dba2488291</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>b8c2abd9-429f-4e0c-be76-08c51432069c</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>cf8bf229-a94f-4d8a-b947-7922d992b06f</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>0b61a4b6-d0c4-426f-ade7-c3a0b7b4164b</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>5cb40b9d-0700-4cab-af81-82dba2488291</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>0b61a4b6-d0c4-426f-ade7-c3a0b7b4164b</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>5cb40b9d-0700-4cab-af81-82dba2488291</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>24e1f856-27f6-4ec7-a88f-36563e1f090d</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>224ff9f6-b49a-41e8-992c-af5e8dc50f77</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>36d23127-9212-4e64-8397-c607d1f2211a</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>24e1f856-27f6-4ec7-a88f-36563e1f090d</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>224ff9f6-b49a-41e8-992c-af5e8dc50f77</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>36d23127-9212-4e64-8397-c607d1f2211a</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>1f8a0e60-c5ae-4b56-8517-877f9dafd5f2</ID>
<NotToShip>true</NotToShip>
<SID>215fed8b-7fee-44c4-924f-b3613a44ce51</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>1f8a0e60-c5ae-4b56-8517-877f9dafd5f2</ID>
<NotToShip>true</NotToShip>
<SID>215fed8b-7fee-44c4-924f-b3613a44ce51</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>b847a9ac-f7ac-43ed-82ff-7f5b17cd1325</ID>
<Name>sample string 3</Name>
<SID>963aa0cd-6409-46d1-b7b8-3298eef11f65</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>b847a9ac-f7ac-43ed-82ff-7f5b17cd1325</ID>
<Name>sample string 3</Name>
<SID>963aa0cd-6409-46d1-b7b8-3298eef11f65</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2026-09-13T00:42:45.1763525-04:00</SurveyDate>
<UID>sample string 3</UID>
<Weight>1</Weight>
<idno>1</idno>
<idsub>1</idsub>
</ShipmentSurvey>