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 Collection of Venues

 

This method is used to retrieve an array of venues that satisfy search criteria.

Method

GET

URL

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

Headers

X-Auth (see Security)

Query Parameters

Any combination of orgId, isActive and/or clientId is accepted, but at least one must be present or the request is considered a bad request.

Parameter

Value

Description

orgId

integer

The identifier of the organization.

isActive

Boolean

Describes whether to search for active (“true”) or inactive (“false”) venues. Both active and inactive venues will be retrieved by default.

clientId

integer

The identifier of the mobile client application.

Example Query Fragment

{
    "orgId": 12,
    "isActive": true,
    "clientId": 4
} 

URL-encoded, minified fragment:

%7B%22orgId%22%3A%2012%2C%20%22isActive%22%3A%20true%2C%20%22clientId%22%3A%204%7D

Example Request 

GET
http://map-api.phunware.com/v1.1/venues?%7B%22orgId%22%3A%2012%2C%20%22isActive%22%3A%20true%2C%20%22clientId%22%3A%204%7D 

Response

A successful response will have a 200 status code and a body containing an array of venues that satisfy the query parameters:

{
    "data": 
	[
        {
            "guid": <string>,
            "name": <string>,
            "appId": <string>,
            "clientIds": <string>,
            "orgIds": <string>,
            "isActive": <Boolean>,
            "mseUdi": <string>,
            "callbackUrl": <string>,
            "createdAt": <string>,
            "updatedAt": <string>,
            "supportsGeographicCoordinates": <Boolean>
        },
        {
            "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:

{
    "data": 
	[
        {
            "guid": "00000000-1234-1234-abcd-123456789012",
            "name": "Sacred Realm",
            "appId": "123",
            "clientIds": "2,3,4",
            "orgIds": "12",
            "isActive": true,
            "mseUdi": "mseUdi value",
            "callbackUrl": "http://www.phunware.com",
            "createdAt": "2014-06-14T12:21:38Z",
            "updatedAt": "2014-06-14T12:21:38Z",
            "supportsGeographicCoordinates": true,
            "draftStatus": "DRAFT"
        },
        {
            "guid": "c8647fc7-ff52-4584-8de5-8361160c32e4",
            "name": "Twilight Realm",
            "appId": "456",
            "clientIds": "1,2,3,4",
            "orgIds": "12",
            "isActive": false,
            "mseUdi": "mseUdi value",
            "callbackUrl": "http://www.phunware.com",
            "createdAt": "2014-06-14T12:21:38Z",
            "updatedAt": "2014-06-14T12:21:38Z",
            "supportsGeographicCoordinates": true,
            "draftStatus": "DRAFT"
        }
    ]
}

ON THIS PAGE

  • No labels