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": "d1798c47-e8a5-47e4-836c-a4cf71b9dcd7",
"EstID": "2eec802c-3a9c-455c-a3f3-0d82688862dd",
"idno": 1,
"idsub": 1,
"SurveyDate": "2026-06-14T11:58:08.5032821-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2026-06-14T11:58:08.5032821-04:00",
"ShipmentSurveyContainers": [
{
"ID": "eed3992a-c8cb-447e-b7bf-ec6de2467a65",
"SID": "992d4c62-2388-4fe0-bf9d-9928e18cfdf1",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "9b0d8fc7-245d-47d4-a01e-1fa3d791d704"
},
{
"ID": "eed3992a-c8cb-447e-b7bf-ec6de2467a65",
"SID": "992d4c62-2388-4fe0-bf9d-9928e18cfdf1",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "9b0d8fc7-245d-47d4-a01e-1fa3d791d704"
}
],
"ShipmentSurveyOthers": [
{
"ID": "168f5d4d-5e98-4770-a4a9-42475633c544",
"SID": "b6e8255d-7c52-4763-9818-80ebb64b5596",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "168f5d4d-5e98-4770-a4a9-42475633c544",
"SID": "b6e8255d-7c52-4763-9818-80ebb64b5596",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "30000174-a631-40b4-8e6e-20774b5292e8",
"SID": "ed7d41ef-0849-4dc5-a5ad-c4173eae696c",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "30000174-a631-40b4-8e6e-20774b5292e8",
"SID": "ed7d41ef-0849-4dc5-a5ad-c4173eae696c",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "4691c75c-3695-4622-a9e3-2515b96242a8",
"SID": "d2add747-55e1-463d-9493-ab93f4ee227c",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "c3103ff4-e96b-45d3-bf90-24f78261a7f5",
"CID": "3e493da2-1bce-4936-ae73-1e6a78b9a994",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "c3103ff4-e96b-45d3-bf90-24f78261a7f5",
"CID": "3e493da2-1bce-4936-ae73-1e6a78b9a994",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "4691c75c-3695-4622-a9e3-2515b96242a8",
"SID": "d2add747-55e1-463d-9493-ab93f4ee227c",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "c3103ff4-e96b-45d3-bf90-24f78261a7f5",
"CID": "3e493da2-1bce-4936-ae73-1e6a78b9a994",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "c3103ff4-e96b-45d3-bf90-24f78261a7f5",
"CID": "3e493da2-1bce-4936-ae73-1e6a78b9a994",
"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:58:08.5032821-04:00</Completed>
<EstID>2eec802c-3a9c-455c-a3f3-0d82688862dd</EstID>
<ID>d1798c47-e8a5-47e4-836c-a4cf71b9dcd7</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>4691c75c-3695-4622-a9e3-2515b96242a8</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>d2add747-55e1-463d-9493-ab93f4ee227c</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>3e493da2-1bce-4936-ae73-1e6a78b9a994</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>c3103ff4-e96b-45d3-bf90-24f78261a7f5</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>3e493da2-1bce-4936-ae73-1e6a78b9a994</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>c3103ff4-e96b-45d3-bf90-24f78261a7f5</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>4691c75c-3695-4622-a9e3-2515b96242a8</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>d2add747-55e1-463d-9493-ab93f4ee227c</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>3e493da2-1bce-4936-ae73-1e6a78b9a994</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>c3103ff4-e96b-45d3-bf90-24f78261a7f5</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>3e493da2-1bce-4936-ae73-1e6a78b9a994</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>c3103ff4-e96b-45d3-bf90-24f78261a7f5</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>9b0d8fc7-245d-47d4-a01e-1fa3d791d704</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>eed3992a-c8cb-447e-b7bf-ec6de2467a65</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>992d4c62-2388-4fe0-bf9d-9928e18cfdf1</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>9b0d8fc7-245d-47d4-a01e-1fa3d791d704</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>eed3992a-c8cb-447e-b7bf-ec6de2467a65</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>992d4c62-2388-4fe0-bf9d-9928e18cfdf1</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>168f5d4d-5e98-4770-a4a9-42475633c544</ID>
<NotToShip>true</NotToShip>
<SID>b6e8255d-7c52-4763-9818-80ebb64b5596</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>168f5d4d-5e98-4770-a4a9-42475633c544</ID>
<NotToShip>true</NotToShip>
<SID>b6e8255d-7c52-4763-9818-80ebb64b5596</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>30000174-a631-40b4-8e6e-20774b5292e8</ID>
<Name>sample string 3</Name>
<SID>ed7d41ef-0849-4dc5-a5ad-c4173eae696c</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>30000174-a631-40b4-8e6e-20774b5292e8</ID>
<Name>sample string 3</Name>
<SID>ed7d41ef-0849-4dc5-a5ad-c4173eae696c</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2026-06-14T11:58:08.5032821-04:00</SurveyDate>
<UID>sample string 3</UID>
<Weight>1</Weight>
<idno>1</idno>
<idsub>1</idsub>
</ShipmentSurvey>