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.

Create a Venue

 

This method is used to create a venue and initialize the data structures provided by the Cisco Prime interface.

Method

POST

URL

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

Headers

X-Auth (see Security)

Request Body

Required parameters are underlined.

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

The identifiers of the organizations associated with this 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).

{
    "name": <string>,
    "appId": <string>,
    "clientIds": <string>,
    "orgIds": <string>,
    "isActive": true,
    "mseUdi": <string>,
    "supportsGeographicCoordinates": <Boolean>
}

Example Request

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

{
    "name": "Hyrule",
    "appId": "123456",
    "clientIds": "98765,6543",
    "orgIds": "8,9",
    "mseUdi": "abcd",
    "supportsGeographicCoordinates": true
}

Response

A successful response will have a 200 status code and a body containing the GUID of the newly created venue:

{
    "data": 
	{
        "guid": <string>
    }
}

See Mapping API Response Handling for error payloads.

Example Response

Example body of successful response:

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

ON THIS PAGE

  • No labels