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	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": "a94fbe43-ee81-4a77-a38e-8f4d4f11fe87",
  "EstID": "e2b72a8d-ec57-4b01-8a69-4947b2b41ce0",
  "idno": 1,
  "idsub": 1,
  "SurveyDate": "2025-01-21T23:49:23.6584824-05:00",
  "Note": "sample string 2",
  "Weight": 1,
  "Area": 1,
  "UID": "sample string 3",
  "Completed": "2025-01-21T23:49:23.6584824-05:00",
  "ShipmentSurveyContainers": [
    {
      "ID": "514d393d-4e60-4692-8cec-fe31d266e725",
      "SID": "3941aa76-b3ef-4d7d-9e84-f80ce2f22254",
      "Name": "sample string 3",
      "Qty": 1.1,
      "Cubes": 1.1,
      "Density": 1.1,
      "SortVal": 1,
      "CID": "cc5e56a9-5d34-4cd4-b15f-ac71bf1775fb"
    },
    {
      "ID": "514d393d-4e60-4692-8cec-fe31d266e725",
      "SID": "3941aa76-b3ef-4d7d-9e84-f80ce2f22254",
      "Name": "sample string 3",
      "Qty": 1.1,
      "Cubes": 1.1,
      "Density": 1.1,
      "SortVal": 1,
      "CID": "cc5e56a9-5d34-4cd4-b15f-ac71bf1775fb"
    }
  ],
  "ShipmentSurveyOthers": [
    {
      "ID": "e6c608d8-17ca-4582-b8bb-e9c2a1a17cd5",
      "SID": "c1edd0f5-8857-448d-bdba-7a80426d3bb8",
      "Description": "sample string 3",
      "Weight": 1,
      "NotToShip": true
    },
    {
      "ID": "e6c608d8-17ca-4582-b8bb-e9c2a1a17cd5",
      "SID": "c1edd0f5-8857-448d-bdba-7a80426d3bb8",
      "Description": "sample string 3",
      "Weight": 1,
      "NotToShip": true
    }
  ],
  "ShipmentSurveyQuestions": [
    {
      "ID": "a6b0fcac-18dd-4e9d-973b-9133fe725e85",
      "SID": "6ee9667d-8f6f-444c-aa81-7a70f965a194",
      "Name": "sample string 3",
      "Checked": true,
      "SortVal": 1,
      "ShipmentField": "sample string 5",
      "AddToCategory": "sample string 6"
    },
    {
      "ID": "a6b0fcac-18dd-4e9d-973b-9133fe725e85",
      "SID": "6ee9667d-8f6f-444c-aa81-7a70f965a194",
      "Name": "sample string 3",
      "Checked": true,
      "SortVal": 1,
      "ShipmentField": "sample string 5",
      "AddToCategory": "sample string 6"
    }
  ],
  "ShipmentSurveyCategories": [
    {
      "ID": "c87e5d95-8fd3-4671-a008-f4eae4529cd4",
      "SID": "c89a0057-e848-4866-8816-9a6e528a8d27",
      "Name": "sample string 3",
      "Cubes": 1.1,
      "Density": 1.1,
      "Note": "sample string 4",
      "Weight": 1,
      "ClassName": "sample string 5",
      "ShipmentSurveyItems": [
        {
          "ID": "205da749-9663-4485-85a3-c6d7149cd764",
          "CID": "5de0ce6c-42c3-4d32-817f-ac536c51679f",
          "Name": "sample string 3",
          "Qty": 1.1,
          "Cubes": 1.1,
          "Density": 1.1,
          "Note": "sample string 4",
          "NotToShip": true,
          "Weight": 1
        },
        {
          "ID": "205da749-9663-4485-85a3-c6d7149cd764",
          "CID": "5de0ce6c-42c3-4d32-817f-ac536c51679f",
          "Name": "sample string 3",
          "Qty": 1.1,
          "Cubes": 1.1,
          "Density": 1.1,
          "Note": "sample string 4",
          "NotToShip": true,
          "Weight": 1
        }
      ]
    },
    {
      "ID": "c87e5d95-8fd3-4671-a008-f4eae4529cd4",
      "SID": "c89a0057-e848-4866-8816-9a6e528a8d27",
      "Name": "sample string 3",
      "Cubes": 1.1,
      "Density": 1.1,
      "Note": "sample string 4",
      "Weight": 1,
      "ClassName": "sample string 5",
      "ShipmentSurveyItems": [
        {
          "ID": "205da749-9663-4485-85a3-c6d7149cd764",
          "CID": "5de0ce6c-42c3-4d32-817f-ac536c51679f",
          "Name": "sample string 3",
          "Qty": 1.1,
          "Cubes": 1.1,
          "Density": 1.1,
          "Note": "sample string 4",
          "NotToShip": true,
          "Weight": 1
        },
        {
          "ID": "205da749-9663-4485-85a3-c6d7149cd764",
          "CID": "5de0ce6c-42c3-4d32-817f-ac536c51679f",
          "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-01-21T23:49:23.6584824-05:00</Completed>
  <EstID>e2b72a8d-ec57-4b01-8a69-4947b2b41ce0</EstID>
  <ID>a94fbe43-ee81-4a77-a38e-8f4d4f11fe87</ID>
  <Note>sample string 2</Note>
  <ShipmentSurveyCategories>
    <ShipmentSurveyCategory>
      <ClassName>sample string 5</ClassName>
      <Cubes>1.1</Cubes>
      <Density>1.1</Density>
      <ID>c87e5d95-8fd3-4671-a008-f4eae4529cd4</ID>
      <Name>sample string 3</Name>
      <Note>sample string 4</Note>
      <SID>c89a0057-e848-4866-8816-9a6e528a8d27</SID>
      <ShipmentSurveyItems>
        <ShipmentSurveyItem>
          <CID>5de0ce6c-42c3-4d32-817f-ac536c51679f</CID>
          <Cubes>1.1</Cubes>
          <Density>1.1</Density>
          <ID>205da749-9663-4485-85a3-c6d7149cd764</ID>
          <Name>sample string 3</Name>
          <NotToShip>true</NotToShip>
          <Note>sample string 4</Note>
          <Qty>1.1</Qty>
          <Weight>1</Weight>
        </ShipmentSurveyItem>
        <ShipmentSurveyItem>
          <CID>5de0ce6c-42c3-4d32-817f-ac536c51679f</CID>
          <Cubes>1.1</Cubes>
          <Density>1.1</Density>
          <ID>205da749-9663-4485-85a3-c6d7149cd764</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>c87e5d95-8fd3-4671-a008-f4eae4529cd4</ID>
      <Name>sample string 3</Name>
      <Note>sample string 4</Note>
      <SID>c89a0057-e848-4866-8816-9a6e528a8d27</SID>
      <ShipmentSurveyItems>
        <ShipmentSurveyItem>
          <CID>5de0ce6c-42c3-4d32-817f-ac536c51679f</CID>
          <Cubes>1.1</Cubes>
          <Density>1.1</Density>
          <ID>205da749-9663-4485-85a3-c6d7149cd764</ID>
          <Name>sample string 3</Name>
          <NotToShip>true</NotToShip>
          <Note>sample string 4</Note>
          <Qty>1.1</Qty>
          <Weight>1</Weight>
        </ShipmentSurveyItem>
        <ShipmentSurveyItem>
          <CID>5de0ce6c-42c3-4d32-817f-ac536c51679f</CID>
          <Cubes>1.1</Cubes>
          <Density>1.1</Density>
          <ID>205da749-9663-4485-85a3-c6d7149cd764</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>cc5e56a9-5d34-4cd4-b15f-ac71bf1775fb</CID>
      <Cubes>1.1</Cubes>
      <Density>1.1</Density>
      <ID>514d393d-4e60-4692-8cec-fe31d266e725</ID>
      <Name>sample string 3</Name>
      <Qty>1.1</Qty>
      <SID>3941aa76-b3ef-4d7d-9e84-f80ce2f22254</SID>
      <SortVal>1</SortVal>
    </ShipmentSurveyContainer>
    <ShipmentSurveyContainer>
      <CID>cc5e56a9-5d34-4cd4-b15f-ac71bf1775fb</CID>
      <Cubes>1.1</Cubes>
      <Density>1.1</Density>
      <ID>514d393d-4e60-4692-8cec-fe31d266e725</ID>
      <Name>sample string 3</Name>
      <Qty>1.1</Qty>
      <SID>3941aa76-b3ef-4d7d-9e84-f80ce2f22254</SID>
      <SortVal>1</SortVal>
    </ShipmentSurveyContainer>
  </ShipmentSurveyContainers>
  <ShipmentSurveyOthers>
    <ShipmentSurveyOther>
      <Description>sample string 3</Description>
      <ID>e6c608d8-17ca-4582-b8bb-e9c2a1a17cd5</ID>
      <NotToShip>true</NotToShip>
      <SID>c1edd0f5-8857-448d-bdba-7a80426d3bb8</SID>
      <Weight>1</Weight>
    </ShipmentSurveyOther>
    <ShipmentSurveyOther>
      <Description>sample string 3</Description>
      <ID>e6c608d8-17ca-4582-b8bb-e9c2a1a17cd5</ID>
      <NotToShip>true</NotToShip>
      <SID>c1edd0f5-8857-448d-bdba-7a80426d3bb8</SID>
      <Weight>1</Weight>
    </ShipmentSurveyOther>
  </ShipmentSurveyOthers>
  <ShipmentSurveyQuestions>
    <ShipmentSurveyQuestion>
      <AddToCategory>sample string 6</AddToCategory>
      <Checked>true</Checked>
      <ID>a6b0fcac-18dd-4e9d-973b-9133fe725e85</ID>
      <Name>sample string 3</Name>
      <SID>6ee9667d-8f6f-444c-aa81-7a70f965a194</SID>
      <ShipmentField>sample string 5</ShipmentField>
      <SortVal>1</SortVal>
    </ShipmentSurveyQuestion>
    <ShipmentSurveyQuestion>
      <AddToCategory>sample string 6</AddToCategory>
      <Checked>true</Checked>
      <ID>a6b0fcac-18dd-4e9d-973b-9133fe725e85</ID>
      <Name>sample string 3</Name>
      <SID>6ee9667d-8f6f-444c-aa81-7a70f965a194</SID>
      <ShipmentField>sample string 5</ShipmentField>
      <SortVal>1</SortVal>
    </ShipmentSurveyQuestion>
  </ShipmentSurveyQuestions>
  <SurveyDate>2025-01-21T23:49:23.6584824-05:00</SurveyDate>
  <UID>sample string 3</UID>
  <Weight>1</Weight>
  <idno>1</idno>
  <idsub>1</idsub>
</ShipmentSurvey>