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.

Update a Venue

 

This method is used to update an existing venue.

Method

PUT

URL

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

Headers

X-Auth (see Security)

Request Body

See Mapping API Architecture > PUT Methods & Partial Updates.

Parameter

Value

Description

name

string

The name of the venue. We recommend a unique string to help differentiate this venue from other venues.

orgIds

string

Identifiers of the organizations associated with the venue.

isActive

Boolean

Describes whether the venue is active (“true)” or inactive (“false”). A venue is typically set to inactive to indicate that it is being populated or edited. It is also used to indicate that the venue was once active but has since been replaced or is no longer valid.

clientIds

string

The identifiers of the mobile client applications associated with this venue.

mseUdi

string

This is a value that corresponds to a Cisco MSE identifier. It is set during the MSE registration process.

supportsGeographicCoordinates

Boolean

Describes whether this venue supports native mapping (latitude and longitude).

{
    "orgIds": <string>,
    "isActive": <Boolean>
}

Example Request

PUT the following request body to: http://map-api.phunware.com/v1.1/venues/99869682-f231-462a-a0a5-33067b48bd74

{
    "orgIds": "13,14,15",
    "isActive": false
}

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

  • No labels