GET api/shipmentsurvey/{idno}/{idsub}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| idno | integer |
Required |
|
| idsub | integer |
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": "ead9808a-d249-4681-baa6-8208d8554f6f",
"EstID": "68d65576-5001-4891-b995-8848ee297df9",
"idno": 1,
"idsub": 1,
"SurveyDate": "2026-03-15T17:36:45.1447065-04:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2026-03-15T17:36:45.1447065-04:00",
"ShipmentSurveyContainers": [
{
"ID": "11610841-5e4e-4c60-abe5-306b7c1e9b90",
"SID": "ca16e5a4-7a3a-4cd7-b0c4-661f8305d32c",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "0def0156-6f76-4a6a-bf57-9595ccf8be72"
},
{
"ID": "11610841-5e4e-4c60-abe5-306b7c1e9b90",
"SID": "ca16e5a4-7a3a-4cd7-b0c4-661f8305d32c",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "0def0156-6f76-4a6a-bf57-9595ccf8be72"
}
],
"ShipmentSurveyOthers": [
{
"ID": "e3652857-e509-4e5a-8bb7-f044a9007631",
"SID": "15f29f4f-0a02-4dcb-b05c-04ffa5e11b8a",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "e3652857-e509-4e5a-8bb7-f044a9007631",
"SID": "15f29f4f-0a02-4dcb-b05c-04ffa5e11b8a",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "9ec11fc0-c468-4b89-b6d7-4a8ad9b5c2e3",
"SID": "e7b3de3d-2fcc-4b30-a907-bd6dacadcd5c",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "9ec11fc0-c468-4b89-b6d7-4a8ad9b5c2e3",
"SID": "e7b3de3d-2fcc-4b30-a907-bd6dacadcd5c",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "04b8fcf5-52c7-42a0-8a6b-9bea2b0218ca",
"SID": "d248d878-4337-4594-8b3f-b54318fa4c07",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "8effafe3-77f1-4fe6-ad08-474e7721eb8b",
"CID": "c2232c96-4e1e-4eaf-96f3-8dd749440590",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "8effafe3-77f1-4fe6-ad08-474e7721eb8b",
"CID": "c2232c96-4e1e-4eaf-96f3-8dd749440590",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "04b8fcf5-52c7-42a0-8a6b-9bea2b0218ca",
"SID": "d248d878-4337-4594-8b3f-b54318fa4c07",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "8effafe3-77f1-4fe6-ad08-474e7721eb8b",
"CID": "c2232c96-4e1e-4eaf-96f3-8dd749440590",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "8effafe3-77f1-4fe6-ad08-474e7721eb8b",
"CID": "c2232c96-4e1e-4eaf-96f3-8dd749440590",
"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-03-15T17:36:45.1447065-04:00</Completed>
<EstID>68d65576-5001-4891-b995-8848ee297df9</EstID>
<ID>ead9808a-d249-4681-baa6-8208d8554f6f</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>04b8fcf5-52c7-42a0-8a6b-9bea2b0218ca</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>d248d878-4337-4594-8b3f-b54318fa4c07</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>c2232c96-4e1e-4eaf-96f3-8dd749440590</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>8effafe3-77f1-4fe6-ad08-474e7721eb8b</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>c2232c96-4e1e-4eaf-96f3-8dd749440590</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>8effafe3-77f1-4fe6-ad08-474e7721eb8b</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>04b8fcf5-52c7-42a0-8a6b-9bea2b0218ca</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>d248d878-4337-4594-8b3f-b54318fa4c07</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>c2232c96-4e1e-4eaf-96f3-8dd749440590</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>8effafe3-77f1-4fe6-ad08-474e7721eb8b</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>c2232c96-4e1e-4eaf-96f3-8dd749440590</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>8effafe3-77f1-4fe6-ad08-474e7721eb8b</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>0def0156-6f76-4a6a-bf57-9595ccf8be72</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>11610841-5e4e-4c60-abe5-306b7c1e9b90</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>ca16e5a4-7a3a-4cd7-b0c4-661f8305d32c</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>0def0156-6f76-4a6a-bf57-9595ccf8be72</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>11610841-5e4e-4c60-abe5-306b7c1e9b90</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>ca16e5a4-7a3a-4cd7-b0c4-661f8305d32c</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>e3652857-e509-4e5a-8bb7-f044a9007631</ID>
<NotToShip>true</NotToShip>
<SID>15f29f4f-0a02-4dcb-b05c-04ffa5e11b8a</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>e3652857-e509-4e5a-8bb7-f044a9007631</ID>
<NotToShip>true</NotToShip>
<SID>15f29f4f-0a02-4dcb-b05c-04ffa5e11b8a</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>9ec11fc0-c468-4b89-b6d7-4a8ad9b5c2e3</ID>
<Name>sample string 3</Name>
<SID>e7b3de3d-2fcc-4b30-a907-bd6dacadcd5c</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>9ec11fc0-c468-4b89-b6d7-4a8ad9b5c2e3</ID>
<Name>sample string 3</Name>
<SID>e7b3de3d-2fcc-4b30-a907-bd6dacadcd5c</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2026-03-15T17:36:45.1447065-04:00</SurveyDate>
<UID>sample string 3</UID>
<Weight>1</Weight>
<idno>1</idno>
<idsub>1</idsub>
</ShipmentSurvey>