Skip to end of metadata
Go to start of metadata

This documentation is no longer actively supported and may be out of date. Going forward, please visit and bookmark our new site (https://docs.phunware.com/) for up-to-date documentation.

Retrieve a Venue

 

This method is used to retrieve a venue by venue ID.

Method

GET

URL

http://map-api.phunware.com/v1.1/venues/[guid]

Headers

X-Auth (see Security)

Query Parameters

None

Example Request

GET
http://map-api.phunware.com/v1.1/venues/99869682-f231-462a-a0a5-33067b48bd74

Response

A successful response will have a 200 status code and a body containing an object with venue data:

{
    "guid": <string>,
    "name": <string>,
    "appId": <string>,
    "clientIds": <string>,
    "orgIds": <string>,
    "isActive": <Boolean>,
    "mseUdi": <string>,
    "callbackUrl": <string>,
    "createdAt": <string>,
    "updatedAt": <string>,
    "supportsGeographicCoordinates": <Boolean>,
    "draftStatus": <string>
}

See Mapping API Response Handling for error payloads. 

Example Response

Example body of a successful response:

{
    "guid": "f0685279-7497-4d90-882e-12201e476b0e",
    "name": "Hyrule",
    "appId": "123456",
    "clientIds": "98765,6543",
    "orgIds": "8,9",
    "isActive": true,
    "mseUdi": "abcd",
    "callbackUrl": "http://www.Hyrule.com",
    "createdAt": "2014-06-14T12:21:38Z",
    "updatedAt": "2014-06-14T12:21:38Z",
    "supportsGeographicCoordinates": true,
    "draftStatus": "DRAFT"
}

 

  • No labels