Points of Interest Official Repository (ROPI) API
API Endpoint
https://api.ropi.porto.digitalROPI API requires authorization. All requests must have valid auth_token.
Use POST /CitySDK/auth with your credentials to authenticate and generate a valid access token. The access token must be used in all the following requests.
API key services ¶
The list of services available for API keys management.
List api keys ¶
GET https://api.ropi.porto.digital/CitySDK/api_keys
List api keysGET/CitySDK/api_keys
Used to obtain the list of api keys.
URI Parameters
- limit
integer(optional)Filter the search to a set of results. The default value is 10.
- offset
integer(optional)Filter the search to a set of results. The default value is 0. The service also accept ‘page’ to get the set of results by page.
POST https://api.ropi.porto.digital/CitySDK/api_keys
Generate API keyPOST/CitySDK/api_keys
Used to generate a new API key.
URI Parameters
- user_id
string(required)The user ID to associate the api key to.
Delete an API key ¶
DELETE https://api.ropi.porto.digital/CitySDK/api_keys/id
Delete an API keyDELETE/CitySDK/api_keys/{id}
Used to delete an API key.
URI Parameters
- id
string(required)The API key ID to delete.
GET https://api.ropi.porto.digital/CitySDK/api_keys/id
Get API key by IDGET/CitySDK/api_keys/{id}
Used to get an API key by ID.
URI Parameters
- id
string(required)The API key ID to retrieve.
PUT https://api.ropi.porto.digital/CitySDK/api_keys/id
Update API keyPUT/CitySDK/api_keys/{id}
Used to update a API key.
URI Parameters
- id
string(required)The API key ID to update.
Authentication services ¶
The list of services available for ROPI API authentication.
Authentication ¶
POST https://api.ropi.porto.digital/CitySDK/auth
AuthenticationPOST/CitySDK/auth
Used to authenticate the requester.
Use the credentials provided to authenticate using the Basic Authentication method.
Example:
curl -u key:secret -X POST -v https://api.ropi.porto.digital/CitySDK/auth
Category services ¶
The list of services available for interacting with the ROPI API categories.
List categories ¶
GET https://api.ropi.porto.digital/CitySDK/categories/list
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc3OCwiaWF0IjoxNTc1MzA3NTc4LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImNjMjZiYTU2LWNlMzItNDc3NS1hMzliLWNmNzU5NGQ3ZmRmMSIsIm5iZiI6MTU3NTMwNzU3Nywic3ViIjoiNWRlNTQ5M2E1NWI0ZmMyMWMwZmZjNDE1IiwidHlwIjoiYWNjZXNzIn0.xIgpDIKHvF6CvpU1xDgx0HTcUj9i6daPQ5HLZq_a_FIrNsTOdcUT7FiixV8dqNrx0a3mdGcc4NTY-xdCqHn8rA
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd5WkjaQ1gdEsAAITBBody
{
"categories": [
{
"author": {
"term": "primary",
"value": "some author"
},
"category": [
{
"author": {
"term": "primary",
"value": "admin"
},
"categories": [
{
"author": {
"term": "primary",
"value": "admin"
},
"created": "2019-12-02T17:26:18.000000Z",
"id": "5c40651ea8f44b313604c748",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "Categoriateste1"
},
{
"lang": "en-GB",
"term": "primary",
"value": "Categorytest1"
}
],
"link": [
{
"href": "some category link href",
"term": "icon",
"value": "some category link"
},
{
"href": "some category link href",
"term": "edit",
"value": "some category link"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c749"
}
],
"term": "category"
}
],
"category": [
{
"id": "5c40651ea8f44b313604c748"
}
],
"created": "2019-12-02T17:26:18.000000Z",
"id": "5c40651ea8f44b313604c749",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "Categoriateste2"
},
{
"lang": "en-GB",
"term": "primary",
"value": "Categorytest2"
}
],
"link": [
{
"href": "some category link1 href",
"term": "icon",
"value": "some category link1"
},
{
"href": "some category link1 href",
"term": "edit",
"value": "some category link1"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c751"
}
],
"term": "category"
},
{
"author": {
"term": "primary",
"value": "admin"
},
"created": "2019-12-02T17:26:18.000000Z",
"id": "5c40651ea8f44b313604c750",
"link": [
{
"term": "parent",
"value": "5c40651ea8f44b313604c751"
}
],
"term": "category"
}
],
"created": "2019-12-02T17:26:18.000000Z",
"id": "5c40651ea8f44b313604c751",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "Categoriateste4"
},
{
"lang": "en-GB",
"term": "primary",
"value": "Categorytest4"
}
],
"link": [
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
},
{
"href": "some category link2 href",
"term": "edit",
"value": "some category link2"
}
],
"term": "category"
},
{
"author": {
"term": "primary",
"value": "some author"
},
"created": "2019-12-02T17:26:18.000000Z",
"id": "5c40651ea8f44b313604c752",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "Categoriateste5"
},
{
"lang": "en-GB",
"term": "primary",
"value": "Categorytest5"
}
],
"term": "category"
},
{
"author": {
"term": "primary",
"value": "some author"
},
"created": "2019-12-02T17:26:18.000000Z",
"id": "5c40651ea8f44b313604c753",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "Categoriateste6"
},
{
"lang": "en-GB",
"term": "primary",
"value": "Categorytest6"
}
],
"term": "category"
},
{
"author": {
"term": "primary",
"value": "some author"
},
"created": "2019-12-02T17:26:18.000000Z",
"id": "5c40651ea8f44b313604c754",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "Categoriateste7"
},
{
"lang": "en-GB",
"term": "primary",
"value": "Categorytest7"
}
],
"term": "category"
}
]
}Headers
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd5VtA7CvQSvYAAIPBBody
{
"categories": [
{
"author": {
"term": "primary",
"value": "some author"
},
"category": [
{
"author": {
"term": "primary",
"value": "admin"
},
"categories": [
{
"author": {
"term": "primary",
"value": "admin"
},
"created": "2019-12-02T17:26:18.000000Z",
"id": "5c40651ea8f44b313604c748",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "Categoriateste1"
},
{
"lang": "en-GB",
"term": "primary",
"value": "Categorytest1"
}
],
"link": [
{
"href": "some category link href",
"term": "icon",
"value": "some category link"
},
{
"href": "some category link href",
"term": "edit",
"value": "some category link"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c749"
}
],
"term": "category"
}
],
"category": [
{
"id": "5c40651ea8f44b313604c748"
}
],
"created": "2019-12-02T17:26:18.000000Z",
"id": "5c40651ea8f44b313604c749",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "Categoriateste2"
},
{
"lang": "en-GB",
"term": "primary",
"value": "Categorytest2"
}
],
"link": [
{
"href": "some category link1 href",
"term": "icon",
"value": "some category link1"
},
{
"href": "some category link1 href",
"term": "edit",
"value": "some category link1"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c751"
}
],
"term": "category"
},
{
"author": {
"term": "primary",
"value": "admin"
},
"created": "2019-12-02T17:26:18.000000Z",
"id": "5c40651ea8f44b313604c750",
"link": [
{
"term": "parent",
"value": "5c40651ea8f44b313604c751"
}
],
"term": "category"
}
],
"created": "2019-12-02T17:26:18.000000Z",
"id": "5c40651ea8f44b313604c751",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "Categoriateste4"
},
{
"lang": "en-GB",
"term": "primary",
"value": "Categorytest4"
}
],
"link": [
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
},
{
"href": "some category link2 href",
"term": "edit",
"value": "some category link2"
}
],
"term": "category"
},
{
"author": {
"term": "primary",
"value": "some author"
},
"created": "2019-12-02T17:26:18.000000Z",
"id": "5c40651ea8f44b313604c752",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "Categoriateste5"
},
{
"lang": "en-GB",
"term": "primary",
"value": "Categorytest5"
}
],
"term": "category"
},
{
"author": {
"term": "primary",
"value": "some author"
},
"created": "2019-12-02T17:26:18.000000Z",
"id": "5c40651ea8f44b313604c753",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "Categoriateste6"
},
{
"lang": "en-GB",
"term": "primary",
"value": "Categorytest6"
}
],
"term": "category"
},
{
"author": {
"term": "primary",
"value": "some author"
},
"created": "2019-12-02T17:26:18.000000Z",
"id": "5c40651ea8f44b313604c754",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "Categoriateste7"
},
{
"lang": "en-GB",
"term": "primary",
"value": "Categorytest7"
}
],
"term": "category"
}
]
}List categoriesGET/CitySDK/categories/{list}
Used to obtain the list of categories.
URI Parameters
- list
string(required)The category list to retrieve
"poi"or"event".- label
string(optional)Search using label. Eg:
"Bares, Restaurantes"or["Bares", "Restaurantes"]- limit
integer(optional)Filter the search to a set of results. The default value is 10.
- offset
integer(optional)Filter the search to a set of results. The default value is 0. The service also accept ‘page’ to get the set of results by page.
POST https://api.ropi.porto.digital/CitySDK/categories/list
Requests
Headers
Content-Type: multipart/mixed; boundary=plug_conn_test
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc3OCwiaWF0IjoxNTc1MzA3NTc4LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6IjQ0MTM4NTZhLWE0ZWItNDJiNC04MzljLTJlYjIxZDhmMzFhYyIsIm5iZiI6MTU3NTMwNzU3Nywic3ViIjoiNWRlNTQ5M2E1NWI0ZmMyMWMwZmZjNDBjIiwidHlwIjoiYWNjZXNzIn0.wHTGmaFDVLMW0_bx6H8XP7AwvFQT0c7gEOaV-ktfHHPjVbRhsQFIDMpoPYT_J1ExarA9-9GUuAwBo9nelKVT9g
accept: application/jsonBody
{
"category": {
"author": {
"term": "primary",
"value": "some author"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c752"
}
],
"href": "some href",
"label": [
{
"term": "primary",
"value": "some label"
}
],
"lang": "some lang",
"license": {
"term": "primary",
"value": "some license"
},
"link": [
{
"href": "some link href",
"term": "icon",
"value": "some link"
}
],
"scheme": "some scheme",
"term": "some term",
"type": "some type",
"value": "some value"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd5WBIqbthl1MAAIQB
location: /CitySDK/categories/poi/5de5493a55b4fc21c0ffc40eBody
{
"categories": {
"author": {
"term": "primary",
"value": "some author"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c752"
}
],
"created": "2019-12-02T17:26:18.000000Z",
"href": "some href",
"id": "5de5493a55b4fc21c0ffc40e",
"label": [
{
"term": "primary",
"value": "some label"
}
],
"lang": "some lang",
"license": {
"term": "primary",
"value": "some license"
},
"link": [
{
"href": "some link href",
"term": "icon",
"value": "some link"
}
],
"scheme": "some scheme",
"term": "some term",
"type": "some type",
"value": "some value"
}
}Headers
Content-Type: multipart/mixed; boundary=plug_conn_test
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc3NywiaWF0IjoxNTc1MzA3NTc3LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6Ijk3NGI5MmY5LWI3ZTItNDdlNC05ZmQzLTRiZDM2Nzg2NDU1OCIsIm5iZiI6MTU3NTMwNzU3Niwic3ViIjoiNWRlNTQ5Mzk1NWI0ZmMyMWMwMWRmMjlmIiwidHlwIjoiYWNjZXNzIn0.CQx6gLauzqUNVqnmRensmDhBt5LhTvx1b9_CBWvjddULw6hwy7Z_Mz59r7tX8tH1TwZDvF1qjgX7cPbY8z-suA
accept: application/jsonBody
{
"category": {
"author": {
"term": "primary",
"value": "some author"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c752"
}
],
"href": "some href",
"label": [
{
"term": "primary",
"value": "some label"
}
],
"lang": "some lang",
"license": {
"term": "primary",
"value": "some license"
},
"link": [
{
"href": "some link href",
"term": "icon",
"value": "some link"
}
],
"scheme": "some scheme",
"term": "some term",
"type": "some type",
"value": "some value"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd5UuIFwGG-PYAAIJh
location: /CitySDK/categories/event/5de5493955b4fc21c01df2a1Body
{
"categories": {
"author": {
"term": "primary",
"value": "some author"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c752"
}
],
"created": "2019-12-02T17:26:17.000000Z",
"href": "some href",
"id": "5de5493955b4fc21c01df2a1",
"label": [
{
"term": "primary",
"value": "some label"
}
],
"lang": "some lang",
"license": {
"term": "primary",
"value": "some license"
},
"link": [
{
"href": "some link href",
"term": "icon",
"value": "some link"
}
],
"scheme": "some scheme",
"term": "some term",
"type": "some type",
"value": "some value"
}
}Create categoryPOST/CitySDK/categories/{list}
Used to create a new category.
URI Parameters
- list
string(required)The category list to create
"poi"or"event".- category
map(required)The category data.
Delete a category ¶
DELETE https://api.ropi.porto.digital/CitySDK/categories/list/id
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc3OCwiaWF0IjoxNTc1MzA3NTc4LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImY0OWQyMGM2LTY5ZWMtNDJmZC1hZmNhLTRlZDQ4ZWFiZTVmNSIsIm5iZiI6MTU3NTMwNzU3Nywic3ViIjoiNWRlNTQ5M2E1NWI0ZmMyMWMwZmZjNDI1IiwidHlwIjoiYWNjZXNzIn0.R45LpJymi7fQLGpWoBXhfNqMT3Ow13Cu3fyN9Ndw8CZeML2BJBKHXaLNpOKDMzEvThlkqnnXq0V_SHR9XI_Ceg
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd5XkrGlVOubEAAIXBBody
"Event Category with id '5de5493a55b4fc21c0ffc427' removed successfully."Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc3NywiaWF0IjoxNTc1MzA3NTc3LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6Ijg0YTI0ODMxLWNmZjItNGZjZi05YmQ2LTYzYWQzOWEwMGYwNCIsIm5iZiI6MTU3NTMwNzU3Niwic3ViIjoiNWRlNTQ5Mzk1NWI0ZmMyMWMwMWRmMjg4IiwidHlwIjoiYWNjZXNzIn0.jRpE_99IlkvlGPZbYWbjCw3zS0JnP1bS2Djz-HynKzD4cRcN_iFUrkKydI9RVl_KDQ1oyU0CsaaqqgFXTAP4-Q
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd5TKzIyDmgEQAAIDBBody
"POI Category with id '5de5493955b4fc21c01df28a' removed successfully."Delete a categoryDELETE/CitySDK/categories/{list}/{id}
Used to delete a category.
URI Parameters
- list
string(required)The category list to delete
"poi"or"event".- id
string(required)The category ID to delete.
GET https://api.ropi.porto.digital/CitySDK/categories/list/id
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc3OCwiaWF0IjoxNTc1MzA3NTc4LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6IjMwMGQyYjU4LWYxNTctNGFmMS04YzkxLTA3NjE3OWJjMDI2ZiIsIm5iZiI6MTU3NTMwNzU3Nywic3ViIjoiNWRlNTQ5M2E1NWI0ZmMyMWMwZmZjNDMxIiwidHlwIjoiYWNjZXNzIn0.tkL-y41vxL7BwgAJnBsBE25qTKwOIgvRYLsk1giN-j0lfDUZyG18Bg7kaqrk7QKE5fWvTQdijhPRukw9fmomZw
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd5YbsSz64mrwAAIbBBody
{
"categories": {
"author": {
"term": "primary",
"value": "some author"
},
"base": "some base",
"category": [
{
"author": {
"term": "primary",
"value": "some author"
},
"created": "2019-12-02T17:26:18.000000Z",
"id": "5c40651ea8f44b313604c752",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "Categoriateste5"
},
{
"lang": "en-GB",
"term": "primary",
"value": "Categorytest5"
}
],
"link": [
{
"term": "parent",
"value": "5de5493a55b4fc21c0ffc433"
}
],
"term": "category"
}
],
"created": "2019-12-02T17:26:18.000000Z",
"href": "some href",
"id": "5de5493a55b4fc21c0ffc433",
"label": [
{
"term": "primary",
"value": "some label"
}
],
"lang": "some lang",
"license": {
"term": "primary",
"value": "some license"
},
"link": [
{
"href": "some link href",
"term": "icon",
"value": "some link"
}
],
"scheme": "some scheme",
"term": "some term",
"type": "some type",
"value": "some value"
}
}Get category by IDGET/CitySDK/categories/{list}/{id}
Used to get a category by ID.
URI Parameters
- list
string(required)The category list to retrieve
"poi"or"event".- id
string(required)The category ID to retrieve.
PUT https://api.ropi.porto.digital/CitySDK/categories/list/id
Requests
Headers
Content-Type: multipart/mixed; boundary=plug_conn_test
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc3OSwiaWF0IjoxNTc1MzA3NTc5LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6IjQ5MzU5MjA1LWE5MmUtNDFiYS05MTNmLWVlMTk1MWI5ZjY2MCIsIm5iZiI6MTU3NTMwNzU3OCwic3ViIjoiNWRlNTQ5M2I1NWI0ZmMyMWMwMjY1YjZjIiwidHlwIjoiYWNjZXNzIn0.XV-pI-lHhsF9VPHHURQ6EcU1L0C3IMOALhskBskw848nlTazNKAd6FEuG3htrOuLV8zAYbvRRyz3GxmvRlIV8Q
accept: application/jsonBody
{
"category": {
"author": {
"term": "secondary",
"value": "some updated author"
},
"base": "some updated base",
"category": [
{
"id": "5c40651ea8f44b313604c753"
}
],
"href": "some updated href",
"label": [
{
"term": "secondary",
"value": "some updated label"
}
],
"lang": "some updated lang",
"license": {
"term": "edit",
"value": "some updated license"
},
"link": [
{
"href": "some updated link href",
"term": "edit",
"value": "some updated link"
}
],
"scheme": "some updated scheme",
"term": "some updated term",
"type": "some updated type",
"value": "some updated value"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd5bP7As23hk0AAImBBody
{
"categories": {
"author": {
"term": "secondary",
"value": "some updated author"
},
"base": "some updated base",
"category": [
{
"id": "5c40651ea8f44b313604c753"
}
],
"created": "2019-12-02T17:26:19.000000Z",
"href": "some updated href",
"id": "5de5493b55b4fc21c0265b6e",
"label": [
{
"term": "secondary",
"value": "some updated label"
}
],
"lang": "some updated lang",
"license": {
"term": "edit",
"value": "some updated license"
},
"link": [
{
"href": "some updated link href",
"term": "edit",
"value": "some updated link"
}
],
"scheme": "some updated scheme",
"term": "some updated term",
"type": "some updated type",
"updated": "2019-12-02T17:26:19.572268Z",
"value": "some updated value"
}
}Headers
Content-Type: multipart/mixed; boundary=plug_conn_test
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc3OSwiaWF0IjoxNTc1MzA3NTc5LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImJlYTE2Mjk2LTYwMDUtNGVmOS1hYTRlLWRlYzc0MzRlOTI1NCIsIm5iZiI6MTU3NTMwNzU3OCwic3ViIjoiNWRlNTQ5M2I1NWI0ZmMyMWMwMjY1YjViIiwidHlwIjoiYWNjZXNzIn0.Zxq3phfU-OrG1P2b9cnZgV3DnMVTp-8BA8UDzxPomMpL0kcBjln0dBQHRisXHv4okqzrboUoeil5IBmHo-_MSA
accept: application/jsonBody
{
"category": {
"author": {
"term": "secondary",
"value": "some updated author"
},
"base": "some updated base",
"category": [
{
"id": "5c40651ea8f44b313604c753"
}
],
"href": "some updated href",
"label": [
{
"term": "secondary",
"value": "some updated label"
}
],
"lang": "some updated lang",
"license": {
"term": "edit",
"value": "some updated license"
},
"link": [
{
"href": "some updated link href",
"term": "edit",
"value": "some updated link"
}
],
"scheme": "some updated scheme",
"term": "some updated term",
"type": "some updated type",
"value": "some updated value"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd5aFTXLO-0ZwAAIgBBody
{
"categories": {
"author": {
"term": "secondary",
"value": "some updated author"
},
"base": "some updated base",
"category": [
{
"id": "5c40651ea8f44b313604c753"
}
],
"created": "2019-12-02T17:26:19.000000Z",
"href": "some updated href",
"id": "5de5493b55b4fc21c0265b5d",
"label": [
{
"term": "secondary",
"value": "some updated label"
}
],
"lang": "some updated lang",
"license": {
"term": "edit",
"value": "some updated license"
},
"link": [
{
"href": "some updated link href",
"term": "edit",
"value": "some updated link"
}
],
"scheme": "some updated scheme",
"term": "some updated term",
"type": "some updated type",
"updated": "2019-12-02T17:26:19.256925Z",
"value": "some updated value"
}
}Update categoryPUT/CitySDK/categories/{list}/{id}
Used to update a category.
URI Parameters
- list
string(required)The category list to update
"poi"or"event".- id
string(required)The category ID to update.
- category
map(required)The category update data.
Set category as deleted ¶
PATCH https://api.ropi.porto.digital/CitySDK/categories/list/set_deleted/id
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc3OSwiaWF0IjoxNTc1MzA3NTc5LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6IjFiYzI2OGI2LTdhNzYtNGFkZi1iYmRkLTlmNTQ4OGMxOWUyNSIsIm5iZiI6MTU3NTMwNzU3OCwic3ViIjoiNWRlNTQ5M2I1NWI0ZmMyMWMwMjY1YjY5IiwidHlwIjoiYWNjZXNzIn0.BaFae2H4lPVWIblYXr3nzQgfxZDciTai55FznntCvSfZJXXRQ__w55vY03HCKgKiBkF_sbu7TM-IyPPaM58FKA
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd5bB8JlgrZQAAAIkhBody
{
"categories": {
"author": {
"term": "primary",
"value": "some author"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c752"
}
],
"created": "2019-12-02T17:26:19.000000Z",
"deleted": "2019-12-02T17:26:19.511974Z",
"href": "some href",
"id": "5de5493b55b4fc21c0265b6b",
"label": [
{
"term": "primary",
"value": "some label"
}
],
"lang": "some lang",
"license": {
"term": "primary",
"value": "some license"
},
"link": [
{
"href": "some link href",
"term": "icon",
"value": "some link"
}
],
"scheme": "some scheme",
"term": "some term",
"type": "some type",
"value": "some value"
}
}Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc3NywiaWF0IjoxNTc1MzA3NTc3LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImRhYWM0MGJiLTIzYzQtNDMxOS04MWRmLTc5ODZjMzRjNGYxOSIsIm5iZiI6MTU3NTMwNzU3Niwic3ViIjoiNWRlNTQ5Mzk1NWI0ZmMyMWMwMWRmMmE5IiwidHlwIjoiYWNjZXNzIn0.jIk54VRAZUogM1SHLV_Rzwlfu6m10o3IOZez-ngb9H-fQfdSsjz0Y-tKnGa20vE2-6PhUmxMVcYLa0FlY5eIGg
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd5ViGvYOipDcAAINhBody
{
"categories": {
"author": {
"term": "primary",
"value": "some author"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c752"
}
],
"created": "2019-12-02T17:26:18.000000Z",
"deleted": "2019-12-02T17:26:18.037816Z",
"href": "some href",
"id": "5de5493a55b4fc21c0ffc408",
"label": [
{
"term": "primary",
"value": "some label"
}
],
"lang": "some lang",
"license": {
"term": "primary",
"value": "some license"
},
"link": [
{
"href": "some link href",
"term": "icon",
"value": "some link"
}
],
"scheme": "some scheme",
"term": "some term",
"type": "some type",
"value": "some value"
}
}Set category as deletedPATCH/CitySDK/categories/{list}/set_deleted/{id}
Used to set the category as deleted.
URI Parameters
- list
string(required)The category list to set as deleted
"poi"or"event".- id
string(required)The category ID to set as deleted.
Event services ¶
The list of services available for interacting with the ROPI API events.
List events ¶
GET https://api.ropi.porto.digital/CitySDK/events
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc2MiwiaWF0IjoxNTc1MzA3NTYyLCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImYyYTA3MjRkLTYwYjktNGIzNi1iOTMwLWNjNGIzMGIzY2VlMSIsIm5iZiI6MTU3NTMwNzU2MSwic3ViIjoiNWRlNTQ5MmE1NWI0ZmMyMWMwYmU0OWFlIiwidHlwIjoiYWNjZXNzIn0.tr86fUABAZemS4XF0BXruujlG7z01OzZpehVeteiYswtQii-2N8kagbLTVQ3Kv5F7FaZJW70jhxQ2HAJlztYeQ
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd4bRYyj-XfYQAAHKBBody
{
"events": [
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c751",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste4"
},
{
"id": "5c40651ea8f44b313604c751",
"lang": "en-GB",
"term": "category",
"value": "Categorytest4"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste6"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "en-GB",
"term": "category",
"value": "Categorytest6"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste7"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "en-GB",
"term": "category",
"value": "Categorytest7"
}
],
"created": "2019-12-02T17:26:02.000000Z",
"description": [
{
"lang": "pt-PT",
"type": "x-citysdk/themes",
"value": "some theme"
},
{
"lang": "pt-PT",
"type": "x-citysdk/segments",
"value": "some segment"
}
],
"id": "5c40651ea8f44b313604c741",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label"
}
],
"link": [
{
"term": "edit",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c745"
},
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
}
],
"location": {
"point": [
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
},
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
},
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
},
{
"Point": {
"posList": "41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
},
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
},
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
},
{
"SimplePolygon": {
"posList": "40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194,42.7623018491608 -13.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
}
],
"relationship": [
{
"description": [
{
"lang": "pt-PT",
"value": "some description1"
}
],
"label": [
{
"lang": "pt-PT",
"value": "some label1"
}
],
"targetPOI": "5c40651ea8f44b313604c742",
"term": "equals",
"value": "some relationship"
},
{
"label": [
{
"lang": "pt-PT",
"value": "some label3"
}
],
"targetPOI": "5c40651ea8f44b313604c744",
"term": "within",
"value": "some relationship"
}
],
"value": "some location"
},
"tags": [
"tag1",
"tag2"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//ddaysoftware.com//NONSGML DDay.iCal 1.0//EN\r\nBEGIN:VEVENT\r\nDTEND:20160312T235900\r\nDTSTART:20160312T093000\r\nSEQUENCE:0\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
]
},
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base1",
"category": [
{
"id": "5c40651ea8f44b313604c752",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste5"
},
{
"id": "5c40651ea8f44b313604c752",
"lang": "en-GB",
"term": "category",
"value": "Categorytest5"
}
],
"created": "2019-12-02T17:26:02.000000Z",
"description": [
{
"lang": "pt-PT",
"type": "x-citysdk/themes",
"value": "some theme"
},
{
"lang": "pt-PT",
"type": "x-citysdk/segments",
"value": "some segment"
}
],
"id": "5c40651ea8f44b313604c742",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label1"
}
],
"link": [
{
"term": "edit",
"value": "some link1"
},
{
"term": "search",
"value": "some code1"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c745"
}
],
"location": {
"point": [
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
},
{
"Point": {
"posList": "41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
},
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
},
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
},
{
"SimplePolygon": {
"posList": "40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194,42.7623018491608 -13.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
},
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
},
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
}
],
"relationship": [
{
"description": [
{
"lang": "pt-PT",
"value": "some description"
}
],
"label": [
{
"lang": "pt-PT",
"value": "some label"
}
],
"targetPOI": "5c40651ea8f44b313604c741",
"term": "within",
"value": "some relationship"
},
{
"description": [
{
"lang": "pt-PT",
"value": "some description2"
}
],
"label": [
{
"lang": "pt-PT",
"value": "some label2"
}
],
"targetPOI": "5c40651ea8f44b313604c743",
"term": "contains",
"value": "some relationship"
},
{
"label": [
{
"lang": "pt-PT",
"value": "some label4"
}
],
"targetPOI": "5c40651ea8f44b313604c745",
"term": "equals",
"value": "some relationship"
}
],
"value": "some location1"
},
"tags": [
"tag3"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//ddaysoftware.com//NONSGML DDay.iCal 1.0//EN\r\nBEGIN:VEVENT\r\nDTEND:20160313T235900\r\nDTSTART:20160313T093000\r\nSEQUENCE:0\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
]
},
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base2",
"category": [
{
"id": "5c40651ea8f44b313604c751",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste4"
},
{
"id": "5c40651ea8f44b313604c751",
"lang": "en-GB",
"term": "category",
"value": "Categorytest4"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste6"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "en-GB",
"term": "category",
"value": "Categorytest6"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste7"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "en-GB",
"term": "category",
"value": "Categorytest7"
}
],
"created": "2019-12-02T17:26:02.000000Z",
"description": [
{
"lang": "pt-PT",
"type": "x-citysdk/themes",
"value": "some theme"
},
{
"lang": "pt-PT",
"type": "x-citysdk/segments",
"value": "some segment"
}
],
"id": "5c40651ea8f44b313604c743",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label2"
}
],
"link": [
{
"term": "parent",
"value": "5c40651ea8f44b313604c745"
},
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
}
],
"location": {
"relationship": [
{
"label": [
{
"lang": "pt-PT",
"value": "some label3"
}
],
"targetPOI": "5c40651ea8f44b313604c744",
"term": "within",
"value": "some relationship"
}
]
},
"tags": [
"tag1",
"tag4"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//ddaysoftware.com//NONSGML DDay.iCal 1.0//EN\r\nBEGIN:VEVENT\r\nDTEND:20160314T235900\r\nDTSTART:20160314T093000\r\nSEQUENCE:0\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
]
},
{
"active": false,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base3",
"category": [
{
"id": "5c40651ea8f44b313604c751",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste4"
},
{
"id": "5c40651ea8f44b313604c751",
"lang": "en-GB",
"term": "category",
"value": "Categorytest4"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste6"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "en-GB",
"term": "category",
"value": "Categorytest6"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste7"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "en-GB",
"term": "category",
"value": "Categorytest7"
}
],
"created": "2019-12-02T17:26:02.000000Z",
"id": "5c40651ea8f44b313604c744",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label3"
}
],
"link": [
{
"term": "search",
"value": "some code2"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c745"
},
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
}
],
"location": {
"point": [
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"relationship": [
{
"description": [
{
"lang": "pt-PT",
"value": "some description2"
}
],
"label": [
{
"lang": "pt-PT",
"value": "some label2"
}
],
"targetPOI": "5c40651ea8f44b313604c743",
"term": "contains",
"value": "some relationship"
}
],
"value": "some location2"
},
"tags": [
"tag1",
"tag5"
],
"time": [
{
"term": "instant",
"type": "text/icalendar",
"value": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//ddaysoftware.com//NONSGML DDay.iCal 1.0//EN\r\nBEGIN:VEVENT\r\nDTEND:20160314T235900\r\nDTSTART:20160314T093000\r\nSEQUENCE:0\r\nRRULE:FREQ=DAILY;UNTIL=20160320T235900;INTERVAL=2\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
]
},
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base4",
"category": [
{
"id": "5c40651ea8f44b313604c751",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste4"
},
{
"id": "5c40651ea8f44b313604c751",
"lang": "en-GB",
"term": "category",
"value": "Categorytest4"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste6"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "en-GB",
"term": "category",
"value": "Categorytest6"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste7"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "en-GB",
"term": "category",
"value": "Categorytest7"
}
],
"created": "2019-12-02T17:26:02.000000Z",
"id": "5c40651ea8f44b313604c745",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label4"
}
],
"link": [
{
"term": "parent",
"value": "5c40651ea8f44b313604c741"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c742"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c743"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c744"
},
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
}
],
"tags": [
"tag1",
"tag5"
],
"time": [
{
"term": "start",
"type": "text/plain",
"value": "some time"
}
]
}
]
}List eventsGET/CitySDK/events
Used to obtain the list of events.
URI Parameters
- active
boolean(optional)Search active/inactive POIs. If set to
"true"only gets active POIs and if set to"false"only gets inactive POIs. If this parameter is ommited, it returns both active and inactive POIs. This will only work as described above if you are authenticated. If not, you will always get only the active POIs.- category
string(optional)Search using categories. Eg:
"Museus, Restaurantes"or["Museus", "Restaurantes"]- tags
string(optional)Search using tags. Eg:
"tag1, tag2"or["tag1", "tag2"]- name
string(optional)Search using name. Eg:
"Festival das Cores, Festival da Francesinha"or["Festival das Cores", "Festival da Francesinha"]- dtstart
string(optional)Search using a start date. The format is: YYYY-MM-DD[THH:mm:ss]. Eg
"2012-11-03"or"2013-01-01T12:00:00"- dtend
string(optional)Search using an end date. The format is: YYYY-MM-DD[THH:mm:ss]. Eg
"2012-11-03"or"2013-01-01T12:00:00"- recurring
boolean(optional)Search for recurrent events. If set to
"true"only gets recurrent events and if set to"false"only gets non-recurrent events. If this parameter is ommited, it returns both recurrent and non-recurrent events.- coords
string(optional)Search using coordinates. If it is a single point, the format is: "lat lon {radius}". If it is multiple points, the format is "lat lon, lat lon". Eg:
"38.70962513631028 -9.136762619018555 250"or"38.70962513631028 -9.136762619018555, 39.70962513631028 -8.136762619018555"- custom
string(optional)Search using multiple custom fields (in json format). "!" can be used before the custom search key to negate the search. Eg:
"{ "label.value": ["Festival das Cores", "Festival da Francesinha"], "time.term": "open", "location.relationship": { "value": ["some relationship", "some other relationship"], "targetPOI": "5c40651ea8f44b313604c741" }, "description": [ { "value": "some theme", "type": "x-citysdk/themes" }, { "value": ["some segment", "some segment1"], "type": "x-citysdk/segments" } ], "!tags": ["some tag", "some other tag"] }"- limit
integer(optional)Filter the search to a set of results. The default value is 10.
- offset
integer(optional)Filter the search to a set of results. The default value is 0. The service also accept ‘page’ to get the set of results by page.
POST https://api.ropi.porto.digital/CitySDK/events
Requests
Headers
Content-Type: multipart/mixed; boundary=plug_conn_test
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc2NSwiaWF0IjoxNTc1MzA3NTY1LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImU4OWFjNGUwLThhMWMtNDYxNC05MzY2LTBjOTQ3YzAzNjUxNCIsIm5iZiI6MTU3NTMwNzU2NCwic3ViIjoiNWRlNTQ5MmQ1NWI0ZmMyMWMwMDU3YTBiIiwidHlwIjoiYWNjZXNzIn0.Kwm-cYNA_wtMBkBQDFLBvh35juSQe6jLOcl5Kywnsh431ilUPvNgLTIRTetIpUWUZ2qfvpWsX-sFsmFV8XfpSA
accept: application/jsonBody
{
"event": {
"author": {
"term": "primary",
"value": "some author"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c748"
}
],
"description": [
{
"type": "x-citysdk/price",
"value": "some description"
}
],
"href": "some href",
"label": [
{
"term": "primary",
"value": "some label"
}
],
"lang": "some lang",
"license": {
"term": "primary",
"value": "some license"
},
"link": [
{
"term": "icon",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c742"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c743"
}
],
"location": {
"address": {
"type": "text/vcard",
"value": "some address"
},
"line": [
{
"LineString": {
"posList": "some line posList"
},
"value": "some line"
}
],
"point": [
{
"Point": {
"posList": "38.7623018491608 -9.09537155864194"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194"
},
"value": "some polygon"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c741",
"term": "contains",
"value": "some relationship"
}
],
"value": "some location"
},
"metadata": "some metadata",
"tags": [
"some tag"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//ddaysoftware.com//NONSGML DDay.iCal 1.0//EN\r\nBEGIN:VEVENT\r\nDTEND:20160312T235900\r\nDTSTART:20160312T093000\r\nSEQUENCE:0\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
],
"type": "some type",
"value": "some value"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd4mTJBFRxGSMAAHUB
location: /CitySDK/events/5de5492d55b4fc21c0057a14Body
{
"events": {
"active": false,
"author": {
"term": "primary",
"value": "some author"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c748"
}
],
"created": "2019-12-02T17:26:05.000000Z",
"description": [
{
"type": "x-citysdk/price",
"value": "some description"
}
],
"href": "some href",
"id": "5de5492d55b4fc21c0057a14",
"label": [
{
"term": "primary",
"value": "some label"
}
],
"lang": "some lang",
"license": {
"term": "primary",
"value": "some license"
},
"link": [
{
"term": "icon",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c742"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c743"
}
],
"location": {
"address": {
"type": "text/vcard",
"value": "some address"
},
"line": [
{
"LineString": {
"posList": "some line posList",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some line"
}
],
"point": [
{
"Point": {
"posList": "38.7623018491608 -9.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c741",
"term": "contains",
"value": "some relationship"
}
],
"value": "some location"
},
"metadata": "some metadata",
"tags": [
"some tag"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//ddaysoftware.com//NONSGML DDay.iCal 1.0//EN\r\nBEGIN:VEVENT\r\nDTEND:20160312T235900\r\nDTSTART:20160312T093000\r\nSEQUENCE:0\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
],
"type": "some type",
"value": "some value"
}
}Create eventPOST/CitySDK/events
Used to create a new event.
URI Parameters
- event
map(required)The event data.
Delete an event ¶
DELETE https://api.ropi.porto.digital/CitySDK/events/id
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc2NywiaWF0IjoxNTc1MzA3NTY3LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6IjdhMDJhZGE3LWVkMTEtNGI2Mi1iMTY5LWUwMTk4NzZhOGNhYiIsIm5iZiI6MTU3NTMwNzU2Niwic3ViIjoiNWRlNTQ5MmY1NWI0ZmMyMWMwYTNhOWEyIiwidHlwIjoiYWNjZXNzIn0.AoB6wk_FC-y_gBdu9DuKC0OSFczbCX-eYddYf892xwt-bKKRPJdPz2TVarEWHSkM1Bs8WukYKGsHRwgoU85Mqw
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd4uL-uBZrZNAAAHiBBody
"Event with id '5de5492f55b4fc21c0a3a9ab' removed successfully."Delete an eventDELETE/CitySDK/events/{id}
Used to delete an event.
URI Parameters
- id
string(required)The event ID to delete.
GET https://api.ropi.porto.digital/CitySDK/events/id
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc2NCwiaWF0IjoxNTc1MzA3NTY0LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImM5MWYyYjQzLWUzZTMtNGFmYS04YjZhLTdkMDBmNTgwOGU5NiIsIm5iZiI6MTU3NTMwNzU2Mywic3ViIjoiNWRlNTQ5MmM1NWI0ZmMyMWMwYjEwMWJmIiwidHlwIjoiYWNjZXNzIn0.RHsb6oaJ1sUoEhLzWTzV5yl2sPrqjtTMCDHeWhK0z5g4xB0ctqeZTMQ1I0Z-WxYDkT2FTpQjlmcemoMigW5sEg
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd4kmsFlMfhdcAAHRhBody
{
"events": {
"active": false,
"author": {
"term": "primary",
"value": "some author"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c748",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste1"
},
{
"id": "5c40651ea8f44b313604c748",
"lang": "en-GB",
"term": "category",
"value": "Categorytest1"
}
],
"created": "2019-12-02T17:26:04.000000Z",
"description": [
{
"type": "x-citysdk/price",
"value": "some description"
}
],
"href": "some href",
"id": "5de5492c55b4fc21c0b101c8",
"label": [
{
"term": "primary",
"value": "some label"
}
],
"lang": "some lang",
"license": {
"term": "primary",
"value": "some license"
},
"link": [
{
"term": "icon",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c742"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c743"
},
{
"href": "some category link href",
"term": "icon",
"value": "some category link"
}
],
"location": {
"address": {
"type": "text/vcard",
"value": "some address"
},
"line": [
{
"LineString": {
"posList": "some line posList",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some line"
}
],
"point": [
{
"Point": {
"posList": "38.7623018491608 -9.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
},
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
},
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
},
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
}
],
"relationship": [
{
"description": [
{
"lang": "pt-PT",
"value": "some description"
}
],
"label": [
{
"lang": "pt-PT",
"value": "some label"
}
],
"targetPOI": "5c40651ea8f44b313604c741",
"term": "contains",
"value": "some relationship"
}
],
"value": "some location"
},
"metadata": "some metadata",
"tags": [
"some tag"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//ddaysoftware.com//NONSGML DDay.iCal 1.0//EN\r\nBEGIN:VEVENT\r\nDTEND:20160312T235900\r\nDTSTART:20160312T093000\r\nSEQUENCE:0\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
],
"type": "some type",
"value": "some value"
}
}Get event by IDGET/CitySDK/events/{id}
Used to get an event by ID.
URI Parameters
- id
string(required)The event ID to retrieve.
PUT https://api.ropi.porto.digital/CitySDK/events/id
Requests
Headers
Content-Type: multipart/mixed; boundary=plug_conn_test
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc2NiwiaWF0IjoxNTc1MzA3NTY2LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImIxYmZkMmU3LTM0MjItNGQwYy05YjA0LTUyZDdiNjg5OTE5YiIsIm5iZiI6MTU3NTMwNzU2NSwic3ViIjoiNWRlNTQ5MmU1NWI0ZmMyMWMwMWI3Mzc2IiwidHlwIjoiYWNjZXNzIn0.09GKSyALB3TUidAp764r5-nLuWjBOmyqP-JMegeKZPyuw2bjtoeUgLP1H0PRQk5Hxm2mBbJqqQj409A-f6eVZQ
accept: application/jsonBody
{
"event": {
"active": true,
"author": {
"term": "secondary",
"value": "some updated author"
},
"base": "some updated base",
"category": [
{
"id": "5c40651ea8f44b313604c749"
}
],
"description": [
{
"type": "x-citysdk/capacity",
"value": "some updated description"
}
],
"href": "some updated href",
"label": [
{
"term": "secondary",
"value": "some updated label"
}
],
"lang": "some updated lang",
"license": {
"term": "edit",
"value": "some updated license"
},
"link": [
{
"href": "some updated link",
"term": "edit",
"value": "some updated link"
},
{
"term": "search",
"value": "some updated code"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c742"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c743"
}
],
"location": {
"address": {
"type": "text/directory",
"value": "some updated address"
},
"line": [
{
"LineString": {
"posList": "some updated line posList"
},
"value": "some updated line"
}
],
"point": [
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194"
},
"value": "some updated point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "41.7623018491608 -12.09537155864194,42.7623018491608 -13.09537155864194,43.7623018491608 -14.09537155864194"
},
"value": "some updated polygon"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c742",
"term": "within",
"value": "some updated relationship"
}
],
"value": "some updated location"
},
"metadata": "some updated metadata",
"tags": [
"some updated tag"
],
"time": [
{
"term": "instant",
"type": "text/plain",
"value": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//ddaysoftware.com//NONSGML DDay.iCal 1.0//EN\r\nBEGIN:VEVENT\r\nDTEND:20160313T235900\r\nDTSTART:20160313T093000\r\nSEQUENCE:0\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
],
"type": "some updated type",
"value": "some updated value"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd4q_r-ZjvpLYAAHahBody
{
"events": {
"active": true,
"author": {
"term": "secondary",
"value": "some updated author"
},
"base": "some updated base",
"category": [
{
"id": "5c40651ea8f44b313604c749"
}
],
"created": "2019-12-02T17:26:06.000000Z",
"description": [
{
"type": "x-citysdk/capacity",
"value": "some updated description"
}
],
"href": "some updated href",
"id": "5de5492e55b4fc21c01b737f",
"label": [
{
"term": "secondary",
"value": "some updated label"
}
],
"lang": "some updated lang",
"license": {
"term": "edit",
"value": "some updated license"
},
"link": [
{
"href": "some updated link",
"term": "edit",
"value": "some updated link"
},
{
"term": "search",
"value": "some updated code"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c742"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c743"
}
],
"location": {
"address": {
"type": "text/directory",
"value": "some updated address"
},
"line": [
{
"LineString": {
"posList": "some updated line posList",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some updated line"
}
],
"point": [
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some updated point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "41.7623018491608 -12.09537155864194,42.7623018491608 -13.09537155864194,43.7623018491608 -14.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some updated polygon"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c742",
"term": "within",
"value": "some updated relationship"
}
],
"value": "some updated location"
},
"metadata": "some updated metadata",
"tags": [
"some updated tag"
],
"time": [
{
"term": "instant",
"type": "text/plain",
"value": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//ddaysoftware.com//NONSGML DDay.iCal 1.0//EN\r\nBEGIN:VEVENT\r\nDTEND:20160313T235900\r\nDTSTART:20160313T093000\r\nSEQUENCE:0\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
],
"type": "some updated type",
"updated": "2019-12-02T17:26:06.619850Z",
"value": "some updated value"
}
}Update eventPUT/CitySDK/events/{id}
Used to update an event.
URI Parameters
- id
string(required)The event ID to update.
- event
map(required)The event update data.
Get event relations by ID ¶
GET https://api.ropi.porto.digital/CitySDK/events/id/relation
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc2NywiaWF0IjoxNTc1MzA3NTY3LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImE1MjU3MWRkLTJmZmUtNDlmYS04MGJkLTliMWMxY2UyMWEyNyIsIm5iZiI6MTU3NTMwNzU2Niwic3ViIjoiNWRlNTQ5MmY1NWI0ZmMyMWMwYTNhOWJmIiwidHlwIjoiYWNjZXNzIn0.l3y4ugmGN3Gl0H9kj6BFfC_yo4zNQ1Z_wz7WG6n4QJ-T0sB3bJJsiZRzmaMIS1cSG95xb4TL5KwQScvXTDzsWw
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd4v6KBlvKMTMAAHlBBody
{
"events": [
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base2",
"category": [
{
"id": "5c40651ea8f44b313604c751",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste4"
},
{
"id": "5c40651ea8f44b313604c751",
"lang": "en-GB",
"term": "category",
"value": "Categorytest4"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste6"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "en-GB",
"term": "category",
"value": "Categorytest6"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste7"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "en-GB",
"term": "category",
"value": "Categorytest7"
}
],
"created": "2019-12-02T17:26:07.000000Z",
"description": [
{
"lang": "pt-PT",
"type": "x-citysdk/themes",
"value": "some theme"
},
{
"lang": "pt-PT",
"type": "x-citysdk/segments",
"value": "some segment"
}
],
"id": "5c40651ea8f44b313604c743",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label2"
}
],
"link": [
{
"term": "parent",
"value": "5c40651ea8f44b313604c745"
},
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
}
],
"location": {
"relationship": [
{
"label": [
{
"lang": "pt-PT",
"value": "some label3"
}
],
"targetPOI": "5c40651ea8f44b313604c744",
"term": "within",
"value": "some relationship"
}
]
},
"tags": [
"tag1",
"tag4"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//ddaysoftware.com//NONSGML DDay.iCal 1.0//EN\r\nBEGIN:VEVENT\r\nDTEND:20160314T235900\r\nDTSTART:20160314T093000\r\nSEQUENCE:0\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
]
},
{
"active": false,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base3",
"category": [
{
"id": "5c40651ea8f44b313604c751",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste4"
},
{
"id": "5c40651ea8f44b313604c751",
"lang": "en-GB",
"term": "category",
"value": "Categorytest4"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste6"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "en-GB",
"term": "category",
"value": "Categorytest6"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste7"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "en-GB",
"term": "category",
"value": "Categorytest7"
}
],
"created": "2019-12-02T17:26:07.000000Z",
"id": "5c40651ea8f44b313604c744",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label3"
}
],
"link": [
{
"term": "search",
"value": "some code2"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c745"
},
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
}
],
"location": {
"point": [
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"relationship": [
{
"description": [
{
"lang": "pt-PT",
"value": "some description2"
}
],
"label": [
{
"lang": "pt-PT",
"value": "some label2"
}
],
"targetPOI": "5c40651ea8f44b313604c743",
"term": "contains",
"value": "some relationship"
}
],
"value": "some location2"
},
"tags": [
"tag1",
"tag5"
],
"time": [
{
"term": "instant",
"type": "text/icalendar",
"value": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//ddaysoftware.com//NONSGML DDay.iCal 1.0//EN\r\nBEGIN:VEVENT\r\nDTEND:20160314T235900\r\nDTSTART:20160314T093000\r\nSEQUENCE:0\r\nRRULE:FREQ=DAILY;UNTIL=20160320T235900;INTERVAL=2\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
]
}
]
}Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc2NiwiaWF0IjoxNTc1MzA3NTY2LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6IjdhYmQ2MTk0LTUzYTgtNDhiMi1hMDRhLWEzNzFiZjZiMGZmNyIsIm5iZiI6MTU3NTMwNzU2NSwic3ViIjoiNWRlNTQ5MmU1NWI0ZmMyMWMwMWI3MzViIiwidHlwIjoiYWNjZXNzIn0.xBOg9Z4YRXexeyZbVp-7YclkRgqPI4ot7tTrvxN19GRqt9YCOtgiVzdeK1A0ErZfc7z_p09uIE9VoT-6ahVnpw
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd4pSYnIBXJmMAAHYBBody
{
"events": [
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c751",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste4"
},
{
"id": "5c40651ea8f44b313604c751",
"lang": "en-GB",
"term": "category",
"value": "Categorytest4"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste6"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "en-GB",
"term": "category",
"value": "Categorytest6"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste7"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "en-GB",
"term": "category",
"value": "Categorytest7"
}
],
"created": "2019-12-02T17:26:06.000000Z",
"description": [
{
"lang": "pt-PT",
"type": "x-citysdk/themes",
"value": "some theme"
},
{
"lang": "pt-PT",
"type": "x-citysdk/segments",
"value": "some segment"
}
],
"id": "5c40651ea8f44b313604c741",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label"
}
],
"link": [
{
"term": "edit",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c745"
},
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
}
],
"location": {
"point": [
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
},
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
},
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
},
{
"Point": {
"posList": "41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
},
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
},
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
},
{
"SimplePolygon": {
"posList": "40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194,42.7623018491608 -13.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
}
],
"relationship": [
{
"description": [
{
"lang": "pt-PT",
"value": "some description1"
}
],
"label": [
{
"lang": "pt-PT",
"value": "some label1"
}
],
"targetPOI": "5c40651ea8f44b313604c742",
"term": "equals",
"value": "some relationship"
},
{
"label": [
{
"lang": "pt-PT",
"value": "some label3"
}
],
"targetPOI": "5c40651ea8f44b313604c744",
"term": "within",
"value": "some relationship"
}
],
"value": "some location"
},
"tags": [
"tag1",
"tag2"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//ddaysoftware.com//NONSGML DDay.iCal 1.0//EN\r\nBEGIN:VEVENT\r\nDTEND:20160312T235900\r\nDTSTART:20160312T093000\r\nSEQUENCE:0\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
]
},
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base1",
"category": [
{
"id": "5c40651ea8f44b313604c752",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste5"
},
{
"id": "5c40651ea8f44b313604c752",
"lang": "en-GB",
"term": "category",
"value": "Categorytest5"
}
],
"created": "2019-12-02T17:26:06.000000Z",
"description": [
{
"lang": "pt-PT",
"type": "x-citysdk/themes",
"value": "some theme"
},
{
"lang": "pt-PT",
"type": "x-citysdk/segments",
"value": "some segment"
}
],
"id": "5c40651ea8f44b313604c742",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label1"
}
],
"link": [
{
"term": "edit",
"value": "some link1"
},
{
"term": "search",
"value": "some code1"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c745"
}
],
"location": {
"point": [
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
},
{
"Point": {
"posList": "41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
},
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
},
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
},
{
"SimplePolygon": {
"posList": "40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194,42.7623018491608 -13.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
},
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
},
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
}
],
"relationship": [
{
"description": [
{
"lang": "pt-PT",
"value": "some description"
}
],
"label": [
{
"lang": "pt-PT",
"value": "some label"
}
],
"targetPOI": "5c40651ea8f44b313604c741",
"term": "within",
"value": "some relationship"
},
{
"description": [
{
"lang": "pt-PT",
"value": "some description2"
}
],
"label": [
{
"lang": "pt-PT",
"value": "some label2"
}
],
"targetPOI": "5c40651ea8f44b313604c743",
"term": "contains",
"value": "some relationship"
},
{
"label": [
{
"lang": "pt-PT",
"value": "some label4"
}
],
"targetPOI": "5c40651ea8f44b313604c745",
"term": "equals",
"value": "some relationship"
}
],
"value": "some location1"
},
"tags": [
"tag3"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//ddaysoftware.com//NONSGML DDay.iCal 1.0//EN\r\nBEGIN:VEVENT\r\nDTEND:20160313T235900\r\nDTSTART:20160313T093000\r\nSEQUENCE:0\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
]
}
]
}Get event relations by IDGET/CitySDK/events/{id}/{relation}
Used to get an event relations by ID.
URI Parameters
- id
string(required)The event ID to retrieve the relations from.
- relation
string(required)The type of relations to retrieve.
- limit
integer(optional)Filter the search to a set of results. The default value is 10.
- offset
integer(optional)Filter the search to a set of results. The default value is 0. The service also accept ‘page’ to get the set of results by page.
Set event as deleted ¶
PATCH https://api.ropi.porto.digital/CitySDK/events/set_deleted/id
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc2NiwiaWF0IjoxNTc1MzA3NTY2LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImU2MWYyZWNiLTEyOWItNDQxMy1iMjc0LThjN2M2ZTA0MjZkMSIsIm5iZiI6MTU3NTMwNzU2NSwic3ViIjoiNWRlNTQ5MmU1NWI0ZmMyMWMwMWI3MzhhIiwidHlwIjoiYWNjZXNzIn0.bDLTHw8apMdzygBApe3vUwlBazeKe0e3BYOohxlxzsA9KLpFwnxXJMC7qqdrehIiRRJ0NObFpbBCfO0Tj33eSw
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd4sQjErdU4p4AAHeBBody
{
"events": {
"active": false,
"author": {
"term": "primary",
"value": "some author"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c748"
}
],
"created": "2019-12-02T17:26:06.000000Z",
"deleted": "2019-12-02T17:26:06.955606Z",
"description": [
{
"type": "x-citysdk/price",
"value": "some description"
}
],
"href": "some href",
"id": "5de5492e55b4fc21c01b7393",
"label": [
{
"term": "primary",
"value": "some label"
}
],
"lang": "some lang",
"license": {
"term": "primary",
"value": "some license"
},
"link": [
{
"term": "icon",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c742"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c743"
}
],
"location": {
"address": {
"type": "text/vcard",
"value": "some address"
},
"line": [
{
"LineString": {
"posList": "some line posList",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some line"
}
],
"point": [
{
"Point": {
"posList": "38.7623018491608 -9.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c741",
"term": "contains",
"value": "some relationship"
}
],
"value": "some location"
},
"metadata": "some metadata",
"tags": [
"some tag"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//ddaysoftware.com//NONSGML DDay.iCal 1.0//EN\r\nBEGIN:VEVENT\r\nDTEND:20160312T235900\r\nDTSTART:20160312T093000\r\nSEQUENCE:0\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
],
"type": "some type",
"value": "some value"
}
}Set event as deletedPATCH/CitySDK/events/set_deleted/{id}
Used to set the event as deleted.
URI Parameters
- id
string(required)The event ID to set as deleted.
Field Options services ¶
The list of services available for interacting with the ROPI API Field Options.
List field options ¶
GET https://api.ropi.porto.digital/CitySDK/field_options
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc3OSwiaWF0IjoxNTc1MzA3NTc5LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImUyNWZhNmY2LTY3MzgtNDRlOS05NjAyLTE2MDFmNzRlNTMzMCIsIm5iZiI6MTU3NTMwNzU3OCwic3ViIjoiNWRlNTQ5M2I1NWI0ZmMyMWMwMjY1YmIwIiwidHlwIjoiYWNjZXNzIn0.mW0yOCxyuCeINlg_XM7Y6f4VW2wM-dyS7ER3YHYfnZPfd47EanKSiiwapHcTcrFcJoJiVAdqsOTqs4XJc515og
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd5cw8ievRdvYAAIyBBody
{
"field_options": [
{
"created": "2019-12-02T17:26:19.000000Z",
"en_GB": "first en_GB",
"es_ES": "first es_ES",
"id": "5de5493b55b4fc21c0265bb2",
"key": "first key",
"pt_PT": "first pt_PT",
"type": "first type",
"updated": "2019-12-02T17:26:19.000000Z"
},
{
"created": "2019-12-02T17:26:19.000000Z",
"en_GB": "second en_GB",
"es_ES": "second es_ES",
"id": "5de5493b55b4fc21c0265bb3",
"key": "second key",
"pt_PT": "second pt_PT",
"type": "second type",
"updated": "2019-12-02T17:26:19.000000Z"
},
{
"created": "2019-12-02T17:26:19.000000Z",
"en_GB": "third en_GB",
"es_ES": "third es_ES",
"id": "5de5493b55b4fc21c0265bb4",
"key": "third key",
"pt_PT": "third pt_PT",
"type": "third type",
"updated": "2019-12-02T17:26:19.000000Z"
}
]
}List field optionsGET/CitySDK/field_options
Used to obtain the list of field options.
URI Parameters
- type
string(optional)Search using types. Eg:
"type_of_food, rooms"or["type_of_food", "rooms"]- key
string(optional)Search using keys. Eg:
"Francesinha, Suites"or["Francesinha", "Suites"]- limit
integer(optional)Filter the search to a set of results. The default value is 10.
- offset
integer(optional)Filter the search to a set of results. The default value is 0. The service also accept ‘page’ to get the set of results by page.
POST https://api.ropi.porto.digital/CitySDK/field_options
Requests
Headers
Content-Type: multipart/mixed; boundary=plug_conn_test
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc3OSwiaWF0IjoxNTc1MzA3NTc5LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImMzZjNlM2IwLTI3ZDYtNDMyYS04ZGY2LWE5MTFmYzcxNjVkYSIsIm5iZiI6MTU3NTMwNzU3OCwic3ViIjoiNWRlNTQ5M2I1NWI0ZmMyMWMwMjY1YjljIiwidHlwIjoiYWNjZXNzIn0.bIpu5fHwhny2nrrYql-fnNgyhYeEPk3OxehqVUgfUFmLjnN7nzuu1WVcfKKfmvrXV7UcdxT61VYiCVOXAGJY1w
accept: application/jsonBody
{
"field_option": {
"en_GB": "some en_GB",
"es_ES": "some es_ES",
"key": "some key",
"pt_PT": "some pt_PT",
"type": "some type"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd5cSnnS0iM9AAAIth
location: /CitySDK/field_options/5de5493b55b4fc21c0265b9eBody
{
"field_options": {
"created": "2019-12-02T17:26:19.000000Z",
"en_GB": "some en_GB",
"es_ES": "some es_ES",
"id": "5de5493b55b4fc21c0265b9e",
"key": "some key",
"pt_PT": "some pt_PT",
"type": "some type",
"updated": "2019-12-02T17:26:19.000000Z"
}
}Create field optionPOST/CitySDK/field_options
Used to create a new field option.
URI Parameters
- field_option
map(required)The field option data.
Delete a field option ¶
DELETE https://api.ropi.porto.digital/CitySDK/field_options/id
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc3OSwiaWF0IjoxNTc1MzA3NTc5LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImFiNDZhNWZiLWVhZDMtNGEyYy05YTNhLTg4OThjODk4NTQzMSIsIm5iZiI6MTU3NTMwNzU3OCwic3ViIjoiNWRlNTQ5M2I1NWI0ZmMyMWMwMjY1YmFhIiwidHlwIjoiYWNjZXNzIn0.5GW7nzaK0TaJ5dfXJRP0UPXLroKT5mRTPv_pSF7tWzUR3jvrLdBqJf7vo2WsnLK9JAL0A4qI92tIAH9jyOc8bA
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd5cobZWTNIT0AAIwhBody
"Field Option with id '5de5493b55b4fc21c0265bac' removed successfully."Delete a field optionDELETE/CitySDK/field_options/{id}
Used to delete a field option.
URI Parameters
- id
string(required)The field option ID to delete.
GET https://api.ropi.porto.digital/CitySDK/field_options/id
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc3OSwiaWF0IjoxNTc1MzA3NTc5LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6Ijg2MjBmM2JlLWZmN2ItNDU1Yy1iZDFlLTY1ZjMxYTMyMGEwYyIsIm5iZiI6MTU3NTMwNzU3OCwic3ViIjoiNWRlNTQ5M2I1NWI0ZmMyMWMwMjY1YmFkIiwidHlwIjoiYWNjZXNzIn0.2u6I-5cTmcmhW79BrK2RMDKju9Q6Dp4epWJZ9iHCWpZje6pST1bMmTMf_51O1mESdidyh5YmmbKFEq3dOfw4cA
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd5ctDaNFpw9QAAIxhBody
{
"field_options": {
"created": "2019-12-02T17:26:19.000000Z",
"en_GB": "some en_GB",
"es_ES": "some es_ES",
"id": "5de5493b55b4fc21c0265baf",
"key": "some key",
"pt_PT": "some pt_PT",
"type": "some type",
"updated": "2019-12-02T17:26:19.000000Z"
}
}Get field option by IDGET/CitySDK/field_options/{id}
Used to get a field option by ID.
URI Parameters
- id
string(required)The field option ID to retrieve.
PUT https://api.ropi.porto.digital/CitySDK/field_options/id
Requests
Headers
Content-Type: multipart/mixed; boundary=plug_conn_test
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc3OSwiaWF0IjoxNTc1MzA3NTc5LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImNiNWY2MWRhLTUyMzEtNDRiYi04YmRjLWUyODkyNDUzMDIxYiIsIm5iZiI6MTU3NTMwNzU3OCwic3ViIjoiNWRlNTQ5M2I1NWI0ZmMyMWMwMjY1Yjk2IiwidHlwIjoiYWNjZXNzIn0.IP5QzFgL-bAzXBJIZo03aYCZujtnIGj3Y_-JEm4S86OrlZfouhtPfaE_wpZhjP5wg_agr6-DG5bbLZFniXF8dg
accept: application/jsonBody
{
"field_option": {
"en_GB": "some updated en_GB",
"es_ES": "some updated es_ES",
"key": "some updated key",
"pt_PT": "some updated pt_PT",
"type": "some updated type"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd5cJOpExY8y8AAIsBBody
{
"field_options": {
"created": "2019-12-02T17:26:19.000000Z",
"en_GB": "some updated en_GB",
"es_ES": "some updated es_ES",
"id": "5de5493b55b4fc21c0265b98",
"key": "some key",
"pt_PT": "some updated pt_PT",
"type": "some updated type",
"updated": "2019-12-02T17:26:19.000000Z"
}
}Update field optionPUT/CitySDK/field_options/{id}
Used to update a field option.
URI Parameters
- id
string(required)The field option ID to update.
- field_option
map(required)The field option update data.
General search services ¶
The list of services available for searching on the ROPI API POIs and Events.
List points of interest and events by code ¶
GET https://api.ropi.porto.digital/CitySDK/search/code
Responses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd409hqAb_7OsAAHqBBody
{
"events": [
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c751",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste4"
},
{
"id": "5c40651ea8f44b313604c751",
"lang": "en-GB",
"term": "category",
"value": "Categorytest4"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste6"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "en-GB",
"term": "category",
"value": "Categorytest6"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste7"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "en-GB",
"term": "category",
"value": "Categorytest7"
}
],
"created": "2019-12-02T17:26:09.000000Z",
"description": [
{
"lang": "pt-PT",
"type": "x-citysdk/themes",
"value": "some theme"
},
{
"lang": "pt-PT",
"type": "x-citysdk/segments",
"value": "some segment"
}
],
"id": "5c40651ea8f44b313604c741",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label"
}
],
"link": [
{
"term": "edit",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c745"
},
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
}
],
"location": {
"point": [
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
},
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
},
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
},
{
"Point": {
"posList": "41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
},
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
},
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
},
{
"SimplePolygon": {
"posList": "40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194,42.7623018491608 -13.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
}
],
"relationship": [
{
"description": [
{
"lang": "pt-PT",
"value": "some description1"
}
],
"label": [
{
"lang": "pt-PT",
"value": "some label1"
}
],
"targetPOI": "5c40651ea8f44b313604c742",
"term": "equals",
"value": "some relationship"
},
{
"label": [
{
"lang": "pt-PT",
"value": "some label3"
}
],
"targetPOI": "5c40651ea8f44b313604c744",
"term": "within",
"value": "some relationship"
}
],
"value": "some location"
},
"tags": [
"tag1",
"tag2"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//ddaysoftware.com//NONSGML DDay.iCal 1.0//EN\r\nBEGIN:VEVENT\r\nDTEND:20160312T235900\r\nDTSTART:20160312T093000\r\nSEQUENCE:0\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
]
},
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base1",
"category": [
{
"id": "5c40651ea8f44b313604c752",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste5"
},
{
"id": "5c40651ea8f44b313604c752",
"lang": "en-GB",
"term": "category",
"value": "Categorytest5"
}
],
"created": "2019-12-02T17:26:09.000000Z",
"description": [
{
"lang": "pt-PT",
"type": "x-citysdk/themes",
"value": "some theme"
},
{
"lang": "pt-PT",
"type": "x-citysdk/segments",
"value": "some segment"
}
],
"id": "5c40651ea8f44b313604c742",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label1"
}
],
"link": [
{
"term": "edit",
"value": "some link1"
},
{
"term": "search",
"value": "some code1"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c745"
}
],
"location": {
"point": [
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
},
{
"Point": {
"posList": "41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
},
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
},
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
},
{
"SimplePolygon": {
"posList": "40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194,42.7623018491608 -13.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
},
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
},
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
}
],
"relationship": [
{
"description": [
{
"lang": "pt-PT",
"value": "some description"
}
],
"label": [
{
"lang": "pt-PT",
"value": "some label"
}
],
"targetPOI": "5c40651ea8f44b313604c741",
"term": "within",
"value": "some relationship"
},
{
"description": [
{
"lang": "pt-PT",
"value": "some description2"
}
],
"label": [
{
"lang": "pt-PT",
"value": "some label2"
}
],
"targetPOI": "5c40651ea8f44b313604c743",
"term": "contains",
"value": "some relationship"
},
{
"label": [
{
"lang": "pt-PT",
"value": "some label4"
}
],
"targetPOI": "5c40651ea8f44b313604c745",
"term": "equals",
"value": "some relationship"
}
],
"value": "some location1"
},
"tags": [
"tag3"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//ddaysoftware.com//NONSGML DDay.iCal 1.0//EN\r\nBEGIN:VEVENT\r\nDTEND:20160313T235900\r\nDTSTART:20160313T093000\r\nSEQUENCE:0\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
]
}
],
"points_of_interest": [
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c751",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste4"
},
{
"id": "5c40651ea8f44b313604c751",
"lang": "en-GB",
"term": "category",
"value": "Categorytest4"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste6"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "en-GB",
"term": "category",
"value": "Categorytest6"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste7"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "en-GB",
"term": "category",
"value": "Categorytest7"
}
],
"created": "2019-12-02T17:26:09.000000Z",
"description": [
{
"lang": "pt-PT",
"value": "some description"
}
],
"id": "5c40651ea8f44b313604c741",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label"
}
],
"link": [
{
"term": "edit",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c745"
},
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
}
],
"location": {
"point": [
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
},
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
},
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
}
],
"value": "some location"
},
"tags": [
"tag1",
"tag2"
]
},
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base1",
"category": [
{
"id": "5c40651ea8f44b313604c752",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste5"
},
{
"id": "5c40651ea8f44b313604c752",
"lang": "en-GB",
"term": "category",
"value": "Categorytest5"
}
],
"created": "2019-12-02T17:26:09.000000Z",
"description": [
{
"lang": "pt-PT",
"type": "x-citysdk/themes",
"value": "some theme"
},
{
"lang": "pt-PT",
"type": "x-citysdk/segments",
"value": "some segment"
},
{
"lang": "pt-PT",
"value": "some description1"
}
],
"id": "5c40651ea8f44b313604c742",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label1"
}
],
"link": [
{
"term": "edit",
"value": "some link1"
},
{
"term": "search",
"value": "some code1"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c745"
}
],
"location": {
"address": {
"type": "text/vcard",
"value": "some address1"
},
"point": [
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
},
{
"Point": {
"posList": "41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
},
{
"SimplePolygon": {
"posList": "40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194,42.7623018491608 -13.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c741",
"term": "contains",
"value": "some relationship"
}
],
"value": "some location1"
},
"tags": [
"tag3"
],
"time": [
{
"term": "instant",
"type": "text/icalendar",
"value": "some time"
}
]
}
]
}Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd4z4GXaNpVNcAAHpBBody
{
"events": [
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c751",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste4"
},
{
"id": "5c40651ea8f44b313604c751",
"lang": "en-GB",
"term": "category",
"value": "Categorytest4"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste6"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "en-GB",
"term": "category",
"value": "Categorytest6"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste7"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "en-GB",
"term": "category",
"value": "Categorytest7"
}
],
"created": "2019-12-02T17:26:08.000000Z",
"description": [
{
"lang": "pt-PT",
"type": "x-citysdk/themes",
"value": "some theme"
},
{
"lang": "pt-PT",
"type": "x-citysdk/segments",
"value": "some segment"
}
],
"id": "5c40651ea8f44b313604c741",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label"
}
],
"link": [
{
"term": "edit",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c745"
},
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
}
],
"location": {
"point": [
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
},
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
},
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
},
{
"Point": {
"posList": "41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
},
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
},
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
},
{
"SimplePolygon": {
"posList": "40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194,42.7623018491608 -13.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
}
],
"relationship": [
{
"description": [
{
"lang": "pt-PT",
"value": "some description1"
}
],
"label": [
{
"lang": "pt-PT",
"value": "some label1"
}
],
"targetPOI": "5c40651ea8f44b313604c742",
"term": "equals",
"value": "some relationship"
},
{
"label": [
{
"lang": "pt-PT",
"value": "some label3"
}
],
"targetPOI": "5c40651ea8f44b313604c744",
"term": "within",
"value": "some relationship"
}
],
"value": "some location"
},
"tags": [
"tag1",
"tag2"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//ddaysoftware.com//NONSGML DDay.iCal 1.0//EN\r\nBEGIN:VEVENT\r\nDTEND:20160312T235900\r\nDTSTART:20160312T093000\r\nSEQUENCE:0\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
]
},
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base1",
"category": [
{
"id": "5c40651ea8f44b313604c752",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste5"
},
{
"id": "5c40651ea8f44b313604c752",
"lang": "en-GB",
"term": "category",
"value": "Categorytest5"
}
],
"created": "2019-12-02T17:26:08.000000Z",
"description": [
{
"lang": "pt-PT",
"type": "x-citysdk/themes",
"value": "some theme"
},
{
"lang": "pt-PT",
"type": "x-citysdk/segments",
"value": "some segment"
}
],
"id": "5c40651ea8f44b313604c742",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label1"
}
],
"link": [
{
"term": "edit",
"value": "some link1"
},
{
"term": "search",
"value": "some code1"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c745"
}
],
"location": {
"point": [
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
},
{
"Point": {
"posList": "41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
},
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
},
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
},
{
"SimplePolygon": {
"posList": "40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194,42.7623018491608 -13.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
},
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
},
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
}
],
"relationship": [
{
"description": [
{
"lang": "pt-PT",
"value": "some description"
}
],
"label": [
{
"lang": "pt-PT",
"value": "some label"
}
],
"targetPOI": "5c40651ea8f44b313604c741",
"term": "within",
"value": "some relationship"
},
{
"description": [
{
"lang": "pt-PT",
"value": "some description2"
}
],
"label": [
{
"lang": "pt-PT",
"value": "some label2"
}
],
"targetPOI": "5c40651ea8f44b313604c743",
"term": "contains",
"value": "some relationship"
},
{
"label": [
{
"lang": "pt-PT",
"value": "some label4"
}
],
"targetPOI": "5c40651ea8f44b313604c745",
"term": "equals",
"value": "some relationship"
}
],
"value": "some location1"
},
"tags": [
"tag3"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//ddaysoftware.com//NONSGML DDay.iCal 1.0//EN\r\nBEGIN:VEVENT\r\nDTEND:20160313T235900\r\nDTSTART:20160313T093000\r\nSEQUENCE:0\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
]
}
],
"points_of_interest": [
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c751",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste4"
},
{
"id": "5c40651ea8f44b313604c751",
"lang": "en-GB",
"term": "category",
"value": "Categorytest4"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste6"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "en-GB",
"term": "category",
"value": "Categorytest6"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste7"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "en-GB",
"term": "category",
"value": "Categorytest7"
}
],
"created": "2019-12-02T17:26:08.000000Z",
"description": [
{
"lang": "pt-PT",
"value": "some description"
}
],
"id": "5c40651ea8f44b313604c741",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label"
}
],
"link": [
{
"term": "edit",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c745"
},
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
}
],
"location": {
"point": [
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
},
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
},
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
}
],
"value": "some location"
},
"tags": [
"tag1",
"tag2"
]
},
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base1",
"category": [
{
"id": "5c40651ea8f44b313604c752",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste5"
},
{
"id": "5c40651ea8f44b313604c752",
"lang": "en-GB",
"term": "category",
"value": "Categorytest5"
}
],
"created": "2019-12-02T17:26:08.000000Z",
"description": [
{
"lang": "pt-PT",
"type": "x-citysdk/themes",
"value": "some theme"
},
{
"lang": "pt-PT",
"type": "x-citysdk/segments",
"value": "some segment"
},
{
"lang": "pt-PT",
"value": "some description1"
}
],
"id": "5c40651ea8f44b313604c742",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label1"
}
],
"link": [
{
"term": "edit",
"value": "some link1"
},
{
"term": "search",
"value": "some code1"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c745"
}
],
"location": {
"address": {
"type": "text/vcard",
"value": "some address1"
},
"point": [
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
},
{
"Point": {
"posList": "41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
},
{
"SimplePolygon": {
"posList": "40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194,42.7623018491608 -13.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c741",
"term": "contains",
"value": "some relationship"
}
],
"value": "some location1"
},
"tags": [
"tag3"
],
"time": [
{
"term": "instant",
"type": "text/icalendar",
"value": "some time"
}
]
}
]
}List points of interest and events by codeGET/CitySDK/search/{code}
Used to obtain a list of points of interest and events by code.
URI Parameters
- code
string(required)Search using code. Eg:
"www.ibishotel.com, www.coliseu.pt"or["www.ibishotel.com", "www.coliseu.pt"]- limit
integer(optional)Filter the search to a set of results. The default value is 10.
- offset
integer(optional)Filter the search to a set of results. The default value is 0. The service also accept ‘page’ to get the set of results by page.
Pending Point Of Interest Changes services ¶
The list of services available for interacting with the ROPI API Pending POI Changes.
List pending point of interest changes ¶
GET https://api.ropi.porto.digital/CitySDK/pending_poi_changes
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc1OCwiaWF0IjoxNTc1MzA3NTU4LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6IjA0ZDU3OWZjLWVmZjAtNDllMi1hNTU4LTAzODQ5ZDMwYjRhOCIsIm5iZiI6MTU3NTMwNzU1Nywic3ViIjoiNWRlNTQ5MjY1NWI0ZmMyMWMwN2U5OTU2IiwidHlwIjoiYWNjZXNzIn0.wO_6xsxyXs_tWYILsMaeVimTVdxeRT60kQZm4SRAKr1aV8RZqhPMTGGSKRPJN6hUC8OQnl_0q9N4eCQyqFOBhQ
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd4OKDr3Db-v8AAHDBBody
{
"pending_poi_changes": [
{
"created": "2019-12-02T17:25:58.000000Z",
"id": "5de5492655b4fc21c07e9958",
"new_poi_version": {
"active": false,
"base": "some base"
},
"poi_id": "5c40651ea8f44b313604c741",
"updated": "2019-12-02T17:25:58.000000Z"
},
{
"created": "2019-12-02T17:25:58.000000Z",
"id": "5de5492655b4fc21c07e9959",
"new_poi_version": {
"active": false,
"base": "some base2"
},
"poi_id": "5c40651ea8f44b313604c742",
"updated": "2019-12-02T17:25:58.000000Z"
},
{
"created": "2019-12-02T17:25:58.000000Z",
"id": "5de5492655b4fc21c07e995a",
"new_poi_version": {
"active": false,
"base": "some base3"
},
"poi_id": "5c40651ea8f44b313604c743",
"updated": "2019-12-02T17:25:58.000000Z"
}
]
}List pending point of interest changesGET/CitySDK/pending_poi_changes
Used to obtain the list of pending point of interest changes.
URI Parameters
- limit
integer(optional)Filter the search to a set of results. The default value is 10.
- offset
integer(optional)Filter the search to a set of results. The default value is 0. The service also accept ‘page’ to get the set of results by page.
Create pending point of interest change ¶
POST https://api.ropi.porto.digital/CitySDK/pending_poi_changes/hash
Requests
Headers
Content-Type: multipart/mixed; boundary=plug_conn_test
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc1OSwiaWF0IjoxNTc1MzA3NTU5LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6IjQxMWQ2MDU0LTViNjctNDI5Yy05MzdlLWQ5OWU1ZjQ5MGI2ZSIsIm5iZiI6MTU3NTMwNzU1OCwic3ViIjoiNWRlNTQ5Mjc1NWI0ZmMyMWMwYmE0N2E5IiwidHlwIjoiYWNjZXNzIn0.p7zesHQ7x5Jig9tNyid4Hbi2m3S5kfGRos3kcXgcyLd8IOAdwZiU8ILOQRzJoxvErqgOnYbYjatTG1EJHn2nzQ
accept: application/jsonBody
{
"pending_poi_change": {
"author": {
"term": "primary",
"value": "some author"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c748"
}
],
"description": [
{
"type": "x-citysdk/price",
"value": "some description"
}
],
"href": "some href",
"label": [
{
"term": "primary",
"value": "some label"
}
],
"lang": "some lang",
"license": {
"term": "primary",
"value": "some license"
},
"link": [
{
"term": "icon",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c742"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c743"
}
],
"location": {
"address": {
"type": "text/vcard",
"value": "some address"
},
"line": [
{
"LineString": {
"posList": "some line posList"
},
"value": "some line"
}
],
"point": [
{
"Point": {
"posList": "38.7623018491608 -9.09537155864194"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194"
},
"value": "some polygon"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c741",
"term": "contains",
"value": "some relationship"
}
],
"value": "some location"
},
"metadata": "some metadata",
"tags": [
"some tag"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "some time"
}
],
"type": "some type",
"value": "some value"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd4Rewj7WU8nwAAHEh
location: /CitySDK/pending_poi_changes/5de5492755b4fc21c0ba47abBody
{
"pending_poi_changes": {
"created": "2019-12-02T17:25:59.000000Z",
"id": "5de5492755b4fc21c0ba47ab",
"new_poi_version": {
"active": false,
"author": {
"term": "primary",
"value": "some author"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c748"
}
],
"description": [
{
"type": "x-citysdk/price",
"value": "some description"
}
],
"href": "some href",
"label": [
{
"term": "primary",
"value": "some label"
}
],
"lang": "some lang",
"license": {
"term": "primary",
"value": "some license"
},
"link": [
{
"term": "icon",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c742"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c743"
}
],
"location": {
"address": {
"type": "text/vcard",
"value": "some address"
},
"geo_json": [
{
"geometry": {
"coordinates": [
-9.09537155864194,
38.7623018491608
],
"type": "Point"
}
},
{
"geometry": {
"coordinates": [
[
[
-9.09537155864194,
38.7623018491608
],
[
-10.09537155864194,
39.7623018491608
],
[
-11.09537155864194,
40.7623018491608
],
[
-9.09537155864194,
38.7623018491608
]
]
],
"type": "Polygon"
}
},
{
"geometry": {
"coordinates": [
-10.09537155864194,
39.7623018491608
],
"type": "Point"
},
"targetPOI": "5c40651ea8f44b313604c741"
},
{
"geometry": {
"coordinates": [
-11.09537155864194,
40.7623018491608
],
"type": "Point"
},
"targetPOI": "5c40651ea8f44b313604c741"
},
{
"geometry": {
"coordinates": [
[
[
-9.09537155864194,
38.7623018491608
],
[
-10.09537155864194,
39.7623018491608
],
[
-11.09537155864194,
40.7623018491608
],
[
-9.09537155864194,
38.7623018491608
]
]
],
"type": "Polygon"
},
"targetPOI": "5c40651ea8f44b313604c741"
},
{
"geometry": {
"coordinates": [
[
[
-10.09537155864194,
39.7623018491608
],
[
-11.09537155864194,
40.7623018491608
],
[
-12.09537155864194,
41.7623018491608
],
[
-10.09537155864194,
39.7623018491608
]
]
],
"type": "Polygon"
},
"targetPOI": "5c40651ea8f44b313604c741"
}
],
"line": [
{
"LineString": {
"posList": "some line posList",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some line"
}
],
"point": [
{
"Point": {
"posList": "38.7623018491608 -9.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c741",
"term": "contains",
"value": "some relationship"
}
],
"value": "some location"
},
"metadata": "some metadata",
"tags": [
"some tag"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "some time"
}
],
"type": "some type",
"value": "some value"
},
"poi_id": "5c40651ea8f44b313604c741",
"updated": "2019-12-02T17:25:59.000000Z"
}
}Create pending point of interest changePOST/CitySDK/pending_poi_changes/{hash}
Used to create a new pending point of interest change by hash.
URI Parameters
- hash
string(required)The point of interest hash to associate to the pending change.
- pending_poi_change
map(required)The pending point of interest change data.
Delete a pending point of interest change ¶
DELETE https://api.ropi.porto.digital/CitySDK/pending_poi_changes/id
Delete a pending point of interest changeDELETE/CitySDK/pending_poi_changes/{id}
Used to delete a pending point of interest change.
URI Parameters
- id
string(required)The pending point of interest change ID to delete.
GET https://api.ropi.porto.digital/CitySDK/pending_poi_changes/id
Get pending point of interest change by IDGET/CitySDK/pending_poi_changes/{id}
Used to get a pending point of interest change by ID.
URI Parameters
- id
string(required)The pending point of interest change ID to retrieve.
PUT https://api.ropi.porto.digital/CitySDK/pending_poi_changes/id
Update pending point of interest changePUT/CitySDK/pending_poi_changes/{id}
Used to update a pending point of interest change.
URI Parameters
- id
string(required)The pending point of interest change ID to update.
- pending_poi_change
map(required)The pending point of interest change update data.
Point of interest services ¶
The list of services available for interacting with the ROPI API POIs.
List points of interest ¶
GET https://api.ropi.porto.digital/CitySDK/pois
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc1MiwiaWF0IjoxNTc1MzA3NTUyLCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImIyNTM1OWM4LTc2ODctNDBlNy05OWU5LWE4ZjI1ZGE2YTQ1NyIsIm5iZiI6MTU3NTMwNzU1MSwic3ViIjoiNWRlNTQ5MjA1NWI0ZmMyMWMwYjVlMWVkIiwidHlwIjoiYWNjZXNzIn0.kZrmNC2p6OphK2J-qtarTrGrgciJ2gfg6vAnOcSsKuKqPgQVTrtr7xS4G7kVInHxTZY7DpY-EWMr4r-w05Uyxw
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd32YyX3rZGckAAGaBBody
{
"points_of_interest": [
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c751",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste4"
},
{
"id": "5c40651ea8f44b313604c751",
"lang": "en-GB",
"term": "category",
"value": "Categorytest4"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste6"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "en-GB",
"term": "category",
"value": "Categorytest6"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste7"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "en-GB",
"term": "category",
"value": "Categorytest7"
}
],
"created": "2019-12-02T17:25:52.000000Z",
"description": [
{
"lang": "pt-PT",
"value": "some description"
}
],
"hash": "7E9rXaMHQDbuOVVMAvWrU-wU4adupoOYHRMQwpy5",
"id": "5c40651ea8f44b313604c741",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label"
}
],
"link": [
{
"term": "edit",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c745"
},
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
}
],
"location": {
"point": [
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
},
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
},
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
}
],
"value": "some location"
},
"notes": "12",
"tags": [
"tag1",
"tag2"
]
},
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base1",
"category": [
{
"id": "5c40651ea8f44b313604c752",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste5"
},
{
"id": "5c40651ea8f44b313604c752",
"lang": "en-GB",
"term": "category",
"value": "Categorytest5"
}
],
"created": "2019-12-02T17:25:52.000000Z",
"description": [
{
"lang": "pt-PT",
"type": "x-citysdk/themes",
"value": "some theme"
},
{
"lang": "pt-PT",
"type": "x-citysdk/segments",
"value": "some segment"
},
{
"lang": "pt-PT",
"value": "some description1"
}
],
"id": "5c40651ea8f44b313604c742",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label1"
}
],
"link": [
{
"term": "edit",
"value": "some link1"
},
{
"term": "search",
"value": "some code1"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c745"
}
],
"location": {
"address": {
"type": "text/vcard",
"value": "some address1"
},
"point": [
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
},
{
"Point": {
"posList": "41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
},
{
"SimplePolygon": {
"posList": "40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194,42.7623018491608 -13.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c741",
"term": "contains",
"value": "some relationship"
}
],
"value": "some location1"
},
"tags": [
"tag3"
],
"time": [
{
"term": "instant",
"type": "text/icalendar",
"value": "some time"
}
]
},
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base2",
"category": [
{
"id": "5c40651ea8f44b313604c751",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste4"
},
{
"id": "5c40651ea8f44b313604c751",
"lang": "en-GB",
"term": "category",
"value": "Categorytest4"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste6"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "en-GB",
"term": "category",
"value": "Categorytest6"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste7"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "en-GB",
"term": "category",
"value": "Categorytest7"
}
],
"created": "2019-12-02T17:25:52.000000Z",
"description": [
{
"lang": "pt-PT",
"type": "x-citysdk/themes",
"value": "some theme"
},
{
"lang": "pt-PT",
"type": "x-citysdk/segments",
"value": "some segment"
},
{
"lang": "pt-PT",
"value": "some description2"
}
],
"id": "5c40651ea8f44b313604c743",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label2"
}
],
"link": [
{
"term": "parent",
"value": "5c40651ea8f44b313604c745"
},
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
}
],
"location": {
"point": [
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c741",
"term": "contains",
"value": "some relationship"
}
]
},
"tags": [
"tag1",
"tag4"
]
},
{
"active": false,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base3",
"category": [
{
"id": "5c40651ea8f44b313604c751",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste4"
},
{
"id": "5c40651ea8f44b313604c751",
"lang": "en-GB",
"term": "category",
"value": "Categorytest4"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste6"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "en-GB",
"term": "category",
"value": "Categorytest6"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste7"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "en-GB",
"term": "category",
"value": "Categorytest7"
}
],
"created": "2019-12-02T17:25:52.000000Z",
"id": "5c40651ea8f44b313604c744",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label3"
}
],
"link": [
{
"term": "search",
"value": "some code2"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c745"
},
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
}
],
"tags": [
"tag1",
"tag5"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "some time"
}
]
},
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base4",
"category": [
{
"id": "5c40651ea8f44b313604c751",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste4"
},
{
"id": "5c40651ea8f44b313604c751",
"lang": "en-GB",
"term": "category",
"value": "Categorytest4"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste6"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "en-GB",
"term": "category",
"value": "Categorytest6"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste7"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "en-GB",
"term": "category",
"value": "Categorytest7"
}
],
"created": "2019-12-02T17:25:52.000000Z",
"id": "5c40651ea8f44b313604c745",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label4"
}
],
"link": [
{
"term": "parent",
"value": "5c40651ea8f44b313604c741"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c742"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c743"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c744"
},
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
}
],
"tags": [
"tag1",
"tag5"
]
}
]
}List points of interestGET/CitySDK/pois
Used to obtain the list of points of interest.
URI Parameters
- active
boolean(optional)Search active/inactive POIs. If set to
"true"only gets active POIs and if set to"false"only gets inactive POIs. If this parameter is ommited, it returns both active and inactive POIs. This will only work as described above if you are authenticated. If not, you will always get only the active POIs.- category
string(optional)Search using categories. Eg:
"Museus, Restaurantes"or["Museus", "Restaurantes"]- tags
string(optional)Search using tags. Eg:
"tag1, tag2"or["tag1", "tag2"]- complete
string(optional)Search using keyword and get the complete description of the POIs. Eg:
"Porto, Aliados"or["Porto", "Aliados"]- minimal
string(optional)Search using keyword and get the minimal description of the POIs. Eg:
"Porto, Aliados"or["Porto", "Aliados"]- coords
string(optional)Search using coordinates. If it is a single point, the format is: "lat lon {radius}". If it is multiple points, the format is "lat lon, lat lon". Eg:
"38.70962513631028 -9.136762619018555 250"or"38.70962513631028 -9.136762619018555, 39.70962513631028 -8.136762619018555"- custom
string(optional)Search using multiple custom fields (in json format). "!" can be used before the custom search key to negate the search. Eg:
"{ "label.value": ["Casa da Música", "Torre dos Clérigos"], "time.term": "open", "location.relationship": { "value": ["some relationship", "some other relationship"], "targetPOI": "5c40651ea8f44b313604c741" }, "description": [ { "value": "some theme", "type": "x-citysdk/themes" }, { "value": ["some segment", "some segment1"], "type": "x-citysdk/segments" } ], "!tags": ["some tag", "some other tag"] }"- limit
integer(optional)Filter the search to a set of results. The default value is 10.
- offset
integer(optional)Filter the search to a set of results. The default value is 0. The service also accept ‘page’ to get the set of results by page.
POST https://api.ropi.porto.digital/CitySDK/pois
Requests
Headers
Content-Type: multipart/mixed; boundary=plug_conn_test
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc1MiwiaWF0IjoxNTc1MzA3NTUyLCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6IjIxZWI2YzQ4LWYzNWMtNDgyYi04MGI1LWQ5NjVjY2RkYzYxMCIsIm5iZiI6MTU3NTMwNzU1MSwic3ViIjoiNWRlNTQ5MjA1NWI0ZmMyMWMwYjVlMWY4IiwidHlwIjoiYWNjZXNzIn0.beZmfqMVA7Q5pxDqbQF_owI50SKjPVKy-jT9FA88cTG_NSCNmmWJCaxw4O5bQ9b5ovUlVCV62ngSmlhtcfvZwQ
accept: application/jsonBody
{
"point_of_interest": {
"author": {
"term": "primary",
"value": "some author"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c748"
}
],
"description": [
{
"type": "x-citysdk/price",
"value": "some description"
}
],
"href": "some href",
"label": [
{
"term": "primary",
"value": "some label"
}
],
"lang": "some lang",
"license": {
"term": "primary",
"value": "some license"
},
"link": [
{
"term": "icon",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c742"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c743"
}
],
"location": {
"address": {
"type": "text/vcard",
"value": "some address"
},
"line": [
{
"LineString": {
"posList": "some line posList"
},
"value": "some line"
}
],
"point": [
{
"Point": {
"posList": "38.7623018491608 -9.09537155864194"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194"
},
"value": "some polygon"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c741",
"term": "contains",
"value": "some relationship"
}
],
"value": "some location"
},
"metadata": "some metadata",
"notes": "some notes",
"tags": [
"some tag"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "some time"
}
],
"type": "some type",
"value": "some value"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd34Oqw2I-0L0AAGeB
location: /CitySDK/pois/5de5492055b4fc21c0b5e1faBody
{
"points_of_interest": {
"active": false,
"author": {
"term": "primary",
"value": "some author"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c748"
}
],
"created": "2019-12-02T17:25:52.000000Z",
"description": [
{
"type": "x-citysdk/price",
"value": "some description"
}
],
"href": "some href",
"id": "5de5492055b4fc21c0b5e1fa",
"label": [
{
"term": "primary",
"value": "some label"
}
],
"lang": "some lang",
"license": {
"term": "primary",
"value": "some license"
},
"link": [
{
"term": "icon",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c742"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c743"
}
],
"location": {
"address": {
"type": "text/vcard",
"value": "some address"
},
"line": [
{
"LineString": {
"posList": "some line posList",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some line"
}
],
"point": [
{
"Point": {
"posList": "38.7623018491608 -9.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c741",
"term": "contains",
"value": "some relationship"
}
],
"value": "some location"
},
"metadata": "some metadata",
"notes": "some notes",
"tags": [
"some tag"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "some time"
}
],
"type": "some type",
"value": "some value"
}
}Create point of interestPOST/CitySDK/pois
Used to create a new point of interest.
URI Parameters
- event
map(required)The point of interest data.
Delete a point of interest ¶
DELETE https://api.ropi.porto.digital/CitySDK/pois/id
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc1NSwiaWF0IjoxNTc1MzA3NTU1LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6IjQyYWJiNDU3LTQwMGUtNDQ2Mi1iNGFkLWUxY2M5NWZmZDIzMiIsIm5iZiI6MTU3NTMwNzU1NCwic3ViIjoiNWRlNTQ5MjM1NWI0ZmMyMWMwZTdmMjAyIiwidHlwIjoiYWNjZXNzIn0.k7UVqb4_BahQ9hwHXEt8Z5ZCUkIIaHwEF22fcEV8BO3B_xcEqeSpPEON5tlx4auvYVT-P42gb23v1i0_Qw1scA
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd4ApTJgYFlc0AAG6CBody
"POI with id '5de5492355b4fc21c0e7f204' removed successfully."Delete a point of interestDELETE/CitySDK/pois/{id}
Used to delete a point of interest.
URI Parameters
- id
string(required)The point of interest ID to delete.
GET https://api.ropi.porto.digital/CitySDK/pois/id
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc1MywiaWF0IjoxNTc1MzA3NTUzLCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImU4MGMyMTUxLWI2Y2EtNDUyNS04NDhkLTZiMTRlMWJhMzc5NyIsIm5iZiI6MTU3NTMwNzU1Miwic3ViIjoiNWRlNTQ5MjE1NWI0ZmMyMWMwMTliODg5IiwidHlwIjoiYWNjZXNzIn0.xstZzmW6tQF1ZikB70Lx1OB04CHUVzJzll-6ECSRfhk0VkzZRQ4JbQfWI9GD4-SrgCFrtVWTMgTg9WAJ2tL5tQ
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd35i4BxS8LIkAAGhBBody
{
"points_of_interest": {
"active": false,
"author": {
"term": "primary",
"value": "some author"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c748",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste1"
},
{
"id": "5c40651ea8f44b313604c748",
"lang": "en-GB",
"term": "category",
"value": "Categorytest1"
}
],
"created": "2019-12-02T17:25:53.000000Z",
"description": [
{
"type": "x-citysdk/price",
"value": "some description"
}
],
"href": "some href",
"id": "5de5492155b4fc21c019b88b",
"label": [
{
"term": "primary",
"value": "some label"
}
],
"lang": "some lang",
"license": {
"term": "primary",
"value": "some license"
},
"link": [
{
"term": "icon",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c742"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c743"
},
{
"href": "some category link href",
"term": "icon",
"value": "some category link"
}
],
"location": {
"address": {
"type": "text/vcard",
"value": "some address"
},
"line": [
{
"LineString": {
"posList": "some line posList",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some line"
}
],
"point": [
{
"Point": {
"posList": "38.7623018491608 -9.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c741",
"term": "contains",
"value": "some relationship"
}
],
"value": "some location"
},
"metadata": "some metadata",
"notes": "some notes",
"tags": [
"some tag"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "some time"
}
],
"type": "some type",
"value": "some value"
}
}Get point of interest by IDGET/CitySDK/pois/{id}
Used to get a point of interest by ID.
URI Parameters
- id
string(required)The point of interest ID to retrieve.
PUT https://api.ropi.porto.digital/CitySDK/pois/id
Requests
Headers
Content-Type: multipart/mixed; boundary=plug_conn_test
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc1MywiaWF0IjoxNTc1MzA3NTUzLCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6IjQ4M2NjMmUyLTRmZjktNDMzMC04MWZkLTk4OThiYWM1MzFmOSIsIm5iZiI6MTU3NTMwNzU1Miwic3ViIjoiNWRlNTQ5MjE1NWI0ZmMyMWMwMTliODhkIiwidHlwIjoiYWNjZXNzIn0.sHb7dWNsAdB-cHE8tNvVhEuDu8Mv1hJ7Muuu97r9hutzG0Zibpfhik7gGVNi-_LQu_yW2ssYFhuV3Zrqm_6g5w
accept: application/jsonBody
{
"point_of_interest": {
"active": true,
"author": {
"term": "secondary",
"value": "some updated author"
},
"base": "some updated base",
"category": [
{
"id": "5c40651ea8f44b313604c749"
}
],
"description": [
{
"type": "x-citysdk/capacity",
"value": "some updated description"
}
],
"href": "some updated href",
"label": [
{
"term": "secondary",
"value": "some updated label"
}
],
"lang": "some updated lang",
"license": {
"term": "edit",
"value": "some updated license"
},
"link": [
{
"href": "some updated link",
"term": "edit",
"value": "some updated link"
},
{
"term": "search",
"value": "some updated code"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c742"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c743"
}
],
"location": {
"address": {
"type": "text/directory",
"value": "some updated address"
},
"line": [
{
"LineString": {
"posList": "some updated line posList"
},
"value": "some updated line"
}
],
"point": [
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194"
},
"value": "some updated point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "41.7623018491608 -12.09537155864194,42.7623018491608 -13.09537155864194,43.7623018491608 -14.09537155864194"
},
"value": "some updated polygon"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c742",
"term": "within",
"value": "some updated relationship"
}
],
"value": "some updated location"
},
"metadata": "some updated metadata",
"notes": "some updated notes",
"tags": [
"some updated tag"
],
"time": [
{
"term": "instant",
"type": "text/plain",
"value": "some updated time"
}
],
"type": "some updated type",
"value": "some updated value"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd358TZMYcRZcAAGihBody
{
"points_of_interest": {
"active": true,
"author": {
"term": "secondary",
"value": "some updated author"
},
"base": "some updated base",
"category": [
{
"id": "5c40651ea8f44b313604c749"
}
],
"created": "2019-12-02T17:25:53.000000Z",
"description": [
{
"type": "x-citysdk/capacity",
"value": "some updated description"
}
],
"href": "some updated href",
"id": "5de5492155b4fc21c019b88f",
"label": [
{
"term": "secondary",
"value": "some updated label"
}
],
"lang": "some updated lang",
"license": {
"term": "edit",
"value": "some updated license"
},
"link": [
{
"href": "some updated link",
"term": "edit",
"value": "some updated link"
},
{
"term": "search",
"value": "some updated code"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c742"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c743"
}
],
"location": {
"address": {
"type": "text/directory",
"value": "some updated address"
},
"line": [
{
"LineString": {
"posList": "some updated line posList",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some updated line"
}
],
"point": [
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some updated point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "41.7623018491608 -12.09537155864194,42.7623018491608 -13.09537155864194,43.7623018491608 -14.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some updated polygon"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c742",
"term": "within",
"value": "some updated relationship"
}
],
"value": "some updated location"
},
"metadata": "some updated metadata",
"notes": "some updated notes",
"tags": [
"some updated tag"
],
"time": [
{
"term": "instant",
"type": "text/plain",
"value": "some updated time"
}
],
"type": "some updated type",
"updated": "2019-12-02T17:25:53.453148Z",
"value": "some updated value"
}
}Update point of interestPUT/CitySDK/pois/{id}
Used to update a point of interest.
URI Parameters
- id
string(required)The point of interest ID to update.
- point_of_interest
map(required)The point of interest update data.
Get point of interest relations by ID ¶
GET https://api.ropi.porto.digital/CitySDK/pois/id/relation
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc1NiwiaWF0IjoxNTc1MzA3NTU2LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImY2MTUyMTQwLWE1NDctNDhmYy1iNzUxLWU2MjI3OGVmZDJhMyIsIm5iZiI6MTU3NTMwNzU1NSwic3ViIjoiNWRlNTQ5MjQ1NWI0ZmMyMWMwZTkwYzE2IiwidHlwIjoiYWNjZXNzIn0.hrq46cSKBi1ZJH4UYxOrz_zPEMNqfIvqfTdN3EKzOYH23rkrDVMenq81pPG2AxZHnkhPxJPNH2LxG2yPuUPONw
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd4EbnUSUJ5-UAAHAiBody
{
"points_of_interest": [
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base2",
"category": [
{
"id": "5c40651ea8f44b313604c751",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste4"
},
{
"id": "5c40651ea8f44b313604c751",
"lang": "en-GB",
"term": "category",
"value": "Categorytest4"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste6"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "en-GB",
"term": "category",
"value": "Categorytest6"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste7"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "en-GB",
"term": "category",
"value": "Categorytest7"
}
],
"created": "2019-12-02T17:25:56.000000Z",
"description": [
{
"lang": "pt-PT",
"type": "x-citysdk/themes",
"value": "some theme"
},
{
"lang": "pt-PT",
"type": "x-citysdk/segments",
"value": "some segment"
},
{
"lang": "pt-PT",
"value": "some description2"
}
],
"id": "5c40651ea8f44b313604c743",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label2"
}
],
"link": [
{
"term": "parent",
"value": "5c40651ea8f44b313604c745"
},
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
}
],
"location": {
"point": [
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c741",
"term": "contains",
"value": "some relationship"
}
]
},
"tags": [
"tag1",
"tag4"
]
},
{
"active": false,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base3",
"category": [
{
"id": "5c40651ea8f44b313604c751",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste4"
},
{
"id": "5c40651ea8f44b313604c751",
"lang": "en-GB",
"term": "category",
"value": "Categorytest4"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste6"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "en-GB",
"term": "category",
"value": "Categorytest6"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste7"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "en-GB",
"term": "category",
"value": "Categorytest7"
}
],
"created": "2019-12-02T17:25:56.000000Z",
"id": "5c40651ea8f44b313604c744",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label3"
}
],
"link": [
{
"term": "search",
"value": "some code2"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c745"
},
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
}
],
"tags": [
"tag1",
"tag5"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "some time"
}
]
}
]
}Headers
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd35CfxfRftUkAAGghBody
{
"points_of_interest": {
"active": true,
"author": {
"term": "primary",
"value": "some author"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c748",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste1"
},
{
"id": "5c40651ea8f44b313604c748",
"lang": "en-GB",
"term": "category",
"value": "Categorytest1"
}
],
"created": "2019-12-02T17:25:53.000000Z",
"description": [
{
"type": "x-citysdk/price",
"value": "some description"
}
],
"href": "some href",
"id": "5de5492155b4fc21c019b888",
"label": [
{
"term": "primary",
"value": "some label"
}
],
"lang": "some lang",
"license": {
"term": "primary",
"value": "some license"
},
"link": [
{
"term": "icon",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c742"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c743"
},
{
"href": "some category link href",
"term": "icon",
"value": "some category link"
}
],
"location": {
"address": {
"type": "text/vcard",
"value": "some address"
},
"line": [
{
"LineString": {
"posList": "some line posList",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some line"
}
],
"point": [
{
"Point": {
"posList": "38.7623018491608 -9.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c741",
"term": "contains",
"value": "some relationship"
}
],
"value": "some location"
},
"metadata": "some metadata",
"tags": [
"some tag"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "some time"
}
],
"type": "some type",
"value": "some value"
}
}Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc1MCwiaWF0IjoxNTc1MzA3NTUwLCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImRiZDQ5MmNiLWY4NTYtNGEyZi1hYmM1LWM1YTgyZTExMzE2NyIsIm5iZiI6MTU3NTMwNzU0OSwic3ViIjoiNWRlNTQ5MWU1NWI0ZmMyMWMwYzVkNjljIiwidHlwIjoiYWNjZXNzIn0.1yL39kwMJKVQevq9lUCceFRiE8dhkPQj8l4pELT5nW42jJOuEb0QhRB_PnEf03kAQDOMIN2hBNw8hEnMpwPHhg
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd3vD_McVfVfgAAGRBBody
{
"points_of_interest": [
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c751",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste4"
},
{
"id": "5c40651ea8f44b313604c751",
"lang": "en-GB",
"term": "category",
"value": "Categorytest4"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste6"
},
{
"id": "5c40651ea8f44b313604c753",
"lang": "en-GB",
"term": "category",
"value": "Categorytest6"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste7"
},
{
"id": "5c40651ea8f44b313604c754",
"lang": "en-GB",
"term": "category",
"value": "Categorytest7"
}
],
"created": "2019-12-02T17:25:50.000000Z",
"description": [
{
"lang": "pt-PT",
"value": "some description"
}
],
"hash": "3IdfpC0OeeydL4toS8rkAcHmi3HLs674g-1rCtq3",
"id": "5c40651ea8f44b313604c741",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label"
}
],
"link": [
{
"term": "edit",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c745"
},
{
"href": "some category link2 href",
"term": "icon",
"value": "some category link2"
}
],
"location": {
"point": [
{
"Point": {
"posList": "39.7623018491608 -10.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
},
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
},
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
}
],
"value": "some location"
},
"notes": "12",
"tags": [
"tag1",
"tag2"
]
},
{
"active": true,
"author": {
"term": "primary",
"value": "admin"
},
"base": "some base1",
"category": [
{
"id": "5c40651ea8f44b313604c752",
"lang": "pt-PT",
"term": "category",
"value": "Categoriateste5"
},
{
"id": "5c40651ea8f44b313604c752",
"lang": "en-GB",
"term": "category",
"value": "Categorytest5"
}
],
"created": "2019-12-02T17:25:50.000000Z",
"description": [
{
"lang": "pt-PT",
"type": "x-citysdk/themes",
"value": "some theme"
},
{
"lang": "pt-PT",
"type": "x-citysdk/segments",
"value": "some segment"
},
{
"lang": "pt-PT",
"value": "some description1"
}
],
"id": "5c40651ea8f44b313604c742",
"label": [
{
"lang": "pt-PT",
"term": "primary",
"value": "some label1"
}
],
"link": [
{
"term": "edit",
"value": "some link1"
},
{
"term": "search",
"value": "some code1"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c745"
}
],
"location": {
"address": {
"type": "text/vcard",
"value": "some address1"
},
"point": [
{
"Point": {
"posList": "40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
},
{
"Point": {
"posList": "41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point1"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
},
{
"SimplePolygon": {
"posList": "40.7623018491608 -11.09537155864194,41.7623018491608 -12.09537155864194,42.7623018491608 -13.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon1"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c741",
"term": "contains",
"value": "some relationship"
}
],
"value": "some location1"
},
"tags": [
"tag3"
],
"time": [
{
"term": "instant",
"type": "text/icalendar",
"value": "some time"
}
]
}
]
}Get point of interest relations by IDGET/CitySDK/pois/{id}/{relation}
Used to get a point of interest relations by ID.
URI Parameters
- id
string(required)The point of interest ID to retrieve the relations from.
- relation
string(required)The type of relations to retrieve.
- limit
integer(optional)Filter the search to a set of results. The default value is 10.
- offset
integer(optional)Filter the search to a set of results. The default value is 0. The service also accept ‘page’ to get the set of results by page.
Get point of interest by hash ¶
GET https://api.ropi.porto.digital/CitySDK/pois/hash/hash
Get point of interest by hashGET/CitySDK/pois/hash/{hash}
Used to get a point of interest by hash.
URI Parameters
- hash
string(required)The point of interest hash to retrieve.
Set point of interest as deleted ¶
PATCH https://api.ropi.porto.digital/CitySDK/pois/set_deleted/id
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc1NCwiaWF0IjoxNTc1MzA3NTU0LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6IjI2ZGFmMjQ1LTI5NTktNDc2Yi04YmE2LTY5NDYwY2Q4OGM4ZSIsIm5iZiI6MTU3NTMwNzU1Mywic3ViIjoiNWRlNTQ5MjI1NWI0ZmMyMWMwNjQ5NDkxIiwidHlwIjoiYWNjZXNzIn0.vlP0X07dtPsdT3cR3qui7uwzcmQI0eAXwB97PaLwtxU9G9-cYHlftWIMGfWB_E4NGAEzYKnDN-p3Y9tDDF3tmw
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd3_MvXP_XDEsAAGsBBody
{
"points_of_interest": {
"active": false,
"author": {
"term": "primary",
"value": "some author"
},
"base": "some base",
"category": [
{
"id": "5c40651ea8f44b313604c748"
}
],
"created": "2019-12-02T17:25:54.000000Z",
"deleted": "2019-12-02T17:25:54.866106Z",
"description": [
{
"type": "x-citysdk/price",
"value": "some description"
}
],
"href": "some href",
"id": "5de5492255b4fc21c0649493",
"label": [
{
"term": "primary",
"value": "some label"
}
],
"lang": "some lang",
"license": {
"term": "primary",
"value": "some license"
},
"link": [
{
"term": "icon",
"value": "some link"
},
{
"term": "search",
"value": "some code"
},
{
"term": "child",
"value": "5c40651ea8f44b313604c742"
},
{
"term": "parent",
"value": "5c40651ea8f44b313604c743"
}
],
"location": {
"address": {
"type": "text/vcard",
"value": "some address"
},
"line": [
{
"LineString": {
"posList": "some line posList",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some line"
}
],
"point": [
{
"Point": {
"posList": "38.7623018491608 -9.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some point"
}
],
"polygon": [
{
"SimplePolygon": {
"posList": "38.7623018491608 -9.09537155864194,39.7623018491608 -10.09537155864194,40.7623018491608 -11.09537155864194",
"srsName": "http://www.opengis.net/def/crs/EPSG/0/4326"
},
"value": "some polygon"
}
],
"relationship": [
{
"targetPOI": "5c40651ea8f44b313604c741",
"term": "contains",
"value": "some relationship"
}
],
"value": "some location"
},
"metadata": "some metadata",
"notes": "some notes",
"tags": [
"some tag"
],
"time": [
{
"term": "open",
"type": "text/icalendar",
"value": "some time"
}
],
"type": "some type",
"value": "some value"
}
}Set point of interest as deletedPATCH/CitySDK/pois/set_deleted/{id}
Used to set the point of interest as deleted.
URI Parameters
- id
string(required)The point of interest ID to set as deleted.
Create/Update point of interest hash ¶
PATCH https://api.ropi.porto.digital/CitySDK/pois/set_hash/id
Create/Update point of interest hashPATCH/CitySDK/pois/set_hash/{id}
Used to create/update a point of interest hash.
URI Parameters
- id
string(required)The point of interest ID to create/update the hash to.
Resource ¶
List the available API resources ¶
GET https://api.ropi.porto.digital/CitySDK/resources
Responses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd41G6mAbcP2sAAHqhBody
{
"citysdk_tourism": {
"links": {
"find_code": {
"href": "http://localhost:4002/CitySDK/search/{code}{?limit,offset}",
"templated": true
},
"find_event": {
"href": "http://localhost:4002/CitySDK/events/{id}",
"templated": true
},
"find_event_relation": {
"href": "http://localhost:4002/CitySDK/events/{id}/{relation}{?limit,offset}",
"templated": true
},
"find_poi": {
"href": "http://localhost:4002/CitySDK/pois/{id}",
"templated": true
},
"find_poi_relation": {
"href": "http://localhost:4002/CitySDK/pois/{id}/{relation}{?limit,offset}",
"templated": true
},
"list_categories": {
"href": "http://localhost:4002/CitySDK/categories/{list}{?limit,offset}",
"templated": true
},
"list_event": {
"href": "http://localhost:4002/CitySDK/events{?category,tag,name,time,coords,limit,offset}",
"templated": true
},
"list_poi": {
"href": "http://localhost:4002/CitySDK/pois{?category,tag,complete,minimal,coords,limit,offset}",
"templated": true
}
},
"version": "1.0.2"
}
}List the available API resourcesGET/CitySDK/resources
Used to obtain a list of the available API resources.
User services ¶
The list of services available for the API User management.
List users ¶
GET https://api.ropi.porto.digital/CitySDK/users
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc1NiwiaWF0IjoxNTc1MzA3NTU2LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImU5N2IxNWIxLTc2M2EtNGNhNi05ZGI5LTU4ZTY1MGZlYTU2NiIsIm5iZiI6MTU3NTMwNzU1NSwic3ViIjoiNWRlNTQ5MjQ1NWI0ZmMyMWMwZTkwYzVmIiwidHlwIjoiYWNjZXNzIn0.-kK9ggb6sQ_4gt4lyCPZQuKSiN-hhekqV47l_zVq9dhzcASo_xgi4bvRMQyeLJ9hf5dJu4DREPz-YDwtm-LsZQ
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd4GkdRF7X0QYAAHJiBody
{
"users": [
{
"api_key": {
"id": "5de5492455b4fc21c0e90c60",
"key": "97E975A1F7CA4A2085733A720369470F",
"secret": "$2b$04$DsPRPO0rIFsy5zPEg7h3Q.DP0l0W6K56Kq/3mZaefcqcDQlZoa3hO",
"user_id": "5de5492455b4fc21c0e90c5f"
},
"id": "5de5492455b4fc21c0e90c5f",
"name": "admin"
},
{
"api_key": null,
"id": "5de5492455b4fc21c0e90c61",
"name": "first"
},
{
"api_key": null,
"id": "5de5492455b4fc21c0e90c62",
"name": "second"
},
{
"api_key": null,
"id": "5de5492455b4fc21c0e90c63",
"name": "third"
}
]
}List usersGET/CitySDK/users
Used to obtain the list of users.
URI Parameters
- username
string(optional)Search using username. Eg:
"Administrador, Utilizador"or["Administrador", "Utilizador"]- active
boolean(optional)Search active/inactive API users. If set to
"true"only gets active API users and if set to"false"only gets inactive API users. If this parameter is ommited, it returns both active and inactive API users.- limit
integer(optional)Filter the search to a set of results. The default value is 10.
- offset
integer(optional)Filter the search to a set of results. The default value is 0. The service also accept ‘page’ to get the set of results by page.
POST https://api.ropi.porto.digital/CitySDK/users
Requests
Headers
Content-Type: multipart/mixed; boundary=plug_conn_test
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc1NiwiaWF0IjoxNTc1MzA3NTU2LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImUwZGFhYzJjLTgyZTAtNDA1OS1hYWJiLTljZGJjMDE4OWQyMSIsIm5iZiI6MTU3NTMwNzU1NSwic3ViIjoiNWRlNTQ5MjQ1NWI0ZmMyMWMwZTkwYzFmIiwidHlwIjoiYWNjZXNzIn0.8WFECTG-H2DIvVkV3zcnlhFLvmP6WEymMXlcIwBc1Nsml9ckb5pwtCU1misxxqpa8Rbt483LVnniPIpBVbwasg
accept: application/jsonBody
{
"user": {
"name": "some name"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd4FLJLQLUxcwAAGuh
location: /CitySDK/users/5de5492455b4fc21c0e90c21Body
{
"users": {
"api_key": null,
"id": "5de5492455b4fc21c0e90c21",
"name": "some name"
}
}Create userPOST/CitySDK/users
Used to create a new user.
URI Parameters
- user
map(required)The user data.
Delete an user ¶
DELETE https://api.ropi.porto.digital/CitySDK/users/id
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc1NiwiaWF0IjoxNTc1MzA3NTU2LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6IjhlZmRjMmI2LTc4ZTUtNDIxNC1hYWNjLWUzM2MyYmQyMjlkMiIsIm5iZiI6MTU3NTMwNzU1NSwic3ViIjoiNWRlNTQ5MjQ1NWI0ZmMyMWMwZTkwYzU0IiwidHlwIjoiYWNjZXNzIn0.CxsNVKpLoGwJp8phXWbnl-tml7Zub8Sr8Z3SWra8refw6v0wIS2fq80OWb1tN7gb8hMRr0VRPxG1xqShFrNW3Q
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd4GWU1ZRVubUAAHHiBody
"User with id '5de5492455b4fc21c0e90c56' removed successfully."Delete an userDELETE/CitySDK/users/{id}
Used to delete a user.
URI Parameters
- id
string(required)The user ID to delete.
GET https://api.ropi.porto.digital/CitySDK/users/id
Requests
Headers
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc1NiwiaWF0IjoxNTc1MzA3NTU2LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6ImM0MGIyZDExLTE2YTgtNDgyOC05NTI3LTJkMWM1Y2Q3YmEwMCIsIm5iZiI6MTU3NTMwNzU1NSwic3ViIjoiNWRlNTQ5MjQ1NWI0ZmMyMWMwZTkwYzFjIiwidHlwIjoiYWNjZXNzIn0.KrI69MJWBwera4k1fTspGN79WYGi4cs9QFRmHB6ienn1RAkagePB6dSNUBJZOaiV92hxw-xU3IgQEKSdpHRdfA
accept: application/jsonResponses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd4FHFq31YvUUAAGuBBody
{
"users": {
"api_key": null,
"id": "5de5492455b4fc21c0e90c1e",
"name": "some name"
}
}Get user by IDGET/CitySDK/users/{id}
Used to get a user by ID.
URI Parameters
- id
string(required)The user ID to retrieve.
PUT https://api.ropi.porto.digital/CitySDK/users/id
Requests
Headers
Content-Type: multipart/mixed; boundary=plug_conn_test
authorization: bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjaXR5X2FwaV9wb3J0byIsImV4cCI6MTU3NzcyNjc1NiwiaWF0IjoxNTc1MzA3NTU2LCJpc3MiOiJjaXR5X2FwaV9wb3J0byIsImp0aSI6IjFiMGE1YTliLWY2MjUtNGRkYy04ZmM0LWFkNjg4MTIyNDllNyIsIm5iZiI6MTU3NTMwNzU1NSwic3ViIjoiNWRlNTQ5MjQ1NWI0ZmMyMWMwZTkwYzUxIiwidHlwIjoiYWNjZXNzIn0.oBj2g0SgRWXBvDDSiU7QXSN-p9_ONhUFrbYMMNPR2jV3bKcy4UP3R_IzyFkjbS6A4O9v7m3Y73cwJMHnQOTZCg
accept: application/jsonBody
{
"user": {
"name": "some updated name"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: Fdyd4GQsh95LOM8AAHGiBody
{
"users": {
"api_key": null,
"id": "5de5492455b4fc21c0e90c53",
"name": "some updated name"
}
}Update userPUT/CitySDK/users/{id}
Used to update a user.
URI Parameters
- id
string(required)The user ID to update.
- user
map(required)The user update data.
Generated by aglio on 30 Dec 2020