Venues

Get all Venues in a Location

Enables you to get all venues in the selected location. Support requests: GET & POST

GET SERVER_URL/venue/getAll?sublocationId={sublocationId}&userHash={userHash}&format={format}

Parameters

See the following table for the list of supported parameters.

Parameter Value
{userHash}

hash of a registered user

0000-0000-0000-0000 - for maps with the public_location flag

{locationId} ID of a specific location, for which you want to get the list of venues
{format} Response format: json

JSON Response Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
   "id":15399,
   "name":"sd",
   "zoneId":2696,
   "descriptionRu":"asd",
   "descriptionEn":"sd",
   "image":null,
   "phone":"asd",
   "kx":"0.13620231",
   "ky":"0.61852270",
   "openings":[
    ],
   "map":{
      "id":1500,
      "user_id":2057,
      "title":"testZoneSegments",
      "description":"description",
      "active":true,
      "state":1
   },
   "objectType":5,
   "w":"479.00000",
   "h":"313.00000",
   "category":1,
   "categoryImage":"http:\/\/client.navigine.com\/uploads\/img\/categories\/1.png",
   "categoryRu":"\u041a\u0430\u0444\u0435",
   "categoryEng":"Caffes"
}

Creating a New Venue

Enables you to create a new venue. Support requests: GET & POST

POST SERVER_URL/venue/add?userHash={userHash}

See the following table for the list of supported parameters.

Request Parameters

Parameter Value
{userHash}

hash of a registered user

0000-0000-0000-0000 - for maps with the public_location flag

{sublocationId} ID of a specific location (map), for which you want to create a new venue
{venue_id} ID of the new venue. Leave empty to let the system assign a number correctly
{category_id} ID of the category that includes the venue
{name} Name of the venue
{descriptionRu} Venue description in Russian
{descriptionEn} Venue description in English
{phone} Venue phone parameter
{kx} Venue X coordinate
{ky} Venue Y coordinate
{serialized} Openings object

JSON Response Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
   "id":15447,
   "name":"\u0439\u0446\u0443",
   "zoneId":2661,
   "file":null,
   "categoryId":1,
   "category":1,
   "pin":"caffes",
   "phone":"12",
   "image":"http:\/\/client2.navigine.com",
   "descriptionRu":"\u0439\u0446\u04431",
   "descriptionEn":"\u0446\u0439\u0443",
   "kx":"0.08674863",
   "ky":"0.25819672",
   "w":"500.00000",
   "h":"500.00000",
   "map":{
      "id":1459,
      "user_id":2036,
      "title":"lovely",
      "description":"lo",
      "active":true,
      "state":1
   }
}

Editing Venues

Enables you to edit an existing venue. Support requests: only POST

POST SERVER_URL/venue/edit?format={format}

Request Parameters

See the following table for the list of supported parameters.

Parameter Value
{userHash}

hash of a registered user

0000-0000-0000-0000 - for maps with the public_location flag

{sublocationId} ID of a specific location (map), for which you want to create a new venue

Body form-data parameters

Parameter Value
{venue_id} ID of the new venue. Leave empty to let the system assign a number correctly
{category_id} ID of the category that includes the venue
{name} Name of the venue
{descriptionRu} Venue description in Russian
{descriptionEn} Venue description in English
{phone} Venue phone parameter
{kx} Venue X coordinate
{ky} Venue Y coordinate
{serialized} Opennings object

JSON body Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "venue_id": 64053,
  "category_id": 2,
  "name": "new_name_venue",
  "descriptionRu": "",
  "descriptionEn": "",
  "phone": "1234567890",
  "coordX": "",
  "coordY": "",
  "serialized": "",
}

JSON Response Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
   "id":15447,
   "name":"\u0439\u0446\u0443",
   "zoneId":2661,
   "file":null,
   "categoryId":1,
   "category":1,
   "pin":"caffes",
   "phone":"1212",
   "image":"http:\/\/client2.navigine.com",
   "descriptionRu":"\u0439\u0446\u04431",
   "descriptionEn":"\u0446\u0439\u0443",
   "kx":"0.08674863",
   "ky":"0.25819672",
   "w":"500.00000",
   "h":"500.00000",
   "map":{
      "id":1459,
      "user_id":2036,
      "title":"lovely",
      "description":"lo",
      "active":true,
      "state":1
   }
}

Deleting a Venue

Enables you to remove a venue from the server. Support requests: GET & POST

POST SERVER_URL/venue/delete

Request Parameters

Parameter Value
{userHash}

hash of a registered user

0000-0000-0000-0000 - for maps with the public_location flag

{sublocationId} ID of the sublocation, from which you want to remove a venue
{id} ID of the venue that you want to remove

JSON Response Example

1
2
3
4
5
6
{
   "zoneId":2661,
   "response":"ok",
   "type":"venue",
   "msg":"the venue deleted"
}