GET api/venues/{id}

GET /api/venues/{id:guid} If successful returns venue details and 200 OK Sets Etag header but as yet DOES NOT SUPPORT requests with "If-None-Match" header If Id is null or Guid.Empty returns 400 Bad Request If venue not found in active venue list in CRM returns 404 Not Found For errors contacting CRM returns 502 Bad Gateway All other errors 500

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Guid identifier of venue from CRM	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

VenueRepresentation

Name	Description	Type	Additional information
Id	Unique identifier - same as in CRM	globally unique identifier	None.
Name	name of this venue	string	None.
AddressStreet1	Address Street 1	string	None.
AddressStreet2	Address Street 2	string	None.
AddressStreet3	Address Street 3	string	None.
AddressCity	City	string	None.
AddressPostalCode	Postcode	string	None.
AddressState	State, e.g. England, Wales	string	None.
AddressCountry	Country, e.g. United Kingdom	string	None.
Longitude	Longitude	decimal number	None.
Latitude	Latitude	decimal number	None.
Telephone	Telephone number of venue	string	None.
Description		string	None.
Website	URL of venue website	string	None.
Links		Collection of Link	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "d06c17a2-424f-4ebc-af0c-fdc262042e70",
  "Name": "sample string 2",
  "AddressStreet1": "sample string 3",
  "AddressStreet2": "sample string 4",
  "AddressStreet3": "sample string 5",
  "AddressCity": "sample string 6",
  "AddressPostalCode": "sample string 7",
  "AddressState": "sample string 8",
  "AddressCountry": "sample string 9",
  "Longitude": 10.1,
  "Latitude": 11.1,
  "Telephone": "sample string 12",
  "Description": "sample string 13",
  "Website": "sample string 14",
  "_links": [
    {
      "Rel": "self",
      "Href": "~/venues/d06c17a2-424f-4ebc-af0c-fdc262042e70",
      "Title": null,
      "IsTemplated": false
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "Title": "sample string 3",
      "IsTemplated": false
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "Title": "sample string 3",
      "IsTemplated": false
    }
  ],
  "_embedded": null
}

application/xml, text/xml

Sample:

<VenueRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSAT.WebServices.WebApp.Representations.Version1">
  <Href xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">~/venues/d06c17a2-424f-4ebc-af0c-fdc262042e70</Href>
  <LinkName xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">sample string 17</LinkName>
  <Links xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">
    <Link>
      <Href>~/venues/d06c17a2-424f-4ebc-af0c-fdc262042e70</Href>
      <Rel>self</Rel>
      <Title i:nil="true" />
    </Link>
    <Link>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
      <Title>sample string 3</Title>
    </Link>
    <Link>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
      <Title>sample string 3</Title>
    </Link>
  </Links>
  <Rel xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">sample string 15</Rel>
  <AddressCity>sample string 6</AddressCity>
  <AddressCountry>sample string 9</AddressCountry>
  <AddressPostalCode>sample string 7</AddressPostalCode>
  <AddressState>sample string 8</AddressState>
  <AddressStreet1>sample string 3</AddressStreet1>
  <AddressStreet2>sample string 4</AddressStreet2>
  <AddressStreet3>sample string 5</AddressStreet3>
  <Description>sample string 13</Description>
  <Id>d06c17a2-424f-4ebc-af0c-fdc262042e70</Id>
  <Latitude>11.1</Latitude>
  <Longitude>10.1</Longitude>
  <Name>sample string 2</Name>
  <Telephone>sample string 12</Telephone>
  <Website>sample string 14</Website>
</VenueRepresentation>

application/hal+json

Sample:

{
  "Id": "d06c17a2-424f-4ebc-af0c-fdc262042e70",
  "Name": "sample string 2",
  "AddressStreet1": "sample string 3",
  "AddressStreet2": "sample string 4",
  "AddressStreet3": "sample string 5",
  "AddressCity": "sample string 6",
  "AddressPostalCode": "sample string 7",
  "AddressState": "sample string 8",
  "AddressCountry": "sample string 9",
  "Longitude": 10.1,
  "Latitude": 11.1,
  "Telephone": "sample string 12",
  "Description": "sample string 13",
  "Website": "sample string 14",
  "_links": {
    "self": {
      "href": "/venues/d06c17a2-424f-4ebc-af0c-fdc262042e70"
    },
    "sample string 1": {
      "href": "sample string 2",
      "title": "sample string 3"
    }
  }
}

application/hal+xml

Sample:

<resource rel="sample string 15" href="~/venues/d06c17a2-424f-4ebc-af0c-fdc262042e70" name="sample string 17">
  <link rel="sample string 1" href="sample string 2" />
  <Id>d06c17a2-424f-4ebc-af0c-fdc262042e70</Id>
  <Name>sample string 2</Name>
  <AddressStreet1>sample string 3</AddressStreet1>
  <AddressStreet2>sample string 4</AddressStreet2>
  <AddressStreet3>sample string 5</AddressStreet3>
  <AddressCity>sample string 6</AddressCity>
  <AddressPostalCode>sample string 7</AddressPostalCode>
  <AddressState>sample string 8</AddressState>
  <AddressCountry>sample string 9</AddressCountry>
  <Longitude>10.1</Longitude>
  <Latitude>11.1</Latitude>
  <Telephone>sample string 12</Telephone>
  <Description>sample string 13</Description>
  <Website>sample string 14</Website>
</resource>