POST api/Locations/Get

Request Information

URI Parameters

None.

Body Parameters

LocationInfo

Name	Type	Additional information
tkn	string	Required String length: inclusive between 1 and 50
LocationGUID	string	None.
Search	string	None.

Name

Description

Type

Additional information

tkn

string

Required

String length: inclusive between 1 and 50

LocationGUID

string

None.

string

None.

Request Formats

application/json, text/json

Sample:

{
  "tkn": "sample string 1",
  "LocationGUID": "sample string 2",
  "Search": "sample string 3"
}

application/octet-stream

Sample:

{"tkn":"sample string 1","LocationGUID":"sample string 2","Search":"sample string 3"}

application/xml, text/xml

Sample:

<LocationInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <tkn>sample string 1</tkn>
  <LocationGUID>sample string 2</LocationGUID>
  <Search>sample string 3</Search>
</LocationInfo>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'LocationInfo'.

Response Information

Resource Description

LocationEntity

Name	Type	Additional information
Name	string	None.
WorkzoneGUID	string	None.
LocationTypeGUID	string	None.
LocationTypeID	string	None.
ContactName	string	None.
Email	string	None.
Phone	string	None.
Fax	string	None.
Street	string	None.
City	string	None.
State	string	None.
PostalCode	string	None.
Country	string	None.
ExternalID	string	None.
Latitude	string	None.
Longitude	string	None.
tagUID	string	None.
LocationGUID	string	None.
UpdatedOn	string	None.
Values	Collection of Field	None.
isDeleted	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "WorkzoneGUID": "sample string 2",
  "LocationTypeGUID": "sample string 3",
  "LocationTypeID": "sample string 4",
  "ContactName": "sample string 5",
  "Email": "sample string 6",
  "Phone": "sample string 7",
  "Fax": "sample string 8",
  "Street": "sample string 9",
  "City": "sample string 10",
  "State": "sample string 11",
  "PostalCode": "sample string 12",
  "Country": "sample string 13",
  "ExternalID": "sample string 14",
  "Latitude": "sample string 15",
  "Longitude": "sample string 16",
  "tagUID": "sample string 17",
  "LocationGUID": "sample string 18",
  "UpdatedOn": "sample string 19",
  "Values": [
    {
      "apiId": "sample string 1",
      "Value": {},
      "ExternalID": "sample string 3"
    },
    {
      "apiId": "sample string 1",
      "Value": {},
      "ExternalID": "sample string 3"
    }
  ],
  "isDeleted": true
}

application/octet-stream

Sample:

{"Name":"sample string 1","WorkzoneGUID":"sample string 2","LocationTypeGUID":"sample string 3","LocationTypeID":"sample string 4","ContactName":"sample string 5","Email":"sample string 6","Phone":"sample string 7","Fax":"sample string 8","Street":"sample string 9","City":"sample string 10","State":"sample string 11","PostalCode":"sample string 12","Country":"sample string 13","ExternalID":"sample string 14","Latitude":"sample string 15","Longitude":"sample string 16","tagUID":"sample string 17","LocationGUID":"sample string 18","UpdatedOn":"sample string 19","Values":[{"apiId":"sample string 1","Value":{},"ExternalID":"sample string 3"},{"apiId":"sample string 1","Value":{},"ExternalID":"sample string 3"}],"isDeleted":true}

application/xml, text/xml

Sample:

<LocationEntity xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Name>sample string 1</Name>
  <WorkzoneGUID>sample string 2</WorkzoneGUID>
  <LocationTypeGUID>sample string 3</LocationTypeGUID>
  <LocationTypeID>sample string 4</LocationTypeID>
  <ContactName>sample string 5</ContactName>
  <Email>sample string 6</Email>
  <Phone>sample string 7</Phone>
  <Fax>sample string 8</Fax>
  <Street>sample string 9</Street>
  <City>sample string 10</City>
  <State>sample string 11</State>
  <PostalCode>sample string 12</PostalCode>
  <Country>sample string 13</Country>
  <ExternalID>sample string 14</ExternalID>
  <Latitude>sample string 15</Latitude>
  <Longitude>sample string 16</Longitude>
  <tagUID>sample string 17</tagUID>
  <LocationGUID>sample string 18</LocationGUID>
  <UpdatedOn>sample string 19</UpdatedOn>
  <Values>
    <Field>
      <apiId>sample string 1</apiId>
      <Value />
      <ExternalID>sample string 3</ExternalID>
    </Field>
    <Field>
      <apiId>sample string 1</apiId>
      <Value />
      <ExternalID>sample string 3</ExternalID>
    </Field>
  </Values>
  <isDeleted>true</isDeleted>
</LocationEntity>