GET api/shipmentsurvey/{idno}/{idsub}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
idno

integer

Required

idsub

integer

Required

Body Parameters

None.

Response Information

Resource Description

ShipmentSurvey
NameDescriptionTypeAdditional 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": "9d60dc95-49b6-48cd-a6c4-9c912359aa76",
  "EstID": "e27919d2-d787-4c68-ba7d-ac5e14b6204e",
  "idno": 1,
  "idsub": 1,
  "SurveyDate": "2025-01-21T23:51:50.6780594-05:00",
  "Note": "sample string 2",
  "Weight": 1,
  "Area": 1,
  "UID": "sample string 3",
  "Completed": "2025-01-21T23:51:50.6780594-05:00",
  "ShipmentSurveyContainers": [
    {
      "ID": "76bb5bf3-44c5-4f96-99cf-35bedf95466e",
      "SID": "c43385af-96fe-4986-96f2-13d3c157edb0",
      "Name": "sample string 3",
      "Qty": 1.1,
      "Cubes": 1.1,
      "Density": 1.1,
      "SortVal": 1,
      "CID": "027e1f33-7830-4bbf-902f-26155da66928"
    },
    {
      "ID": "76bb5bf3-44c5-4f96-99cf-35bedf95466e",
      "SID": "c43385af-96fe-4986-96f2-13d3c157edb0",
      "Name": "sample string 3",
      "Qty": 1.1,
      "Cubes": 1.1,
      "Density": 1.1,
      "SortVal": 1,
      "CID": "027e1f33-7830-4bbf-902f-26155da66928"
    }
  ],
  "ShipmentSurveyOthers": [
    {
      "ID": "88b93e7c-5672-4f43-8e6a-c6c67d12a455",
      "SID": "259ae35b-fc46-4fc4-81ab-f63a6958b9b3",
      "Description": "sample string 3",
      "Weight": 1,
      "NotToShip": true
    },
    {
      "ID": "88b93e7c-5672-4f43-8e6a-c6c67d12a455",
      "SID": "259ae35b-fc46-4fc4-81ab-f63a6958b9b3",
      "Description": "sample string 3",
      "Weight": 1,
      "NotToShip": true
    }
  ],
  "ShipmentSurveyQuestions": [
    {
      "ID": "a53d1e82-973c-4f9f-8fb8-6298b64db3be",
      "SID": "1a7a057e-89fc-415f-925d-99cc93e6ca58",
      "Name": "sample string 3",
      "Checked": true,
      "SortVal": 1,
      "ShipmentField": "sample string 5",
      "AddToCategory": "sample string 6"
    },
    {
      "ID": "a53d1e82-973c-4f9f-8fb8-6298b64db3be",
      "SID": "1a7a057e-89fc-415f-925d-99cc93e6ca58",
      "Name": "sample string 3",
      "Checked": true,
      "SortVal": 1,
      "ShipmentField": "sample string 5",
      "AddToCategory": "sample string 6"
    }
  ],
  "ShipmentSurveyCategories": [
    {
      "ID": "d53d98c9-eac0-4050-b19a-538feb6577bd",
      "SID": "d536a371-81db-4ba3-a93f-e6bfa974d36f",
      "Name": "sample string 3",
      "Cubes": 1.1,
      "Density": 1.1,
      "Note": "sample string 4",
      "Weight": 1,
      "ClassName": "sample string 5",
      "ShipmentSurveyItems": [
        {
          "ID": "6eaa5584-a120-42a1-bd4c-2b76604b172c",
          "CID": "33e6d33c-4882-4474-8051-68dffa9bd59b",
          "Name": "sample string 3",
          "Qty": 1.1,
          "Cubes": 1.1,
          "Density": 1.1,
          "Note": "sample string 4",
          "NotToShip": true,
          "Weight": 1
        },
        {
          "ID": "6eaa5584-a120-42a1-bd4c-2b76604b172c",
          "CID": "33e6d33c-4882-4474-8051-68dffa9bd59b",
          "Name": "sample string 3",
          "Qty": 1.1,
          "Cubes": 1.1,
          "Density": 1.1,
          "Note": "sample string 4",
          "NotToShip": true,
          "Weight": 1
        }
      ]
    },
    {
      "ID": "d53d98c9-eac0-4050-b19a-538feb6577bd",
      "SID": "d536a371-81db-4ba3-a93f-e6bfa974d36f",
      "Name": "sample string 3",
      "Cubes": 1.1,
      "Density": 1.1,
      "Note": "sample string 4",
      "Weight": 1,
      "ClassName": "sample string 5",
      "ShipmentSurveyItems": [
        {
          "ID": "6eaa5584-a120-42a1-bd4c-2b76604b172c",
          "CID": "33e6d33c-4882-4474-8051-68dffa9bd59b",
          "Name": "sample string 3",
          "Qty": 1.1,
          "Cubes": 1.1,
          "Density": 1.1,
          "Note": "sample string 4",
          "NotToShip": true,
          "Weight": 1
        },
        {
          "ID": "6eaa5584-a120-42a1-bd4c-2b76604b172c",
          "CID": "33e6d33c-4882-4474-8051-68dffa9bd59b",
          "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:51:50.6780594-05:00</Completed>
  <EstID>e27919d2-d787-4c68-ba7d-ac5e14b6204e</EstID>
  <ID>9d60dc95-49b6-48cd-a6c4-9c912359aa76</ID>
  <Note>sample string 2</Note>
  <ShipmentSurveyCategories>
    <ShipmentSurveyCategory>
      <ClassName>sample string 5</ClassName>
      <Cubes>1.1</Cubes>
      <Density>1.1</Density>
      <ID>d53d98c9-eac0-4050-b19a-538feb6577bd</ID>
      <Name>sample string 3</Name>
      <Note>sample string 4</Note>
      <SID>d536a371-81db-4ba3-a93f-e6bfa974d36f</SID>
      <ShipmentSurveyItems>
        <ShipmentSurveyItem>
          <CID>33e6d33c-4882-4474-8051-68dffa9bd59b</CID>
          <Cubes>1.1</Cubes>
          <Density>1.1</Density>
          <ID>6eaa5584-a120-42a1-bd4c-2b76604b172c</ID>
          <Name>sample string 3</Name>
          <NotToShip>true</NotToShip>
          <Note>sample string 4</Note>
          <Qty>1.1</Qty>
          <Weight>1</Weight>
        </ShipmentSurveyItem>
        <ShipmentSurveyItem>
          <CID>33e6d33c-4882-4474-8051-68dffa9bd59b</CID>
          <Cubes>1.1</Cubes>
          <Density>1.1</Density>
          <ID>6eaa5584-a120-42a1-bd4c-2b76604b172c</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>d53d98c9-eac0-4050-b19a-538feb6577bd</ID>
      <Name>sample string 3</Name>
      <Note>sample string 4</Note>
      <SID>d536a371-81db-4ba3-a93f-e6bfa974d36f</SID>
      <ShipmentSurveyItems>
        <ShipmentSurveyItem>
          <CID>33e6d33c-4882-4474-8051-68dffa9bd59b</CID>
          <Cubes>1.1</Cubes>
          <Density>1.1</Density>
          <ID>6eaa5584-a120-42a1-bd4c-2b76604b172c</ID>
          <Name>sample string 3</Name>
          <NotToShip>true</NotToShip>
          <Note>sample string 4</Note>
          <Qty>1.1</Qty>
          <Weight>1</Weight>
        </ShipmentSurveyItem>
        <ShipmentSurveyItem>
          <CID>33e6d33c-4882-4474-8051-68dffa9bd59b</CID>
          <Cubes>1.1</Cubes>
          <Density>1.1</Density>
          <ID>6eaa5584-a120-42a1-bd4c-2b76604b172c</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>027e1f33-7830-4bbf-902f-26155da66928</CID>
      <Cubes>1.1</Cubes>
      <Density>1.1</Density>
      <ID>76bb5bf3-44c5-4f96-99cf-35bedf95466e</ID>
      <Name>sample string 3</Name>
      <Qty>1.1</Qty>
      <SID>c43385af-96fe-4986-96f2-13d3c157edb0</SID>
      <SortVal>1</SortVal>
    </ShipmentSurveyContainer>
    <ShipmentSurveyContainer>
      <CID>027e1f33-7830-4bbf-902f-26155da66928</CID>
      <Cubes>1.1</Cubes>
      <Density>1.1</Density>
      <ID>76bb5bf3-44c5-4f96-99cf-35bedf95466e</ID>
      <Name>sample string 3</Name>
      <Qty>1.1</Qty>
      <SID>c43385af-96fe-4986-96f2-13d3c157edb0</SID>
      <SortVal>1</SortVal>
    </ShipmentSurveyContainer>
  </ShipmentSurveyContainers>
  <ShipmentSurveyOthers>
    <ShipmentSurveyOther>
      <Description>sample string 3</Description>
      <ID>88b93e7c-5672-4f43-8e6a-c6c67d12a455</ID>
      <NotToShip>true</NotToShip>
      <SID>259ae35b-fc46-4fc4-81ab-f63a6958b9b3</SID>
      <Weight>1</Weight>
    </ShipmentSurveyOther>
    <ShipmentSurveyOther>
      <Description>sample string 3</Description>
      <ID>88b93e7c-5672-4f43-8e6a-c6c67d12a455</ID>
      <NotToShip>true</NotToShip>
      <SID>259ae35b-fc46-4fc4-81ab-f63a6958b9b3</SID>
      <Weight>1</Weight>
    </ShipmentSurveyOther>
  </ShipmentSurveyOthers>
  <ShipmentSurveyQuestions>
    <ShipmentSurveyQuestion>
      <AddToCategory>sample string 6</AddToCategory>
      <Checked>true</Checked>
      <ID>a53d1e82-973c-4f9f-8fb8-6298b64db3be</ID>
      <Name>sample string 3</Name>
      <SID>1a7a057e-89fc-415f-925d-99cc93e6ca58</SID>
      <ShipmentField>sample string 5</ShipmentField>
      <SortVal>1</SortVal>
    </ShipmentSurveyQuestion>
    <ShipmentSurveyQuestion>
      <AddToCategory>sample string 6</AddToCategory>
      <Checked>true</Checked>
      <ID>a53d1e82-973c-4f9f-8fb8-6298b64db3be</ID>
      <Name>sample string 3</Name>
      <SID>1a7a057e-89fc-415f-925d-99cc93e6ca58</SID>
      <ShipmentField>sample string 5</ShipmentField>
      <SortVal>1</SortVal>
    </ShipmentSurveyQuestion>
  </ShipmentSurveyQuestions>
  <SurveyDate>2025-01-21T23:51:50.6780594-05:00</SurveyDate>
  <UID>sample string 3</UID>
  <Weight>1</Weight>
  <idno>1</idno>
  <idsub>1</idsub>
</ShipmentSurvey>