POST api/shipmentsurvey
Request Information
URI Parameters
None.
Body Parameters
ShipmentSurveyName | 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": "1e65ba55-d6a4-4869-ac89-38a9bb7ac871", "EstID": "f18b6c35-d9f3-4f27-a348-7764fe1b4211", "idno": 1, "idsub": 1, "SurveyDate": "2025-07-01T05:59:55.2378954-04:00", "Note": "sample string 2", "Weight": 1, "Area": 1, "UID": "sample string 3", "Completed": "2025-07-01T05:59:55.2378954-04:00", "ShipmentSurveyContainers": [ { "ID": "1d6a7145-b5d2-47cd-b590-bd5ac24acbb5", "SID": "873a2af8-255f-4ff2-9129-1cdbe4331eea", "Name": "sample string 3", "Qty": 1.1, "Cubes": 1.1, "Density": 1.1, "SortVal": 1, "CID": "8bf3c97f-f02d-415c-bb50-be5fe13ec315" }, { "ID": "1d6a7145-b5d2-47cd-b590-bd5ac24acbb5", "SID": "873a2af8-255f-4ff2-9129-1cdbe4331eea", "Name": "sample string 3", "Qty": 1.1, "Cubes": 1.1, "Density": 1.1, "SortVal": 1, "CID": "8bf3c97f-f02d-415c-bb50-be5fe13ec315" } ], "ShipmentSurveyOthers": [ { "ID": "02fb4781-3379-46f4-87ae-adeb15d1ed05", "SID": "3267e10c-11be-4d6f-8826-8271ba7231f2", "Description": "sample string 3", "Weight": 1, "NotToShip": true }, { "ID": "02fb4781-3379-46f4-87ae-adeb15d1ed05", "SID": "3267e10c-11be-4d6f-8826-8271ba7231f2", "Description": "sample string 3", "Weight": 1, "NotToShip": true } ], "ShipmentSurveyQuestions": [ { "ID": "6b9c1af6-3d0c-4ea1-bb8c-9444315d4c72", "SID": "2ab7075a-7db3-4443-b2c3-e977f1d6cc31", "Name": "sample string 3", "Checked": true, "SortVal": 1, "ShipmentField": "sample string 5", "AddToCategory": "sample string 6" }, { "ID": "6b9c1af6-3d0c-4ea1-bb8c-9444315d4c72", "SID": "2ab7075a-7db3-4443-b2c3-e977f1d6cc31", "Name": "sample string 3", "Checked": true, "SortVal": 1, "ShipmentField": "sample string 5", "AddToCategory": "sample string 6" } ], "ShipmentSurveyCategories": [ { "ID": "be0e4d93-c20f-423c-8a64-98fa1f1c8368", "SID": "4e7aec5d-e42d-4793-a8d6-55e788545520", "Name": "sample string 3", "Cubes": 1.1, "Density": 1.1, "Note": "sample string 4", "Weight": 1, "ClassName": "sample string 5", "ShipmentSurveyItems": [ { "ID": "ccc33908-5d52-4d2e-beee-1c2ba1ebfb2f", "CID": "5400676c-de03-4395-80c9-f798a07c1dd0", "Name": "sample string 3", "Qty": 1.1, "Cubes": 1.1, "Density": 1.1, "Note": "sample string 4", "NotToShip": true, "Weight": 1 }, { "ID": "ccc33908-5d52-4d2e-beee-1c2ba1ebfb2f", "CID": "5400676c-de03-4395-80c9-f798a07c1dd0", "Name": "sample string 3", "Qty": 1.1, "Cubes": 1.1, "Density": 1.1, "Note": "sample string 4", "NotToShip": true, "Weight": 1 } ] }, { "ID": "be0e4d93-c20f-423c-8a64-98fa1f1c8368", "SID": "4e7aec5d-e42d-4793-a8d6-55e788545520", "Name": "sample string 3", "Cubes": 1.1, "Density": 1.1, "Note": "sample string 4", "Weight": 1, "ClassName": "sample string 5", "ShipmentSurveyItems": [ { "ID": "ccc33908-5d52-4d2e-beee-1c2ba1ebfb2f", "CID": "5400676c-de03-4395-80c9-f798a07c1dd0", "Name": "sample string 3", "Qty": 1.1, "Cubes": 1.1, "Density": 1.1, "Note": "sample string 4", "NotToShip": true, "Weight": 1 }, { "ID": "ccc33908-5d52-4d2e-beee-1c2ba1ebfb2f", "CID": "5400676c-de03-4395-80c9-f798a07c1dd0", "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-07-01T05:59:55.2378954-04:00</Completed> <EstID>f18b6c35-d9f3-4f27-a348-7764fe1b4211</EstID> <ID>1e65ba55-d6a4-4869-ac89-38a9bb7ac871</ID> <Note>sample string 2</Note> <ShipmentSurveyCategories> <ShipmentSurveyCategory> <ClassName>sample string 5</ClassName> <Cubes>1.1</Cubes> <Density>1.1</Density> <ID>be0e4d93-c20f-423c-8a64-98fa1f1c8368</ID> <Name>sample string 3</Name> <Note>sample string 4</Note> <SID>4e7aec5d-e42d-4793-a8d6-55e788545520</SID> <ShipmentSurveyItems> <ShipmentSurveyItem> <CID>5400676c-de03-4395-80c9-f798a07c1dd0</CID> <Cubes>1.1</Cubes> <Density>1.1</Density> <ID>ccc33908-5d52-4d2e-beee-1c2ba1ebfb2f</ID> <Name>sample string 3</Name> <NotToShip>true</NotToShip> <Note>sample string 4</Note> <Qty>1.1</Qty> <Weight>1</Weight> </ShipmentSurveyItem> <ShipmentSurveyItem> <CID>5400676c-de03-4395-80c9-f798a07c1dd0</CID> <Cubes>1.1</Cubes> <Density>1.1</Density> <ID>ccc33908-5d52-4d2e-beee-1c2ba1ebfb2f</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>be0e4d93-c20f-423c-8a64-98fa1f1c8368</ID> <Name>sample string 3</Name> <Note>sample string 4</Note> <SID>4e7aec5d-e42d-4793-a8d6-55e788545520</SID> <ShipmentSurveyItems> <ShipmentSurveyItem> <CID>5400676c-de03-4395-80c9-f798a07c1dd0</CID> <Cubes>1.1</Cubes> <Density>1.1</Density> <ID>ccc33908-5d52-4d2e-beee-1c2ba1ebfb2f</ID> <Name>sample string 3</Name> <NotToShip>true</NotToShip> <Note>sample string 4</Note> <Qty>1.1</Qty> <Weight>1</Weight> </ShipmentSurveyItem> <ShipmentSurveyItem> <CID>5400676c-de03-4395-80c9-f798a07c1dd0</CID> <Cubes>1.1</Cubes> <Density>1.1</Density> <ID>ccc33908-5d52-4d2e-beee-1c2ba1ebfb2f</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>8bf3c97f-f02d-415c-bb50-be5fe13ec315</CID> <Cubes>1.1</Cubes> <Density>1.1</Density> <ID>1d6a7145-b5d2-47cd-b590-bd5ac24acbb5</ID> <Name>sample string 3</Name> <Qty>1.1</Qty> <SID>873a2af8-255f-4ff2-9129-1cdbe4331eea</SID> <SortVal>1</SortVal> </ShipmentSurveyContainer> <ShipmentSurveyContainer> <CID>8bf3c97f-f02d-415c-bb50-be5fe13ec315</CID> <Cubes>1.1</Cubes> <Density>1.1</Density> <ID>1d6a7145-b5d2-47cd-b590-bd5ac24acbb5</ID> <Name>sample string 3</Name> <Qty>1.1</Qty> <SID>873a2af8-255f-4ff2-9129-1cdbe4331eea</SID> <SortVal>1</SortVal> </ShipmentSurveyContainer> </ShipmentSurveyContainers> <ShipmentSurveyOthers> <ShipmentSurveyOther> <Description>sample string 3</Description> <ID>02fb4781-3379-46f4-87ae-adeb15d1ed05</ID> <NotToShip>true</NotToShip> <SID>3267e10c-11be-4d6f-8826-8271ba7231f2</SID> <Weight>1</Weight> </ShipmentSurveyOther> <ShipmentSurveyOther> <Description>sample string 3</Description> <ID>02fb4781-3379-46f4-87ae-adeb15d1ed05</ID> <NotToShip>true</NotToShip> <SID>3267e10c-11be-4d6f-8826-8271ba7231f2</SID> <Weight>1</Weight> </ShipmentSurveyOther> </ShipmentSurveyOthers> <ShipmentSurveyQuestions> <ShipmentSurveyQuestion> <AddToCategory>sample string 6</AddToCategory> <Checked>true</Checked> <ID>6b9c1af6-3d0c-4ea1-bb8c-9444315d4c72</ID> <Name>sample string 3</Name> <SID>2ab7075a-7db3-4443-b2c3-e977f1d6cc31</SID> <ShipmentField>sample string 5</ShipmentField> <SortVal>1</SortVal> </ShipmentSurveyQuestion> <ShipmentSurveyQuestion> <AddToCategory>sample string 6</AddToCategory> <Checked>true</Checked> <ID>6b9c1af6-3d0c-4ea1-bb8c-9444315d4c72</ID> <Name>sample string 3</Name> <SID>2ab7075a-7db3-4443-b2c3-e977f1d6cc31</SID> <ShipmentField>sample string 5</ShipmentField> <SortVal>1</SortVal> </ShipmentSurveyQuestion> </ShipmentSurveyQuestions> <SurveyDate>2025-07-01T05:59:55.2378954-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
ShipmentSurveyName | 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": "740a955b-b414-4384-8df6-7bd859173377", "EstID": "0af54eb1-50fa-49a0-bbe7-28254f948c46", "idno": 1, "idsub": 1, "SurveyDate": "2025-07-01T05:59:55.2378954-04:00", "Note": "sample string 2", "Weight": 1, "Area": 1, "UID": "sample string 3", "Completed": "2025-07-01T05:59:55.2378954-04:00", "ShipmentSurveyContainers": [ { "ID": "3872c51d-b01b-4545-92d5-5ed0318d0f2c", "SID": "c79427f9-fef8-4a04-8a52-bfc193798f19", "Name": "sample string 3", "Qty": 1.1, "Cubes": 1.1, "Density": 1.1, "SortVal": 1, "CID": "31f46931-0ce5-4c58-93e5-ec5090f63a4f" }, { "ID": "3872c51d-b01b-4545-92d5-5ed0318d0f2c", "SID": "c79427f9-fef8-4a04-8a52-bfc193798f19", "Name": "sample string 3", "Qty": 1.1, "Cubes": 1.1, "Density": 1.1, "SortVal": 1, "CID": "31f46931-0ce5-4c58-93e5-ec5090f63a4f" } ], "ShipmentSurveyOthers": [ { "ID": "6a1a0e51-3e83-441e-83ef-5f6a7849c7aa", "SID": "d569cd90-0548-48b4-9e14-d5b14f47280b", "Description": "sample string 3", "Weight": 1, "NotToShip": true }, { "ID": "6a1a0e51-3e83-441e-83ef-5f6a7849c7aa", "SID": "d569cd90-0548-48b4-9e14-d5b14f47280b", "Description": "sample string 3", "Weight": 1, "NotToShip": true } ], "ShipmentSurveyQuestions": [ { "ID": "24fa529d-120e-4441-b1ca-510125e693e6", "SID": "bfdd4bca-de9e-4843-8eb4-8b60d45bece4", "Name": "sample string 3", "Checked": true, "SortVal": 1, "ShipmentField": "sample string 5", "AddToCategory": "sample string 6" }, { "ID": "24fa529d-120e-4441-b1ca-510125e693e6", "SID": "bfdd4bca-de9e-4843-8eb4-8b60d45bece4", "Name": "sample string 3", "Checked": true, "SortVal": 1, "ShipmentField": "sample string 5", "AddToCategory": "sample string 6" } ], "ShipmentSurveyCategories": [ { "ID": "0ebcc489-d6f4-4be2-830a-d769f79621cd", "SID": "8b70f834-5e7d-4d89-9408-f777b36902ab", "Name": "sample string 3", "Cubes": 1.1, "Density": 1.1, "Note": "sample string 4", "Weight": 1, "ClassName": "sample string 5", "ShipmentSurveyItems": [ { "ID": "fc13d811-cb3b-495c-9311-89ccdf469b3c", "CID": "195f85db-38fe-4284-b1b3-58468f4076e6", "Name": "sample string 3", "Qty": 1.1, "Cubes": 1.1, "Density": 1.1, "Note": "sample string 4", "NotToShip": true, "Weight": 1 }, { "ID": "fc13d811-cb3b-495c-9311-89ccdf469b3c", "CID": "195f85db-38fe-4284-b1b3-58468f4076e6", "Name": "sample string 3", "Qty": 1.1, "Cubes": 1.1, "Density": 1.1, "Note": "sample string 4", "NotToShip": true, "Weight": 1 } ] }, { "ID": "0ebcc489-d6f4-4be2-830a-d769f79621cd", "SID": "8b70f834-5e7d-4d89-9408-f777b36902ab", "Name": "sample string 3", "Cubes": 1.1, "Density": 1.1, "Note": "sample string 4", "Weight": 1, "ClassName": "sample string 5", "ShipmentSurveyItems": [ { "ID": "fc13d811-cb3b-495c-9311-89ccdf469b3c", "CID": "195f85db-38fe-4284-b1b3-58468f4076e6", "Name": "sample string 3", "Qty": 1.1, "Cubes": 1.1, "Density": 1.1, "Note": "sample string 4", "NotToShip": true, "Weight": 1 }, { "ID": "fc13d811-cb3b-495c-9311-89ccdf469b3c", "CID": "195f85db-38fe-4284-b1b3-58468f4076e6", "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-07-01T05:59:55.2378954-04:00</Completed> <EstID>0af54eb1-50fa-49a0-bbe7-28254f948c46</EstID> <ID>740a955b-b414-4384-8df6-7bd859173377</ID> <Note>sample string 2</Note> <ShipmentSurveyCategories> <ShipmentSurveyCategory> <ClassName>sample string 5</ClassName> <Cubes>1.1</Cubes> <Density>1.1</Density> <ID>0ebcc489-d6f4-4be2-830a-d769f79621cd</ID> <Name>sample string 3</Name> <Note>sample string 4</Note> <SID>8b70f834-5e7d-4d89-9408-f777b36902ab</SID> <ShipmentSurveyItems> <ShipmentSurveyItem> <CID>195f85db-38fe-4284-b1b3-58468f4076e6</CID> <Cubes>1.1</Cubes> <Density>1.1</Density> <ID>fc13d811-cb3b-495c-9311-89ccdf469b3c</ID> <Name>sample string 3</Name> <NotToShip>true</NotToShip> <Note>sample string 4</Note> <Qty>1.1</Qty> <Weight>1</Weight> </ShipmentSurveyItem> <ShipmentSurveyItem> <CID>195f85db-38fe-4284-b1b3-58468f4076e6</CID> <Cubes>1.1</Cubes> <Density>1.1</Density> <ID>fc13d811-cb3b-495c-9311-89ccdf469b3c</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>0ebcc489-d6f4-4be2-830a-d769f79621cd</ID> <Name>sample string 3</Name> <Note>sample string 4</Note> <SID>8b70f834-5e7d-4d89-9408-f777b36902ab</SID> <ShipmentSurveyItems> <ShipmentSurveyItem> <CID>195f85db-38fe-4284-b1b3-58468f4076e6</CID> <Cubes>1.1</Cubes> <Density>1.1</Density> <ID>fc13d811-cb3b-495c-9311-89ccdf469b3c</ID> <Name>sample string 3</Name> <NotToShip>true</NotToShip> <Note>sample string 4</Note> <Qty>1.1</Qty> <Weight>1</Weight> </ShipmentSurveyItem> <ShipmentSurveyItem> <CID>195f85db-38fe-4284-b1b3-58468f4076e6</CID> <Cubes>1.1</Cubes> <Density>1.1</Density> <ID>fc13d811-cb3b-495c-9311-89ccdf469b3c</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>31f46931-0ce5-4c58-93e5-ec5090f63a4f</CID> <Cubes>1.1</Cubes> <Density>1.1</Density> <ID>3872c51d-b01b-4545-92d5-5ed0318d0f2c</ID> <Name>sample string 3</Name> <Qty>1.1</Qty> <SID>c79427f9-fef8-4a04-8a52-bfc193798f19</SID> <SortVal>1</SortVal> </ShipmentSurveyContainer> <ShipmentSurveyContainer> <CID>31f46931-0ce5-4c58-93e5-ec5090f63a4f</CID> <Cubes>1.1</Cubes> <Density>1.1</Density> <ID>3872c51d-b01b-4545-92d5-5ed0318d0f2c</ID> <Name>sample string 3</Name> <Qty>1.1</Qty> <SID>c79427f9-fef8-4a04-8a52-bfc193798f19</SID> <SortVal>1</SortVal> </ShipmentSurveyContainer> </ShipmentSurveyContainers> <ShipmentSurveyOthers> <ShipmentSurveyOther> <Description>sample string 3</Description> <ID>6a1a0e51-3e83-441e-83ef-5f6a7849c7aa</ID> <NotToShip>true</NotToShip> <SID>d569cd90-0548-48b4-9e14-d5b14f47280b</SID> <Weight>1</Weight> </ShipmentSurveyOther> <ShipmentSurveyOther> <Description>sample string 3</Description> <ID>6a1a0e51-3e83-441e-83ef-5f6a7849c7aa</ID> <NotToShip>true</NotToShip> <SID>d569cd90-0548-48b4-9e14-d5b14f47280b</SID> <Weight>1</Weight> </ShipmentSurveyOther> </ShipmentSurveyOthers> <ShipmentSurveyQuestions> <ShipmentSurveyQuestion> <AddToCategory>sample string 6</AddToCategory> <Checked>true</Checked> <ID>24fa529d-120e-4441-b1ca-510125e693e6</ID> <Name>sample string 3</Name> <SID>bfdd4bca-de9e-4843-8eb4-8b60d45bece4</SID> <ShipmentField>sample string 5</ShipmentField> <SortVal>1</SortVal> </ShipmentSurveyQuestion> <ShipmentSurveyQuestion> <AddToCategory>sample string 6</AddToCategory> <Checked>true</Checked> <ID>24fa529d-120e-4441-b1ca-510125e693e6</ID> <Name>sample string 3</Name> <SID>bfdd4bca-de9e-4843-8eb4-8b60d45bece4</SID> <ShipmentField>sample string 5</ShipmentField> <SortVal>1</SortVal> </ShipmentSurveyQuestion> </ShipmentSurveyQuestions> <SurveyDate>2025-07-01T05:59:55.2378954-04:00</SurveyDate> <UID>sample string 3</UID> <Weight>1</Weight> <idno>1</idno> <idsub>1</idsub> </ShipmentSurvey>