GET Location/GetLocation?IncludeInactive={IncludeInactive}

Returns a list of locations.

Request Information

URI Parameters

Name	Description	Type	Additional Information
IncludeInactive	"true" to include the inactive locations in the return. (optional)	string	Default value is string.Empty

Body Parameters

Response Information

Resource Description

Returns a list of locations.

AgvLocation

Name	Description	Type	Additional Information
Status		string
Message		string
Count		string
Locations		Collection of Location

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "sample string 3",
  "Locations": [
    {
      "ID": "sample string 1",
      "Name": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "LocationGUID": "sample string 5",
      "UDSTestHead": "sample string 6",
      "Region": "sample string 7",
      "SubRegion": "sample string 8",
      "Territory": "sample string 9",
      "Address": "sample string 10",
      "Zip": "sample string 11",
      "Country": "sample string 12",
      "ICCodeNumber": "sample string 13",
      "MappingGuid": "sample string 14"
    },
    {
      "ID": "sample string 1",
      "Name": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "LocationGUID": "sample string 5",
      "UDSTestHead": "sample string 6",
      "Region": "sample string 7",
      "SubRegion": "sample string 8",
      "Territory": "sample string 9",
      "Address": "sample string 10",
      "Zip": "sample string 11",
      "Country": "sample string 12",
      "ICCodeNumber": "sample string 13",
      "MappingGuid": "sample string 14"
    }
  ]
}

application/xml, text/xml

Sample:

<AgvLocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Location">
  <Count>sample string 3</Count>
  <Locations>
    <AgvLocation.Location>
      <Address>sample string 10</Address>
      <City>sample string 3</City>
      <Country>sample string 12</Country>
      <ICCodeNumber>sample string 13</ICCodeNumber>
      <ID>sample string 1</ID>
      <LocationGUID>sample string 5</LocationGUID>
      <MappingGuid>sample string 14</MappingGuid>
      <Name>sample string 2</Name>
      <Region>sample string 7</Region>
      <State>sample string 4</State>
      <SubRegion>sample string 8</SubRegion>
      <Territory>sample string 9</Territory>
      <UDSTestHead>sample string 6</UDSTestHead>
      <Zip>sample string 11</Zip>
    </AgvLocation.Location>
    <AgvLocation.Location>
      <Address>sample string 10</Address>
      <City>sample string 3</City>
      <Country>sample string 12</Country>
      <ICCodeNumber>sample string 13</ICCodeNumber>
      <ID>sample string 1</ID>
      <LocationGUID>sample string 5</LocationGUID>
      <MappingGuid>sample string 14</MappingGuid>
      <Name>sample string 2</Name>
      <Region>sample string 7</Region>
      <State>sample string 4</State>
      <SubRegion>sample string 8</SubRegion>
      <Territory>sample string 9</Territory>
      <UDSTestHead>sample string 6</UDSTestHead>
      <Zip>sample string 11</Zip>
    </AgvLocation.Location>
  </Locations>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvLocation>