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.

CAMPUS

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.

Create a Campus

 

This method is used to create a campus.

Method

POST

URL

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

Headers

X-Auth (see Security)

Request Body

Required parameters are underlined.

Parameter

Value

Description

name

string

The name of the campus.

venueGuid

string

The identifier of the venue that the campus belongs to. Must be a draft venue.

{
    "name": <string>,
    "venueGuid": <string>
} 

Example Request

POST the following request body to: http://map-api.phunware.com/v1.1/campuses

{
    "name": "Hyrule Castle",
    "venueGuid": null
} 

Response

A successful response will have a 200 status code and a body containing the newly created campus' ID:

{
    "data": 
	{
        "id": <integer>
    }
}

See Mapping API Response Handling for error payloads.

Example Response

Example body of successful response:

{
    "data": 
	{
        "id": 1986
    }
}

ON THIS PAGE

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.

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

Method

GET

URL

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

Headers

X-Auth (see Security)

Query Parameters

Required parameters are underlined.  The draftStatus parameter indicates whether to return the live or draft version of this campus.

Parameter

Value

Description

draftStatus

string

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

 

  

Example Query Fragment

{
    "draftStatus": "DRAFT"
} 

Example Request

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

Response

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

{
    "id": <string>,
    "name": <string>,
    "venueGuid": <string>,
    "createdAt": <string>,
    "updatedAt": <string>
} 

See Mapping API Response Handling for error payloads.

Example Response

Example body of a successful response:

{
    "id": 1986,
    "name": "Hyrule Castle",
    "venueGuid": "f0685279-7497-4d90-882e-12201e476b0e",
    "createdAt": "2014-06-06T18:25:26Z",
    "updatedAt": "2014-06-06T18:25:26Z"
} 

ON THIS PAGE

 

 

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

 

 

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.

Update a Campus

 

This method is used to update an existing campus.  Only draft campuses (i.e. campuses that belong to a draft venue) may be modified via this method.

Method

PUT

URL

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

Headers

X-Auth (see Security)

Request Body

See Mapping API Architecture > PUT Methods & Partial Updates.

Parameter

Value

Description

name

string

The name of the campus.

venueGuid

string

The identifier of the venue that the campus belongs to.

{
	"name": <string> 
}  

Example Request

PUT the following request body to: http://map-api.phunware.com/v1.1/campuses/1986

{
	"name": "San Jose Campus"
} 

Response

A success response will return a 204 status code with no data in the body of the response. See Mapping API Response Handling for error payloads.

ON THIS PAGE

 

 

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.

Delete a Campus

 

This method is used to delete a campus.  Only draft campuses (i.e. campuses that belong to a draft venue) may be modified via this method.

Method

DELETE

URL

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

Headers

X-Auth (see Security)

Request Parameters

None

Example Request

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

Response

A success response will return a 204 status code with no data in the body of the response. See Mapping API Response Handling for error payloads.

ON THIS PAGE

 

 

 

A campus is a collection of one or more buildings grouped together by a common theme.

{
    "id": <string>,
    "name": <string>,
    "venueGuid": <string>
}
  • No labels