GET Department/GetDepartmentByLocationID?LocationID={LocationID}&ProductID={ProductID}

Returns a list of departments by location ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
LocationID

LocationID of the departments to return, also Location GUID can be used as a filter

string

Required

ProductID

ProductID of the departments to return

string

Default value is string.Empty

Body Parameters

Response Information

Resource Description

Returns a list of departments by location ID.

AgvDepartment
NameDescriptionTypeAdditional Information
Status

Status of the API call.

string
Message

Message of the API call.

string
Count

Count of how many Department JSON dictionaries.

string
Departments

JSON dictionary of Department.

Collection of Department

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "Departments": [
    {
      "ID": "sample string 1",
      "Name": "sample string 2",
      "LocationID": "sample string 3",
      "Category": "sample string 4",
      "XRef1": {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      "XRef2": {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      "XRef3": {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      "XRef4": {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    },
    {
      "ID": "sample string 1",
      "Name": "sample string 2",
      "LocationID": "sample string 3",
      "Category": "sample string 4",
      "XRef1": {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      "XRef2": {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      "XRef3": {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      "XRef4": {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    }
  ]
}

application/xml, text/xml

Sample:
<AgvDepartment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Location">
  <Departments>
    <Department>
      <Category>sample string 4</Category>
      <ID>sample string 1</ID>
      <LocationID>sample string 3</LocationID>
      <Name>sample string 2</Name>
      <XRef1 xmlns:d4p1="http://schemas.datacontract.org/2004/07/SSI.API">
        <d4p1:Name>sample string 1</d4p1:Name>
        <d4p1:Value>sample string 2</d4p1:Value>
      </XRef1>
      <XRef2 xmlns:d4p1="http://schemas.datacontract.org/2004/07/SSI.API">
        <d4p1:Name>sample string 1</d4p1:Name>
        <d4p1:Value>sample string 2</d4p1:Value>
      </XRef2>
      <XRef3 xmlns:d4p1="http://schemas.datacontract.org/2004/07/SSI.API">
        <d4p1:Name>sample string 1</d4p1:Name>
        <d4p1:Value>sample string 2</d4p1:Value>
      </XRef3>
      <XRef4 xmlns:d4p1="http://schemas.datacontract.org/2004/07/SSI.API">
        <d4p1:Name>sample string 1</d4p1:Name>
        <d4p1:Value>sample string 2</d4p1:Value>
      </XRef4>
    </Department>
    <Department>
      <Category>sample string 4</Category>
      <ID>sample string 1</ID>
      <LocationID>sample string 3</LocationID>
      <Name>sample string 2</Name>
      <XRef1 xmlns:d4p1="http://schemas.datacontract.org/2004/07/SSI.API">
        <d4p1:Name>sample string 1</d4p1:Name>
        <d4p1:Value>sample string 2</d4p1:Value>
      </XRef1>
      <XRef2 xmlns:d4p1="http://schemas.datacontract.org/2004/07/SSI.API">
        <d4p1:Name>sample string 1</d4p1:Name>
        <d4p1:Value>sample string 2</d4p1:Value>
      </XRef2>
      <XRef3 xmlns:d4p1="http://schemas.datacontract.org/2004/07/SSI.API">
        <d4p1:Name>sample string 1</d4p1:Name>
        <d4p1:Value>sample string 2</d4p1:Value>
      </XRef3>
      <XRef4 xmlns:d4p1="http://schemas.datacontract.org/2004/07/SSI.API">
        <d4p1:Name>sample string 1</d4p1:Name>
        <d4p1:Value>sample string 2</d4p1:Value>
      </XRef4>
    </Department>
  </Departments>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvDepartment>