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.

Workflow - Publish and Revert

 

The only way to modify a “live” venue or any of its child elements is via a publish operation.  This allows better control over who can modify “live” data.

 

Publish

Publishing overwrites the "live" venue with the values in the "draft" venue.  The body of the request must contain the GUID of the draft venue to be published.

Method

PUT

URL

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

Headers

X-Auth (see Security)

Query Parameters

None

Request Body

See Mapping API Architecture > PUT Methods & Partial Updates.

Parameter

Value

Description

sourceGuid

string

The GUID of the draft version of the venue, which will be published, overwriting the live version.

   

 

 

{ 
   "sourceGuid": <string>
}

Example Request

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

{ 
   "sourceGuid": "432f21fa-b997-436a-ac1a-dafc9406d025"
}

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.

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

 

Example 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.

{
     "data": {
         "message": "Accepted",
         "guid": "1bff7beb-05b8-4049-854d-137de3e38303"
     }
}

 

 

 

Revert

"Reverting" overwrites the "draft" venue with the values in the "live" venue.  The body of the request must contain the GUID of the live venue to PUT to draft.

Method

PUT

URL

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

Headers

X-Auth (see Security)

Query Parameters

None

Request Body

See Mapping API Architecture > PUT Methods & Partial Updates.

Parameter

Value

Description

sourceGuid

string

The GUID of the live version of the venue, which will be used to overwrite the current draft version

   

 

 

{ 
   "sourceGuid": <string>
}

Example Request

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

{ 
   "sourceGuid": "1bff7beb-05b8-4049-854d-137de3e38303"
}

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.

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

 

Example 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.

{
     "data": {
         "message": "Accepted",
         "guid": "432f21fa-b997-436a-ac1a-dafc9406d025"
     }
}
  • No labels