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": "f61aa72f-7d1c-4b97-9642-713484d88842",
"EstID": "52341941-847d-4696-a0a7-60c22ed31831",
"idno": 1,
"idsub": 1,
"SurveyDate": "2025-12-15T18:26:33.5168518-05:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2025-12-15T18:26:33.5168518-05:00",
"ShipmentSurveyContainers": [
{
"ID": "fb828a52-0f95-43f8-963e-db993e780186",
"SID": "f2a3fe4c-dc2b-4cf3-8668-b02d7550892a",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "3c2a82fe-e16d-4e87-80cd-9c7586a21b99"
},
{
"ID": "fb828a52-0f95-43f8-963e-db993e780186",
"SID": "f2a3fe4c-dc2b-4cf3-8668-b02d7550892a",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "3c2a82fe-e16d-4e87-80cd-9c7586a21b99"
}
],
"ShipmentSurveyOthers": [
{
"ID": "8fe2fa1f-a716-497b-9103-e28a4e2dcfac",
"SID": "2b88304a-93bd-43f4-9c5a-eaf4ab03def6",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "8fe2fa1f-a716-497b-9103-e28a4e2dcfac",
"SID": "2b88304a-93bd-43f4-9c5a-eaf4ab03def6",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "e12cff5b-8103-4510-a190-b10efd5ac833",
"SID": "88e0f281-e247-4358-acbf-b14e74e3d3e4",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "e12cff5b-8103-4510-a190-b10efd5ac833",
"SID": "88e0f281-e247-4358-acbf-b14e74e3d3e4",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "ed60114d-4c03-409e-b698-690d02a0ae7c",
"SID": "98b22aec-f9e3-4110-9be1-ff51b60dc08c",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "d6a4a730-6a7c-415e-b7c8-3ce958d71e24",
"CID": "f251cf69-6654-4f57-a8f6-0521769cac08",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "d6a4a730-6a7c-415e-b7c8-3ce958d71e24",
"CID": "f251cf69-6654-4f57-a8f6-0521769cac08",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "ed60114d-4c03-409e-b698-690d02a0ae7c",
"SID": "98b22aec-f9e3-4110-9be1-ff51b60dc08c",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "d6a4a730-6a7c-415e-b7c8-3ce958d71e24",
"CID": "f251cf69-6654-4f57-a8f6-0521769cac08",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "d6a4a730-6a7c-415e-b7c8-3ce958d71e24",
"CID": "f251cf69-6654-4f57-a8f6-0521769cac08",
"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>2025-12-15T18:26:33.5168518-05:00</Completed>
<EstID>52341941-847d-4696-a0a7-60c22ed31831</EstID>
<ID>f61aa72f-7d1c-4b97-9642-713484d88842</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>ed60114d-4c03-409e-b698-690d02a0ae7c</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>98b22aec-f9e3-4110-9be1-ff51b60dc08c</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>f251cf69-6654-4f57-a8f6-0521769cac08</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>d6a4a730-6a7c-415e-b7c8-3ce958d71e24</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>f251cf69-6654-4f57-a8f6-0521769cac08</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>d6a4a730-6a7c-415e-b7c8-3ce958d71e24</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>ed60114d-4c03-409e-b698-690d02a0ae7c</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>98b22aec-f9e3-4110-9be1-ff51b60dc08c</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>f251cf69-6654-4f57-a8f6-0521769cac08</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>d6a4a730-6a7c-415e-b7c8-3ce958d71e24</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>f251cf69-6654-4f57-a8f6-0521769cac08</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>d6a4a730-6a7c-415e-b7c8-3ce958d71e24</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>3c2a82fe-e16d-4e87-80cd-9c7586a21b99</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>fb828a52-0f95-43f8-963e-db993e780186</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>f2a3fe4c-dc2b-4cf3-8668-b02d7550892a</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>3c2a82fe-e16d-4e87-80cd-9c7586a21b99</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>fb828a52-0f95-43f8-963e-db993e780186</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>f2a3fe4c-dc2b-4cf3-8668-b02d7550892a</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>8fe2fa1f-a716-497b-9103-e28a4e2dcfac</ID>
<NotToShip>true</NotToShip>
<SID>2b88304a-93bd-43f4-9c5a-eaf4ab03def6</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>8fe2fa1f-a716-497b-9103-e28a4e2dcfac</ID>
<NotToShip>true</NotToShip>
<SID>2b88304a-93bd-43f4-9c5a-eaf4ab03def6</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>e12cff5b-8103-4510-a190-b10efd5ac833</ID>
<Name>sample string 3</Name>
<SID>88e0f281-e247-4358-acbf-b14e74e3d3e4</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>e12cff5b-8103-4510-a190-b10efd5ac833</ID>
<Name>sample string 3</Name>
<SID>88e0f281-e247-4358-acbf-b14e74e3d3e4</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2025-12-15T18:26:33.5168518-05: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": "aaeb173f-6805-48b7-8d42-f2e92dd48f65",
"EstID": "e73687db-df32-43b1-a73d-4ca1ec3a43f0",
"idno": 1,
"idsub": 1,
"SurveyDate": "2025-12-15T18:26:33.5168518-05:00",
"Note": "sample string 2",
"Weight": 1,
"Area": 1,
"UID": "sample string 3",
"Completed": "2025-12-15T18:26:33.5168518-05:00",
"ShipmentSurveyContainers": [
{
"ID": "12c88c5b-39d2-422a-95a7-3d249afca290",
"SID": "f39560f6-d44d-4f79-9a54-450fda529ada",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "8299d5c9-9fc6-46d0-bb37-b7381fbff7a5"
},
{
"ID": "12c88c5b-39d2-422a-95a7-3d249afca290",
"SID": "f39560f6-d44d-4f79-9a54-450fda529ada",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"SortVal": 1,
"CID": "8299d5c9-9fc6-46d0-bb37-b7381fbff7a5"
}
],
"ShipmentSurveyOthers": [
{
"ID": "bbb27df1-2921-4d5d-a0cb-be9b95397037",
"SID": "523cac26-97b2-4597-97c1-8545f97a004d",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
},
{
"ID": "bbb27df1-2921-4d5d-a0cb-be9b95397037",
"SID": "523cac26-97b2-4597-97c1-8545f97a004d",
"Description": "sample string 3",
"Weight": 1,
"NotToShip": true
}
],
"ShipmentSurveyQuestions": [
{
"ID": "d60fd6ba-c589-491f-85b1-c5390c346b8f",
"SID": "dc6b6c85-0cb8-4728-962b-2ec702e35d46",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
},
{
"ID": "d60fd6ba-c589-491f-85b1-c5390c346b8f",
"SID": "dc6b6c85-0cb8-4728-962b-2ec702e35d46",
"Name": "sample string 3",
"Checked": true,
"SortVal": 1,
"ShipmentField": "sample string 5",
"AddToCategory": "sample string 6"
}
],
"ShipmentSurveyCategories": [
{
"ID": "b7b75629-7d54-443b-baba-e9f3728eb5f6",
"SID": "5667bf24-7288-47d9-9a78-a2214fa0f1df",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "59262036-c768-401e-9528-2f65a7fc638a",
"CID": "e9016cff-3ad0-488f-aadc-0828e8fcc0b7",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "59262036-c768-401e-9528-2f65a7fc638a",
"CID": "e9016cff-3ad0-488f-aadc-0828e8fcc0b7",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
}
]
},
{
"ID": "b7b75629-7d54-443b-baba-e9f3728eb5f6",
"SID": "5667bf24-7288-47d9-9a78-a2214fa0f1df",
"Name": "sample string 3",
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"Weight": 1,
"ClassName": "sample string 5",
"ShipmentSurveyItems": [
{
"ID": "59262036-c768-401e-9528-2f65a7fc638a",
"CID": "e9016cff-3ad0-488f-aadc-0828e8fcc0b7",
"Name": "sample string 3",
"Qty": 1.1,
"Cubes": 1.1,
"Density": 1.1,
"Note": "sample string 4",
"NotToShip": true,
"Weight": 1
},
{
"ID": "59262036-c768-401e-9528-2f65a7fc638a",
"CID": "e9016cff-3ad0-488f-aadc-0828e8fcc0b7",
"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>2025-12-15T18:26:33.5168518-05:00</Completed>
<EstID>e73687db-df32-43b1-a73d-4ca1ec3a43f0</EstID>
<ID>aaeb173f-6805-48b7-8d42-f2e92dd48f65</ID>
<Note>sample string 2</Note>
<ShipmentSurveyCategories>
<ShipmentSurveyCategory>
<ClassName>sample string 5</ClassName>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>b7b75629-7d54-443b-baba-e9f3728eb5f6</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>5667bf24-7288-47d9-9a78-a2214fa0f1df</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>e9016cff-3ad0-488f-aadc-0828e8fcc0b7</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>59262036-c768-401e-9528-2f65a7fc638a</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>e9016cff-3ad0-488f-aadc-0828e8fcc0b7</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>59262036-c768-401e-9528-2f65a7fc638a</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>b7b75629-7d54-443b-baba-e9f3728eb5f6</ID>
<Name>sample string 3</Name>
<Note>sample string 4</Note>
<SID>5667bf24-7288-47d9-9a78-a2214fa0f1df</SID>
<ShipmentSurveyItems>
<ShipmentSurveyItem>
<CID>e9016cff-3ad0-488f-aadc-0828e8fcc0b7</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>59262036-c768-401e-9528-2f65a7fc638a</ID>
<Name>sample string 3</Name>
<NotToShip>true</NotToShip>
<Note>sample string 4</Note>
<Qty>1.1</Qty>
<Weight>1</Weight>
</ShipmentSurveyItem>
<ShipmentSurveyItem>
<CID>e9016cff-3ad0-488f-aadc-0828e8fcc0b7</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>59262036-c768-401e-9528-2f65a7fc638a</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>8299d5c9-9fc6-46d0-bb37-b7381fbff7a5</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>12c88c5b-39d2-422a-95a7-3d249afca290</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>f39560f6-d44d-4f79-9a54-450fda529ada</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
<ShipmentSurveyContainer>
<CID>8299d5c9-9fc6-46d0-bb37-b7381fbff7a5</CID>
<Cubes>1.1</Cubes>
<Density>1.1</Density>
<ID>12c88c5b-39d2-422a-95a7-3d249afca290</ID>
<Name>sample string 3</Name>
<Qty>1.1</Qty>
<SID>f39560f6-d44d-4f79-9a54-450fda529ada</SID>
<SortVal>1</SortVal>
</ShipmentSurveyContainer>
</ShipmentSurveyContainers>
<ShipmentSurveyOthers>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>bbb27df1-2921-4d5d-a0cb-be9b95397037</ID>
<NotToShip>true</NotToShip>
<SID>523cac26-97b2-4597-97c1-8545f97a004d</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
<ShipmentSurveyOther>
<Description>sample string 3</Description>
<ID>bbb27df1-2921-4d5d-a0cb-be9b95397037</ID>
<NotToShip>true</NotToShip>
<SID>523cac26-97b2-4597-97c1-8545f97a004d</SID>
<Weight>1</Weight>
</ShipmentSurveyOther>
</ShipmentSurveyOthers>
<ShipmentSurveyQuestions>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>d60fd6ba-c589-491f-85b1-c5390c346b8f</ID>
<Name>sample string 3</Name>
<SID>dc6b6c85-0cb8-4728-962b-2ec702e35d46</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
<ShipmentSurveyQuestion>
<AddToCategory>sample string 6</AddToCategory>
<Checked>true</Checked>
<ID>d60fd6ba-c589-491f-85b1-c5390c346b8f</ID>
<Name>sample string 3</Name>
<SID>dc6b6c85-0cb8-4728-962b-2ec702e35d46</SID>
<ShipmentField>sample string 5</ShipmentField>
<SortVal>1</SortVal>
</ShipmentSurveyQuestion>
</ShipmentSurveyQuestions>
<SurveyDate>2025-12-15T18:26:33.5168518-05:00</SurveyDate>
<UID>sample string 3</UID>
<Weight>1</Weight>
<idno>1</idno>
<idsub>1</idsub>
</ShipmentSurvey>