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 Campuses

 

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

Method

GET

URL

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

Headers

X-Auth (see Security)

Query Parameters

Required parameters are underlined.

Parameter

Value

Description

venueGuid

string

Identifier of the venue for which to retrieve campuses.

name

string

The name of the campus to search for.

draftStatusstringEither "LIVE" or "DRAFT". Defaults to "LIVE".

Example Query Fragment

{
	"venueGuid": "f0685279-7497-4d90-882e-12201e476b0e"
} 

URL-encoded, minified fragment:

%7B%22venueGuid%22%3A+%22f0685279-7497-4d90-882e-12201e476b0e%22%7D 

Example Request 

GET
http://map-api.phunware.com/v1.1/campuses?%7B%22venueGuid%22%3A+%22f0685279-7497-4d90-882e-12201e476b0e%22%7D

Response

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

{
    "data": 
	[
        {
            "id": <integer>,
            "name": <string>,
            "venueGuid": <string>,
            "createdAt": <string>,
            "updatedAt": <string>,
            "externalId": <integer>
        },
        {
            "id": <integer>,
            "name": <string>,
            "venueGuid": <string>,
            "createdAt": <string>,
            "updatedAt": <string>,
            "externalId": <integer>
        },
        ...
    ]
}

See Mapping API Response Handling for error payloads.

Example Response

Example body of a successful response:

{
    "data": 
	[
        {
            "id": 1,
            "name": "Lost Woods",
            "venueGuid": "f0685279-7497-4d90-882e-12201e476b0e",
            "createdAt": "2014-06-06T18:25:26Z",
            "updatedAt": "2014-06-06T18:25:26Z",
            "externalId": 1
        },
        {
            "id": 2,
            "name": "Kakariko Village",
            "venueGuid": "f0685279-7497-4d90-882e-12201e471111",
            "createdAt": "2014-06-06T18:25:26Z",
            "updatedAt": "2014-06-06T18:25:26Z",
            "externalId": 2
        }
    ]
} 

ON THIS PAGE

 

 

  • No labels