NAV
shell

Introduction

Welcome to MyCity API reference.

Tutte le chiamate devono contenere l'header Accept:application/json.

Authentication

L'autenticazione avviene tramite il protocollo OAuth 2.0.

È possibile autenticarsi con due diversi tipi di grant, client_credentials e password_grant.

Per le chiamate che non richiedono uno specifico utente loggato è possibile autenticarsi con entrambi i metodi.

Per le chiamate che richiedono uno specifico utente loggato è necessario autenticarsi con password_grant.

Get Access Token with Client login

This endpoint retrieves a token for authorization, using grant type client_credentials.

Attribute Description
grant_type Deve essere client_credentials.
client_id Il client ID fornito da GaspariLab.
client_secret Il client secred fornito da GaspariLab.

Example request:

curl -X POST "https://api.mycitydemo.it/oauth/token"
-H "Accept: application/json"
-d "grant_type=client_credentials&client_id=<client_id>&client_secret=<client_secret>"

Example response:

{
    "token_type": "Bearer",
    "expires_in": 86400,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjAwMjI0ZDE0NDhlMTEwMWM1ZTFlMTRmOGM1OTY4MTJjYWI2NTMwYzE5MTYyYzIwNzBmNDVjODlmMTc0OGI3ZTRlNThiMDVlZGNkZDViMTQ0In0.eyJhdWQiOiIyIiwianRpIjoiMDAyMjRkMTQ0OGUxMTAxYzVlMWUxNGY4YzU5NjgxMmNhYjY1MzBjMTkxNjJjMjA3MGY0NWM4OWYxNzQ4YjdlNGU1OGIwNWVkY2RkNWIxNDQiLCJpYXQiOjE1MDE3NDQ3MzEsIm5iZiI6MTUwMTc0NDczMSwiZXhwIjoxNTAxODMxMTMxLCJzdWIiOiIiLCJzY29wZXMiOltdfQ.Y2D1No5lYmdRmp8v1VuWgHcqaI7pCSV1Ey5XkDFn6hUOz0WYRhJ9X64Z7riJMCLAoaoAWpzUudVP_f6KDwbKSnb8gx6fZQ6z7HpkxcC7h1OYS2dkQXG6j0-AuORmXJyTHAMNqW7fvUqrWqFWcjL8tvkIJ2vW81tio3DRsKOS7odUjV4C3ociRNDzm7SbDtyYx7vkExrtjyjFB3zNTbg4rQuwmWDavDrUVAb8yhkP-V019NMMQjFE2lFhi160O73nrsXvRruKm8wWgxSRjoS59KlkpFbdUdNOKnTtdbJfmv_PPRZ068vDQwtJeQkLw_TvSEz2a2qgufMW-07BWu8QFshpxEtX3uVl690Y-4Zth0R6g8aGzeFxXDtpuxQTND2rPDEWZVKVCl-t-gGh4sDlMsjs5e-BqZyOl8IWI86Pr-fRCxJP09-7TMkw-a8NxuxpVI78XJ_nuaGheOnq8FkbJbwXJcyjVYeuKXpo5IAV1qc-hOw3a9DOXC5LqNQPpO2YWaQfBphF1R0UcmhfCsr4Gt6bydwtmiJ3H_9Owxruo8d7PBn89kQkhBRA36gjpUrq8A_3o1656iCgllyhFBHdUGFecRMkXOyGypnAaBT5Bl6rVSdYDb6xqu1SmbGKTU5p6a2Mz6wlnVrCZIyJzr94bHM2_whGkILHra4cyCqhjgw"
}

HTTP Request

POST oauth/token

Get Access Token with User login

This endpoint retrieves a token for authorization, using grant type password_grant.

Attribute Description
grant_type Deve essere password.
client_id Il client ID fornito da GaspariLab.
client_secret Il client secred fornito da GaspariLab.
username Lo username dell'utente.
password La password dell'utente.

Example request:

curl -X POST "https://api.mycitydemo.it/oauth/token"
-H "Accept: application/json"
-d "grant_type=password&client_id=<client_id>&client_secret=<client_secret>&username=<username>&password=<password>"

Example response:

{
    "token_type": "Bearer",
    "expires_in": 86400,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjJiOWMxYjY2ZmRlMmY4MGY3MmJlMzRmNGM3NGM0N2E3NmFmNzUxYzZkNzMzMjhhMmFkYjRiMmI0MzFkNDU5MDI4MTFkNGFmZDYwYmE1Nzc2In0.eyJhdWQiOiIzIiwianRpIjoiMmI5YzFiNjZmZGUyZjgwZjcyYmUzNGY0Yzc0YzQ3YTc2YWY3NTFjNmQ3MzMyOGEyYWRiNGIyYjQzMWQ0NTkwMjgxMWQ0YWZkNjBiYTU3NzYiLCJpYXQiOjE1MDg5MjU5ODYsIm5iZiI6MTUwODkyNTk4NiwiZXhwIjoxNTA5MDEyMzg1LCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.gEBVEJR9IE9uFHzJH7ZoO5IHQIBrC1UNnokwWVPqcpBr6-7TwLP3ZayGHCdGZbCODeDnT0binUFVixD4AP5giLbensIEFf0gOWNc_V-0LI6PJZr2QCAJwyWblCbM7QgBb3dZao6bofDbnHeMpIV2L1PCRZ3_8cC7MSVluuMkSULxXJ6s01W2WiqSh5p-Bdr7GWaSHjQhZq1Y7YXmsrz2k9OiM3WIAWiIXD9B4PDL4d_t7cjdmr3j9uPi3FCA5PIy6p4-tLsBw2jmDUBz__3ytAUhtReJBRAlrAHaOr7fjr0CoXTf5sDDjmocoAoZTI0icnDsoSC_G6GnNY9TPaNAOaIRzGC2Y0meNeFeOpfbU1pphO1JaSqqxtrCgBh88-5CK956n4k7ts5_HZyZcEd_1bfYPLzudvUhbwVR4OAiIiW0brunulfdwpO1FpqeJPkPXdFGiY2VhbW7OhGUWcDiW-gApRaoMTL9k4XJbHeJwGn0azGjU5QZQeE6kFrUP-bC6dmZmWcWdKRFdRStE6IcB85s1_NCZacPKjTKm_sne8LW4pOt3O9eAD7uy1Fgjqk7jtzk7Vjk4fc6rZeLRYNAY5ECHZON5W4fmpKcvsP6EKa5dEB_ABUOfVO2CsZpB1DZ94lYJWWm2ynstNK_HhcebzUTOHT_NNMoppqzeXAy5hM",
    "refresh_token": "def50200599bc1ff441722bdb410114d20f19db9c0d607c4ef68766a0f65fa24700141d9fab985e9b604c7bb42566c7a95d47e1cfaf91e11ca52834058d104daff77432df94993c773ac56f99483440269263faa97a4d2334d8966def4887d729b9322b344c05f6830a290e89dc5290ca9d5599429a0a3b314d2a541b7bbe25819223197150a68ac6a51a2d7d76a7cfd196d115e965a20953d45a909731ca022614208316f59f7dd4af8d2fb08276c5f7b75fe4149d87b95fc82329f247cc857fe22f14d54dcaa2290d16cf6a8b2f4105d0d9753c3bf001c05ca39ee7dde1520353743ad1342946c0151861c934a9791437a177d6db4a13b16b43b8f1f137ef9d4698bc4f756dc3138a68e235b90af7bac774095a14c7b85949559d6059eba6e9d42f0c99edce9cef71bc3afac2f90a46561c3c6bd4389d6aa1fd08c7ebc3cb2daf3744bb3a4ff9cb20dad6d1b8d3cd3d94b6159dc40f7977f09796ad393e22aed"
}

HTTP Request

POST oauth/token

Refresh User Token

This endpoint is used to refresh the token obtained with grant type password_grant.

Attribute Description
grant_type Deve essere refresh_token.
refresh_token Il refresh token.
client_id Il client ID fornito da GaspariLab.
client_secret Il client secred fornito da GaspariLab.

Example request:

curl -X POST "https://api.mycitydemo.it/oauth/token"
-H "Accept: application/json"
-d "grant_type=refresh_token&refresh_token=<refresh_token>&client_id=<client_id>&client_secret=<client_secret>"

Example response:

{
    "token_type": "Bearer",
    "expires_in": 86400,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjJiOWMxYjY2ZmRlMmY4MGY3MmJlMzRmNGM3NGM0N2E3NmFmNzUxYzZkNzMzMjhhMmFkYjRiMmI0MzFkNDU5MDI4MTFkNGFmZDYwYmE1Nzc2In0.eyJhdWQiOiIzIiwianRpIjoiMmI5YzFiNjZmZGUyZjgwZjcyYmUzNGY0Yzc0YzQ3YTc2YWY3NTFjNmQ3MzMyOGEyYWRiNGIyYjQzMWQ0NTkwMjgxMWQ0YWZkNjBiYTU3NzYiLCJpYXQiOjE1MDg5MjU5ODYsIm5iZiI6MTUwODkyNTk4NiwiZXhwIjoxNTA5MDEyMzg1LCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.gEBVEJR9IE9uFHzJH7ZoO5IHQIBrC1UNnokwWVPqcpBr6-7TwLP3ZayGHCdGZbCODeDnT0binUFVixD4AP5giLbensIEFf0gOWNc_V-0LI6PJZr2QCAJwyWblCbM7QgBb3dZao6bofDbnHeMpIV2L1PCRZ3_8cC7MSVluuMkSULxXJ6s01W2WiqSh5p-Bdr7GWaSHjQhZq1Y7YXmsrz2k9OiM3WIAWiIXD9B4PDL4d_t7cjdmr3j9uPi3FCA5PIy6p4-tLsBw2jmDUBz__3ytAUhtReJBRAlrAHaOr7fjr0CoXTf5sDDjmocoAoZTI0icnDsoSC_G6GnNY9TPaNAOaIRzGC2Y0meNeFeOpfbU1pphO1JaSqqxtrCgBh88-5CK956n4k7ts5_HZyZcEd_1bfYPLzudvUhbwVR4OAiIiW0brunulfdwpO1FpqeJPkPXdFGiY2VhbW7OhGUWcDiW-gApRaoMTL9k4XJbHeJwGn0azGjU5QZQeE6kFrUP-bC6dmZmWcWdKRFdRStE6IcB85s1_NCZacPKjTKm_sne8LW4pOt3O9eAD7uy1Fgjqk7jtzk7Vjk4fc6rZeLRYNAY5ECHZON5W4fmpKcvsP6EKa5dEB_ABUOfVO2CsZpB1DZ94lYJWWm2ynstNK_HhcebzUTOHT_NNMoppqzeXAy5hM",
    "refresh_token": "def50200599bc1ff441722bdb410114d20f19db9c0d607c4ef68766a0f65fa24700141d9fab985e9b604c7bb42566c7a95d47e1cfaf91e11ca52834058d104daff77432df94993c773ac56f99483440269263faa97a4d2334d8966def4887d729b9322b344c05f6830a290e89dc5290ca9d5599429a0a3b314d2a541b7bbe25819223197150a68ac6a51a2d7d76a7cfd196d115e965a20953d45a909731ca022614208316f59f7dd4af8d2fb08276c5f7b75fe4149d87b95fc82329f247cc857fe22f14d54dcaa2290d16cf6a8b2f4105d0d9753c3bf001c05ca39ee7dde1520353743ad1342946c0151861c934a9791437a177d6db4a13b16b43b8f1f137ef9d4698bc4f756dc3138a68e235b90af7bac774095a14c7b85949559d6059eba6e9d42f0c99edce9cef71bc3afac2f90a46561c3c6bd4389d6aa1fd08c7ebc3cb2daf3744bb3a4ff9cb20dad6d1b8d3cd3d94b6159dc40f7977f09796ad393e22aed"
}

HTTP Request

POST oauth/token

Get logged in User

This endpoint retrieves the currently logged in User by its token.

Example request:

curl -X POST "https://api.mycitydemo.it/api/v1/user"
-H "Accept: application/json"
-H "Authorization: Bearer <token>"

Example response:

{
    "data": {
        "id": 2,
        "email": "bologna@egaspari.net",
        "name": "Nicolas",
        "surname": "Cage",
        "scenarios": [
            5
        ]
    }
}

HTTP Request

GET api/v1/user

Accept policies

This endpoint send user policies acceptance.

Example request:

curl -X PUT \
  http://istituzionale.mycity.api/api/v1/user/accept_policies
  -H 'Accept: application/json, text/plain, */*'
  -H 'Content-Type: application/json'
  -H "Authorization: Bearer <token>"

  -d '{
    "privacy_policy_accepted": true,
    "user_policy_accepted": true,
    "cookies_policy_accepted": true
}'

Example response:

{
    "data": {
        "id": 27,
        "email": "demo@mycitydemo.it",
        "name": "Giorgio",
        "surname": "Giorgio",
        "phone": null,
        "scenarios": [
            23,
            8,
            25,
            1,
            2
        ],
        "verified": 1,
        "privacy_policy_last_acceptance": "29-08-2019 12:41",
        "user_policy_last_acceptance": "29-08-2019 12:41",
        "cookies_policy_last_acceptance": "29-08-2019 12:41",
    }
}

HTTP Request

PUT api/v1/user/accept_policies

PUT Parameters

Parameter Type Description
scenario_id integer Id of current scenario if setted.
privacy_policy_accepted boolean (opt) if user accepts privacy policy
user_policy_accepted boolean (opt) if user accepts user policy
cookies_policy_accepted boolean (opt) if user accepts cookies policy

HTTP Request

GET api/v1/user

Update logged in User

This endpoint updates informations for currently logged in User by its token. It permits also to set scenario_id for the current User.

Example request:

curl -X PUT \
  https://api.mycitydemo.it/api/v1/user \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer <token>" \
  -d '{
    "name": "Mario",
    "surname": "Rossi",
    "scenarios": [
        5
    ]
}'

Example response:

{
    "data": {
        "id": 2,
        "email": "demo@mycitydemo.it",
        "name": "Mario",
        "surname": "Rossi",
        "scenarios": [
            5
        ]
    }
}

HTTP Request

PUT api/v1/user

PUT Parameters

Parameter Type Description
scenario_id integer Id of current scenario if setted.
name string user Name.
surname string user Surname.
scenarios array list of scenario ids

Login/Register with Facebook

This endpoint is used to login or register & login a user with Facebook access_token

Attribute Description
access_token access_token from Facebook
client_id your client_id
email [OPTIONAL] user email if Facebook doesn't provide it

Example request:

curl -X POST \
  https://api.mycitydemo.it/api/v1/login/facebook \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "access_token": "EAAERxDHZB3x8BAN7AchRKMTRXZC5w5wwWyC3QWKNO7pcV9ZAw08Gm9oV8FpVWfzm6iDR6z9MxMN8COHWxeRSuAYZA0ZBZCQGzKHaQftdOcrbhEukCboxXAD14CPO7OAaU7V2l19DFgOAGQZCc0RT0fRXII4OEALu6o9ZAdnXADbVvAZDZD",
    "client_id": "5"
}'

Example response:

{
    "token_type": "Bearer",
    "expires_in": 86399,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImY5NjQzMjU1MDRkYzBkMzZkODc4MzA0MWRlNzJkY2JiZTJiZDg2Zjk5YTcwMzlmZTE4MWQyOTExOTMwOWRjM2M1NmJkMzljNDRjNTYwZmFkIn0.eyJhdWQiOiIxIiwianRpIjoiZjk2NDMyNTUwNGRjMGQzNmQ4NzgzMDQxZGU3MmRjYmJlMmJkODZmOTlhNzAzOWZlMTgxZDI5MTE5MzA5ZGMzYzU2YmQzOWM0NGM1NjBmYWQiLCJpYXQiOjE1MTg0NTk2OTQsIm5iZiI6MTUxODQ1OTY5NCwiZXhwIjoxNTE4NTQ2MDkzLCJzdWIiOiIyOSIsInNjb3BlcyI6W119.JUIo7E-vMaawxmR6y7cInKRsp9G5inTzURn-YKCoSVntayIEAjYbIbswpIisopJ_b9xn602HfSoiUKkrHKx62RvylLOEFyc9mD9jp_0yPvKHmUDhstIy-fkWgyCO1ejK7Lw2slqiYz2rm5EgLOXMcXbhY08475cenS0Nnefqa5gfdgdfgdfgdfdgQB6x3smgwrrotQL_TKZdfHGNReV5F5LSoSM2gg1J12fek_8MWY",
    "refresh_token": "def5020098dae29516be29e1172120cead28815d50b55bdd1b9df2gdgfgdgdfcdcc046396cf9e3150606e4e8bc22025c4582a1d127d02cb65e65bd3b5219dd8f5f305feb88fe6fa7298ad779635a967c79ebf434ca9ba594a7e4befc0a4e1e1d9cc4d263265b38382e1221c93d317d2173f9d1bf9a0adc0f52a09d78e3d5b724f6d330010baa473b54f2d192cc2565b33eddb0fa70b48d419a2e17bdd32624308d147c76fd1e2c018e13dcc6b51dbac2de4f911c17ba66582a8886554e536612b5a8686a3d2c94ad36304a639bbb5ee63ff4d8e82d99aaf8bf1af5fb6b8cfa000576ccb0e747adffd24748e9c2ed1174c95d34e6a3af84cdab971f30e860b49dc88ba64a496cf01e667a1a16bdbdf8a84a670e4e7456ae44966861533e494b44109889716f16acc4783d310dc292d887596e71c1796a115ddc1e0ebe1d2c30f835"
}

HTTP Request

POST api/v1/login/facebook

Request a Long lived access token

This endpoint permit's to client to have a long term access token

Attribute Description
access_token access_token from Facebook

Example request:

curl -X POST \
  https://api.mycitydemo.it/api/v1/login/facebook/long_term_access_token \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "access_token": "EAAERxDHZB3x8BAN7AchRKMTRXZC5w5wwWyC3QWKNO7pcV9ZAw08Gm9oV8FpVWfzm6iDR6z9MxMN8COHWxeRSuAYZA0ZBZCQGzKHaQftdOcrbhEukCboxXAD14CPO7OAaU7V2l19DFgOAGQZCc0RT0fRXII4OEALu6o9ZAdnXADbVvAZDZD"
}'

Example response:

{
    "access_token": "EAAERxDHZB3x8BAJyN0AZCSwdJevB3oJzquuIxeTdkJLoDEMAjLatLlWudRt5X5qOmwzMxi04oT8jXX5fgfdgfdgdfgfuSjbuXKeFE5bRsa7KwIv1E2zr4ZBPhOgOb21xMx7vfYVcMUeAZD"
}

HTTP Request

POST api/v1/login/facebook/long_term_access_token

Albums

Get all Albums

This endpoint retrieves all Albums of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/albums" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 342,
            "type": "albums",
            "title": "Omnis natus eos occaecati",
            "permalink": "omnis-natus-eos-occaecati",
            "abstract": "Molestias rerum natus vel aspernatur eum est at. Et nisi consequatur in vel. Tempora repudiandae commodi ut blanditiis ipsum. Repudiandae tenetur similique corrupti ut consequatur et et.",
            "body": "Alias sit dignissimos occaecati eum quo sunt dolor. Aliquam fugit sequi quisquam quisquam quia. Illo eum voluptatem minima rem fugiat. Illum dolor necessitatibus eligendi iste voluptatem et unde. Sed quis nobis dignissimos architecto nesciunt. Aliquam ut voluptatem perferendis sit. Qui fugit at ut temporibus et. Qui at aliquid doloribus. Molestiae ut velit sit quia. Est voluptatem consequatur rem sit. Esse fuga assumenda accusantium. Amet inventore in laboriosam provident.",
            "publish_date": null,
            "unpublish_date": null,
            "pois": [],
            "image_url": null,
            "photos_count": 2,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/342"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/342/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/342/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/342/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/342/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/albums/342",
            "share_url": "https://bologna.mycitydemo.it/albums/342/omnis-natus-eos-occaecati"
        },
        {
            "id": 343,
            "type": "albums",
            "title": "Facilis mollitia quia laborum et dicta",
            "permalink": "facilis-mollitia-quia-laborum-et-dicta",
            "abstract": "Ut voluptatem laborum repellat. Enim impedit dolorem et aut soluta et tenetur totam. Sit quibusdam tempore ut a repellat eos rerum. Qui autem dolorem consequatur.",
            "body": "Aut vel necessitatibus sapiente culpa qui est quidem. Corrupti aliquam nemo quia optio laboriosam. Eum aliquam sed sit placeat unde debitis. Unde rerum perferendis enim repudiandae provident nesciunt aut laboriosam. Sed id eos officia aspernatur. Consequuntur provident sint cumque et architecto. Enim hic consequatur aspernatur est quae. Dolores consequatur voluptatum aut ut. Et iure praesentium voluptates aut vero fugiat eligendi. Qui rerum et asperiores nesciunt quia.",
            "publish_date": null,
            "unpublish_date": null,
            "pois": [],
            "image_url": null,
            "photos_count": 3,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/343"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/343/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/343/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/343/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/343/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/albums/343",
            "share_url": "https://bologna.mycitydemo.it/albums/343/facilis-mollitia-quia-laborum-et-dicta"
        },
        {
            "id": 344,
            "type": "albums",
            "title": "Provident enim fugiat in non",
            "permalink": "provident-enim-fugiat-non",
            "abstract": "Molestias quibusdam nemo atque maiores dolorem magni quidem. Necessitatibus deleniti earum laborum quis. Quia voluptate illum officiis facere temporibus. Et ut asperiores sed eligendi voluptas.",
            "body": "Quo pariatur illo ex quisquam. Dolores sunt eos eos in. Voluptates vel aut assumenda corporis. Impedit voluptas et velit nobis laboriosam reprehenderit debitis. Eos dignissimos voluptas similique dolor saepe. Ea consequatur alias sint cupiditate qui natus ut minima. Est inventore hic enim perferendis quia voluptatibus vel. Sapiente non accusantium dolorum dicta ut porro sed. Est eligendi dolor officiis quibusdam unde.",
            "publish_date": null,
            "unpublish_date": null,
            "pois": [],
            "image_url": null,
            "photos_count": 2,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/344"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/344/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/344/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/344/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/344/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/albums/344",
            "share_url": "https://bologna.mycitydemo.it/albums/344/provident-enim-fugiat-non"
        }
    ],
    "links": {
        "first": "https://api.mycitydemo.it/api/v1/scenarios/2/albums?page=1",
        "last": "https://api.mycitydemo.it/api/v1/scenarios/2/albums?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://api.mycitydemo.it/api/v1/scenarios/2/albums",
        "per_page": 10,
        "to": 3,
        "total": 3
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/albums

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get a specific Album

This endpoint retrieves a specific Album of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/albums/{album}" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 342,
        "type": "albums",
        "title": "Omnis natus eos occaecati",
        "permalink": "omnis-natus-eos-occaecati",
        "abstract": "Molestias rerum natus vel aspernatur eum est at. Et nisi consequatur in vel. Tempora repudiandae commodi ut blanditiis ipsum. Repudiandae tenetur similique corrupti ut consequatur et et.",
        "body": "Alias sit dignissimos occaecati eum quo sunt dolor. Aliquam fugit sequi quisquam quisquam quia. Illo eum voluptatem minima rem fugiat. Illum dolor necessitatibus eligendi iste voluptatem et unde. Sed quis nobis dignissimos architecto nesciunt. Aliquam ut voluptatem perferendis sit. Qui fugit at ut temporibus et. Qui at aliquid doloribus. Molestiae ut velit sit quia. Est voluptatem consequatur rem sit. Esse fuga assumenda accusantium. Amet inventore in laboriosam provident.",
        "publish_date": null,
        "unpublish_date": null,
        "image_url": null,
        "photos_count": 2,
        "links": [
            {
                "rel": "self",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/342"
            },
            {
                "rel": "gallery",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/342/gallery"
            },
            {
                "rel": "menu",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/342/menu"
            },
            {
                "rel": "pois",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/342/pois"
            },
            {
                "rel": "attachments",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/albums/342/attachments"
            }
        ],
        "deeplink": "mycity://scenarios/2/albums/342",
        "share_url": "https://bologna.mycitydemo.it/albums/342/omnis-natus-eos-occaecati"
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/albums/{album}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
album int The ID of the Album to retrieve.

Get the Menu that contains the Album

This endpoint retrieves the Menu that contains the Album.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/albums/{album}/menu" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 4,
        "type": "menus",
        "title": "Ad excepturi provident sit consequatur",
        "permalink": "ad-excepturi-provident-sit-consequatur",
        "abstract": "",
        "body": "",
        "icon_url": "https://api.mycitydemo.it/menu.png",
        "single_content": false,
        "links": [
            {
                "rel": "self",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/4"
            },
            {
                "rel": "contents",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/4/contents"
            }
        ]
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/albums/{album}/menu

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
album int The ID of the Album to retrieve.

Get the POIs of an Album

This endpoint retrieves a list of Points Of Interest for a specific Album of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/albums/{album}/pois" \
-H "Accept: application/json"

Example response:

HTTP Request

GET api/v1/scenarios/{scenario}/albums/{album}/pois

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
album int The ID of the Album to retrieve.

Get the Gallery of an Album

This endpoint retrieves a list of Photos (album) for a specific Album of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/albums/{album}/gallery" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 206,
            "collection_name": "photos",
            "name": "Dolorem ut quia et et dolore repellat.",
            "file_name": "test_1.jpg",
            "mime_type": "image/png",
            "size": 1185,
            "order_column": 206,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/206/test_1.jpg",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/206"
                }
            ]
        },
        {
            "id": 207,
            "collection_name": "photos",
            "name": "Nesciunt laboriosam dolorem voluptas non consequuntur.",
            "file_name": "test_2.jpg",
            "mime_type": "image/png",
            "size": 1671,
            "order_column": 207,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/207/test_2.jpg",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/207"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/albums/{album}/gallery

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
album int The ID of the Album to retrieve.

Get the Attachments of an Album

This endpoint retrieves a list of documents and files (attachments) for a specific Album of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/albums/{album}/attachments" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 206,
            "collection_name": "attachments",
            "name": "Dolorem ut quia et et dolore repellat.",
            "file_name": "test_1.pdf",
            "mime_type": "image/png",
            "size": 1185,
            "order_column": 206,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/206/test_1.pdf",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/206"
                }
            ]
        },
        {
            "id": 207,
            "collection_name": "attachments",
            "name": "Nesciunt laboriosam dolorem voluptas non consequuntur.",
            "file_name": "test_2.pdf",
            "mime_type": "image/png",
            "size": 1671,
            "order_column": 207,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/207/test_2.pdf",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/207"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/albums/{album}/attachments

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
album int The ID of the Album to retrieve.

Pages

Get all Pages

This endpoint retrieves all Pages of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/pages" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 87,
            "type": "pages",
            "title": "Quia repudiandae eos omnis temporibus",
            "permalink": "quia-repudiandae-eos-omnis-temporibus",
            "abstract": "Facere dolorem aut illum corporis culpa esse odio. Unde in recusandae vitae dolorem blanditiis quis. Minima et inventore animi exercitationem.",
            "body": "Et tempora eaque molestiae autem autem nemo. In enim quia voluptatem. Optio atque doloribus aspernatur at quae. Doloremque exercitationem architecto et quia ipsa. Rerum aut aperiam ad repellat quisquam eum mollitia. Eos voluptas ea tempora sed minima deleniti. Corporis consequuntur quas est commodi. Odit dicta placeat et odit enim aut. Quos corrupti sequi minus. Et voluptate nostrum voluptatem dolor magnam voluptatum. Dolore repudiandae qui eaque totam. Recusandae reprehenderit quasi ea et quod eveniet.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/11/100",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/87"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/87/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/87/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/87/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/87/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/pages/87",
            "share_url": "https://bologna.mycitydemo.it/pages/87/quia-repudiandae-eos-omnis-temporibus",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 88,
            "type": "pages",
            "title": "Enim sit vero fugit at totam vitae",
            "permalink": "enim-sit-vero-fugit-at-totam-vitae",
            "abstract": "Eligendi minima vitae reiciendis quasi sed corporis labore. Error officia qui nam quo maiores fugit dignissimos.",
            "body": "Quos exercitationem enim fugiat ut odio asperiores mollitia. Eligendi aut officiis esse id ea. Qui labore sequi assumenda ex. Error magni dolorem ipsa suscipit perferendis. Qui alias ut soluta quibusdam minima architecto. Dolores voluptatem qui modi eveniet sint. Laboriosam officia iste velit provident. Qui id corporis impedit pariatur fugiat consequatur sequi.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/12/100",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/88"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/88/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/88/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/88/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/88/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/pages/88",
            "share_url": "https://bologna.mycitydemo.it/pages/88/enim-sit-vero-fugit-at-totam-vitae",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 89,
            "type": "pages",
            "title": "Voluptatem omnis iure modi provident",
            "permalink": "voluptatem-omnis-iure-modi-provident",
            "abstract": "Voluptatem et quasi quae aliquid. Dolor quo voluptatem laudantium aliquam nesciunt et. Quis repellat sit minus. Soluta aspernatur nulla qui dolorem expedita libero ut ab.",
            "body": "Saepe eum voluptate eos iure vitae. Ut quasi laudantium et vel. Earum sed nostrum dolorem ea quis. Numquam possimus libero odio. Velit et fugit culpa sed corporis suscipit. Et ut pariatur ipsam voluptas cupiditate voluptates. Ut velit enim consequatur. Fugit ipsam quisquam laboriosam ipsa. Enim architecto nihil vero ea ut tenetur voluptatem. Tenetur non vel id repellat et architecto totam.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/13/100",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/89"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/89/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/89/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/89/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/89/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/pages/89",
            "share_url": "https://bologna.mycitydemo.it/pages/89/voluptatem-omnis-iure-modi-provident",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 90,
            "type": "pages",
            "title": "Maiores voluptas autem mollitia",
            "permalink": "maiores-voluptas-autem-mollitia",
            "abstract": "Dolores numquam et ex doloribus quam aperiam sunt. Officiis non dolor quam deleniti eveniet.",
            "body": "Natus earum est vitae quia et totam. Ut laboriosam hic repellendus id omnis nam aliquam iure. Natus autem repellat nobis. Eum magnam consectetur sit. Corporis soluta et eos blanditiis omnis. Eos perferendis voluptates est nesciunt et corrupti. Consequatur et magni excepturi dolores. Qui et tempora qui sint delectus et quo quasi. Eaque id ut consectetur tempora non est rerum enim. Explicabo rerum aut et est at ut. Voluptas nemo quisquam nam dolor.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/14/100",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/90"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/90/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/90/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/90/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/90/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/pages/90",
            "share_url": "https://bologna.mycitydemo.it/pages/90/maiores-voluptas-autem-mollitia",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 91,
            "type": "pages",
            "title": "Rerum nemo voluptatem qui cumque",
            "permalink": "rerum-nemo-voluptatem-qui-cumque",
            "abstract": "Non officia explicabo quia qui. Quam natus quisquam dolores maiores consectetur voluptatem deserunt. Hic nesciunt perferendis nemo a et.",
            "body": "In qui autem accusamus facilis blanditiis aut ut sit. Voluptatem consequuntur voluptates iusto aut eos voluptates. Voluptatem autem facilis sed. Esse quam non qui. Incidunt repellat rem ab corrupti. Pariatur quia ipsam nemo quo et. Ullam vero sunt qui et enim. Itaque maiores consectetur illo ut. Porro molestiae rerum quis est est illo dolorem qui. Corrupti sequi libero cupiditate ea dolores optio iusto. Aut odio ducimus sit necessitatibus.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/15/100",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/91"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/91/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/91/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/91/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/91/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/pages/91",
            "share_url": "https://bologna.mycitydemo.it/pages/91/rerum-nemo-voluptatem-qui-cumque",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 92,
            "type": "pages",
            "title": "Aperiam sed laborum quia ut libero",
            "permalink": "aperiam-sed-laborum-quia-ut-libero",
            "abstract": "Fuga sed expedita quo officia. Ipsum modi vel perferendis nulla suscipit. Ullam natus dolorum eos quam vero.",
            "body": "Architecto dolorem ullam quia soluta est in aspernatur. Est beatae accusantium qui et impedit illum consectetur. Qui aliquam aut sit nulla odio quo quo. Deserunt dolorem unde sit nesciunt sunt. Dolor beatae esse nulla rerum. Incidunt necessitatibus hic eius. Libero nemo et fugit voluptatem. Et nobis excepturi veniam ut repudiandae. Quos commodi excepturi nostrum. Corrupti et exercitationem voluptatum sed dolores. Quae velit illo earum ut.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/16/100",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/92"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/92/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/92/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/92/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/92/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/pages/92",
            "share_url": "https://bologna.mycitydemo.it/pages/92/aperiam-sed-laborum-quia-ut-libero",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 93,
            "type": "pages",
            "title": "Cumque ut ut aperiam minus facere",
            "permalink": "cumque-ut-aperiam-minus-facere",
            "abstract": "Sed qui nihil magni. Ea asperiores ab voluptatem enim vero. Enim magnam labore sit minus rerum.",
            "body": "Soluta ducimus qui aperiam eos quis omnis. Qui ullam eius culpa aliquam. Eos quaerat perferendis nesciunt vel veritatis sapiente sed. Illum dolor tempore modi qui. Error et voluptatum laboriosam. Saepe id laudantium quia. Quos non pariatur impedit inventore qui at beatae. Culpa est quis quisquam aut qui. Odio porro molestiae ut sunt enim. Sequi ea et blanditiis enim. Voluptatem similique maxime sed quis repellendus cum.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/17/100",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/93"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/93/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/93/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/93/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/93/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/pages/93",
            "share_url": "https://bologna.mycitydemo.it/pages/93/cumque-ut-aperiam-minus-facere",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 94,
            "type": "pages",
            "title": "Minima assumenda error rerum",
            "permalink": "minima-assumenda-error-rerum",
            "abstract": "Nisi eum deserunt asperiores ullam excepturi est in. Aut quos fugiat sed. Adipisci amet pariatur natus rerum rerum et voluptatem.",
            "body": "Dolore eum sed impedit iste non quia. Quo repudiandae harum commodi porro odit distinctio. Deleniti voluptatum quae in fugiat rerum fugiat. Facilis et et error sed repellat. Explicabo ut est qui consectetur aut. Dolores voluptas iusto id eaque ipsam. Velit dolor voluptate magnam consequatur minus iusto perspiciatis. Temporibus soluta omnis quia ut aut non asperiores. Id asperiores occaecati rerum voluptate voluptas quaerat. Est fuga id dicta fugiat autem distinctio porro.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/18/100",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/94"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/94/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/94/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/94/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/94/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/pages/94",
            "share_url": "https://bologna.mycitydemo.it/pages/94/minima-assumenda-error-rerum",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 95,
            "type": "pages",
            "title": "Voluptas est impedit sed optio",
            "permalink": "voluptas-est-impedit-sed-optio",
            "abstract": "Nobis tempora soluta quo provident voluptatem culpa. Ad rerum repudiandae distinctio aliquam deserunt cum ducimus. Est animi est quisquam cupiditate nemo. Illum animi deleniti ut asperiores nulla.",
            "body": "Minima maiores placeat et. Eum molestiae occaecati fugiat id. Ut qui commodi veritatis. Voluptatum accusamus soluta neque qui reiciendis. Et nulla autem fuga id deleniti rem. Dolor eum sequi nostrum veniam nemo. Aut aut dignissimos nobis provident dolores. Et voluptatem omnis eius impedit quaerat. Pariatur sunt similique ea explicabo. Perferendis a ut labore sequi et quo. Assumenda est iste in et.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/19/100",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/95"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/95/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/95/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/95/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/95/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/pages/95",
            "share_url": "https://bologna.mycitydemo.it/pages/95/voluptas-est-impedit-sed-optio",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 96,
            "type": "pages",
            "title": "Sit ut quibusdam minus tempora",
            "permalink": "sit-ut-quibusdam-minus-tempora",
            "abstract": "Placeat optio autem deleniti non similique explicabo soluta. Nostrum earum hic quod sit maxime. Hic perspiciatis dolor amet. Occaecati occaecati cumque et quas fugit esse cum.",
            "body": "Laborum et quasi non est ducimus ut voluptatem. Enim ratione voluptatem quia quam. Cumque tempora sequi libero aut assumenda magni. Quae est voluptatum nobis et sed. Eligendi in id reiciendis laborum sit placeat culpa. Aliquid sit et ab. Numquam sint in amet labore non. Corporis quia dolores vero sequi distinctio fugit. Velit quod fugiat quidem velit non.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/20/100",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/96"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/96/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/96/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/96/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/96/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/pages/96",
            "share_url": "https://bologna.mycitydemo.it/pages/96/sit-ut-quibusdam-minus-tempora",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        }
    ],
    "links": {
        "first": "https://api.mycitydemo.it/api/v1/scenarios/2/pages?page=1",
        "last": "https://api.mycitydemo.it/api/v1/scenarios/2/pages?page=4",
        "prev": null,
        "next": "https://api.mycitydemo.it/api/v1/scenarios/2/pages?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 4,
        "path": "https://api.mycitydemo.it/api/v1/scenarios/2/pages",
        "per_page": 10,
        "to": 10,
        "total": 33
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/pages

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get a specific Page

This endpoint retrieves a specific Page of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/pages/{page}" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 87,
        "type": "pages",
        "title": "Quia repudiandae eos omnis temporibus",
        "permalink": "quia-repudiandae-eos-omnis-temporibus",
        "abstract": "Facere dolorem aut illum corporis culpa esse odio. Unde in recusandae vitae dolorem blanditiis quis. Minima et inventore animi exercitationem.",
        "body": "Et tempora eaque molestiae autem autem nemo. In enim quia voluptatem. Optio atque doloribus aspernatur at quae. Doloremque exercitationem architecto et quia ipsa. Rerum aut aperiam ad repellat quisquam eum mollitia. Eos voluptas ea tempora sed minima deleniti. Corporis consequuntur quas est commodi. Odit dicta placeat et odit enim aut. Quos corrupti sequi minus. Et voluptate nostrum voluptatem dolor magnam voluptatum. Dolore repudiandae qui eaque totam. Recusandae reprehenderit quasi ea et quod eveniet.",
        "publish_date": null,
        "unpublish_date": null,
        "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/11/100",
        "links": [
            {
                "rel": "self",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/87"
            },
            {
                "rel": "gallery",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/87/gallery"
            },
            {
                "rel": "menu",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/87/menu"
            },
            {
                "rel": "pois",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/87/pois"
            },
            {
                "rel": "attachments",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/87/attachments"
            }
        ],
        "deeplink": "mycity://scenarios/2/pages/87",
        "share_url": "https://bologna.mycitydemo.it/pages/87/quia-repudiandae-eos-omnis-temporibus",
        "liked": false,
        "likes": 0,
        "shared": false,
        "shares": 0
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/pages/{page}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
page int The ID of the Page to retrieve.

Get the Menu that contains the Page

This endpoint retrieves the Menu that contains the Page.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/pages/{page}/menu" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 26,
        "type": "menus",
        "title": "Quia est animi adipisci mollitia",
        "permalink": "quia-est-animi-adipisci-mollitia",
        "abstract": "",
        "body": "",
        "icon_url": "https://api.mycitydemo.it/menu.png",
        "single_content": false,
        "links": [
            {
                "rel": "self",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/26"
            },
            {
                "rel": "contents",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/26/contents"
            }
        ]
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/pages/{page}/menu

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
page int The ID of the Page to retrieve.

Get the Gallery of a Page

This endpoint retrieves a list of Photos (page) for a specific Page of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/pages/{page}/gallery" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 206,
            "collection_name": "photos",
            "name": "Dolorem ut quia et et dolore repellat.",
            "file_name": "test_1.jpg",
            "mime_type": "image/png",
            "size": 1185,
            "order_column": 206,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/206/test_1.jpg",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/206"
                }
            ]
        },
        {
            "id": 207,
            "collection_name": "photos",
            "name": "Nesciunt laboriosam dolorem voluptas non consequuntur.",
            "file_name": "test_2.jpg",
            "mime_type": "image/png",
            "size": 1671,
            "order_column": 207,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/207/test_2.jpg",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/207"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/pages/{page}/gallery

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
page int The ID of the Page to retrieve.

Get the Attachments of a Page

This endpoint retrieves a list of documents and files (attachments) for a specific Page of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/pages/{page}/attachments" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 206,
            "collection_name": "attachments",
            "name": "Dolorem ut quia et et dolore repellat.",
            "file_name": "test_1.pdf",
            "mime_type": "image/png",
            "size": 1185,
            "order_column": 206,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/206/test_1.pdf",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/206"
                }
            ]
        },
        {
            "id": 207,
            "collection_name": "attachments",
            "name": "Nesciunt laboriosam dolorem voluptas non consequuntur.",
            "file_name": "test_2.pdf",
            "mime_type": "image/png",
            "size": 1671,
            "order_column": 207,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/207/test_2.pdf",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/207"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/pages/{page}/attachments

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
page int The ID of the Page to retrieve.

Get the POIs of a Page

This endpoint retrieves a list of Points Of Interest for a specific Page of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/pages/{page}/pois" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "title": "Laudantium sit dolorum quia et",
            "latitude": "27.5541840",
            "longitude": "15.6636200",
            "address": "Via Neri 37 Piano 0\nSesto Cleopatra, 74421 Livorno (VI)"
        },
        {
            "id": 2,
            "title": "Vero numquam nostrum sed",
            "latitude": "19.7934200",
            "longitude": "46.3182570",
            "address": "Via Montanari 3 Piano 0\nQuarto Sarita del friuli, 65982 Alessandria (BI)"
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/pages/{page}/pois

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
page int The ID of the Page to retrieve.

Employees

Get all Employees

This endpoint retrieves all Employees of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/employees" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 20,
            "type": "employees",
            "title": "Ortensia Gentile",
            "permalink": "ortensia-gentile",
            "abstract": "Id eum ratione consequatur omnis quae. Molestias est modi et cupiditate rem.",
            "body": "Voluptatem et ex architecto deserunt vero. Voluptatum non distinctio sint nesciunt eligendi repudiandae nemo. Iusto non est enim quibusdam perspiciatis et eum iusto. Expedita rem aut eum accusamus et et amet.\n\nEa harum sapiente laboriosam dolorum. Animi aperiam eaque eum quo et labore. Et porro hic tempore et et doloremque quia. Possimus soluta quisquam deserunt voluptates. Aut eaque vel dolor ea unde ea.\n\nSit sit dolores saepe dignissimos qui excepturi reprehenderit. Perspiciatis enim facere sint maxime recusandae et.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/81/generic-person.jpg",
            "role": "suscipit",
            "phone": "+84 674 9526679",
            "fax": "+39 336 436 550",
            "email": "patrizio21@example.net",
            "pec": "grazia.amato@example.com",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/20"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/20/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/20/menu"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/20/attachments"
                },
                {
                    "rel": "offices",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/20/offices"
                },
                {
                    "rel": "administrations",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/20/administrations"
                }
            ],
            "deeplink": "mycity://scenarios/5/employees/20",
            "share_url": "http://istituzionale.mycity.api/personale/20/ortensia-gentile"
        },
        {
            "id": 21,
            "type": "employees",
            "title": "Ing. Anselmo Vitale",
            "permalink": "ing-anselmo-vitale",
            "abstract": "Nostrum possimus dolorum nesciunt aut. Illo sint autem ducimus cupiditate est. Quod ratione sit excepturi ut dicta.",
            "body": "Similique nostrum voluptate odio tenetur iusto ipsam. Quam sed iste quod in perspiciatis voluptatibus ipsum velit.\n\nOmnis illo commodi omnis id voluptatum culpa modi enim. Qui ipsam non maiores quam.\n\nTempora sint reiciendis ipsam quia quo perferendis. Porro temporibus perspiciatis recusandae voluptas. Quae debitis libero sit unde. Aut assumenda ea libero nihil.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/82/generic-person.jpg",
            "role": "accusantium",
            "phone": "+11 2264 71782649",
            "fax": "+21 8919 08262868",
            "email": "primo.valentini@example.com",
            "pec": "akira96@example.com",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/21"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/21/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/21/menu"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/21/attachments"
                },
                {
                    "rel": "offices",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/21/offices"
                },
                {
                    "rel": "administrations",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/21/administrations"
                }
            ],
            "deeplink": "mycity://scenarios/5/employees/21",
            "share_url": "http://istituzionale.mycity.api/personale/21/ing-anselmo-vitale"
        },
        {
            "id": 22,
            "type": "employees",
            "title": "Dr. Joshua Ruggiero",
            "permalink": "dr-joshua-ruggiero",
            "abstract": "Consectetur qui praesentium ea natus veniam aut. Fugiat dolor officia repellendus ex sit quia explicabo veniam. Quae ipsa et et deleniti. Aliquam nobis sed veritatis fugit quod.",
            "body": "Ut suscipit harum quo enim. Est est est iure omnis fuga. Vel ad ut ut eaque.\n\nOmnis enim qui a ipsa reprehenderit quo quos. Soluta ea commodi pariatur nulla quis. Sint assumenda rem enim mollitia.\n\nQuaerat quia doloribus sunt ut sit enim. Repudiandae sit enim laborum explicabo qui voluptatem repellendus. Accusantium voluptates a itaque est qui dolor. Nesciunt nobis rerum odio adipisci.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/83/generic-person.jpg",
            "role": "reiciendis",
            "phone": "+74 40 8764123",
            "fax": "+39 094 784 540",
            "email": "fabio.rossetti@example.net",
            "pec": "kristel19@example.org",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/22"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/22/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/22/menu"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/22/attachments"
                },
                {
                    "rel": "offices",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/22/offices"
                },
                {
                    "rel": "administrations",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/22/administrations"
                }
            ],
            "deeplink": "mycity://scenarios/5/employees/22",
            "share_url": "http://istituzionale.mycity.api/personale/22/dr-joshua-ruggiero"
        },
        {
            "id": 23,
            "type": "employees",
            "title": "Joannes Pellegrino",
            "permalink": "joannes-pellegrino",
            "abstract": "Adipisci tenetur doloribus sed rem qui. Voluptas aliquid ipsam ea et accusamus illo. Qui autem quisquam incidunt deleniti. Omnis molestiae et eius qui velit cum autem.",
            "body": "Quia quidem aut at maiores. Sint sunt sed sunt consectetur.\n\nIste incidunt est aspernatur eligendi. Soluta id rerum minus ut cupiditate non. Eaque nulla cupiditate accusamus perspiciatis cum iure.\n\nOfficia sequi modi harum aliquid sed ut. Et voluptatem error omnis molestiae. Explicabo ullam ea deleniti iste velit.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/84/generic-person.jpg",
            "role": "qui",
            "phone": "+39 024 579 052",
            "fax": "+40 601 4943102",
            "email": "boris.dangelo@example.org",
            "pec": "obattaglia@example.org",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/23"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/23/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/23/menu"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/23/attachments"
                },
                {
                    "rel": "offices",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/23/offices"
                },
                {
                    "rel": "administrations",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/23/administrations"
                }
            ],
            "deeplink": "mycity://scenarios/5/employees/23",
            "share_url": "http://istituzionale.mycity.api/personale/23/joannes-pellegrino"
        },
        {
            "id": 24,
            "type": "employees",
            "title": "Sig.ra Luna Gallo",
            "permalink": "sig-ra-luna-gallo",
            "abstract": "Laudantium rerum id maxime et. Illum dicta aut fuga quasi dolor voluptatem saepe debitis. Dolores eveniet velit porro velit eius non excepturi. Voluptatem mollitia non est vel et et ducimus ipsum.",
            "body": "Consequuntur velit occaecati pariatur laboriosam est ipsum. Vitae officia similique odio atque tenetur eaque. Fuga placeat amet vero corrupti nemo cumque. Numquam quia omnis ipsa perspiciatis est quo sed. Et quo soluta in fugiat et numquam libero.\n\nDolor quod nulla enim dignissimos vitae. Aliquid repellat dicta inventore sed est numquam. Soluta architecto magnam et exercitationem. Ut quidem harum dolore aut ratione ut.\n\nEius voluptatum dolorem culpa voluptatem ratione alias architecto facilis. Soluta officia hic facilis quas. Ea esse vel in dolores doloribus eligendi. Perferendis voluptate doloribus fuga et.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/85/generic-person.jpg",
            "role": "veritatis",
            "phone": "+47 5488 40736974",
            "fax": "+26 87 4513268",
            "email": "filomena.negri@example.com",
            "pec": "cfabbri@example.com",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/24"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/24/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/24/menu"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/24/attachments"
                },
                {
                    "rel": "offices",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/24/offices"
                },
                {
                    "rel": "administrations",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/24/administrations"
                }
            ],
            "deeplink": "mycity://scenarios/5/employees/24",
            "share_url": "http://istituzionale.mycity.api/personale/24/sig-ra-luna-gallo"
        },
        {
            "id": 25,
            "type": "employees",
            "title": "Demis Bianchi",
            "permalink": "demis-bianchi",
            "abstract": "Minus et quis ex odio veritatis labore magnam. Est ea recusandae rerum in. Beatae sunt cupiditate cupiditate qui laboriosam velit quos.",
            "body": "Fuga magni quia repellat aliquam debitis sed nam. Dolores nemo est rerum laborum facilis ullam ut voluptatibus. Ea quod id quod accusamus. Dolore voluptates qui ut.\n\nLaudantium aut ducimus sint quisquam rerum ducimus. Sapiente eum voluptatem molestias exercitationem consequatur autem animi. Maiores corrupti possimus sit quia a in. Voluptatem aut iusto alias eius dolorum quis. Odio ea modi optio.\n\nLabore aut reprehenderit accusantium velit. Sed vel debitis laboriosam voluptas ratione sit sed ut. Nihil rerum aperiam quo voluptas quas sit aperiam.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/86/generic-person.jpg",
            "role": "voluptatem",
            "phone": "351 631 570",
            "fax": "+92 465 65520962",
            "email": "pagano.donatella@example.com",
            "pec": "diana46@example.com",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/25"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/25/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/25/menu"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/25/attachments"
                },
                {
                    "rel": "offices",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/25/offices"
                },
                {
                    "rel": "administrations",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/25/administrations"
                }
            ],
            "deeplink": "mycity://scenarios/5/employees/25",
            "share_url": "http://istituzionale.mycity.api/personale/25/demis-bianchi"
        },
        {
            "id": 26,
            "type": "employees",
            "title": "Ettore Ferri",
            "permalink": "ettore-ferri",
            "abstract": "Sequi et corporis aliquid perspiciatis nihil ut quam. Fuga dignissimos ducimus et voluptatum fugit. Ipsam voluptas earum autem quis. Et aut sunt iure dolor quasi.",
            "body": "Dolor sed quia et dolorum nostrum. Vero qui laboriosam maxime. Et quis sunt magni autem rerum et quo.\n\nEt ipsum et pariatur sit blanditiis porro veritatis. Consequatur dicta et molestiae. Perspiciatis et omnis est veniam unde. Qui quae ut consequatur labore est ipsa corporis nulla.\n\nVoluptates deleniti enim nihil neque fuga. Numquam officiis debitis odit unde possimus voluptas aut. Est sunt rerum autem ipsum eius eos illo.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/87/generic-person.jpg",
            "role": "sapiente",
            "phone": "+39 397 485 639",
            "fax": "320 422 930",
            "email": "amos05@example.net",
            "pec": "selvaggia.serra@example.com",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/26"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/26/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/26/menu"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/26/attachments"
                },
                {
                    "rel": "offices",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/26/offices"
                },
                {
                    "rel": "administrations",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/26/administrations"
                }
            ],
            "deeplink": "mycity://scenarios/5/employees/26",
            "share_url": "http://istituzionale.mycity.api/personale/26/ettore-ferri"
        },
        {
            "id": 27,
            "type": "employees",
            "title": "Rosolino Battaglia",
            "permalink": "rosolino-battaglia",
            "abstract": "Consectetur necessitatibus explicabo ut iste. Qui ut inventore animi sunt quisquam inventore. Repellat dolor distinctio ut ipsa culpa amet sapiente et.",
            "body": "Vitae aut minus iusto velit facilis provident quis. Omnis deserunt quos consequatur a in voluptatem eum. Quis illum cum eum culpa minus. Ipsa autem et aut eius facere quae.\n\nEarum quia dolor dolores sit. Itaque ea sed aut corrupti consequuntur alias. Ipsam ut id eos ex.\n\nUt eos voluptatem vero consequatur. Doloremque ea sequi repellat magnam voluptas sit aut rem. Dolore commodi dolores eos ea officiis optio tempore. Maxime ipsam earum dignissimos provident consequuntur non ipsam et.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/88/generic-person.jpg",
            "role": "illo",
            "phone": "+63 39 54711966",
            "fax": "+94 007 05 04 3670",
            "email": "hruggiero@example.com",
            "pec": "shaira46@example.net",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/27"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/27/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/27/menu"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/27/attachments"
                },
                {
                    "rel": "offices",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/27/offices"
                },
                {
                    "rel": "administrations",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/27/administrations"
                }
            ],
            "deeplink": "mycity://scenarios/5/employees/27",
            "share_url": "http://istituzionale.mycity.api/personale/27/rosolino-battaglia"
        },
        {
            "id": 30,
            "type": "employees",
            "title": "Dott. Lidia Conte",
            "permalink": "dott-lidia-conte",
            "abstract": "Accusantium quos id assumenda aliquid ut a magni. Aliquam autem quasi corporis ut et nostrum quia. Sequi aut quia sequi voluptatem.",
            "body": "Nesciunt nihil animi sed optio aut alias reiciendis quisquam. Error non dolores dolore rerum. Nesciunt reiciendis officiis ab cum. Quia fugit expedita id perspiciatis officiis rerum architecto unde. Nulla perferendis deleniti atque et non sit.\n\nUt dolorum ut et id aut et. Totam provident repudiandae est voluptates. Et reprehenderit temporibus perspiciatis expedita.\n\nRepellat voluptatem quam voluptas alias vel soluta libero. Nesciunt voluptas expedita accusamus qui. Voluptatibus optio tenetur explicabo a quas earum quia.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/89/generic-person.jpg",
            "role": "vel",
            "phone": "+56 341 54141167",
            "fax": "+45 5227 9512929",
            "email": "assia.barone@example.com",
            "pec": "marianita.donati@example.org",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/30"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/30/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/30/menu"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/30/attachments"
                },
                {
                    "rel": "offices",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/30/offices"
                },
                {
                    "rel": "administrations",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/30/administrations"
                }
            ],
            "deeplink": "mycity://scenarios/5/employees/30",
            "share_url": "http://istituzionale.mycity.api/personale/30/dott-lidia-conte"
        },
        {
            "id": 31,
            "type": "employees",
            "title": "Dott. Guendalina Parisi",
            "permalink": "dott-guendalina-parisi",
            "abstract": "Magnam accusantium ipsum incidunt ex illo sed minima. Quibusdam voluptatem dolorum ut voluptatem unde eos sit facere. Voluptates sint distinctio nisi aperiam nostrum at natus.",
            "body": "Rerum et odio voluptatem dolor. Autem fugiat rerum ut rerum saepe assumenda. Distinctio iste nesciunt ea fugiat sint deserunt omnis. Itaque quae quo officia necessitatibus debitis error. Culpa repellendus exercitationem sequi sint sunt aut sed.\n\nTotam quod nihil delectus et et quo. Accusantium nam dolore quod nulla cupiditate adipisci voluptatem quia. Ipsam qui ea ipsa facere nulla nobis. Est consectetur nihil eum fuga.\n\nVelit voluptatibus praesentium maxime veritatis tenetur iusto nostrum. Sit qui qui aut nulla. Libero cumque reprehenderit quod eligendi facere accusantium.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/90/generic-person.jpg",
            "role": "qui",
            "phone": "+15 59 4381851",
            "fax": "024 020 5553",
            "email": "elda.galli@example.org",
            "pec": "npagano@example.org",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/31"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/31/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/31/menu"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/31/attachments"
                },
                {
                    "rel": "offices",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/31/offices"
                },
                {
                    "rel": "administrations",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/31/administrations"
                }
            ],
            "deeplink": "mycity://scenarios/5/employees/31",
            "share_url": "http://istituzionale.mycity.api/personale/31/dott-guendalina-parisi"
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/5/employees?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/5/employees?page=3",
        "prev": null,
        "next": "http://api.mycity.api/api/v1/scenarios/5/employees?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 3,
        "path": "http://api.mycity.api/api/v1/scenarios/5/employees",
        "per_page": 10,
        "to": 10,
        "total": 21
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/employees

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get a specific Employee

This endpoint retrieves a specific Employee of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/employees/{employee}" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 20,
        "type": "employees",
        "title": "Ortensia Gentile",
        "permalink": "ortensia-gentile",
        "abstract": "Id eum ratione consequatur omnis quae. Molestias est modi et cupiditate rem.",
        "body": "Voluptatem et ex architecto deserunt vero. Voluptatum non distinctio sint nesciunt eligendi repudiandae nemo. Iusto non est enim quibusdam perspiciatis et eum iusto. Expedita rem aut eum accusamus et et amet.\n\nEa harum sapiente laboriosam dolorum. Animi aperiam eaque eum quo et labore. Et porro hic tempore et et doloremque quia. Possimus soluta quisquam deserunt voluptates. Aut eaque vel dolor ea unde ea.\n\nSit sit dolores saepe dignissimos qui excepturi reprehenderit. Perspiciatis enim facere sint maxime recusandae et.",
        "publish_date": null,
        "unpublish_date": null,
        "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/81/generic-person.jpg",
        "role": "suscipit",
        "phone": "+84 674 9526679",
        "fax": "+39 336 436 550",
        "email": "patrizio21@example.net",
        "pec": "grazia.amato@example.com",
        "links": [
            {
                "rel": "self",
                "href": "http://api.mycity.api/api/v1/scenarios/5/employees/20"
            },
            {
                "rel": "gallery",
                "href": "http://api.mycity.api/api/v1/scenarios/5/employees/20/gallery"
            },
            {
                "rel": "menu",
                "href": "http://api.mycity.api/api/v1/scenarios/5/employees/20/menu"
            },
            {
                "rel": "attachments",
                "href": "http://api.mycity.api/api/v1/scenarios/5/employees/20/attachments"
            },
            {
                "rel": "offices",
                "href": "http://api.mycity.api/api/v1/scenarios/5/employees/20/offices"
            },
            {
                "rel": "administrations",
                "href": "http://api.mycity.api/api/v1/scenarios/5/employees/20/administrations"
            }
        ],
        "deeplink": "mycity://scenarios/5/employees/20",
        "share_url": "http://istituzionale.mycity.api/personale/20/ortensia-gentile"
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/employees/{employee}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
employee int The ID of the Employee to retrieve.

Get the Menu that contains the Employee

This endpoint retrieves the Menu that contains the Employee.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/employees/{employee}/menu" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 38,
        "type": "menus",
        "title": "Et iure autem consequatur esse",
        "permalink": "et-iure-autem-consequatur-esse",
        "abstract": "",
        "body": "",
        "icon_url": "http://api.mycity.api/menu.png",
        "single_content": false,
        "links": [
            {
                "rel": "self",
                "href": "http://api.mycity.api/api/v1/scenarios/2/menus/38"
            },
            {
                "rel": "contents",
                "href": "http://api.mycity.api/api/v1/scenarios/2/menus/38/contents"
            }
        ]
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/employees/{employee}/menu

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
employee int The ID of the Employee to retrieve.

Get the Attachments of an Employee

This endpoint retrieves a list of documents and files (attachments) for a specific Employee of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/employees/{employee}/attachments" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 206,
            "collection_name": "attachments",
            "name": "Dolorem ut quia et et dolore repellat.",
            "file_name": "test_1.pdf",
            "mime_type": "image/png",
            "size": 1185,
            "order_column": 206,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/206/test_1.pdf",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/206"
                }
            ]
        },
        {
            "id": 207,
            "collection_name": "attachments",
            "name": "Nesciunt laboriosam dolorem voluptas non consequuntur.",
            "file_name": "test_2.pdf",
            "mime_type": "image/png",
            "size": 1671,
            "order_column": 207,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/207/test_2.pdf",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/207"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/employees/{employee}/attachments

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
employee int The ID of the Employee to retrieve.

Get the Gallery of an Employee

This endpoint retrieves a list of Photos (employee) for a specific Employee of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/employees/{employee}/gallery" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 206,
            "collection_name": "photos",
            "name": "Dolorem ut quia et et dolore repellat.",
            "file_name": "test_1.jpg",
            "mime_type": "image/png",
            "size": 1185,
            "order_column": 206,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/206/test_1.jpg",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/206"
                }
            ]
        },
        {
            "id": 207,
            "collection_name": "photos",
            "name": "Nesciunt laboriosam dolorem voluptas non consequuntur.",
            "file_name": "test_2.jpg",
            "mime_type": "image/png",
            "size": 1671,
            "order_column": 207,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/207/test_2.jpg",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/207"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/employees/{employee}/gallery

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
employee int The ID of the Employee to retrieve.

Events

Get all Events

This endpoint retrieves all Events of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/events" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 177,
            "type": "events",
            "title": "Sit quia harum quas odit autem error",
            "permalink": "sit-quia-harum-quas-odit-autem-error",
            "abstract": "Odit vel voluptatem nihil eligendi corrupti. Qui sint iure labore. Dolor praesentium vero odit natus molestiae accusamus dolorum ullam.",
            "body": "Quasi qui dolor voluptas eos eveniet aspernatur harum est. Consequatur dolorem alias voluptatem. Tempora ea id vel. Quasi voluptatem quia voluptatem totam occaecati in sed. Et repellat necessitatibus saepe. Id ipsa nihil accusantium necessitatibus non natus. Neque dicta sit reiciendis libero eos quia autem. Omnis et qui porro tempore. Et eos est quis eos praesentium accusantium optio eaque.",
            "publish_date": null,
            "unpublish_date": null,
            "pois": [
                {
                    "id": 1,
                    "title": "Laudantium sit dolorum quia et",
                    "latitude": "27.5541840",
                    "longitude": "15.6636200",
                    "address": "Via Neri 37 Piano 0\nSesto Cleopatra, 74421 Livorno (VI)"
                },
                {
                    "id": 2,
                    "title": "Vero numquam nostrum sed",
                    "latitude": "19.7934200",
                    "longitude": "46.3182570",
                    "address": "Via Montanari 3 Piano 0\nQuarto Sarita del friuli, 65982 Alessandria (BI)"
                }
            ],
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/101/100",
            "start_date": "2017-06-04 19:50:05",
            "end_date": null,
            "all_day": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/177"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/177/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/177/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/177/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/177/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/events/177",
            "share_url": "https://bologna.mycitydemo.it/events/177/sit-quia-harum-quas-odit-autem-error",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 178,
            "type": "events",
            "title": "Vel non voluptate qui nam quis quam",
            "permalink": "vel-non-voluptate-qui-nam-quis-quam",
            "abstract": "Amet maiores eligendi est ut sed ratione. Laborum provident unde labore magnam ut voluptates. Tempora quidem non perspiciatis ullam. Laudantium excepturi rerum cum est.",
            "body": "Vero qui aut esse rerum. Quis maxime deserunt minima autem fuga velit quidem. Temporibus doloremque autem architecto quos doloribus id. Facilis cumque sequi earum dolores fugiat et amet. Iste rem velit distinctio suscipit repellendus. Culpa sit odit et necessitatibus earum quis dolor enim. Ab in aut dolor eum est aut perferendis temporibus. Molestiae nobis voluptatem exercitationem.",
            "publish_date": null,
            "unpublish_date": null,
            "pois": [
                {
                    "id": 3,
                    "title": "Repudiandae nihil itaque nam fugit",
                    "latitude": "59.2045710",
                    "longitude": "53.1791540",
                    "address": "Piazza Rinaldi 738 Appartamento 59\nQuarto Rudy calabro, 26931 Como (CH)"
                }
            ],
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/102/100",
            "start_date": "2017-07-25 09:14:44",
            "end_date": null,
            "all_day": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/178"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/178/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/178/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/178/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/178/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/events/178",
            "share_url": "https://bologna.mycitydemo.it/events/178/vel-non-voluptate-qui-nam-quis-quam",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 179,
            "type": "events",
            "title": "Mollitia beatae omnis delectus unde",
            "permalink": "mollitia-beatae-omnis-delectus-unde",
            "abstract": "Ea dolorem quam inventore rerum. Pariatur quisquam sit dolorem corporis error. Id odio quae numquam rerum. Aut qui quod eos sequi et sed.",
            "body": "Et neque aperiam sapiente iure velit voluptate. Nostrum et fuga quo saepe itaque aspernatur. Minima laboriosam harum blanditiis quibusdam tempora. Omnis harum illum totam voluptas nam ut. Natus rerum voluptatibus totam fugiat. Et voluptatum debitis voluptatem placeat. Debitis perspiciatis dolor ullam eius et nostrum harum. Qui corrupti ea ad eum. Sapiente fuga iste optio sunt debitis aut qui. Dolorem est corrupti enim est tenetur ipsum.",
            "publish_date": null,
            "unpublish_date": null,
            "pois": [
                {
                    "id": 4,
                    "title": "Non odit iste quidem ipsum",
                    "latitude": "41.4164760",
                    "longitude": "48.7622390",
                    "address": "Contrada Barone 27\nSan Giobbe, 16816 Vercelli (PT)"
                },
                {
                    "id": 5,
                    "title": "Qui et maiores dicta velit",
                    "latitude": "17.3600280",
                    "longitude": "29.7935030",
                    "address": "Piazza De Angelis 9\nBorgo Rocco nell'emilia, 22895 Ferrara (CL)"
                }
            ],
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/103/100",
            "start_date": "2018-01-21 04:17:43",
            "end_date": null,
            "all_day": 1,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/179"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/179/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/179/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/179/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/179/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/events/179",
            "share_url": "https://bologna.mycitydemo.it/events/179/mollitia-beatae-omnis-delectus-unde",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 180,
            "type": "events",
            "title": "Odit alias velit a placeat",
            "permalink": "odit-alias-velit-placeat",
            "abstract": "Incidunt omnis ea velit dolore. Odio cumque et omnis quidem provident nisi veritatis. Sed voluptatem suscipit velit aut quas.",
            "body": "Beatae perferendis distinctio voluptatem voluptas. Nisi tempora tempora neque adipisci vel quam illum. Sit aut ut illum odio qui quis deserunt. Architecto ea dolores eum est quisquam rerum. Eligendi ipsum et sunt sed. Et est totam cum. Quo voluptatibus fuga saepe sed eum sit. Doloribus maxime sint sint quo. Officiis sed explicabo accusamus in non impedit. Quam qui quis rerum velit odio. Eligendi qui enim quis et. Fugit repellendus neque molestiae minus.",
            "publish_date": null,
            "unpublish_date": null,
            "pois": [
                {
                    "id": 6,
                    "title": "Vel officiis voluptas voluptatem et",
                    "latitude": "13.5101980",
                    "longitude": "22.0333190",
                    "address": "Borgo Palumbo 664\nBorgo Miriana a mare, 47456 Trento (VI)"
                }
            ],
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/104/100",
            "start_date": "2017-04-13 18:42:14",
            "end_date": "2017-05-09 16:15:45",
            "all_day": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/180"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/180/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/180/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/180/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/180/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/events/180",
            "share_url": "https://bologna.mycitydemo.it/events/180/odit-alias-velit-placeat",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 181,
            "type": "events",
            "title": "Rerum dolorum quaerat et et",
            "permalink": "rerum-dolorum-quaerat-et",
            "abstract": "Modi impedit non nesciunt ex quasi explicabo. Aliquid facere sapiente modi magnam perspiciatis ipsam laborum. Ea temporibus autem ut error suscipit.",
            "body": "Asperiores magni quia ut maiores. Quidem doloribus molestiae possimus velit. Autem fugiat deserunt est nesciunt adipisci. Qui sed amet hic quo velit. Qui voluptatem molestiae eligendi qui quo et sed. Deserunt blanditiis maiores provident natus ab molestias aspernatur. Aut in id consequatur non nesciunt ducimus consequatur. Inventore tenetur doloribus dolorum omnis ipsum deleniti dolore. Cupiditate voluptatum sint et sequi. Et sit consequatur eos aut nisi.",
            "publish_date": null,
            "unpublish_date": null,
            "pois": [
                {
                    "id": 7,
                    "title": "Ut aut consequuntur rem velit",
                    "latitude": "44.3311230",
                    "longitude": "59.5056010",
                    "address": "Incrocio Lino 96 Appartamento 06\nBorgo Flaviana, 01585 Sassari (LT)"
                }
            ],
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/105/100",
            "start_date": "2017-07-05 21:47:27",
            "end_date": null,
            "all_day": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/181"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/181/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/181/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/181/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/181/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/events/181",
            "share_url": "https://bologna.mycitydemo.it/events/181/rerum-dolorum-quaerat-et",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        }
    ],
    "links": {
        "first": "https://api.mycitydemo.it/api/v1/scenarios/2/events?page=1",
        "last": "https://api.mycitydemo.it/api/v1/scenarios/2/events?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://api.mycitydemo.it/api/v1/scenarios/2/events",
        "per_page": 10,
        "to": 5,
        "total": 5
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/events

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get a specific Event

This endpoint retrieves a specific Event of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/events/{event}" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 177,
        "type": "events",
        "title": "Sit quia harum quas odit autem error",
        "permalink": "sit-quia-harum-quas-odit-autem-error",
        "abstract": "Odit vel voluptatem nihil eligendi corrupti. Qui sint iure labore. Dolor praesentium vero odit natus molestiae accusamus dolorum ullam.",
        "body": "Quasi qui dolor voluptas eos eveniet aspernatur harum est. Consequatur dolorem alias voluptatem. Tempora ea id vel. Quasi voluptatem quia voluptatem totam occaecati in sed. Et repellat necessitatibus saepe. Id ipsa nihil accusantium necessitatibus non natus. Neque dicta sit reiciendis libero eos quia autem. Omnis et qui porro tempore. Et eos est quis eos praesentium accusantium optio eaque.",
        "publish_date": null,
        "unpublish_date": null,
        "pois": [
            {
                "id": 1,
                "title": "Laudantium sit dolorum quia et",
                "latitude": "27.5541840",
                "longitude": "15.6636200",
                "address": "Via Neri 37 Piano 0\nSesto Cleopatra, 74421 Livorno (VI)"
            },
            {
                "id": 2,
                "title": "Vero numquam nostrum sed",
                "latitude": "19.7934200",
                "longitude": "46.3182570",
                "address": "Via Montanari 3 Piano 0\nQuarto Sarita del friuli, 65982 Alessandria (BI)"
            }
        ],
        "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/101/100",
        "start_date": "2017-06-04 19:50:05",
        "end_date": null,
        "all_day": 0,
        "links": [
            {
                "rel": "self",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/177"
            },
            {
                "rel": "gallery",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/177/gallery"
            },
            {
                "rel": "menu",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/177/menu"
            },
            {
                "rel": "pois",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/177/pois"
            },
            {
                "rel": "attachments",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events/177/attachments"
            }
        ],
        "deeplink": "mycity://scenarios/2/events/177",
        "share_url": "https://bologna.mycitydemo.it/events/177/sit-quia-harum-quas-odit-autem-error",
        "liked": false,
        "likes": 0,
        "shared": false,
        "shares": 0
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/events/{event}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
event int The ID of the Event to retrieve.

Get the Menu that contains the Event

This endpoint retrieves the Menu that contains the Event.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/events/{event}/menu" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 17,
        "type": "menus",
        "title": "Ut ut ipsa quas sint",
        "permalink": "ut-ipsa-quas-sint",
        "abstract": "",
        "body": "",
        "icon_url": "https://api.mycitydemo.it/menu.png",
        "single_content": true,
        "links": [
            {
                "rel": "self",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/17"
            },
            {
                "rel": "contents",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/17/contents"
            }
        ]
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/events/{event}/menu

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
event int The ID of the Event to retrieve.

Get the POIs of a Event

This endpoint retrieves a list of Points Of Interest for a specific Event of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/events/{event}/pois" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "title": "Laudantium sit dolorum quia et",
            "latitude": "27.5541840",
            "longitude": "15.6636200",
            "address": "Via Neri 37 Piano 0\nSesto Cleopatra, 74421 Livorno (VI)"
        },
        {
            "id": 2,
            "title": "Vero numquam nostrum sed",
            "latitude": "19.7934200",
            "longitude": "46.3182570",
            "address": "Via Montanari 3 Piano 0\nQuarto Sarita del friuli, 65982 Alessandria (BI)"
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/events/{event}/pois

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
event int The ID of the Event to retrieve.

Get the Attachments of an Event

This endpoint retrieves a list of documents and files (attachments) for a specific Event of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/events/{event}/attachments" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 206,
            "collection_name": "attachments",
            "name": "Dolorem ut quia et et dolore repellat.",
            "file_name": "test_1.pdf",
            "mime_type": "image/png",
            "size": 1185,
            "order_column": 206,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/206/test_1.pdf",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/206"
                }
            ]
        },
        {
            "id": 207,
            "collection_name": "attachments",
            "name": "Nesciunt laboriosam dolorem voluptas non consequuntur.",
            "file_name": "test_2.pdf",
            "mime_type": "image/png",
            "size": 1671,
            "order_column": 207,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/207/test_2.pdf",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/207"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/events/{event}/attachments

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
event int The ID of the Event to retrieve.

Get the Gallery of an Event

This endpoint retrieves a list of Photos (event) for a specific Event of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/events/{event}/gallery" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 206,
            "collection_name": "photos",
            "name": "Dolorem ut quia et et dolore repellat.",
            "file_name": "test_1.jpg",
            "mime_type": "image/png",
            "size": 1185,
            "order_column": 206,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/206/test_1.jpg",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/206"
                }
            ]
        },
        {
            "id": 207,
            "collection_name": "photos",
            "name": "Nesciunt laboriosam dolorem voluptas non consequuntur.",
            "file_name": "test_2.jpg",
            "mime_type": "image/png",
            "size": 1671,
            "order_column": 207,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/207/test_2.jpg",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/207"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/events/{event}/gallery

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
event int The ID of the Event to retrieve.

Search

Search infos in current Scenario

This endpoint retrieves all infos matching q parameter

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/search?q=qualcosa" \
-H "Accept: application/json"

Example response:

{
  "data": [
    {
      "id": 63311,
      "type": "news",
      "title": "Palau cinema Montiggia",
      "abstract": "",
      "image_url": "https://bussola.s3-eu-west-1.amazonaws.com/108050/conversions/thumb.jpg",
      "image_thumb_url": "https://bussola.s3-eu-west-1.amazonaws.com/108050/conversions/thumb.jpg"
    },
    {
      "id": 61546,
      "type": "pages",
      "title": "Imposta di Soggiorno",
      "abstract": "",
      "image_url": "https://bussola.s3-eu-west-1.amazonaws.com/127154/conversions/thumb.png",
      "image_thumb_url": "https://bussola.s3-eu-west-1.amazonaws.com/127154/conversions/thumb.png",
      "deeplink": "mypalau://scenarios/481/pages/61546",
      "share_url": "https://palauturismo.com/contenuti/61546/imposta-soggiorno"
    }
  ],
  "links": {
    "first": "https://palauturismo.com/api/v1/scenarios/481/search?query=qualcosa&page=1",
    "last": "https://palauturismo.com/api/v1/scenarios/481/search?query=qualcosa&page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://palauturismo.com/api/v1/scenarios/481/search",
    "per_page": 25,
    "to": 2,
    "total": 2
  }
}

HTTP Request

GET api/v1/scenarios/{scenario}/search

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
q string The search.
filters string[] Infoable filters

Get all infoable filters

This endpoint retrieves all available infos filter for the search request

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/filter-types" \
-H "Accept: application/json"

Example response:

[
  {
    "class_name": "App\\Models\\MenuInfoable",
    "name": "Voce di Menu",
    "plural_name": "Voci di Menu",
    "index_url": null,
    "id": "menus"
  },
  {
    "class_name": "App\\Models\\ProtezioneCivile\\EmergencyPlanInfoable",
    "name": "Piano di emergenza",
    "plural_name": "Piani di emergenza",
    "index_url": "https://api.mycity.it/protezione-civile/piano-emergenza",
    "id": "prociv_emergencyplan"
  },
  ...
]

HTTP Request

GET api/v1/scenarios/{scenario}/filter-types

Menus

Get all Menus of the Scenario

This endpoint retrieves all Menus of the requested Scenario

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/menus" \
-H "Accept: application/json"

Example response:

{
  "data": [
    {
      "id": 1,
      "type": "menus",
      "title": "Veniam qui enim sint quis",
      "permalink": "veniam-qui-enim-sint-quis",
      "abstract": "",
      "body": "",
      "module_id": 1,
      "external_url": null,
      "default_info": null,
      "submenus": [
        {
          "id": 4,
          "type": "menus",
          "title": "Rem velit perspiciatis explicabo",
          "permalink": "rem-velit-perspiciatis-explicabo",
          "abstract": "",
          "body": "",
          "module_id": 1,
          "external_url": null,
          "default_info": null,
          "links": [
            {
              "rel": "self",
              "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/4"
            },
            {
              "rel": "contents",
              "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/4/contents"
            }
          ]
        }
      ],
      "links": [
        {
          "rel": "self",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/1"
        },
        {
          "rel": "contents",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/1/contents"
        },
        {
          "rel": "submenus",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/1"
        }
      ]
    },
    {
      "id": 2,
      "type": "menus",
      "title": "Debitis sunt aliquam recusandae sed",
      "permalink": "debitis-sunt-aliquam-recusandae-sed",
      "abstract": "",
      "body": "",
      "module_id": 1,
      "external_url": null,
      "default_info": null,
      "links": [
        {
          "rel": "self",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/2"
        },
        {
          "rel": "contents",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/2/contents"
        }
      ]
    }
  ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/menus

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: contents).

Get the detail of a Menu of the Scenario

This endpoint retrieves the detail of a Menu that belongs to the requested Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/menus/{menu}" \
-H "Accept: application/json"

Example response:

{
  "data": {
    "id": 11,
    "type": "menus",
    "title": "Et impedit doloremque est fugit et",
    "permalink": "et-impedit-doloremque-est-fugit",
    "abstract": "",
    "body": "",
    "module_id": 1,
    "external_url": null,
    "default_info": null,
    "links": [
      {
        "rel": "self",
        "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/11"
      },
      {
        "rel": "contents",
        "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/11/contents"
      }
    ]
  }
}

HTTP Request

GET api/v1/scenarios/{scenario}/menus/{menu}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
menu int The ID of the Menu to retrieve.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: contents).

Get all the contents (submenus & infos) associated to a Menu

This endpoint retrieves all the infos associated to a Menu

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/menus/{menu}/contents" \
-H "Accept: application/json"

Example response:

{
  "data": [
    {
      "id": 4,
      "type": "menus",
      "title": "Rem velit perspiciatis explicabo",
      "permalink": "rem-velit-perspiciatis-explicabo",
      "abstract": "",
      "body": "",
      "links": [
        {
          "rel": "self",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/4"
        },
        {
          "rel": "contents",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/4/contents"
        }
      ]
    },
    {
      "id": 269,
      "type": "Page",
      "title": "Fuga non qui iste consequatur",
      "permalink": "fuga-non-qui-iste-consequatur",
      "abstract": "Quia incidunt in sunt.",
      "body": "Fugiat quas non facilis. Libero qui sed maxime cum. Sint eveniet ex esse praesentium labore iure.",
      "links": [
        {
          "rel": "self",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/269"
        },
        {
          "rel": "gallery",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/269/gallery"
        },
        {
          "rel": "menu",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/269/menu"
        }
      ]
    },
    {
      "id": 280,
      "type": "Page",
      "title": "Accusantium id assumenda ut",
      "permalink": "accusantium-id-assumenda-ut",
      "abstract": "Ut eum rerum accusamus illum quisquam. Assumenda expedita aut non ut quis earum. Illum esse possimus maxime delectus numquam.",
      "links": [
        {
          "rel": "self",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/280"
        },
        {
          "rel": "gallery",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/280/gallery"
        },
        {
          "rel": "menu",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/280/menu"
        }
      ]
    }
  ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/menus/{menu}/contents

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
menu int The ID of the Menu.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: tables).

Mobile

Get Highlighted Contents

This endpoint retrieves all the highlighted contents of the requested Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/highlights" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 98,
            "type": "pages",
            "title": "Reprehenderit et enim dolor adipisci",
            "permalink": "reprehenderit-et-enim-dolor-adipisci",
            "abstract": "Omnis aspernatur quam nihil ut soluta. Asperiores consequuntur perspiciatis ut. Assumenda placeat optio ipsa sint. Porro quia ut laudantium laudantium et et laboriosam.",
            "body": "Iure est tempora rerum nulla doloribus sunt. Aut aut qui suscipit. Et fuga quo error ipsa voluptate. Sint totam enim expedita qui beatae. Neque quaerat optio eos qui. Incidunt doloremque consequuntur et doloribus mollitia magnam ad. Quis dolorem nobis alias similique aliquam. Sint numquam non debitis dolorum porro. Molestias fugiat temporibus tempora. Laborum quo voluptatum officia neque omnis labore ut veniam.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/22/100",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/98"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/98/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/98/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/98/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/98/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/pages/98",
            "share_url": "https://bologna.mycitydemo.it/pages/98/reprehenderit-et-enim-dolor-adipisci"
        },
        {
            "id": 113,
            "type": "pages",
            "title": "Repudiandae sapiente pariatur ipsam",
            "permalink": "repudiandae-sapiente-pariatur-ipsam",
            "abstract": "Consequuntur occaecati ipsa dicta voluptatem quae. Minima dolore perspiciatis fugiat est non quasi unde. Explicabo officiis iste facilis eligendi minus.",
            "body": "Debitis aut quia id nam quisquam pariatur quam ex. Sunt amet et aspernatur et maxime nostrum nostrum nobis. Earum et molestias praesentium numquam. Fuga aspernatur provident nemo ea consequuntur possimus illum. Ipsum esse itaque vel omnis illo velit voluptate. Iusto fugiat consequuntur sequi saepe incidunt. Nulla temporibus vel veritatis nobis suscipit dolor qui sed. Beatae sit asperiores sed qui molestias voluptas. Adipisci explicabo vel dolorem nulla et.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/37/100",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/113"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/113/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/113/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/113/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/113/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/pages/113",
            "share_url": "https://bologna.mycitydemo.it/pages/113/repudiandae-sapiente-pariatur-ipsam"
        },
        {
            "id": 216,
            "type": "news",
            "title": "Ratione adipisci ullam quia",
            "permalink": "ratione-adipisci-ullam-quia",
            "abstract": "Quis dolor dignissimos aut iure voluptas labore est voluptates. Sed maiores aut est explicabo velit ex voluptatem. Maiores totam magnam et perferendis.",
            "body": "Sit temporibus qui et iusto et voluptatem voluptatem temporibus. Autem possimus quam consequatur exercitationem velit quis qui. Debitis temporibus sunt quis numquam. Consequatur facere repellat tempore. Consequatur deleniti distinctio qui quo et exercitationem. Qui accusantium consequatur exercitationem. Id labore sed culpa. Adipisci ipsa sequi sed aut. Ut quos corrupti accusantium. Possimus et omnis et porro.",
            "publish_date": "2005-06-20 04:16:28",
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/140/100",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/216"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/216/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/216/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/216/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/216/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/news/216",
            "share_url": "https://bologna.mycitydemo.it/news/216/ratione-adipisci-ullam-quia"
        },
        {
            "id": 291,
            "type": "employees",
            "title": "Sig. Moreno Longo",
            "permalink": "sig-moreno-longo",
            "abstract": "Iure debitis sequi qui. Nobis quas illum minus hic ea dolorem. Enim est recusandae voluptatem non aut molestias veritatis est. Nostrum omnis quia incidunt recusandae et eos iure.",
            "body": "Magni quia commodi quibusdam eaque. Natus sequi sed sed exercitationem tenetur. Deserunt ab dolores rerum sed vel omnis occaecati. Ut rerum nostrum voluptas veniam similique. Culpa cum dicta blanditiis delectus.\n\nEst dignissimos magni a quo voluptas aliquam est. Et aspernatur rem magnam et. Deserunt libero quae sunt ut vel. Aut et labore consequatur minus et odit.\n\nLabore omnis reprehenderit nobis sit. Aut id sed commodi et est et. Soluta aut dolores porro hic est voluptas eum aut.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "role": "accusantium",
            "phone": "353 470 605",
            "fax": "+96 655 6987154",
            "email": "serra.silvano@example.net",
            "pec": "edilio.lombardi@example.org",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/employees/291"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/employees/291/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/employees/291/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/employees/291/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/employees/291/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/employees/291",
            "share_url": "https://bologna.mycitydemo.it/employees/291/sig-moreno-longo"
        },
        {
            "id": 316,
            "type": "offices",
            "title": "Ferrari, Romano e Conti SPA",
            "permalink": "ferrari-romano-conti-spa",
            "abstract": "Et consequuntur et voluptatem et est atque vero quos. Cum porro maxime officia aliquam cupiditate. Aut officia labore molestias accusamus. Consectetur beatae voluptatem voluptatem.",
            "body": "Saepe mollitia ut quod qui culpa et expedita odit. Possimus velit ut autem vero neque aut numquam. Consequuntur omnis laudantium harum excepturi sed qui illum. Assumenda et sit id fuga quae explicabo ipsa qui.\n\nNostrum rerum doloribus et. Laboriosam qui cumque minus aliquid. Eos explicabo aspernatur nobis in eaque.\n\nLaudantium enim vitae consequatur sint iusto. Est quibusdam dolore libero sit omnis. Autem repudiandae qui sint aspernatur delectus et quaerat quidem.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "employee_id": null,
            "address": "Incrocio Maruska 758 Appartamento 18\nTristano sardo, 07780 Potenza (SV)",
            "latitude": "-2.0568520",
            "longitude": "-90.4743270",
            "phone": "+18 5581 01241906",
            "fax": "+38 9615 22235816",
            "email": "mauro.deangelis@example.com",
            "pec": "benedetta.desantis@example.net",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/offices/316"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/offices/316/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/offices/316/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/offices/316/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/offices/316/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/offices/316",
            "share_url": "https://bologna.mycitydemo.it/offices/316/ferrari-romano-conti-spa"
        },
        {
            "id": 536,
            "type": "categories",
            "title": "Numquam tempore doloribus adipisci nam",
            "permalink": "numquam-tempore-doloribus-adipisci-nam",
            "abstract": "Iusto architecto voluptatum quia est. Excepturi sit molestiae voluptatibus et quia in molestiae. Earum et id aut quaerat fugit odit laudantium quaerat. Perspiciatis id et id impedit.",
            "body": "Est dicta atque vero fuga cupiditate praesentium porro. Aliquid aut ducimus id voluptatem asperiores dolores. Voluptatum animi necessitatibus quae quia iusto autem. Atque placeat exercitationem rerum recusandae eos. Possimus aut aperiam aut aliquam excepturi nam. Iusto consectetur quas facere in eos. Odio culpa dolor commodi quo consequatur voluptates laboriosam.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "is_gaspari": 1,
            "external_link": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/categories/536"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/categories/536/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/categories/536/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/categories/536/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/categories/536/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/categories/536",
            "share_url": "https://bologna.mycitydemo.it/categories/536/numquam-tempore-doloribus-adipisci-nam"
        },
        {
            "id": 804,
            "type": "forms",
            "title": "Eum aut dignissimos laborum eius",
            "permalink": "eum-aut-dignissimos-laborum-eius",
            "abstract": "Ea nesciunt quidem atque est quae. Ab esse eligendi accusantium dicta non. Sint alias at voluptas exercitationem.",
            "body": "Accusantium consequuntur porro voluptatum sed. Praesentium dolorem rerum est quia et nemo. Corporis quidem dolorum fugit corporis recusandae. Aspernatur iure delectus beatae possimus. Iusto molestiae dignissimos rerum deserunt debitis. Tempora perspiciatis ullam totam aliquam quasi atque occaecati. Cupiditate qui adipisci eum sapiente ea consequatur et. Non et odit asperiores veniam architecto. Et velit distinctio accusamus. Delectus non nihil enim dolores enim. Sint commodi est velit est.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "gaspari_code": "4@B.HLST",
            "region_id": null,
            "national_id": null,
            "omnia_id": 11425,
            "omnia_modello_updated_at": null,
            "omnia_file_updated_at": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/forms/804"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/forms/804/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/forms/804/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/forms/804/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/forms/804/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/forms/804",
            "share_url": "https://bologna.mycitydemo.it/forms/804/eum-aut-dignissimos-laborum-eius"
        },
        {
            "id": 880,
            "type": "pages",
            "title": "Libero nemo ratione impedit qui",
            "permalink": "libero-nemo-ratione-impedit-qui",
            "abstract": "Cumque nihil eos eos et quaerat impedit suscipit. Praesentium laboriosam blanditiis architecto nisi vero et aliquam. Ipsum doloremque id repellat voluptatem.",
            "body": "Magni itaque blanditiis autem quis vel. Similique ut voluptatem numquam aut eos illum. Sunt ut voluptatem ipsum earum quidem nobis beatae. Reiciendis natus blanditiis repellendus aperiam nihil laboriosam. Dolor tenetur ipsam voluptatem explicabo aperiam officia ex. Quidem dolores illum quisquam ducimus. Est quisquam non quam ex. Explicabo nostrum aliquid magni laboriosam.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/880"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/880/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/880/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/880/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/880/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/pages/880",
            "share_url": "https://bologna.mycitydemo.it/pages/880/libero-nemo-ratione-impedit-qui"
        },
        {
            "id": 905,
            "type": "associations",
            "title": "Battaglia-Piras s.r.l.",
            "permalink": "battaglia-piras-s-r",
            "abstract": "Et consequuntur sequi culpa velit. Cum dolores assumenda voluptates molestiae voluptate. Qui molestiae vitae iusto et eveniet. Quas expedita fugit similique. Illum inventore qui quisquam earum saepe.",
            "body": "Quis magni explicabo molestiae. Vel est natus sit. Vero voluptatem dolore dolores qui. Laborum id ut voluptatem accusantium culpa. Vero similique eaque sint dolor dignissimos molestiae. Consectetur voluptates laboriosam reprehenderit suscipit eum facere voluptates. Qui fugit sit sunt in. Est fugit eum dignissimos totam molestiae deserunt temporibus. Possimus accusamus nam accusantium enim. Enim qui non ut itaque voluptatem. Aut veniam optio amet quo quibusdam consequatur quia magnam.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/261/100",
            "phone": "+32 827 72 71 5033",
            "fax": "+95 56 5450466",
            "email": "nleone@example.com",
            "pec": "ingrid.silvestri@example.net",
            "external_link": null,
            "user_id": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/associations/905"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/associations/905/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/associations/905/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/associations/905/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/associations/905/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/associations/905",
            "share_url": "https://bologna.mycitydemo.it/associations/905/battaglia-piras-s-r"
        },
        {
            "id": 906,
            "type": "associations",
            "title": "Mariani, Martini e Ferraro Group",
            "permalink": "mariani-martini-ferraro-group",
            "abstract": "Voluptatem eius fugit rerum quibusdam commodi. Repellat laborum corporis quisquam non. Rerum rem laborum magnam suscipit aut. Earum dolores est autem amet qui et praesentium.",
            "body": "Atque est dolores mollitia dolore. Eos voluptatum molestiae eos reprehenderit. Eaque omnis temporibus fuga incidunt mollitia. Mollitia minus aut tempore deleniti accusantium aliquam. Autem autem iure eaque. Magnam recusandae dolorem sapiente omnis dolore tenetur voluptatem. Inventore ut cupiditate dicta qui labore sit reprehenderit. Vitae eos vero laudantium veritatis. Nam molestiae repellat deleniti non debitis sed atque. Modi iure et soluta.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/263/100",
            "phone": "+69 60 87562015",
            "fax": "325 547 732",
            "email": "rgrasso@example.net",
            "pec": "mrusso@example.com",
            "external_link": null,
            "user_id": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/associations/906"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/associations/906/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/associations/906/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/associations/906/pois"
                },
                {
                    "rel": "attachments",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/associations/906/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/associations/906",
            "share_url": "https://bologna.mycitydemo.it/associations/906/mariani-martini-ferraro-group"
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/highlights

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get Homepage widgets

This endpoint retrieves homepage widgets of the requested Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/app/homepage" \
-H "Accept: application/json"

Example response:

{
    "widgets": [
        {
            "type": "latest_news",
            "data": [
                {
                    "id": 3449,
                    "type": "news",
                    "title": "AVVISO CHIUSURA TEMPORANEA SPORTELLO EDILIZIA PRIVATA",
                    "abstract": "",
                    "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "deeplink": "mycity://scenarios/8/news/3449",
                    "share_url": "http://istituzionale.mycity.api/notizie/3449/avviso-chiusura-temporanea-sportello-edilizia"
                },
                {
                    "id": 3448,
                    "type": "news",
                    "title": "CONCORSO PUBBLICO ASSUNZIONE AGENTI DI POLIZIA LOCALE",
                    "abstract": "",
                    "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "deeplink": "mycity://scenarios/8/news/3448",
                    "share_url": "http://istituzionale.mycity.api/notizie/3448/concorso-pubblico-assunzione-agenti-polizia-locale"
                }
            ]
        },
        {
            "type": "upcoming_events",
            "data": [
                {
                    "id": 1571,
                    "type": "events",
                    "title": "ALTRO 2",
                    "abstract": "ALTRO",
                    "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "deeplink": "mycity://scenarios/8/events/1571",
                    "share_url": "http://istituzionale.mycity.api/eventi/1571/altro-2"
                },
                {
                    "id": 1569,
                    "type": "events",
                    "title": "sdsdds",
                    "abstract": "dfdfdfdfd",
                    "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "deeplink": "mycity://scenarios/8/events/1569",
                    "share_url": "http://istituzionale.mycity.api/eventi/1569/sdsdds"
                }
            ]
        },
        {
            "type": "dynamic_highlights",
            "data": [
                {
                    "id": 1575,
                    "type": "news",
                    "title": "niuss",
                    "abstract": "niuss",
                    "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1145/conversions/thumb.jpg",
                    "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1145/conversions/thumb.jpg",
                    "deeplink": "mycity://scenarios/8/news/1575",
                    "share_url": "http://istituzionale.mycity.api/notizie/1575/niuss"
                }
            ]
        },
        {
            "type": "widget_reports",
            "data": [
                {
                    "id": 10,
                    "type": "reports",
                    "title": "Segnalazione Dissesti Stradali",
                    "abstract": null,
                    "deeplink": "mycity://scenarios/8/reports/10",
                    "share_url": "http://istituzionale.mycity.api/segnalazioni/10"
                },
                {
                    "id": 9,
                    "type": "reports",
                    "title": "Segnalazione Energia Elettrica",
                    "abstract": null,
                    "deeplink": "mycity://scenarios/8/reports/9",
                    "share_url": "http://istituzionale.mycity.api/segnalazioni/9"
                },
                {
                    "id": 8,
                    "type": "reports",
                    "title": "segnalazione01",
                    "abstract": null,
                    "deeplink": "mycity://scenarios/8/reports/8",
                    "share_url": "http://istituzionale.mycity.api/segnalazioni/8"
                }
            ]
        },
        {
            "type": "widget_surveys",
            "data": [
                {
                    "id": 718,
                    "type": "surveys",
                    "title": "Piano Urbano della Mobilità Sostenibile",
                    "abstract": "",
                    "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "deeplink": "mycity://scenarios/8/surveys/718",
                    "share_url": "http://istituzionale.mycity.api/sondaggi/718/piano-urbano-mobilita-sostenibile"
                },
                {
                    "id": 717,
                    "type": "surveys",
                    "title": "Progetto di costruzione nuova linea Metro",
                    "abstract": "Approvazioni Linea Metro",
                    "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "deeplink": "mycity://scenarios/8/surveys/717",
                    "share_url": "http://istituzionale.mycity.api/sondaggi/717/progetto-costruzione-nuova-linea-metro"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/app/homepage

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

News

Get all News

This endpoint retrieves all News of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/news" \
-H "Accept: application/json"

Example response:

{
    "widgets": [
        {
            "type": "latest_news",
            "data": [
                {
                    "id": 3449,
                    "type": "news",
                    "title": "AVVISO CHIUSURA TEMPORANEA SPORTELLO EDILIZIA PRIVATA",
                    "abstract": "",
                    "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "deeplink": "mycity://scenarios/8/news/3449",
                    "share_url": "http://istituzionale.mycity.api/notizie/3449/avviso-chiusura-temporanea-sportello-edilizia"
                },
                {
                    "id": 3448,
                    "type": "news",
                    "title": "CONCORSO PUBBLICO ASSUNZIONE AGENTI DI POLIZIA LOCALE",
                    "abstract": "",
                    "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "deeplink": "mycity://scenarios/8/news/3448",
                    "share_url": "http://istituzionale.mycity.api/notizie/3448/concorso-pubblico-assunzione-agenti-polizia-locale"
                }
            ]
        },
        {
            "type": "upcoming_events",
            "data": [
                {
                    "id": 1571,
                    "type": "events",
                    "title": "ALTRO 2",
                    "abstract": "ALTRO",
                    "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "deeplink": "mycity://scenarios/8/events/1571",
                    "share_url": "http://istituzionale.mycity.api/eventi/1571/altro-2"
                },
                {
                    "id": 1569,
                    "type": "events",
                    "title": "sdsdds",
                    "abstract": "dfdfdfdfd",
                    "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "deeplink": "mycity://scenarios/8/events/1569",
                    "share_url": "http://istituzionale.mycity.api/eventi/1569/sdsdds"
                }
            ]
        },
        {
            "type": "dynamic_highlights",
            "data": [
                {
                    "id": 1575,
                    "type": "news",
                    "title": "niuss",
                    "abstract": "niuss",
                    "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1145/conversions/thumb.jpg",
                    "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1145/conversions/thumb.jpg",
                    "deeplink": "mycity://scenarios/8/news/1575",
                    "share_url": "http://istituzionale.mycity.api/notizie/1575/niuss"
                },
                {
                    "id": 1575,
                    "type": "news",
                    "title": "niuss",
                    "abstract": "niuss",
                    "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1145/conversions/thumb.jpg",
                    "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1145/conversions/thumb.jpg",
                    "deeplink": "mycity://scenarios/8/news/1575",
                    "share_url": "http://istituzionale.mycity.api/notizie/1575/niuss"
                }
            ]
        },
        {
            "type": "widget_reports",
            "data": [
                {
                    "id": 10,
                    "type": "reports",
                    "title": "Segnalazione Dissesti Stradali",
                    "abstract": null,
                    "deeplink": "mycity://scenarios/8/reports/10",
                    "share_url": "http://istituzionale.mycity.api/segnalazioni/10"
                },
                {
                    "id": 9,
                    "type": "reports",
                    "title": "Segnalazione Energia Elettrica",
                    "abstract": null,
                    "deeplink": "mycity://scenarios/8/reports/9",
                    "share_url": "http://istituzionale.mycity.api/segnalazioni/9"
                },
                {
                    "id": 8,
                    "type": "reports",
                    "title": "segnalazione01",
                    "abstract": null,
                    "deeplink": "mycity://scenarios/8/reports/8",
                    "share_url": "http://istituzionale.mycity.api/segnalazioni/8"
                }
            ]
        },
        {
            "type": "widget_surveys",
            "data": [
                {
                    "id": 718,
                    "type": "surveys",
                    "title": "Piano Urbano della Mobilità Sostenibile",
                    "abstract": "",
                    "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "deeplink": "mycity://scenarios/8/surveys/718",
                    "share_url": "http://istituzionale.mycity.api/sondaggi/718/piano-urbano-mobilita-sostenibile"
                },
                {
                    "id": 717,
                    "type": "surveys",
                    "title": "Progetto di costruzione nuova linea Metro",
                    "abstract": "Approvazioni Linea Metro",
                    "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1177/conversions/thumb.png",
                    "deeplink": "mycity://scenarios/8/surveys/717",
                    "share_url": "http://istituzionale.mycity.api/sondaggi/717/progetto-costruzione-nuova-linea-metro"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/news

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get a specific News

This endpoint retrieves a specific News of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/news/{news}" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 192,
        "type": "news",
        "title": "Ullam rem delectus qui ut error",
        "permalink": "ullam-rem-delectus-qui-ut-error",
        "abstract": "Qui non eaque amet fuga qui officiis. Autem ut excepturi autem et dolor officia dolor. Rem qui iure delectus ratione.",
        "body": "Temporibus voluptatibus aut impedit ut laudantium voluptas. Suscipit dolores earum illo ea est. Est ipsam totam nam quis repudiandae ea. Quae et facere ut minima asperiores. Asperiores corrupti hic nulla. Quaerat ad excepturi et reiciendis laudantium. Laudantium pariatur possimus quas ab alias. Incidunt ullam voluptatem enim velit. Deserunt rerum magnam quo. Dignissimos magnam beatae eos nemo nam rerum aperiam et.",
        "publish_date": "1991-11-26 05:45:26",
        "unpublish_date": null,
        "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/116/100",
        "links": [
            {
                "rel": "self",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/192"
            },
            {
                "rel": "gallery",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/192/gallery"
            },
            {
                "rel": "menu",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/192/menu"
            },
            {
                "rel": "pois",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/192/pois"
            },
            {
                "rel": "attachments",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/192/attachments"
            }
        ],
        "deeplink": "mycity://scenarios/2/news/192",
        "share_url": "https://bologna.mycitydemo.it/news/192/ullam-rem-delectus-qui-ut-error",
        "liked": false,
        "likes": 0,
        "shared": false,
        "shares": 0
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/news/{news}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
news int The ID of the News to retrieve.

Get the Menu that contains the News

This endpoint retrieves the Menu that contains the News.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/news/{news}/menu" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 4,
        "type": "menus",
        "title": "Ad excepturi provident sit consequatur",
        "permalink": "ad-excepturi-provident-sit-consequatur",
        "abstract": "",
        "body": "",
        "icon_url": "https://api.mycitydemo.it/menu.png",
        "single_content": false,
        "links": [
            {
                "rel": "self",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/4"
            },
            {
                "rel": "contents",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus/4/contents"
            }
        ]
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/news/{news}/menu

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
news int The ID of the News to retrieve.

Get the POIs of a News

This endpoint retrieves a list of Points Of Interest for a specific News of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/news/{news}/pois" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "title": "Laudantium sit dolorum quia et",
            "latitude": "27.5541840",
            "longitude": "15.6636200",
            "address": "Via Neri 37 Piano 0\nSesto Cleopatra, 74421 Livorno (VI)"
        },
        {
            "id": 2,
            "title": "Vero numquam nostrum sed",
            "latitude": "19.7934200",
            "longitude": "46.3182570",
            "address": "Via Montanari 3 Piano 0\nQuarto Sarita del friuli, 65982 Alessandria (BI)"
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/news/{news}/pois

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
news int The ID of the News to retrieve.

Get the Gallery of a News

This endpoint retrieves a list of Photos (news) for a specific News of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/news/{news}/gallery" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 206,
            "collection_name": "photos",
            "name": "Dolorem ut quia et et dolore repellat.",
            "file_name": "test_1.jpg",
            "mime_type": "image/png",
            "size": 1185,
            "order_column": 206,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/206/test_1.jpg",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/206"
                }
            ]
        },
        {
            "id": 207,
            "collection_name": "photos",
            "name": "Nesciunt laboriosam dolorem voluptas non consequuntur.",
            "file_name": "test_2.jpg",
            "mime_type": "image/png",
            "size": 1671,
            "order_column": 207,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/207/test_2.jpg",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/207"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/news/{news}/gallery

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
news int The ID of the News to retrieve.

Get the Attachments of a News

This endpoint retrieves a list of documents and files (attachments) for a specific News of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/news/{news}/attachments" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 206,
            "collection_name": "attachments",
            "name": "Dolorem ut quia et et dolore repellat.",
            "file_name": "test_1.pdf",
            "mime_type": "image/png",
            "size": 1185,
            "order_column": 206,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/206/test_1.pdf",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/206"
                }
            ]
        },
        {
            "id": 207,
            "collection_name": "attachments",
            "name": "Nesciunt laboriosam dolorem voluptas non consequuntur.",
            "file_name": "test_2.pdf",
            "mime_type": "image/png",
            "size": 1671,
            "order_column": 207,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/207/test_2.pdf",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/207"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/news/{news}/attachments

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
news int The ID of the News to retrieve.

Offices

Get all Offices

This endpoint retrieves all Offices of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/offices" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 38,
            "type": "offices",
            "title": "Anagrafe",
            "permalink": "valentini-group",
            "abstract": "Asperiores officia dignissimos quia suscipit qui quasi. Beatae est in maxime pariatur consequatur quod ipsam. Impedit voluptate voluptas et et.",
            "body": "Perferendis sint illum est nesciunt quisquam quidem. Minus molestiae qui voluptatem ea fugiat ut neque necessitatibus. Dolor nulla rem aperiam corporis. Eos non at ut quae hic repellendus et. Molestiae quo reprehenderit animi minima.\n\nSunt dolorum quia voluptas ea error laboriosam occaecati. Ut quae esse architecto ea adipisci ad fugit. Aut temporibus dolore rerum molestiae velit aut inventore.\n\nMaiores quia velit illum qui ullam quibusdam harum. Et quidem voluptas cum sit itaque culpa fuga. Qui est et eligendi error temporibus. Et nihil expedita modi dolores voluptates.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "employee_id": 30,
            "address": "Borgo Sasha 732\nLucia terme, 39675 Siracusa (VS)",
            "latitude": "-88.4140410",
            "longitude": "-173.1110440",
            "phone": "+13 0341 9724239",
            "fax": "061 673 6349",
            "email": "alessandro15@example.org",
            "pec": "wcattaneo@example.org",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/offices/38"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/offices/38/menu"
                },
                {
                    "rel": "employees",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/offices/38/employees"
                }
            ],
            "deeplink": "mycity://scenarios/5/offices/38",
            "share_url": "http://istituzionale.mycity.api/uffici/38/valentini-group"
        },
        {
            "id": 41,
            "type": "offices",
            "title": "Polizia urbana",
            "permalink": "mariani-vitale-marino-figli",
            "abstract": "Quod porro ut porro omnis ipsa. Est inventore rerum quam. Dolorum enim consequatur sit ex vitae.",
            "body": "Tempora voluptas labore est ratione provident est ad. Nisi quaerat unde nam qui deserunt dolorem.\n\nImpedit et vel sit ut eos. Ex voluptatibus natus cupiditate iste. Assumenda eum maiores et ut esse aut.\n\nRepellat earum doloribus similique aut et et qui. Quia maxime at fugit dolore.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "employee_id": null,
            "address": "Contrada Costa 5 Piano 3\nBorgo Demis sardo, 72124 Bari (VB)",
            "latitude": "21.4442580",
            "longitude": "-124.3361430",
            "phone": "+74 32 71612002",
            "fax": "+64 418 31 56 7504",
            "email": "dindo95@example.com",
            "pec": "giordano.damico@example.net",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/offices/41"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/offices/41/menu"
                },
                {
                    "rel": "employees",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/offices/41/employees"
                }
            ],
            "deeplink": "mycity://scenarios/5/offices/41",
            "share_url": "http://istituzionale.mycity.api/uffici/41/mariani-vitale-marino-figli"
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/5/offices?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/5/offices?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/5/offices",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/offices

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get a specific Office

This endpoint retrieves a specific Office of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/offices/{office}" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 38,
        "type": "offices",
        "title": "Anagrafe",
        "permalink": "valentini-group",
        "abstract": "Asperiores officia dignissimos quia suscipit qui quasi. Beatae est in maxime pariatur consequatur quod ipsam. Impedit voluptate voluptas et et.",
        "body": "Perferendis sint illum est nesciunt quisquam quidem. Minus molestiae qui voluptatem ea fugiat ut neque necessitatibus. Dolor nulla rem aperiam corporis. Eos non at ut quae hic repellendus et. Molestiae quo reprehenderit animi minima.\n\nSunt dolorum quia voluptas ea error laboriosam occaecati. Ut quae esse architecto ea adipisci ad fugit. Aut temporibus dolore rerum molestiae velit aut inventore.\n\nMaiores quia velit illum qui ullam quibusdam harum. Et quidem voluptas cum sit itaque culpa fuga. Qui est et eligendi error temporibus. Et nihil expedita modi dolores voluptates.",
        "publish_date": null,
        "unpublish_date": null,
        "image_url": null,
        "employee_id": 30,
        "address": "Borgo Sasha 732\nLucia terme, 39675 Siracusa (VS)",
        "latitude": "-88.4140410",
        "longitude": "-173.1110440",
        "phone": "+13 0341 9724239",
        "fax": "061 673 6349",
        "email": "alessandro15@example.org",
        "pec": "wcattaneo@example.org",
        "links": [
            {
                "rel": "self",
                "href": "http://api.mycity.api/api/v1/scenarios/5/offices/38"
            },
            {
                "rel": "menu",
                "href": "http://api.mycity.api/api/v1/scenarios/5/offices/38/menu"
            },
            {
                "rel": "employees",
                "href": "http://api.mycity.api/api/v1/scenarios/5/offices/38/employees"
            }
        ],
        "deeplink": "mycity://scenarios/5/offices/38",
        "share_url": "http://istituzionale.mycity.api/uffici/38/valentini-group"
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/offices/{office}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
office int The ID of the Office to retrieve.

Get the Menu that contains the Office

This endpoint retrieves the Menu that contains the Office.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/offices/{office}/menu" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 17,
        "type": "menus",
        "title": "Organi e Uffici",
        "permalink": "organi-uffici",
        "abstract": "",
        "body": "",
        "icon_url": "http://api.mycity.api/images/app_icons/00-standard.png",
        "icon": "00-standard",
        "single_content": false,
        "module_name": "cms",
        "module_id": 1,
        "external_url": null,
        "default_info": null,
        "links": [
            {
                "rel": "self",
                "href": "http://api.mycity.api/api/v1/scenarios/5/menus/17"
            },
            {
                "rel": "contents",
                "href": "http://api.mycity.api/api/v1/scenarios/5/menus/17/contents"
            }
        ]
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/offices/{office}/menu

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
office int The ID of the Office to retrieve.

Get the Employees that contains the Office

This endpoint retrieves the Employees that contains the Office.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/offices/{office}/employees" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 39,
            "type": "employees",
            "title": "Nick Fiore",
            "permalink": "nick-fiore",
            "abstract": "Aliquam ut ratione sed voluptatem. Aspernatur iste in libero nesciunt. Dicta fugiat perferendis impedit sit necessitatibus esse et. Voluptatum mollitia incidunt sint quis.",
            "body": "Mollitia eligendi nisi omnis repellat. Adipisci ipsum alias ut totam et. Nisi possimus alias dolor qui. Iste non voluptatum corporis illo ut.\n\nTempora sint dolores quam eum aut assumenda enim voluptatem. Pariatur sit nostrum ipsa sint eos. Aut blanditiis dignissimos quo assumenda vero velit dignissimos.\n\nAssumenda id aut voluptates dolorum. Qui dolore impedit rerum eum est perspiciatis. Quaerat ad nisi quia libero aut sunt non. Minima veritatis odio cupiditate ea qui quae.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/97/generic-person.jpg",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/39"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/39/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/39/menu"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/39/attachments"
                },
                {
                    "rel": "offices",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/39/offices"
                },
                {
                    "rel": "administrations",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/39/administrations"
                }
            ],
            "deeplink": "mycity://scenarios/5/employees/39",
            "share_url": "http://istituzionale.mycity.api/personale/39/nick-fiore"
        },
        {
            "id": 40,
            "type": "employees",
            "title": "Irene Grasso",
            "permalink": "irene-grasso",
            "abstract": "Quae ex ullam minus aut unde qui. Qui ipsam et natus illum asperiores possimus. Ut modi atque nihil deserunt delectus earum.",
            "body": "Ipsum sit doloribus aut quia ut. Odit explicabo eum blanditiis velit eligendi hic explicabo sed. Itaque velit commodi esse. Consequatur ut ut non eaque sapiente dicta dolor pariatur.\n\nNostrum rerum minus ipsum ut nihil ducimus earum. Qui est sint quia et perferendis quo. Excepturi ut incidunt est quis. Quo tempora autem dolores ea qui blanditiis fugit.\n\nEx qui tenetur qui repellendus iste facere rem. Fuga et quod qui expedita aspernatur quis. Incidunt doloremque tenetur sunt ut eos.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/98/generic-person.jpg",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/40"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/40/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/40/menu"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/40/attachments"
                },
                {
                    "rel": "offices",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/40/offices"
                },
                {
                    "rel": "administrations",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/40/administrations"
                }
            ],
            "deeplink": "mycity://scenarios/5/employees/40",
            "share_url": "http://istituzionale.mycity.api/personale/40/irene-grasso"
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/5/offices/38/employees?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/5/offices/38/employees?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/5/offices/38/employees",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/offices/{office}/employees

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
office int The ID of the Office to retrieve.

Get the POIs of a Office

This endpoint retrieves a list of Points Of Interest for a specific Office of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/offices/{office}/pois" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "title": "Laudantium sit dolorum quia et",
            "latitude": "27.5541840",
            "longitude": "15.6636200",
            "address": "Via Neri 37 Piano 0\nSesto Cleopatra, 74421 Livorno (VI)"
        },
        {
            "id": 2,
            "title": "Vero numquam nostrum sed",
            "latitude": "19.7934200",
            "longitude": "46.3182570",
            "address": "Via Montanari 3 Piano 0\nQuarto Sarita del friuli, 65982 Alessandria (BI)"
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/offices/{office}/pois

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
office int The ID of the Office to retrieve.

Administrations

Get all Administrations

This endpoint retrieves all Administrations of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/administrations" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 19,
            "type": "administrations",
            "title": "Assessori",
            "permalink": "guerra-silvestri-figli",
            "abstract": "Vero et temporibus unde aut et quos. Cupiditate eligendi autem odit cumque sequi odio.",
            "body": "Sapiente porro aut possimus est sit. Aperiam quisquam cumque consectetur quis rerum. Nesciunt eum officia reiciendis quasi tempora qui. Magnam aliquam ipsam fugit quidem.\n\nEst fugiat sapiente doloremque sequi architecto voluptates. Pariatur natus eligendi quia officia eveniet est. Expedita doloribus velit corrupti minus omnis sit soluta. Corporis voluptas deserunt dignissimos velit quis.\n\nOptio cumque iusto ad dignissimos dolorem repudiandae assumenda. Ut exercitationem expedita enim sed modi. Et itaque et doloremque rerum officia. Recusandae repellendus ullam amet ea. Qui pariatur molestiae temporibus.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "created_at": null,
            "updated_at": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/administrations/19"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/administrations/19/menu"
                },
                {
                    "rel": "employees",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/administrations/19/employees"
                }
            ],
            "deeplink": "mycity://scenarios/5/administrations/19",
            "share_url": "http://istituzionale.mycity.api/organi/19/guerra-silvestri-figli"
        },
        {
            "id": 29,
            "type": "administrations",
            "title": "Consiglieri",
            "permalink": "gentile-rizzo-bianco-s-r",
            "abstract": "Sunt non dignissimos dolorem ipsum accusamus optio saepe. Sint ab aut est eum nemo quia. Voluptas sequi velit in dolorem nam. Non quia neque nesciunt eum et eum.",
            "body": "Qui eaque voluptatum aspernatur libero et enim expedita. Suscipit delectus est est voluptatem. Laboriosam hic at et id aut repudiandae.\n\nUnde non omnis accusantium dolores numquam sint unde. Provident sed saepe necessitatibus et dolorum aut. Rerum sit ut quia eius quos.\n\nUt voluptas omnis pariatur assumenda est aliquid quidem. Doloribus ipsam eveniet quis quo. Repudiandae ipsum voluptatibus quaerat aut a laboriosam iusto maxime.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "created_at": null,
            "updated_at": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/administrations/29"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/administrations/29/menu"
                },
                {
                    "rel": "employees",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/administrations/29/employees"
                }
            ],
            "deeplink": "mycity://scenarios/5/administrations/29",
            "share_url": "http://istituzionale.mycity.api/organi/29/gentile-rizzo-bianco-s-r"
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/5/administrations?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/5/administrations?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/5/administrations",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/administrations

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get a specific Administration

This endpoint retrieves a specific Administration of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/administrations/{administration}" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 19,
        "type": "administrations",
        "title": "Assessori",
        "permalink": "guerra-silvestri-figli",
        "abstract": "Vero et temporibus unde aut et quos. Cupiditate eligendi autem odit cumque sequi odio.",
        "body": "Sapiente porro aut possimus est sit. Aperiam quisquam cumque consectetur quis rerum. Nesciunt eum officia reiciendis quasi tempora qui. Magnam aliquam ipsam fugit quidem.\n\nEst fugiat sapiente doloremque sequi architecto voluptates. Pariatur natus eligendi quia officia eveniet est. Expedita doloribus velit corrupti minus omnis sit soluta. Corporis voluptas deserunt dignissimos velit quis.\n\nOptio cumque iusto ad dignissimos dolorem repudiandae assumenda. Ut exercitationem expedita enim sed modi. Et itaque et doloremque rerum officia. Recusandae repellendus ullam amet ea. Qui pariatur molestiae temporibus.",
        "publish_date": null,
        "unpublish_date": null,
        "image_url": null,
        "created_at": null,
        "updated_at": null,
        "links": [
            {
                "rel": "self",
                "href": "http://api.mycity.api/api/v1/scenarios/5/administrations/19"
            },
            {
                "rel": "menu",
                "href": "http://api.mycity.api/api/v1/scenarios/5/administrations/19/menu"
            },
            {
                "rel": "employees",
                "href": "http://api.mycity.api/api/v1/scenarios/5/administrations/19/employees"
            }
        ],
        "deeplink": "mycity://scenarios/5/administrations/19",
        "share_url": "http://istituzionale.mycity.api/organi/19/guerra-silvestri-figli"
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/administrations/{administration}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
administration int The ID of the Administration to retrieve.

Get the Menu that contains the Administration

This endpoint retrieves the Menu that contains the Administration.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/administrations/{administration}/menu" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 17,
        "type": "menus",
        "title": "Organi e Uffici",
        "permalink": "organi-uffici",
        "abstract": "",
        "body": "",
        "icon_url": "http://api.mycity.api/images/app_icons/00-standard.png",
        "icon": "00-standard",
        "single_content": false,
        "module_name": "cms",
        "module_id": 1,
        "external_url": null,
        "default_info": null,
        "module": {
            "id": 1,
            "class_name": "App\\Models\\Modules\\Cms"
        },
        "links": [
            {
                "rel": "self",
                "href": "http://api.mycity.api/api/v1/scenarios/5/menus/17"
            },
            {
                "rel": "contents",
                "href": "http://api.mycity.api/api/v1/scenarios/5/menus/17/contents"
            }
        ]
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/administrations/{administration}/menu

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
administration int The ID of the Administration to retrieve.

Get the Employees that contains the Administration

This endpoint retrieves the Employees that contains the Administration.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/administrations/{administration}/employees" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 20,
            "type": "employees",
            "title": "Ortensia Gentile",
            "permalink": "ortensia-gentile",
            "abstract": "Id eum ratione consequatur omnis quae. Molestias est modi et cupiditate rem.",
            "body": "Voluptatem et ex architecto deserunt vero. Voluptatum non distinctio sint nesciunt eligendi repudiandae nemo. Iusto non est enim quibusdam perspiciatis et eum iusto. Expedita rem aut eum accusamus et et amet.\n\nEa harum sapiente laboriosam dolorum. Animi aperiam eaque eum quo et labore. Et porro hic tempore et et doloremque quia. Possimus soluta quisquam deserunt voluptates. Aut eaque vel dolor ea unde ea.\n\nSit sit dolores saepe dignissimos qui excepturi reprehenderit. Perspiciatis enim facere sint maxime recusandae et.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/81/generic-person.jpg",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/20"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/20/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/20/menu"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/20/attachments"
                },
                {
                    "rel": "offices",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/20/offices"
                },
                {
                    "rel": "administrations",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/20/administrations"
                }
            ],
            "deeplink": "mycity://scenarios/5/employees/20",
            "share_url": "http://istituzionale.mycity.api/personale/20/ortensia-gentile"
        },
        {
            "id": 21,
            "type": "employees",
            "title": "Ing. Anselmo Vitale",
            "permalink": "ing-anselmo-vitale",
            "abstract": "Nostrum possimus dolorum nesciunt aut. Illo sint autem ducimus cupiditate est. Quod ratione sit excepturi ut dicta.",
            "body": "Similique nostrum voluptate odio tenetur iusto ipsam. Quam sed iste quod in perspiciatis voluptatibus ipsum velit.\n\nOmnis illo commodi omnis id voluptatum culpa modi enim. Qui ipsam non maiores quam.\n\nTempora sint reiciendis ipsam quia quo perferendis. Porro temporibus perspiciatis recusandae voluptas. Quae debitis libero sit unde. Aut assumenda ea libero nihil.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/82/generic-person.jpg",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/21"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/21/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/21/menu"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/21/attachments"
                },
                {
                    "rel": "offices",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/21/offices"
                },
                {
                    "rel": "administrations",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/21/administrations"
                }
            ],
            "deeplink": "mycity://scenarios/5/employees/21",
            "share_url": "http://istituzionale.mycity.api/personale/21/ing-anselmo-vitale"
        },
        {
            "id": 22,
            "type": "employees",
            "title": "Dr. Joshua Ruggiero",
            "permalink": "dr-joshua-ruggiero",
            "abstract": "Consectetur qui praesentium ea natus veniam aut. Fugiat dolor officia repellendus ex sit quia explicabo veniam. Quae ipsa et et deleniti. Aliquam nobis sed veritatis fugit quod.",
            "body": "Ut suscipit harum quo enim. Est est est iure omnis fuga. Vel ad ut ut eaque.\n\nOmnis enim qui a ipsa reprehenderit quo quos. Soluta ea commodi pariatur nulla quis. Sint assumenda rem enim mollitia.\n\nQuaerat quia doloribus sunt ut sit enim. Repudiandae sit enim laborum explicabo qui voluptatem repellendus. Accusantium voluptates a itaque est qui dolor. Nesciunt nobis rerum odio adipisci.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/83/generic-person.jpg",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/22"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/22/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/22/menu"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/22/attachments"
                },
                {
                    "rel": "offices",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/22/offices"
                },
                {
                    "rel": "administrations",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/employees/22/administrations"
                }
            ],
            "deeplink": "mycity://scenarios/5/employees/22",
            "share_url": "http://istituzionale.mycity.api/personale/22/dr-joshua-ruggiero"
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/5/administrations/19/employees?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/5/administrations/19/employees?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/5/administrations/19/employees",
        "per_page": 10,
        "to": 8,
        "total": 8
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/administrations/{administration}/employee

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
administration int The ID of the Administration to retrieve.

Provinces

Get All Provinces

This endpoint retrieves all provinces.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/provinces" \
-H "Accept: application/json"

Example response:

{
  "data": [
    {
      "id": 1,
      "name": "Chieti",
      "initials": "CH",
      "links": [
        {
          "rel": "self",
          "href": "https://api.mycitydemo.it/api/v1/provinces/1"
        },
        {
          "rel": "region",
          "href": "https://api.mycitydemo.it/api/v1/provinces/1/region"
        },
        {
          "rel": "scenarios",
          "href": "https://api.mycitydemo.it/api/v1/provinces/1/scenarios"
        }
      ]
    },
    {
      "id": 2,
      "name": "L'Aquila",
      "initials": "AQ",
      "links": [
        {
          "rel": "self",
          "href": "https://api.mycitydemo.it/api/v1/provinces/2"
        },
        {
          "rel": "region",
          "href": "https://api.mycitydemo.it/api/v1/provinces/2/region"
        },
        {
          "rel": "scenarios",
          "href": "https://api.mycitydemo.it/api/v1/provinces/2/scenarios"
        }
      ]
    }
  ]
}

HTTP Request

GET api/v1/provinces

Get a Specific Province

This endpoint retrieves a specific province.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/provinces/{province}" \
-H "Accept: application/json"

Example response:

{
  "data": {
    "id": 1,
    "name": "Chieti",
    "initials": "CH",
    "links": [
      {
        "rel": "self",
        "href": "https://api.mycitydemo.it/api/v1/provinces/1"
      },
      {
        "rel": "region",
        "href": "https://api.mycitydemo.it/api/v1/provinces/1/region"
      },
      {
        "rel": "scenarios",
        "href": "https://api.mycitydemo.it/api/v1/provinces/1/scenarios"
      }
    ]
  }
}

HTTP Request

GET api/v1/provinces/{province}

Url Parameters

Parameter Type Description
province int The ID of the Province.

Get all Scenarios of a Province

This endpoint retrieves all the Scenarios that belong to a province.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/provinces/{province}/scenarios" \
-H "Accept: application/json"

Example response:

{
  "data": [
    {
      "id": 3,
      "site_name": "Comune di Lake Mekhi",
      "name": "Lake Mekhi",
      "url": "lake-mekhi.mycitydemo.it",
      "description": "Nisi voluptas officia hic facilis autem et dolorum. Quisquam ad sed provident minima. Culpa labore enim porro debitis laborum veniam. Dignissimos quia similique ullam autem aut illum.",
      "address": "14732 Napoleon Ramp\nSouth Nathanburgh, DC 49859",
      "zip_code": "7807",
      "latitude": "-60.3945620",
      "longitude": "-164.4730650",
      "cadastre_code": "L039",
      "phone": "1-289-568-1952",
      "fax": "1-678-755-6755 x0001",
      "email": "reymundo.jakubowski@example.org",
      "pec": "oheidenreich@example.net",
      "is_active": 1,
      "type": 1,
      "facebook_url": null,
      "youtube_url": null,
      "twitter_url": null,
      "instagram_url": null,
      "telegram_url": null,
      "fiscal_code": null,
      "vat_code": null,
      "web_style": 1,
      "web_color": 1,
      "links": [
        {
          "rel": "self",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3"
        },
        {
          "rel": "pages",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/pages"
        },
        {
          "rel": "employees",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/employees"
        },
        {
          "rel": "events",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/events"
        },
        {
          "rel": "infos",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/infos"
        },
        {
          "rel": "menus",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/menus"
        },
        {
          "rel": "modules",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/modules"
        },
        {
          "rel": "news",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/news"
        },
        {
          "rel": "offices",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/offices"
        },
        {
          "rel": "reports",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/reports"
        },
        {
          "rel": "report_categories",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/report_categories"
        }
      ]
    }
  ]
}

HTTP Request

GET api/v1/provinces/{province}/scenarios

Url Parameters

Parameter Type Description
province int The ID of the Province.

Regions

Get All Regions

This endpoint retrieves all regions.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/regions" \
-H "Accept: application/json"

Example response:

{
  "data": [
    {
      "id": 1,
      "name": "Abruzzo",
      "code": "abr",
      "links": [
        {
          "rel": "self",
          "href": "https://api.mycitydemo.it/api/v1/regions/1"
        },
        {
          "rel": "provinces",
          "href": "https://api.mycitydemo.it/api/v1/regions/1/provinces"
        },
        {
          "rel": "scenarios",
          "href": "https://api.mycitydemo.it/api/v1/regions/1/scenarios"
        }
      ]
    },
    {
      "id": 2,
      "name": "Basilicata",
      "code": "bas",
      "links": [
        {
          "rel": "self",
          "href": "https://api.mycitydemo.it/api/v1/regions/2"
        },
        {
          "rel": "provinces",
          "href": "https://api.mycitydemo.it/api/v1/regions/2/provinces"
        },
        {
          "rel": "scenarios",
          "href": "https://api.mycitydemo.it/api/v1/regions/2/scenarios"
        }
      ]
    }
  ]
}

HTTP Request

GET api/v1/regions

Get a Specific Region

This endpoint retrieves a specific region.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/regions/{region}" \
-H "Accept: application/json"

Example response:

{
  "data": {
    "id": 2,
    "name": "Basilicata",
    "code": "bas",
    "links": [
      {
        "rel": "self",
        "href": "https://api.mycitydemo.it/api/v1/regions/2"
      },
      {
        "rel": "provinces",
        "href": "https://api.mycitydemo.it/api/v1/regions/2/provinces"
      },
      {
        "rel": "scenarios",
        "href": "https://api.mycitydemo.it/api/v1/regions/2/scenarios"
      }
    ]
  }
}

HTTP Request

GET api/v1/regions/{region}

Url Parameters

Parameter Type Description
region int The ID of the Region.

Get all Provinces of a Region

This endpoint retrieves all the provinces that belong to a region.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/regions/{region}/provinces" \
-H "Accept: application/json"

Example response:

{
  "data": [
    {
      "id": 5,
      "name": "Matera",
      "initials": "MT",
      "links": [
        {
          "rel": "self",
          "href": "https://api.mycitydemo.it/api/v1/provinces/5"
        },
        {
          "rel": "region",
          "href": "https://api.mycitydemo.it/api/v1/provinces/5/region"
        },
        {
          "rel": "scenarios",
          "href": "https://api.mycitydemo.it/api/v1/provinces/5/scenarios"
        }
      ]
    },
    {
      "id": 6,
      "name": "Potenza",
      "initials": "PZ",
      "links": [
        {
          "rel": "self",
          "href": "https://api.mycitydemo.it/api/v1/provinces/6"
        },
        {
          "rel": "region",
          "href": "https://api.mycitydemo.it/api/v1/provinces/6/region"
        },
        {
          "rel": "scenarios",
          "href": "https://api.mycitydemo.it/api/v1/provinces/6/scenarios"
        }
      ]
    }
  ]
}

HTTP Request

GET api/v1/regions/{region}/provinces

Url Parameters

Parameter Type Description
region int The ID of the Region.

Get all Scenarios of a Region

This endpoint retrieves all the Scenarios that belong to a region.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/regions/{region}/scenarios" \
-H "Accept: application/json"

Example response:

{
  "data": [
    {
      "id": 9,
      "site_name": "Comune di South Casimir",
      "name": "South Casimir",
      "url": "south-casimir.mycitydemo.it",
      "description": "Provident aut dolores ea quis ipsum mollitia. Suscipit sed ullam id dolorem. Modi ut deserunt nobis perferendis natus. In omnis sed tenetur in velit eligendi quo. Ab cum error quia ut saepe.",
      "address": "721 Zion Field Suite 852\nStrackefurt, VT 39598-0501",
      "zip_code": "99121",
      "latitude": "-64.7636250",
      "longitude": "131.6029590",
      "cadastre_code": "C790",
      "phone": "1-347-417-2184 x23821",
      "fax": "(924) 729-1224 x027",
      "email": "gretchen.vandervort@example.org",
      "pec": "alena.marvin@example.com",
      "is_active": 1,
      "type": 1,
      "facebook_url": null,
      "youtube_url": null,
      "twitter_url": null,
      "instagram_url": null,
      "telegram_url": null,
      "fiscal_code": null,
      "vat_code": null,
      "web_style": 1,
      "web_color": 1,
      "links": [
        {
          "rel": "self",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/9"
        },
        {
          "rel": "pages",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/9/pages"
        },
        {
          "rel": "employees",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/9/employees"
        },
        {
          "rel": "events",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/9/events"
        },
        {
          "rel": "infos",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/9/infos"
        },
        {
          "rel": "menus",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/9/menus"
        },
        {
          "rel": "modules",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/9/modules"
        },
        {
          "rel": "news",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/9/news"
        },
        {
          "rel": "offices",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/9/offices"
        },
        {
          "rel": "reports",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/9/reports"
        },
        {
          "rel": "report_categories",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/9/report_categories"
        }
      ]
    }
  ]
}

HTTP Request

GET api/v1/regions/{region}/scenarios

Url Parameters

Parameter Type Description
region int The ID of the Region.

Reports

Get all Reports

This endpoint retrieves all Reports of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/reports" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 2,
            "type": "reports",
            "title": "Blanditiis soluta occaecati dicta.",
            "body": "Quaerat molestiae similique iusto earum natus. Est corporis pariatur veritatis enim eaque. In repudiandae eos dicta enim dicta delectus. Ducimus aperiam exercitationem accusantium omnis fugit. Nulla inventore non suscipit soluta velit.",
            "result_text": "",
            "taken_over_at": null,
            "completed_at": null,
            "rejected_at": null,
            "created_at": "2018-02-21 10:32:31",
            "category_id": 198,
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2/gallery"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2/category"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/reports/2",
            "share_url": "https://bologna.mycity.api/reports/2/"
        },
        {
            "id": 1,
            "type": "reports",
            "title": "A minus eos non quam.",
            "body": "Necessitatibus quam quia ducimus voluptatem quae ea. Quia quae consequuntur vero doloremque vero. Placeat nisi unde quisquam iusto quisquam soluta beatae. Aliquam quia numquam libero. Molestiae expedita sunt eos nihil aut commodi ab.",
            "result_text": "",
            "taken_over_at": null,
            "completed_at": null,
            "rejected_at": null,
            "created_at": "2018-02-21 10:32:31",
            "category_id": 198,
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1/gallery"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1/category"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/reports/1",
            "share_url": "https://bologna.mycity.api/reports/1/"
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/2/reports?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/2/reports?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/2/reports",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/reports

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get a specific Report

This endpoint retrieves a specific Report of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/reports/{report}" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 2,
        "type": "reports",
        "title": "Blanditiis soluta occaecati dicta.",
        "body": "Quaerat molestiae similique iusto earum natus. Est corporis pariatur veritatis enim eaque. In repudiandae eos dicta enim dicta delectus. Ducimus aperiam exercitationem accusantium omnis fugit. Nulla inventore non suscipit soluta velit.",
        "result_text": "",
        "taken_over_at": null,
        "completed_at": null,
        "rejected_at": null,
        "created_at": "2018-02-21 10:32:31",
        "category_id": 198,
        "liked": false,
        "likes": 0,
        "shared": false,
        "shares": 0,
        "links": [
            {
                "rel": "self",
                "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2"
            },
            {
                "rel": "gallery",
                "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2/gallery"
            },
            {
                "rel": "category",
                "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2/category"
            },
            {
                "rel": "pois",
                "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2/pois"
            },
            {
                "rel": "attachments",
                "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2/attachments"
            }
        ],
        "deeplink": "mycity://scenarios/2/reports/2",
        "share_url": "https://bologna.mycity.api/reports/2/"
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/reports/{report}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
report int The ID of the Report to retrieve.

Get the POIs of a Report

This endpoint retrieves a list of Points Of Interest for a specific Report of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/reports/{report}/pois" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "title": "Laudantium sit dolorum quia et",
            "latitude": "27.5541840",
            "longitude": "15.6636200",
            "address": "Via Neri 37 Piano 0\nSesto Cleopatra, 74421 Livorno (VI)"
        },
        {
            "id": 2,
            "title": "Vero numquam nostrum sed",
            "latitude": "19.7934200",
            "longitude": "46.3182570",
            "address": "Via Montanari 3 Piano 0\nQuarto Sarita del friuli, 65982 Alessandria (BI)"
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/reports/{report}/pois

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
report int The ID of the Report to retrieve.

Get the Gallery of a Report

This endpoint retrieves a list of Photos (report) for a specific Report of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/reports/{report}/gallery" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 206,
            "collection_name": "photos",
            "name": "Dolorem ut quia et et dolore repellat.",
            "file_name": "test_1.jpg",
            "mime_type": "image/png",
            "size": 1185,
            "order_column": 206,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/206/test_1.jpg",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/206"
                }
            ]
        },
        {
            "id": 207,
            "collection_name": "photos",
            "name": "Nesciunt laboriosam dolorem voluptas non consequuntur.",
            "file_name": "test_2.jpg",
            "mime_type": "image/png",
            "size": 1671,
            "order_column": 207,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/207/test_2.jpg",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/207"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/reports/{report}/gallery

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
report int The ID of the Report to retrieve.

Get the Attachments of a Report

This endpoint retrieves a list of documents and files (attachments) for a specific Report of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/reports/{report}/attachments" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 206,
            "collection_name": "attachments",
            "name": "Dolorem ut quia et et dolore repellat.",
            "file_name": "test_1.pdf",
            "mime_type": "image/png",
            "size": 1185,
            "order_column": 206,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/206/test_1.pdf",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/206"
                }
            ]
        },
        {
            "id": 207,
            "collection_name": "attachments",
            "name": "Nesciunt laboriosam dolorem voluptas non consequuntur.",
            "file_name": "test_2.pdf",
            "mime_type": "image/png",
            "size": 1671,
            "order_column": 207,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/207/test_2.pdf",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/207"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/reports/{report}/attachments

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
report int The ID of the Report to retrieve.

Get the Category of a Report

This endpoint retrieves the Category of a Report.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/reports/{report}/category" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 198,
        "type": "report_categories",
        "title": "Self-enabling clear-thinking hierarchy",
        "permalink": "dolor-omnis-officiis-quia-voluptas-est",
        "abstract": "Pariatur architecto ut dolor asperiores vel aliquam quos libero. Natus minima temporibus qui sit reiciendis.",
        "body": "Quo eveniet eos odit fugit vitae. Debitis repellendus totam velit quos. Fuga doloremque quia doloremque blanditiis quos laboriosam.",
        "authentication_required": 0,
        "links": [
            {
                "rel": "self",
                "href": "http://api.mycity.api/api/v1/scenarios/2/report_categories/198"
            },
            {
                "rel": "reports",
                "href": "http://api.mycity.api/api/v1/scenarios/2/report_categories/198/reports"
            }
        ]
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/reports/{report}/category

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
report int The ID of the Report to retrieve.

Get all Reports created by current User

This endpoint retrieves all Reports of a Scenario created by current User.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/reports/my" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 2,
            "type": "reports",
            "title": "Blanditiis soluta occaecati dicta.",
            "body": "Quaerat molestiae similique iusto earum natus. Est corporis pariatur veritatis enim eaque. In repudiandae eos dicta enim dicta delectus. Ducimus aperiam exercitationem accusantium omnis fugit. Nulla inventore non suscipit soluta velit.",
            "result_text": "",
            "taken_over_at": null,
            "completed_at": null,
            "rejected_at": null,
            "created_at": "2018-02-21 10:32:31",
            "category_id": 198,
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2/gallery"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2/category"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/reports/2",
            "share_url": "https://bologna.mycity.api/reports/2/"
        },
        {
            "id": 1,
            "type": "reports",
            "title": "A minus eos non quam.",
            "body": "Necessitatibus quam quia ducimus voluptatem quae ea. Quia quae consequuntur vero doloremque vero. Placeat nisi unde quisquam iusto quisquam soluta beatae. Aliquam quia numquam libero. Molestiae expedita sunt eos nihil aut commodi ab.",
            "result_text": "",
            "taken_over_at": null,
            "completed_at": null,
            "rejected_at": null,
            "created_at": "2018-02-21 10:32:31",
            "category_id": 198,
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1/gallery"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1/category"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/reports/1",
            "share_url": "https://bologna.mycity.api/reports/1/"
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/2/reports?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/2/reports?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/2/reports",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/reports/my

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get all the Reports that belong to a Category

This endpoint retrieves all the Reports that belong to the specified Category.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/report_categories/{report_category}/reports" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 2,
            "type": "reports",
            "title": "Blanditiis soluta occaecati dicta.",
            "body": "Quaerat molestiae similique iusto earum natus. Est corporis pariatur veritatis enim eaque. In repudiandae eos dicta enim dicta delectus. Ducimus aperiam exercitationem accusantium omnis fugit. Nulla inventore non suscipit soluta velit.",
            "result_text": "",
            "taken_over_at": null,
            "completed_at": null,
            "rejected_at": null,
            "created_at": "2018-02-21 10:32:31",
            "category_id": 198,
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2/gallery"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2/category"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/2/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/reports/2",
            "share_url": "https://bologna.mycity.api/reports/2/"
        },
        {
            "id": 1,
            "type": "reports",
            "title": "A minus eos non quam.",
            "body": "Necessitatibus quam quia ducimus voluptatem quae ea. Quia quae consequuntur vero doloremque vero. Placeat nisi unde quisquam iusto quisquam soluta beatae. Aliquam quia numquam libero. Molestiae expedita sunt eos nihil aut commodi ab.",
            "result_text": "",
            "taken_over_at": null,
            "completed_at": null,
            "rejected_at": null,
            "created_at": "2018-02-21 10:32:31",
            "category_id": 198,
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1/gallery"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1/category"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/reports/1",
            "share_url": "https://bologna.mycity.api/reports/1/"
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/2/report_categories/198/reports?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/2/report_categories/198/reports?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/2/report_categories/198/reports",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/report_categories/{report_category}/reports

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
report_category int The ID of the Report Category to retrieve.

Submit a Report

This endpoint submits a Report for a specific Scenario.

Example request:

curl -X POST "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/reports?include=gallery,pois" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer frtgt4g4634s' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \

  -F 'title=segnalazione importante' \
  -F 'body=uscendo di casa mi ritrovai in una selva oscura che la dritta via era smarrita' \
  -F 'photos[]=@/home/utente/Scrivania/test.jpg' \
  -F 'photos[]=@/home/utente/Scrivania/prova.png' \
  -F 'attachments[]=@/home/utente/Scrivania/test.pdf' \
  -F 'attachments[]=@/home/utente/Scrivania/prova.docx' \
  -F scenario_id=2 \
  -F category_id=781 \
  -F 'pois[0][latitude]=12,21212121' \
  -F 'pois[0][longitude]=13,323443434' \
  -F 'pois[1][latitude]=14,21212121' \
  -F 'pois[1][longitude]=15,323443434'
  -F 'custom_input_fields = [{"id":"RKDGa9m0HoknIOsz","label":"Nome e cognome","required":true,"multiline":false,"value":"Mario Rossi"},{"id":"C1iMF9rj40mlCinZ","label":"indirizzo mail","required":true,"multiline":false,"value":"mariorossi@mycity.it"},{"id":"hvw4e0vt44SX5ZNw","label":"telefono","required":true,"multiline":false,"value":"0510010111"}]'

Example response:

{
    "data": {
        "id": 29,
        "type": "Report",
        "title": "AIUTO AIUTO",
        "body": "uscendo di casa mi ritrovai in una selva oscura che la dritta via era smarrita",
        "result_text": null,
        "taken_over_at": null,
        "completed_at": null,
        "rejected_at": null,
        "created_at": "2018-02-12 16:51:53",
        "category_id": "781",
        "links": [
            {
                "rel": "self",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/reports/29"
            },
            {
                "rel": "gallery",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/reports/29/gallery"
            },
            {
                "rel": "category",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/reports/29/category"
            },
            {
                "rel": "pois",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/reports/29/pois"
            }
        ]
    }
}

HTTP Request

POST api/v1/scenarios/{scenario}/reports

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Parameters

Parameter Type Description
address string Address.
title string Title of the report. required
body string Description of the report. required
category_id int The ID of the category the report belongs to. required
pois[] array Array containing the report positions composed by latitude (decimal) and longitude (decimal)
photos[] array Array containing photos to attach to the report. Photos must be maximum 2048x2048 pixels.
attachments[] array Array containing documents and files to attach to the report.
custom_input_fields array Array containing custom fields.

Protezione Civile

Get all Pages

This endpoint retrieves all Pages from Protezione Civile of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/prociv_pages" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 381,
            "type": "pages",
            "title": "Vel quos molestiae officiis deserunt",
            "permalink": "vel-quos-molestiae-officiis-deserunt",
            "abstract": "Soluta laborum modi expedita ut beatae et voluptatem et. Aut eligendi porro aut totam blanditiis aut possimus aut. Et quaerat blanditiis sint aut. Minus ut est corporis quia laudantium eveniet dicta.",
            "body": "Magnam ut deserunt omnis pariatur quibusdam necessitatibus. Reiciendis quis quaerat id. Odio amet ut rem nesciunt aperiam veniam. Ex in sint expedita repellat. Illo inventore esse quisquam ullam. Asperiores blanditiis neque fuga. Consequatur optio at dicta eligendi veritatis quis. Debitis sit id aperiam voluptatem reprehenderit est qui. Repudiandae quia saepe tempora similique porro minima. Id a architecto nemo corporis hic. Et earum et blanditiis rem ea voluptas. Et in dolores sit omnis laboriosam eum.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/264/100",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/pages/381"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/pages/381/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/pages/381/menu"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/pages/381/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/pages/381/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/pages/381",
            "share_url": "https://bologna.mycity.api/pages/381/vel-quos-molestiae-officiis-deserunt"
        },
        {
            "id": 382,
            "type": "pages",
            "title": "Sunt hic dolorum et cupiditate nemo",
            "permalink": "sunt-hic-dolorum-et-cupiditate-nemo",
            "abstract": "Quas rerum eum sequi animi nihil distinctio cum. Eveniet vel vitae nihil quibusdam aut delectus delectus. Itaque id consequatur asperiores eos quaerat sed cumque. Aut repellat qui iure tenetur sed.",
            "body": "Dolores aspernatur veniam reprehenderit ea repellat. Voluptates asperiores vero ut voluptates sint quasi quisquam. Sint aut atque corporis eius consequatur qui. Quo voluptas dolorem explicabo nam suscipit. Doloremque non consequatur id eos unde culpa. Harum aut dolor labore velit aperiam odio. Facilis qui dolorum accusantium magnam. Aut omnis aliquam fugit. Voluptas tenetur nam sint est nam ut deleniti. Non repellendus nisi nihil quo expedita minus. Expedita fugiat qui odio totam.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/265/100",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/pages/382"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/pages/382/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/pages/382/menu"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/pages/382/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/pages/382/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/pages/382",
            "share_url": "https://bologna.mycity.api/pages/382/sunt-hic-dolorum-et-cupiditate-nemo"
        },
        {
            "id": 383,
            "type": "pages",
            "title": "Rerum consequuntur iusto illo cum",
            "permalink": "rerum-consequuntur-iusto-illo-cum",
            "abstract": "Neque aliquam eaque voluptas magni dolores aspernatur veritatis temporibus. Odit necessitatibus id sed qui enim corrupti. Repellendus magnam sunt ab at. Aut et porro inventore.",
            "body": "Dolores amet placeat perferendis aut quo voluptas et. Officia maxime est soluta odit. Illum nesciunt molestiae sapiente non labore quia. Nam deserunt aut unde non. Magni et quisquam soluta dolore. Ullam autem sed iure qui. Eum id quasi earum nisi eum similique deserunt. Omnis molestiae quis sed ratione sed repudiandae. Vero dignissimos quibusdam adipisci deserunt porro in. Expedita nisi atque occaecati ea. Iure unde dolor quibusdam dolorum optio quis.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/pages/383"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/pages/383/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/pages/383/menu"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/pages/383/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/pages/383/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/pages/383",
            "share_url": "https://bologna.mycity.api/pages/383/rerum-consequuntur-iusto-illo-cum"
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/prociv_pages

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get a specific Page

This endpoint retrieves a specific News of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/pages/{page}" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 2967,
        "type": "Page",
        "title": "Labore quisquam officiis rerum",
        "permalink": "labore-quisquam-officiis-rerum",
        "abstract": "Quis dolorem non ad mollitia quas quasi. Voluptatibus pariatur praesentium in quam aspernatur natus. Aliquam dignissimos nobis omnis ipsam est. Sequi numquam culpa facilis et maiores explicabo.",
        "body": "Mollitia sint labore sint nobis sunt nobis vero. Molestiae impedit voluptatem voluptas. Explicabo impedit qui dignissimos expedita quaerat sit ipsa natus. Itaque aliquam et quos a aut ipsam. Eum nulla consequatur eum veritatis voluptatem explicabo.",
        "links": [
            {
                "rel": "self",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/2967"
            },
            {
                "rel": "gallery",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/2967/gallery"
            },
            {
                "rel": "menu",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/2967/menu"
            },
            {
                "rel": "pois",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages/2967/pois"
            }
        ]
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/pages/{page}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
page int The ID of the Page to retrieve.

Get the Emergency Plan

This endpoint retrieves the Emergency Plan of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/prociv_emergencyplan" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 384,
        "type": "emergencyPlans",
        "title": "Piano di emergenza",
        "permalink": "piano-emergenza",
        "abstract": "Quos nam est omnis alias impedit et. At dolorem omnis accusantium aut ut. Enim libero consequatur id enim incidunt id nam.",
        "body": "Soluta alias ducimus blanditiis et et accusantium consequuntur. In accusamus laboriosam nobis ut fugit quibusdam. Optio quod dignissimos qui earum. Quisquam molestias porro sed. Cum et consequatur repudiandae. Iusto dolores officiis tempora totam voluptatem ab debitis. Aliquid ipsum mollitia quam. Molestiae eos praesentium numquam voluptatem officia rem optio. Placeat sunt est eos neque rerum sed. Animi minima odio non deserunt tempora. Soluta eum porro vel saepe error.",
        "publish_date": null,
        "unpublish_date": null,
        "attachments": [
            {
                "id": 86,
                "collection_name": "attachments",
                "name": "emergency plan",
                "file_name": "test_pdf.pdf",
                "mime_type": "application/pdf",
                "size": 433994,
                "order_column": 86,
                "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/86/test_pdf.pdf",
                "liked": false,
                "likes": 0,
                "shared": false,
                "shares": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "http://api.mycity.api/api/v1/scenarios/2/media/86"
                    }
                ]
            },
            {
                "id": 87,
                "collection_name": "attachments",
                "name": "emergency plan",
                "file_name": "test_pdf.pdf",
                "mime_type": "application/pdf",
                "size": 433994,
                "order_column": 87,
                "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/87/test_pdf.pdf",
                "liked": false,
                "likes": 0,
                "shared": false,
                "shares": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "http://api.mycity.api/api/v1/scenarios/2/media/87"
                    }
                ]
            }
        ],
        "image_url": null,
        "links": [
            {
                "rel": "self",
                "href": "http://api.mycity.api/api/v1/scenarios/2/prociv_emergencyplan"
            },
            {
                "rel": "attachments",
                "href": "http://api.mycity.api/api/v1/scenarios/2/prociv_emergencyplan/attachments"
            }
        ],
        "deeplink": "mycity://scenarios/2/emergencyPlans/384",
        "share_url": "https://bologna.mycity.api/emergencyPlans/384/piano-emergenza",
        "shared": false,
        "shares": 0
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/prociv_emergencyplan

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get all Points of Interest

This endpoint retrieves all Points of Interest from Protezione Civile of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/prociv_pois" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "title": "Hic commodi in illo est",
            "latitude": "26.0719600",
            "longitude": "20.3096350",
            "address": "37732 Dana Loaf\nWest Cora, NE 88462-3371"
        },
        {
            "id": 2,
            "title": "Deserunt odit est nesciunt",
            "latitude": "11.4575840",
            "longitude": "39.4786190",
            "address": "8037 Lakin Grove\nHammesside, AR 55598"
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/prociv_pois

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Recycling

Get all Recycling Stations

This endpoint retrieves all Recycling Stations from Recycling of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/waste_stations" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "title": "Contrada Rodolfo",
            "description": "Raccolta di indifferenziata, carta, organico",
            "days": [
                "Tuesday",
                "Monday"
            ],
            "hour_from": "7:00",
            "hour_to": "14:00",
            "pois": [
                {
                    "id": 44,
                    "title": "Explicabo at in quia sed",
                    "latitude": "44.4965170",
                    "longitude": "11.3268580",
                    "address": "Rotonda Ricci 37 Appartamento 23\nSettimo Italo a mare, 16449 Asti (PZ)"
                },
                {
                    "id": 45,
                    "title": "Doloribus quos cumque libero et",
                    "latitude": "44.4975940",
                    "longitude": "11.3291210",
                    "address": "Strada Caputo 7 Piano 9\nSan Deborah, 92271 Bari (PU)"
                },
                {
                    "id": 52,
                    "title": "Eum qui eius et dolores minima",
                    "latitude": "44.4957680",
                    "longitude": "11.3217490",
                    "address": "Via Gastone 63 Appartamento 02\nVienna sardo, 49290 Cuneo (PG)"
                },
                {
                    "id": 53,
                    "title": "Cum ea totam ipsum",
                    "latitude": "44.4953880",
                    "longitude": "11.3219850",
                    "address": "Contrada Flaviana 58 Piano 9\nSettimo Orfeo, 37928 Salerno (BZ)"
                },
                {
                    "id": 60,
                    "title": "Qui id id sunt repellendus vero",
                    "latitude": "44.4928060",
                    "longitude": "11.3218010",
                    "address": "Rotonda Sebastian 0 Piano 4\nSan Flaviana, 22474 Matera (RG)"
                },
                {
                    "id": 61,
                    "title": "Quo ratione quidem eaque",
                    "latitude": "44.4934250",
                    "longitude": "11.3224810",
                    "address": "Contrada Galli 95\nSesto Patrizio laziale, 19024 Genova (AG)"
                },
                {
                    "id": 68,
                    "title": "Ipsam et dignissimos optio vel",
                    "latitude": "44.4957910",
                    "longitude": "11.3206350",
                    "address": "Incrocio Gerlando 929 Piano 7\nSettimo Clodovea laziale, 76738 Crotone (CE)"
                },
                {
                    "id": 69,
                    "title": "Corporis aliquid et sed adipisci",
                    "latitude": "44.4941110",
                    "longitude": "11.3269130",
                    "address": "Piazza Gentile 7\nSettimo Joannes, 02039 Belluno (EN)"
                },
                {
                    "id": 76,
                    "title": "Omnis est et non tempore",
                    "latitude": "44.4921420",
                    "longitude": "11.3209500",
                    "address": "Strada Greco 702 Appartamento 90\nUrsula del friuli, 34359 Torino (SA)"
                },
                {
                    "id": 77,
                    "title": "Sunt ut qui iusto impedit sequi qui",
                    "latitude": "44.4902900",
                    "longitude": "11.3256860",
                    "address": "Piazza Rizzi 481\nSesto Evita veneto, 21396 Parma (RN)"
                },
                {
                    "id": 84,
                    "title": "Tempore nihil voluptas at unde",
                    "latitude": "44.4966370",
                    "longitude": "11.3247730",
                    "address": "Strada Jari 632\nQuarto Lino sardo, 72557 Cuneo (LO)"
                },
                {
                    "id": 85,
                    "title": "Praesentium officia quis in",
                    "latitude": "44.4905080",
                    "longitude": "11.3216890",
                    "address": "Contrada Genziana 732 Piano 0\nSan Piccarda lido, 13772 Ascoli Piceno (MN)"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/waste_stations

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get all Recycling Types

This endpoint retrieves all Recycling Types from Recycling of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/waste_types" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "title": "plastica",
            "acceptable": "Autem nulla molestiae error ullam tenetur. Maiores eum fugiat assumenda.",
            "not_acceptable": "Sit ipsa nihil consequuntur eaque praesentium non ad quisquam. Est consectetur mollitia aspernatur quaerat.",
            "icon_url": "http://istituzionale.mycity.api/images/app_icons/00-standard.png",
            "icon": "00-standard",
            "color": "#d81dfb"
        },
        {
            "id": 2,
            "title": "carta",
            "acceptable": "Consequatur iusto rem unde corrupti incidunt ipsa. Molestiae deleniti consequatur eum aut.",
            "not_acceptable": "Quia debitis dicta corrupti. Animi nihil quibusdam alias assumenda architecto. Nisi quaerat magni repudiandae ex culpa.",
            "icon_url": "http://istituzionale.mycity.api/images/app_icons/00-standard.png",
            "icon": "00-standard",
            "color": "#35735a"
        },
        {
            "id": 3,
            "title": "vetro",
            "acceptable": "Quas vitae repellat consectetur voluptate repudiandae non. Enim error consequatur illo ut sed.",
            "not_acceptable": "Nemo magni odio dignissimos quam beatae sed eum ducimus. Occaecati ipsum et sint. Dicta quod qui qui.",
            "icon_url": "http://istituzionale.mycity.api/images/app_icons/00-standard.png",
            "icon": "00-standard",
            "color": "#0b3dc0"
        },
        {
            "id": 4,
            "title": "organico",
            "acceptable": "Error perspiciatis optio saepe qui. Reprehenderit odio earum consequuntur aut.",
            "not_acceptable": "Provident et ratione modi iusto facere saepe. Provident omnis aperiam assumenda. Iure et hic et dolor et voluptas.",
            "icon_url": "http://istituzionale.mycity.api/images/app_icons/00-standard.png",
            "icon": "00-standard",
            "color": "#66f5b8"
        },
        {
            "id": 5,
            "title": "indifferenziata",
            "acceptable": "Ut qui eaque est praesentium. Et odit occaecati fuga illo tempora et. Harum et dolor asperiores ratione ut.",
            "not_acceptable": "Magnam officia rem hic necessitatibus aliquid nemo. Aut aut ut cum. Deleniti magnam praesentium quia fugiat.",
            "icon_url": "http://istituzionale.mycity.api/images/app_icons/00-standard.png",
            "icon": "00-standard",
            "color": "#b56dc9"
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/waste_types

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get all Zones

This endpoint retrieves all Zones from Recycling of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/waste_zones" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 385,
            "type": "waste_zones",
            "title": "Zona di raccolta Naomi a mare",
            "permalink": "naomi-mare",
            "abstract": "",
            "body": "",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "shape": null,
            "created_at": null,
            "updated_at": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/385"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/385/menu"
                },
                {
                    "rel": "calendar",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/385/calendar"
                },
                {
                    "rel": "types",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/385/types"
                }
            ],
            "deeplink": "mycity://scenarios/5/wasteZones/385",
            "share_url": "http://istituzionale.mycity.api/zone_raccolta_rifiuti/385/naomi-mare",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 390,
            "type": "waste_zones",
            "title": "Zona di raccolta Damico sardo",
            "permalink": "damico-sardo",
            "abstract": "",
            "body": "",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "shape": null,
            "created_at": null,
            "updated_at": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/390"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/390/menu"
                },
                {
                    "rel": "calendar",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/390/calendar"
                },
                {
                    "rel": "types",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/390/types"
                }
            ],
            "deeplink": "mycity://scenarios/5/wasteZones/390",
            "share_url": "http://istituzionale.mycity.api/zone_raccolta_rifiuti/390/damico-sardo",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 410,
            "type": "waste_zones",
            "title": "Zona di raccolta Settimo Cristyn",
            "permalink": "settimo-cristyn",
            "abstract": "",
            "body": "",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "shape": null,
            "created_at": null,
            "updated_at": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/410"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/410/menu"
                },
                {
                    "rel": "calendar",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/410/calendar"
                },
                {
                    "rel": "types",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/410/types"
                }
            ],
            "deeplink": "mycity://scenarios/5/wasteZones/410",
            "share_url": "http://istituzionale.mycity.api/zone_raccolta_rifiuti/410/settimo-cristyn",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 386,
            "type": "waste_zones",
            "title": "Zona di raccolta Esposito calabro",
            "permalink": "esposito-calabro",
            "abstract": "",
            "body": "",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "shape": null,
            "created_at": null,
            "updated_at": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/386"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/386/menu"
                },
                {
                    "rel": "calendar",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/386/calendar"
                },
                {
                    "rel": "types",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/386/types"
                }
            ],
            "deeplink": "mycity://scenarios/5/wasteZones/386",
            "share_url": "http://istituzionale.mycity.api/zone_raccolta_rifiuti/386/esposito-calabro",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 391,
            "type": "waste_zones",
            "title": "Zona di raccolta San Teseo sardo",
            "permalink": "san-teseo-sardo",
            "abstract": "",
            "body": "",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "shape": null,
            "created_at": null,
            "updated_at": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/391"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/391/menu"
                },
                {
                    "rel": "calendar",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/391/calendar"
                },
                {
                    "rel": "types",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/391/types"
                }
            ],
            "deeplink": "mycity://scenarios/5/wasteZones/391",
            "share_url": "http://istituzionale.mycity.api/zone_raccolta_rifiuti/391/san-teseo-sardo",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 411,
            "type": "waste_zones",
            "title": "Zona di raccolta Loris a mare",
            "permalink": "loris-mare",
            "abstract": "",
            "body": "",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "shape": null,
            "created_at": null,
            "updated_at": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/411"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/411/menu"
                },
                {
                    "rel": "calendar",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/411/calendar"
                },
                {
                    "rel": "types",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/411/types"
                }
            ],
            "deeplink": "mycity://scenarios/5/wasteZones/411",
            "share_url": "http://istituzionale.mycity.api/zone_raccolta_rifiuti/411/loris-mare",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 387,
            "type": "waste_zones",
            "title": "Zona di raccolta Quarto Oreste",
            "permalink": "quarto-oreste",
            "abstract": "",
            "body": "",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "shape": null,
            "created_at": null,
            "updated_at": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/387"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/387/menu"
                },
                {
                    "rel": "calendar",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/387/calendar"
                },
                {
                    "rel": "types",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/387/types"
                }
            ],
            "deeplink": "mycity://scenarios/5/wasteZones/387",
            "share_url": "http://istituzionale.mycity.api/zone_raccolta_rifiuti/387/quarto-oreste",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 392,
            "type": "waste_zones",
            "title": "Zona di raccolta Borgo Marianita umbro",
            "permalink": "borgo-marianita-umbro",
            "abstract": "",
            "body": "",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "shape": null,
            "created_at": null,
            "updated_at": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/392"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/392/menu"
                },
                {
                    "rel": "calendar",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/392/calendar"
                },
                {
                    "rel": "types",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/392/types"
                }
            ],
            "deeplink": "mycity://scenarios/5/wasteZones/392",
            "share_url": "http://istituzionale.mycity.api/zone_raccolta_rifiuti/392/borgo-marianita-umbro",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 412,
            "type": "waste_zones",
            "title": "Zona di raccolta Luce ligure",
            "permalink": "luce-ligure",
            "abstract": "",
            "body": "",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "shape": null,
            "created_at": null,
            "updated_at": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/412"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/412/menu"
                },
                {
                    "rel": "calendar",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/412/calendar"
                },
                {
                    "rel": "types",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/412/types"
                }
            ],
            "deeplink": "mycity://scenarios/5/wasteZones/412",
            "share_url": "http://istituzionale.mycity.api/zone_raccolta_rifiuti/412/luce-ligure",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 388,
            "type": "waste_zones",
            "title": "Zona di raccolta Quarto Caligola del friuli",
            "permalink": "quarto-caligola-friuli",
            "abstract": "",
            "body": "",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "shape": null,
            "created_at": null,
            "updated_at": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/388"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/388/menu"
                },
                {
                    "rel": "calendar",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/388/calendar"
                },
                {
                    "rel": "types",
                    "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/388/types"
                }
            ],
            "deeplink": "mycity://scenarios/5/wasteZones/388",
            "share_url": "http://istituzionale.mycity.api/zone_raccolta_rifiuti/388/quarto-caligola-friuli",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        }
    ],
    "links": {
        "first": "http://istituzionale.mycity.api/api/v1/scenarios/5/waste_zones?page=1",
        "last": "http://istituzionale.mycity.api/api/v1/scenarios/5/waste_zones?page=2",
        "prev": null,
        "next": "http://istituzionale.mycity.api/api/v1/scenarios/5/waste_zones?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "path": "http://istituzionale.mycity.api/api/v1/scenarios/5/waste_zones",
        "per_page": 10,
        "to": 10,
        "total": 12
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/waste_zones

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get a specific Zone

This endpoint retrieves a specific Zone of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/waste_zones/{zone}" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 413,
        "type": "waste_zones",
        "title": "Zona di raccolta Coppola umbro",
        "permalink": "coppola-umbro",
        "abstract": "",
        "body": "",
        "publish_date": null,
        "unpublish_date": null,
        "image_url": null,
        "shape": null,
        "created_at": null,
        "updated_at": null,
        "links": [
            {
                "rel": "self",
                "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/413"
            },
            {
                "rel": "menu",
                "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/413/menu"
            },
            {
                "rel": "calendar",
                "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/413/calendar"
            },
            {
                "rel": "types",
                "href": "http://api.mycity.api/api/v1/scenarios/5/waste_zones/413/types"
            }
        ],
        "deeplink": "mycity://scenarios/5/wasteZones/413",
        "share_url": "http://istituzionale.mycity.api/zone_raccolta_rifiuti/413/coppola-umbro",
        "liked": false,
        "likes": 0,
        "shared": false,
        "shares": 0
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/waste_zones/{zone}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
zone int The ID of the Zone to retrieve.

Get types specific for Zone

This endpoint retrieves specific types for a zone.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/waste_zones/{zone}/types" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "title": "plastica",
            "description": "Dolores aut occaecati quasi nihil aut illum est.",
            "color": "#ce2837"
        },
        {
            "id": 2,
            "title": "carta",
            "description": "Fugiat natus suscipit aut ab et.",
            "color": "#6c0a58"
        },
        {
            "id": 3,
            "title": "vetro",
            "description": "Quibusdam rem officia consequatur omnis est quasi accusantium.",
            "color": "#8b76bd"
        },
        {
            "id": 4,
            "title": "organico",
            "description": "Itaque quos tenetur sed id est temporibus.",
            "color": "#3d8581"
        },
        {
            "id": 5,
            "title": "indifferenziata",
            "description": "Alias veritatis vel in ullam illum.",
            "color": "#a6ed11"
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/waste_zones/{zone}/types

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
zone int The ID of the Zone to retrieve.

Verify subscription to notifications for a zone

This endpoint verify if a device issubscribe to recycling zone calendar.

Example request:

curl -X PUT \
"https://api.mycitydemo.it/api/v1/scenarios/2/waste_zones/{zone}/verify_subscription" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer [Bearer] \
  -H 'Content-Type: application/json' \
  -d '{
    "push_key": "[push_key]"
}'

Example response:

{
    "push_key": "eJ8eKK3y3C8:APA91bGCxe8FOhBHBysFle_ds-9iVj5tGWLCF7at0HY0eatMvT75S3wwVehbfqXmu0ltJoDl7_fvj2t2kJIttcCcDDIVT7Et1uEp3VTGkV4CN4nT3Otr8HNPL6XMlBrv57vShbO5IBJs",
    "zone_id": 413,
    "subscribed": false
}

HTTP Request

PUT api/v1/scenarios/{scenario}/waste_zones/{zone}/verify_subscription

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
zone int The ID of the zone.
push_key int FCM device key.

Subcribing notifications for a zone

This endpoint permits to subscribe a device to recycling zone calendar.

Example request:

curl -X POST \
"https://api.mycitydemo.it/api/v1/scenarios/2/waste_zones/{zone}/subscribe" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer [Bearer] \
  -H 'Content-Type: application/json' \
  -d '{
    "push_key": "[push_key]"
}'

Example response:

{
    "push_key": "eJ8eKK3y3C8:APA91bGCxe8FOhBHBysFle_ds-9iVj5tGWLCF7at0HY0eatMvT75S3wwVehbfqXmu0ltJoDl7_fvj2t2kJIttcCcDDIVT7Et1uEp3VTGkV4CN4nT3Otr8HNPL6XMlBrv57vShbO5IBJs",
    "zone_id": 413,
    "success": true
}

HTTP Request

POST api/v1/scenarios/{scenario}/waste_zones/{zone}/subscribe

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
zone int The ID of the zone.
push_key int FCM device key.

Unsubcribing notifications for an zone

This endpoint permits to unsubscribe a device to recycling zone calendar.

Example request:

curl -X POST \
"https://api.mycitydemo.it/api/v1/scenarios/2/waste_zones/{zone}/unsubscribe" \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer [Bearer] \
  -H 'Content-Type: application/json' \
  -d '{
    "push_key": "[push_key]"
}'

Example response:

{
    "push_key": "eJ8eKK3y3C8:APA91bGCxe8FOhBHBysFle_ds-9iVj5tGWLCF7at0HY0eatMvT75S3wwVehbfqXmu0ltJoDl7_fvj2t2kJIttcCcDDIVT7Et1uEp3VTGkV4CN4nT3Otr8HNPL6XMlBrv57vShbO5IBJs",
    "zone_id": 413,
    "success": true
}

HTTP Request

POST api/v1/scenarios/{scenario}/waste_zones/{zone}/unsubscribe

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
zone int The ID of the zone.
push_key int FCM device key.

Get Recycling Calendar for Zone

This endpoint retrieves recycling calendar of a specific zone.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/waste_zones/{zone}/calendar" \
-H "Accept: application/json"

Example response:

{
  "data": [
    {
      "year": "2018",
      "months": [
        {
          "month": "04",
          "days": [
            {
              "day": "30",
              "types": [
                {
                  "id": 341,
                  "waste_zone_id": 415,
                  "day": "2018-04-30 00:00:00",
                  "type_name": "organico",
                  "type_color": "#3d8581",
                  "hour_from": "20:00:00",
                  "hour_to": "23:00:00"
                }
              ]
            }
          ]
        },
        {
          "month": "05",
          "days": [
            {
              "day": "21",
              "types": [
                {
                  "id": 347,
                  "waste_zone_id": 415,
                  "day": "2018-05-21 00:00:00",
                  "type_name": "organico",
                  "type_color": "#3d8581",
                  "hour_from": "20:00:00",
                  "hour_to": "23:00:00"
                }
              ]
            },
            {
              "day": "22",
              "types": [
                {
                  "id": 458,
                  "waste_zone_id": 415,
                  "day": "2018-05-22 00:00:00",
                  "type_name": "indifferenziata",
                  "type_color": "#a6ed11",
                  "hour_from": "19:00:00",
                  "hour_to": "24:00:00"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/waste_zones/{zone}/calendar

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
zone int The ID of the Zone to retrieve.

Associations

Get all Association Categories

This endpoint retrieves all Association Categories from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/associations_categories" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 406,
            "type": "associations_categories",
            "title": "Reprehenderit voluptas ullam magnam",
            "permalink": "reprehenderit-voluptas-ullam-magnam",
            "abstract": "Esse aliquid omnis enim nulla maiores. Alias voluptatem est odit accusantium omnis. Sed sed quae dolor et. Ea tenetur minus nihil maxime corrupti repudiandae.",
            "body": "Praesentium enim dolore exercitationem voluptas voluptas minus. Voluptates recusandae libero sunt odio rerum. Ea qui officiis et impedit esse iusto. Ut iusto dolorum ex nulla enim porro minima. Culpa id eum earum earum. Minima veniam sit corporis dolor. Molestiae quia nobis nisi facere molestiae temporibus. Molestiae consectetur molestiae voluptatem ducimus ab sint ipsam saepe. Dolor inventore at sit. Aut rerum voluptatibus maxime aspernatur sunt vel aut.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_categories/406"
                },
                {
                    "rel": "associations",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_categories/406/associations"
                },
                {
                    "rel": "job_ads",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_categories/406/job_ads"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_categories/406/menu"
                }
            ],
            "deeplink": "mycity://scenarios/2/categories/406",
            "share_url": "https://bologna.mycity.api/categories/406/reprehenderit-voluptas-ullam-magnam"
        },
        {
            "id": 412,
            "type": "associations_categories",
            "title": "Tempora porro et sunt aut neque et sit",
            "permalink": "tempora-porro-et-sunt-aut-neque-sit",
            "abstract": "Qui aut aut id. Qui laborum praesentium ut possimus. Beatae magnam minus inventore est ut aperiam alias.",
            "body": "Enim a nostrum unde quisquam est. Esse consequatur voluptatem ut nisi at cumque. Voluptatem minus quibusdam velit inventore natus placeat. Maxime aut accusamus alias dicta nisi optio. Tempora dolor sit explicabo facilis voluptate inventore aspernatur. Ad velit aut libero et. Porro repellendus error sapiente sed temporibus quibusdam. Excepturi aut accusamus numquam. Vel quia dolore est voluptate. Sed repudiandae incidunt eum dolores. Perspiciatis delectus facere praesentium beatae et.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_categories/412"
                },
                {
                    "rel": "associations",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_categories/412/associations"
                },
                {
                    "rel": "job_ads",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_categories/412/job_ads"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_categories/412/menu"
                }
            ],
            "deeplink": "mycity://scenarios/2/categories/412",
            "share_url": "https://bologna.mycity.api/categories/412/tempora-porro-et-sunt-aut-neque-sit"
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/2/associations_categories?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/2/associations_categories?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/2/associations_categories",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/associations_categories

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get a specific Association Category

This endpoint retrieves a specific Association Category from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/associations_categories/{association_category}" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 406,
        "type": "associations_categories",
        "title": "Reprehenderit voluptas ullam magnam",
        "permalink": "reprehenderit-voluptas-ullam-magnam",
        "abstract": "Esse aliquid omnis enim nulla maiores. Alias voluptatem est odit accusantium omnis. Sed sed quae dolor et. Ea tenetur minus nihil maxime corrupti repudiandae.",
        "body": "Praesentium enim dolore exercitationem voluptas voluptas minus. Voluptates recusandae libero sunt odio rerum. Ea qui officiis et impedit esse iusto. Ut iusto dolorum ex nulla enim porro minima. Culpa id eum earum earum. Minima veniam sit corporis dolor. Molestiae quia nobis nisi facere molestiae temporibus. Molestiae consectetur molestiae voluptatem ducimus ab sint ipsam saepe. Dolor inventore at sit. Aut rerum voluptatibus maxime aspernatur sunt vel aut.",
        "publish_date": null,
        "unpublish_date": null,
        "image_url": null,
        "links": [
            {
                "rel": "self",
                "href": "http://api.mycity.api/api/v1/scenarios/2/associations_categories/406"
            },
            {
                "rel": "associations",
                "href": "http://api.mycity.api/api/v1/scenarios/2/associations_categories/406/associations"
            },
            {
                "rel": "job_ads",
                "href": "http://api.mycity.api/api/v1/scenarios/2/associations_categories/406/job_ads"
            },
            {
                "rel": "menu",
                "href": "http://api.mycity.api/api/v1/scenarios/2/associations_categories/406/menu"
            }
        ],
        "deeplink": "mycity://scenarios/2/categories/406",
        "share_url": "https://bologna.mycity.api/categories/406/reprehenderit-voluptas-ullam-magnam"
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/associations_categories/{association_category}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
association_category int The ID of the Association to retrieve.

Get all Associations from Category

This endpoint retrieves all Association belonging to a category from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/associations_categories/{association_category}/associations" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 407,
            "type": "associations",
            "title": "Conti, Lombardo e Galli e figli",
            "permalink": "conti-lombardo-galli-figli",
            "abstract": "Adipisci doloribus alias reiciendis. Dolores minus vitae quia explicabo nihil illo reprehenderit molestiae. Velit hic vero veniam.",
            "body": "Veniam cumque dolorum veniam similique et cumque commodi illo. Esse illo dolor esse voluptate. Quia voluptas expedita inventore iusto eos. Voluptate doloremque quo quod voluptas et omnis et ipsam. Earum voluptatem neque quia odio distinctio dolorem. Quod eos vel quam aliquid mollitia. Earum est omnis sint dolore laborum. Quisquam pariatur iste magnam reiciendis assumenda modi. Perferendis maxime consequatur molestiae est ratione. Velit nobis iure tempore veniam quod sit qui repellendus.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/96/100",
            "phone": "+99 6999 40235373",
            "fax": "+03 952 86996603",
            "email": "cleros.costantini@example.com",
            "pec": "jguerra@example.org",
            "external_link": null,
            "user_id": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/407"
                },
                {
                    "rel": "job_ads",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/407/job_ads"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/407/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/407/gallery"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/407/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/407/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/associations/407",
            "share_url": "https://bologna.mycity.api/associations/407/conti-lombardo-galli-figli",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 408,
            "type": "associations",
            "title": "Grassi-Donati SPA",
            "permalink": "grassi-donati-spa",
            "abstract": "Iure dolorem non ea amet et cum occaecati alias. Eum recusandae cumque exercitationem autem rerum. Natus repellat est et et. Deleniti fugiat et blanditiis placeat.",
            "body": "Magnam repudiandae odio ea eos ratione voluptatibus. Soluta ratione qui ipsam aliquam. Illo et voluptas sit. Quaerat pariatur hic repellat voluptatibus. Consequatur placeat voluptate exercitationem rerum est. Quod quas nobis ipsa necessitatibus. Sit rem doloribus adipisci ad aut nesciunt dolore. Voluptas ut quia iure totam eligendi numquam quo.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/98/100",
            "phone": "+26 317 08873549",
            "fax": "+14 49 42751958",
            "email": "ngalli@example.com",
            "pec": "genziana.rossi@example.net",
            "external_link": null,
            "user_id": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/408"
                },
                {
                    "rel": "job_ads",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/408/job_ads"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/408/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/408/gallery"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/408/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/408/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/associations/408",
            "share_url": "https://bologna.mycity.api/associations/408/grassi-donati-spa",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/2/associations_categories/406/associations?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/2/associations_categories/406/associations?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/2/associations_categories/406/associations",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/associations_categories/{association_category}/associations

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
association_category int The ID of the Category to retrieve.

Get all Associations

This endpoint retrieves all Associations from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/associations" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 407,
            "type": "associations",
            "title": "Conti, Lombardo e Galli e figli",
            "permalink": "conti-lombardo-galli-figli",
            "abstract": "Adipisci doloribus alias reiciendis. Dolores minus vitae quia explicabo nihil illo reprehenderit molestiae. Velit hic vero veniam.",
            "body": "Veniam cumque dolorum veniam similique et cumque commodi illo. Esse illo dolor esse voluptate. Quia voluptas expedita inventore iusto eos. Voluptate doloremque quo quod voluptas et omnis et ipsam. Earum voluptatem neque quia odio distinctio dolorem. Quod eos vel quam aliquid mollitia. Earum est omnis sint dolore laborum. Quisquam pariatur iste magnam reiciendis assumenda modi. Perferendis maxime consequatur molestiae est ratione. Velit nobis iure tempore veniam quod sit qui repellendus.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/96/100",
            "phone": "+99 6999 40235373",
            "fax": "+03 952 86996603",
            "email": "cleros.costantini@example.com",
            "pec": "jguerra@example.org",
            "external_link": null,
            "user_id": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/407"
                },
                {
                    "rel": "job_ads",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/407/job_ads"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/407/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/407/gallery"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/407/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/407/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/associations/407",
            "share_url": "https://bologna.mycity.api/associations/407/conti-lombardo-galli-figli",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 408,
            "type": "associations",
            "title": "Grassi-Donati SPA",
            "permalink": "grassi-donati-spa",
            "abstract": "Iure dolorem non ea amet et cum occaecati alias. Eum recusandae cumque exercitationem autem rerum. Natus repellat est et et. Deleniti fugiat et blanditiis placeat.",
            "body": "Magnam repudiandae odio ea eos ratione voluptatibus. Soluta ratione qui ipsam aliquam. Illo et voluptas sit. Quaerat pariatur hic repellat voluptatibus. Consequatur placeat voluptate exercitationem rerum est. Quod quas nobis ipsa necessitatibus. Sit rem doloribus adipisci ad aut nesciunt dolore. Voluptas ut quia iure totam eligendi numquam quo.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/98/100",
            "phone": "+26 317 08873549",
            "fax": "+14 49 42751958",
            "email": "ngalli@example.com",
            "pec": "genziana.rossi@example.net",
            "external_link": null,
            "user_id": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/408"
                },
                {
                    "rel": "job_ads",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/408/job_ads"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/408/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/408/gallery"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/408/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/408/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/associations/408",
            "share_url": "https://bologna.mycity.api/associations/408/grassi-donati-spa",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 413,
            "type": "associations",
            "title": "Silvestri-Orlando Group",
            "permalink": "silvestri-orlando-group",
            "abstract": "Enim et ut voluptates ipsa. Aut ut asperiores optio sit necessitatibus. Sed autem nobis consequatur et temporibus quaerat est.",
            "body": "Assumenda error quisquam aliquam culpa est nesciunt. Fugiat et et voluptatum ipsa quo minus. Quae repudiandae assumenda deserunt et et repellendus. Eos sit minima aspernatur delectus debitis molestias iure. Velit et voluptatem aut eos exercitationem. Repellendus distinctio nihil eligendi est fugiat. Asperiores incidunt facilis qui animi aperiam qui aut. Omnis aut illum qui totam nesciunt quaerat. Et sit occaecati perferendis tenetur est vel.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/101/100",
            "phone": "+82 29 2003616",
            "fax": "+14 8461 3312909",
            "email": "rosaria.santoro@example.org",
            "pec": "mariani.michael@example.com",
            "external_link": null,
            "user_id": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/413"
                },
                {
                    "rel": "job_ads",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/413/job_ads"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/413/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/413/gallery"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/413/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations/413/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/associations/413",
            "share_url": "https://bologna.mycity.api/associations/413/silvestri-orlando-group",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/2/associations?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/2/associations?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/2/associations",
        "per_page": 10,
        "to": 3,
        "total": 3
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/associations

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get a specific Association

This endpoint retrieves a specific Association from a Scenario.

HTTP Request

GET api/v1/scenarios/{scenario}/associations/{association}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
association int The ID of the Association to retrieve.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/associations/{association}" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 407,
        "type": "associations",
        "title": "Conti, Lombardo e Galli e figli",
        "permalink": "conti-lombardo-galli-figli",
        "abstract": "Adipisci doloribus alias reiciendis. Dolores minus vitae quia explicabo nihil illo reprehenderit molestiae. Velit hic vero veniam.",
        "body": "Veniam cumque dolorum veniam similique et cumque commodi illo. Esse illo dolor esse voluptate. Quia voluptas expedita inventore iusto eos. Voluptate doloremque quo quod voluptas et omnis et ipsam. Earum voluptatem neque quia odio distinctio dolorem. Quod eos vel quam aliquid mollitia. Earum est omnis sint dolore laborum. Quisquam pariatur iste magnam reiciendis assumenda modi. Perferendis maxime consequatur molestiae est ratione. Velit nobis iure tempore veniam quod sit qui repellendus.",
        "publish_date": null,
        "unpublish_date": null,
        "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/96/100",
        "phone": "+99 6999 40235373",
        "fax": "+03 952 86996603",
        "email": "cleros.costantini@example.com",
        "pec": "jguerra@example.org",
        "external_link": null,
        "user_id": null,
        "links": [
            {
                "rel": "self",
                "href": "http://api.mycity.api/api/v1/scenarios/2/associations/407"
            },
            {
                "rel": "job_ads",
                "href": "http://api.mycity.api/api/v1/scenarios/2/associations/407/job_ads"
            },
            {
                "rel": "category",
                "href": "http://api.mycity.api/api/v1/scenarios/2/associations/407/category"
            },
            {
                "rel": "gallery",
                "href": "http://api.mycity.api/api/v1/scenarios/2/associations/407/gallery"
            },
            {
                "rel": "pois",
                "href": "http://api.mycity.api/api/v1/scenarios/2/associations/407/pois"
            },
            {
                "rel": "attachments",
                "href": "http://api.mycity.api/api/v1/scenarios/2/associations/407/attachments"
            }
        ],
        "deeplink": "mycity://scenarios/2/associations/407",
        "share_url": "https://bologna.mycity.api/associations/407/conti-lombardo-galli-figli",
        "liked": false,
        "likes": 0,
        "shared": false,
        "shares": 0
    }
}

Get all Job_ads from Association

This endpoint retrieves all Job_ads belonging to an association from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/associations/{association}/job_ads" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 409,
            "type": "associations_job_ads",
            "title": "Libero rem sint rerum odit est id",
            "permalink": "libero-rem-sint-rerum-odit-est-id",
            "abstract": "Magnam sint praesentium aspernatur vero. Aliquam iusto delectus et quo doloribus odio asperiores nostrum. Id dolores modi adipisci maiores. Molestiae sit modi non sit aut.",
            "body": "Vero blanditiis quia sit. Rerum laudantium saepe consequuntur. Quod in explicabo esse ducimus in. Voluptatibus velit veritatis aut non sed debitis ut. Aut iste autem ex dolorem tempora repellendus non. Dolores aut pariatur harum in vero. Non incidunt aspernatur qui rem eligendi magni saepe. Illo praesentium aperiam facilis et. Ut consequuntur omnis deserunt perferendis quis dolores et voluptas.",
            "publish_date": "2017-12-24 05:18:11",
            "unpublish_date": "2018-03-14 09:52:18",
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/97/100",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/409"
                },
                {
                    "rel": "author",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/409/author"
                },
                {
                    "rel": "applications",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/409/applications"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/409/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/409/gallery"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/409/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/job_ads/409",
            "share_url": "https://bologna.mycity.api/job_ads/409/libero-rem-sint-rerum-odit-est-id",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/2/associations/407/job_ads?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/2/associations/407/job_ads?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/2/associations/407/job_ads",
        "per_page": 10,
        "to": 1,
        "total": 1
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/associations/{association}/job_ads

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
association int The ID of the Association to retrieve.

Get all Job_ads from Category

This endpoint retrieves all Job_ads belonging to a category from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/associations_categories/{association_category}/job_ads" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 409,
            "type": "associations_job_ads",
            "title": "Libero rem sint rerum odit est id",
            "permalink": "libero-rem-sint-rerum-odit-est-id",
            "abstract": "Magnam sint praesentium aspernatur vero. Aliquam iusto delectus et quo doloribus odio asperiores nostrum. Id dolores modi adipisci maiores. Molestiae sit modi non sit aut.",
            "body": "Vero blanditiis quia sit. Rerum laudantium saepe consequuntur. Quod in explicabo esse ducimus in. Voluptatibus velit veritatis aut non sed debitis ut. Aut iste autem ex dolorem tempora repellendus non. Dolores aut pariatur harum in vero. Non incidunt aspernatur qui rem eligendi magni saepe. Illo praesentium aperiam facilis et. Ut consequuntur omnis deserunt perferendis quis dolores et voluptas.",
            "publish_date": "2017-12-24 05:18:11",
            "unpublish_date": "2018-03-14 09:52:18",
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/97/100",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/409"
                },
                {
                    "rel": "author",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/409/author"
                },
                {
                    "rel": "applications",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/409/applications"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/409/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/409/gallery"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/409/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/job_ads/409",
            "share_url": "https://bologna.mycity.api/job_ads/409/libero-rem-sint-rerum-odit-est-id",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 410,
            "type": "associations_job_ads",
            "title": "Debitis aliquam omnis maiores eveniet",
            "permalink": "debitis-aliquam-omnis-maiores-eveniet",
            "abstract": "Omnis consequuntur esse cum modi. Tenetur in blanditiis dolorum harum assumenda est. Nihil pariatur dolores sunt praesentium dolores assumenda. Veniam voluptatem ut voluptates omnis rerum iusto.",
            "body": "Aperiam aut ut quo quaerat. At consectetur aut in magnam. Possimus provident voluptatem fuga vel laboriosam. Aut voluptatem sit quae velit velit nesciunt ab et. Qui eum nam non voluptas ullam enim. Nobis asperiores minima qui consequatur nihil deserunt. Aliquam officiis aliquam quisquam voluptatem doloribus inventore. Laudantium perspiciatis fugiat velit exercitationem quasi. Quis qui impedit laborum dolor ut animi. Inventore officiis veniam impedit.",
            "publish_date": "2017-12-24 02:14:00",
            "unpublish_date": "2018-04-19 21:18:34",
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/99/100",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/410"
                },
                {
                    "rel": "author",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/410/author"
                },
                {
                    "rel": "applications",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/410/applications"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/410/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/410/gallery"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/410/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/job_ads/410",
            "share_url": "https://bologna.mycity.api/job_ads/410/debitis-aliquam-omnis-maiores-eveniet",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 411,
            "type": "associations_job_ads",
            "title": "Non magnam autem est sit",
            "permalink": "non-magnam-autem-est-sit",
            "abstract": "Libero voluptatibus maiores odio nesciunt. Non odio sapiente iusto tenetur autem eos ea. Ut doloremque dicta animi omnis. Rem accusamus sunt nulla et laboriosam incidunt.",
            "body": "Autem ab nihil vitae sunt. Deleniti et dignissimos sint nulla aliquam deleniti. Sit ea repudiandae eius dolorem eligendi beatae asperiores incidunt. Voluptatibus nostrum corporis eligendi vel. Numquam voluptas saepe vel in et. Minus soluta ipsum et qui provident pariatur. Voluptate laudantium occaecati commodi fuga. Sit facilis doloribus quae minima ut excepturi alias. Et et quaerat odio. Nulla illum temporibus quis qui quo. Id pariatur vel autem quas sunt id.",
            "publish_date": "2017-12-24 08:19:12",
            "unpublish_date": "2018-03-20 19:29:50",
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/100/100",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/411"
                },
                {
                    "rel": "author",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/411/author"
                },
                {
                    "rel": "applications",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/411/applications"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/411/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/411/gallery"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/associations_job_ads/411/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/job_ads/411",
            "share_url": "https://bologna.mycity.api/job_ads/411/non-magnam-autem-est-sit",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/2/associations_categories/406/job_ads?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/2/associations_categories/406/job_ads?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/2/associations_categories/406/job_ads",
        "per_page": 10,
        "to": 3,
        "total": 3
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/associations_categories/{association_category}/job_ads

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
association_category int The ID of the Category to retrieve.

Companies

Get all Company Categories

This endpoint retrieves all Company Categories from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/business_categories" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 406,
            "type": "business_categories",
            "title": "Reprehenderit voluptas ullam magnam",
            "permalink": "reprehenderit-voluptas-ullam-magnam",
            "abstract": "Esse aliquid omnis enim nulla maiores. Alias voluptatem est odit accusantium omnis. Sed sed quae dolor et. Ea tenetur minus nihil maxime corrupti repudiandae.",
            "body": "Praesentium enim dolore exercitationem voluptas voluptas minus. Voluptates recusandae libero sunt odio rerum. Ea qui officiis et impedit esse iusto. Ut iusto dolorum ex nulla enim porro minima. Culpa id eum earum earum. Minima veniam sit corporis dolor. Molestiae quia nobis nisi facere molestiae temporibus. Molestiae consectetur molestiae voluptatem ducimus ab sint ipsam saepe. Dolor inventore at sit. Aut rerum voluptatibus maxime aspernatur sunt vel aut.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/business_categories/406"
                },
                {
                    "rel": "companies",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/business_categories/406/companies"
                },
                {
                    "rel": "job_ads",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/business_categories/406/job_ads"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/business_categories/406/menu"
                }
            ],
            "deeplink": "mycity://scenarios/2/categories/406",
            "share_url": "https://bologna.mycity.api/categories/406/reprehenderit-voluptas-ullam-magnam"
        },
        {
            "id": 412,
            "type": "business_categories",
            "title": "Tempora porro et sunt aut neque et sit",
            "permalink": "tempora-porro-et-sunt-aut-neque-sit",
            "abstract": "Qui aut aut id. Qui laborum praesentium ut possimus. Beatae magnam minus inventore est ut aperiam alias.",
            "body": "Enim a nostrum unde quisquam est. Esse consequatur voluptatem ut nisi at cumque. Voluptatem minus quibusdam velit inventore natus placeat. Maxime aut accusamus alias dicta nisi optio. Tempora dolor sit explicabo facilis voluptate inventore aspernatur. Ad velit aut libero et. Porro repellendus error sapiente sed temporibus quibusdam. Excepturi aut accusamus numquam. Vel quia dolore est voluptate. Sed repudiandae incidunt eum dolores. Perspiciatis delectus facere praesentium beatae et.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/business_categories/412"
                },
                {
                    "rel": "companies",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/business_categories/412/companies"
                },
                {
                    "rel": "job_ads",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/business_categories/412/job_ads"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/business_categories/412/menu"
                }
            ],
            "deeplink": "mycity://scenarios/2/categories/412",
            "share_url": "https://bologna.mycity.api/categories/412/tempora-porro-et-sunt-aut-neque-sit"
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/2/business_categories?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/2/business_categories?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/2/business_categories",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/business_categories

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get a specific Company Category

This endpoint retrieves a specific Company Category from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/business_categories/{company_category}" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 406,
        "type": "business_categories",
        "title": "Reprehenderit voluptas ullam magnam",
        "permalink": "reprehenderit-voluptas-ullam-magnam",
        "abstract": "Esse aliquid omnis enim nulla maiores. Alias voluptatem est odit accusantium omnis. Sed sed quae dolor et. Ea tenetur minus nihil maxime corrupti repudiandae.",
        "body": "Praesentium enim dolore exercitationem voluptas voluptas minus. Voluptates recusandae libero sunt odio rerum. Ea qui officiis et impedit esse iusto. Ut iusto dolorum ex nulla enim porro minima. Culpa id eum earum earum. Minima veniam sit corporis dolor. Molestiae quia nobis nisi facere molestiae temporibus. Molestiae consectetur molestiae voluptatem ducimus ab sint ipsam saepe. Dolor inventore at sit. Aut rerum voluptatibus maxime aspernatur sunt vel aut.",
        "publish_date": null,
        "unpublish_date": null,
        "image_url": null,
        "links": [
            {
                "rel": "self",
                "href": "http://api.mycity.api/api/v1/scenarios/2/business_categories/406"
            },
            {
                "rel": "companies",
                "href": "http://api.mycity.api/api/v1/scenarios/2/business_categories/406/companies"
            },
            {
                "rel": "job_ads",
                "href": "http://api.mycity.api/api/v1/scenarios/2/business_categories/406/job_ads"
            },
            {
                "rel": "menu",
                "href": "http://api.mycity.api/api/v1/scenarios/2/business_categories/406/menu"
            }
        ],
        "deeplink": "mycity://scenarios/2/categories/406",
        "share_url": "https://bologna.mycity.api/categories/406/reprehenderit-voluptas-ullam-magnam"
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/business_categories/{company_category}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
company_category int The ID of the Company to retrieve.

Get all Companies from Category

This endpoint retrieves all Company belonging to a category from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/business_categories/{company_category}/companies" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 407,
            "type": "companies",
            "title": "Conti, Lombardo e Galli e figli",
            "permalink": "conti-lombardo-galli-figli",
            "abstract": "Adipisci doloribus alias reiciendis. Dolores minus vitae quia explicabo nihil illo reprehenderit molestiae. Velit hic vero veniam.",
            "body": "Veniam cumque dolorum veniam similique et cumque commodi illo. Esse illo dolor esse voluptate. Quia voluptas expedita inventore iusto eos. Voluptate doloremque quo quod voluptas et omnis et ipsam. Earum voluptatem neque quia odio distinctio dolorem. Quod eos vel quam aliquid mollitia. Earum est omnis sint dolore laborum. Quisquam pariatur iste magnam reiciendis assumenda modi. Perferendis maxime consequatur molestiae est ratione. Velit nobis iure tempore veniam quod sit qui repellendus.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/96/100",
            "phone": "+99 6999 40235373",
            "fax": "+03 952 86996603",
            "email": "cleros.costantini@example.com",
            "pec": "jguerra@example.org",
            "external_link": null,
            "user_id": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/407"
                },
                {
                    "rel": "job_ads",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/407/job_ads"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/407/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/407/gallery"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/407/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/407/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/companies/407",
            "share_url": "https://bologna.mycity.api/companies/407/conti-lombardo-galli-figli",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 408,
            "type": "companies",
            "title": "Grassi-Donati SPA",
            "permalink": "grassi-donati-spa",
            "abstract": "Iure dolorem non ea amet et cum occaecati alias. Eum recusandae cumque exercitationem autem rerum. Natus repellat est et et. Deleniti fugiat et blanditiis placeat.",
            "body": "Magnam repudiandae odio ea eos ratione voluptatibus. Soluta ratione qui ipsam aliquam. Illo et voluptas sit. Quaerat pariatur hic repellat voluptatibus. Consequatur placeat voluptate exercitationem rerum est. Quod quas nobis ipsa necessitatibus. Sit rem doloribus adipisci ad aut nesciunt dolore. Voluptas ut quia iure totam eligendi numquam quo.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/98/100",
            "phone": "+26 317 08873549",
            "fax": "+14 49 42751958",
            "email": "ngalli@example.com",
            "pec": "genziana.rossi@example.net",
            "external_link": null,
            "user_id": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/408"
                },
                {
                    "rel": "job_ads",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/408/job_ads"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/408/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/408/gallery"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/408/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/408/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/companies/408",
            "share_url": "https://bologna.mycity.api/companies/408/grassi-donati-spa",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/2/business_categories/406/companies?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/2/business_categories/406/companies?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/2/business_categories/406/companies",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/business_categories/{company_category}/companies

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
company_category int The ID of the Category to retrieve.

Get all Companies

This endpoint retrieves all Companies from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/companies" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 407,
            "type": "companies",
            "title": "Conti, Lombardo e Galli e figli",
            "permalink": "conti-lombardo-galli-figli",
            "abstract": "Adipisci doloribus alias reiciendis. Dolores minus vitae quia explicabo nihil illo reprehenderit molestiae. Velit hic vero veniam.",
            "body": "Veniam cumque dolorum veniam similique et cumque commodi illo. Esse illo dolor esse voluptate. Quia voluptas expedita inventore iusto eos. Voluptate doloremque quo quod voluptas et omnis et ipsam. Earum voluptatem neque quia odio distinctio dolorem. Quod eos vel quam aliquid mollitia. Earum est omnis sint dolore laborum. Quisquam pariatur iste magnam reiciendis assumenda modi. Perferendis maxime consequatur molestiae est ratione. Velit nobis iure tempore veniam quod sit qui repellendus.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/96/100",
            "phone": "+99 6999 40235373",
            "fax": "+03 952 86996603",
            "email": "cleros.costantini@example.com",
            "pec": "jguerra@example.org",
            "external_link": null,
            "user_id": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/407"
                },
                {
                    "rel": "job_ads",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/407/job_ads"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/407/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/407/gallery"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/407/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/407/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/companies/407",
            "share_url": "https://bologna.mycity.api/companies/407/conti-lombardo-galli-figli",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 408,
            "type": "companies",
            "title": "Grassi-Donati SPA",
            "permalink": "grassi-donati-spa",
            "abstract": "Iure dolorem non ea amet et cum occaecati alias. Eum recusandae cumque exercitationem autem rerum. Natus repellat est et et. Deleniti fugiat et blanditiis placeat.",
            "body": "Magnam repudiandae odio ea eos ratione voluptatibus. Soluta ratione qui ipsam aliquam. Illo et voluptas sit. Quaerat pariatur hic repellat voluptatibus. Consequatur placeat voluptate exercitationem rerum est. Quod quas nobis ipsa necessitatibus. Sit rem doloribus adipisci ad aut nesciunt dolore. Voluptas ut quia iure totam eligendi numquam quo.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/98/100",
            "phone": "+26 317 08873549",
            "fax": "+14 49 42751958",
            "email": "ngalli@example.com",
            "pec": "genziana.rossi@example.net",
            "external_link": null,
            "user_id": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/408"
                },
                {
                    "rel": "job_ads",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/408/job_ads"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/408/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/408/gallery"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/408/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/408/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/companies/408",
            "share_url": "https://bologna.mycity.api/companies/408/grassi-donati-spa",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 413,
            "type": "companies",
            "title": "Silvestri-Orlando Group",
            "permalink": "silvestri-orlando-group",
            "abstract": "Enim et ut voluptates ipsa. Aut ut asperiores optio sit necessitatibus. Sed autem nobis consequatur et temporibus quaerat est.",
            "body": "Assumenda error quisquam aliquam culpa est nesciunt. Fugiat et et voluptatum ipsa quo minus. Quae repudiandae assumenda deserunt et et repellendus. Eos sit minima aspernatur delectus debitis molestias iure. Velit et voluptatem aut eos exercitationem. Repellendus distinctio nihil eligendi est fugiat. Asperiores incidunt facilis qui animi aperiam qui aut. Omnis aut illum qui totam nesciunt quaerat. Et sit occaecati perferendis tenetur est vel.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/101/100",
            "phone": "+82 29 2003616",
            "fax": "+14 8461 3312909",
            "email": "rosaria.santoro@example.org",
            "pec": "mariani.michael@example.com",
            "external_link": null,
            "user_id": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/413"
                },
                {
                    "rel": "job_ads",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/413/job_ads"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/413/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/413/gallery"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/413/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/companies/413/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/companies/413",
            "share_url": "https://bologna.mycity.api/companies/413/silvestri-orlando-group",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/2/companies?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/2/companies?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/2/companies",
        "per_page": 10,
        "to": 3,
        "total": 3
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/companies

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get a specific Company

This endpoint retrieves a specific Company from a Scenario.

HTTP Request

GET api/v1/scenarios/{scenario}/companies/{company}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
company int The ID of the Company to retrieve.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/companies/{company}" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 407,
        "type": "companies",
        "title": "Conti, Lombardo e Galli e figli",
        "permalink": "conti-lombardo-galli-figli",
        "abstract": "Adipisci doloribus alias reiciendis. Dolores minus vitae quia explicabo nihil illo reprehenderit molestiae. Velit hic vero veniam.",
        "body": "Veniam cumque dolorum veniam similique et cumque commodi illo. Esse illo dolor esse voluptate. Quia voluptas expedita inventore iusto eos. Voluptate doloremque quo quod voluptas et omnis et ipsam. Earum voluptatem neque quia odio distinctio dolorem. Quod eos vel quam aliquid mollitia. Earum est omnis sint dolore laborum. Quisquam pariatur iste magnam reiciendis assumenda modi. Perferendis maxime consequatur molestiae est ratione. Velit nobis iure tempore veniam quod sit qui repellendus.",
        "publish_date": null,
        "unpublish_date": null,
        "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/96/100",
        "phone": "+99 6999 40235373",
        "fax": "+03 952 86996603",
        "email": "cleros.costantini@example.com",
        "pec": "jguerra@example.org",
        "external_link": null,
        "user_id": null,
        "links": [
            {
                "rel": "self",
                "href": "http://api.mycity.api/api/v1/scenarios/2/companies/407"
            },
            {
                "rel": "job_ads",
                "href": "http://api.mycity.api/api/v1/scenarios/2/companies/407/job_ads"
            },
            {
                "rel": "category",
                "href": "http://api.mycity.api/api/v1/scenarios/2/companies/407/category"
            },
            {
                "rel": "gallery",
                "href": "http://api.mycity.api/api/v1/scenarios/2/companies/407/gallery"
            },
            {
                "rel": "pois",
                "href": "http://api.mycity.api/api/v1/scenarios/2/companies/407/pois"
            },
            {
                "rel": "attachments",
                "href": "http://api.mycity.api/api/v1/scenarios/2/companies/407/attachments"
            }
        ],
        "deeplink": "mycity://scenarios/2/companies/407",
        "share_url": "https://bologna.mycity.api/companies/407/conti-lombardo-galli-figli",
        "liked": false,
        "likes": 0,
        "shared": false,
        "shares": 0
    }
}

Get all Job_ads from Company

This endpoint retrieves all Job_ads belonging to an company from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/companies/{company}/job_ads" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 409,
            "type": "job_ads",
            "title": "Libero rem sint rerum odit est id",
            "permalink": "libero-rem-sint-rerum-odit-est-id",
            "abstract": "Magnam sint praesentium aspernatur vero. Aliquam iusto delectus et quo doloribus odio asperiores nostrum. Id dolores modi adipisci maiores. Molestiae sit modi non sit aut.",
            "body": "Vero blanditiis quia sit. Rerum laudantium saepe consequuntur. Quod in explicabo esse ducimus in. Voluptatibus velit veritatis aut non sed debitis ut. Aut iste autem ex dolorem tempora repellendus non. Dolores aut pariatur harum in vero. Non incidunt aspernatur qui rem eligendi magni saepe. Illo praesentium aperiam facilis et. Ut consequuntur omnis deserunt perferendis quis dolores et voluptas.",
            "publish_date": "2017-12-24 05:18:11",
            "unpublish_date": "2018-03-14 09:52:18",
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/97/100",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409"
                },
                {
                    "rel": "author",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/author"
                },
                {
                    "rel": "applications",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/applications"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/gallery"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/job_ads/409",
            "share_url": "https://bologna.mycity.api/job_ads/409/libero-rem-sint-rerum-odit-est-id",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/2/companies/407/job_ads?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/2/companies/407/job_ads?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/2/companies/407/job_ads",
        "per_page": 10,
        "to": 1,
        "total": 1
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/companies/{company}/job_ads

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
company int The ID of the Company to retrieve.

Get all Job_ads from Category

This endpoint retrieves all Job_ads belonging to a category from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/business_categories/{company_category}/job_ads" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 409,
            "type": "job_ads",
            "title": "Libero rem sint rerum odit est id",
            "permalink": "libero-rem-sint-rerum-odit-est-id",
            "abstract": "Magnam sint praesentium aspernatur vero. Aliquam iusto delectus et quo doloribus odio asperiores nostrum. Id dolores modi adipisci maiores. Molestiae sit modi non sit aut.",
            "body": "Vero blanditiis quia sit. Rerum laudantium saepe consequuntur. Quod in explicabo esse ducimus in. Voluptatibus velit veritatis aut non sed debitis ut. Aut iste autem ex dolorem tempora repellendus non. Dolores aut pariatur harum in vero. Non incidunt aspernatur qui rem eligendi magni saepe. Illo praesentium aperiam facilis et. Ut consequuntur omnis deserunt perferendis quis dolores et voluptas.",
            "publish_date": "2017-12-24 05:18:11",
            "unpublish_date": "2018-03-14 09:52:18",
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/97/100",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409"
                },
                {
                    "rel": "author",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/author"
                },
                {
                    "rel": "applications",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/applications"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/gallery"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/job_ads/409",
            "share_url": "https://bologna.mycity.api/job_ads/409/libero-rem-sint-rerum-odit-est-id",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 410,
            "type": "job_ads",
            "title": "Debitis aliquam omnis maiores eveniet",
            "permalink": "debitis-aliquam-omnis-maiores-eveniet",
            "abstract": "Omnis consequuntur esse cum modi. Tenetur in blanditiis dolorum harum assumenda est. Nihil pariatur dolores sunt praesentium dolores assumenda. Veniam voluptatem ut voluptates omnis rerum iusto.",
            "body": "Aperiam aut ut quo quaerat. At consectetur aut in magnam. Possimus provident voluptatem fuga vel laboriosam. Aut voluptatem sit quae velit velit nesciunt ab et. Qui eum nam non voluptas ullam enim. Nobis asperiores minima qui consequatur nihil deserunt. Aliquam officiis aliquam quisquam voluptatem doloribus inventore. Laudantium perspiciatis fugiat velit exercitationem quasi. Quis qui impedit laborum dolor ut animi. Inventore officiis veniam impedit.",
            "publish_date": "2017-12-24 02:14:00",
            "unpublish_date": "2018-04-19 21:18:34",
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/99/100",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/410"
                },
                {
                    "rel": "author",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/410/author"
                },
                {
                    "rel": "applications",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/410/applications"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/410/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/410/gallery"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/410/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/job_ads/410",
            "share_url": "https://bologna.mycity.api/job_ads/410/debitis-aliquam-omnis-maiores-eveniet",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 411,
            "type": "job_ads",
            "title": "Non magnam autem est sit",
            "permalink": "non-magnam-autem-est-sit",
            "abstract": "Libero voluptatibus maiores odio nesciunt. Non odio sapiente iusto tenetur autem eos ea. Ut doloremque dicta animi omnis. Rem accusamus sunt nulla et laboriosam incidunt.",
            "body": "Autem ab nihil vitae sunt. Deleniti et dignissimos sint nulla aliquam deleniti. Sit ea repudiandae eius dolorem eligendi beatae asperiores incidunt. Voluptatibus nostrum corporis eligendi vel. Numquam voluptas saepe vel in et. Minus soluta ipsum et qui provident pariatur. Voluptate laudantium occaecati commodi fuga. Sit facilis doloribus quae minima ut excepturi alias. Et et quaerat odio. Nulla illum temporibus quis qui quo. Id pariatur vel autem quas sunt id.",
            "publish_date": "2017-12-24 08:19:12",
            "unpublish_date": "2018-03-20 19:29:50",
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/100/100",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/411"
                },
                {
                    "rel": "author",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/411/author"
                },
                {
                    "rel": "applications",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/411/applications"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/411/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/411/gallery"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/411/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/job_ads/411",
            "share_url": "https://bologna.mycity.api/job_ads/411/non-magnam-autem-est-sit",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/2/business_categories/406/job_ads?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/2/business_categories/406/job_ads?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/2/business_categories/406/job_ads",
        "per_page": 10,
        "to": 3,
        "total": 3
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/business_categories/{company_category}/job_ads

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
company_category int The ID of the Category to retrieve.

Job Ads

Get all Job Ads

This endpoint retrieves all Job Ads from a Scenario. You can filter request with this GET parameter:

type: "associations" (only published from associations), "companies" (only from companies), "scenario" (only from scenario), "work" (published from Companies and current Scenario)

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/job_ads" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 409,
            "type": "job_ads",
            "title": "Libero rem sint rerum odit est id",
            "permalink": "libero-rem-sint-rerum-odit-est-id",
            "abstract": "Magnam sint praesentium aspernatur vero. Aliquam iusto delectus et quo doloribus odio asperiores nostrum. Id dolores modi adipisci maiores. Molestiae sit modi non sit aut.",
            "body": "Vero blanditiis quia sit. Rerum laudantium saepe consequuntur. Quod in explicabo esse ducimus in. Voluptatibus velit veritatis aut non sed debitis ut. Aut iste autem ex dolorem tempora repellendus non. Dolores aut pariatur harum in vero. Non incidunt aspernatur qui rem eligendi magni saepe. Illo praesentium aperiam facilis et. Ut consequuntur omnis deserunt perferendis quis dolores et voluptas.",
            "publish_date": "2017-12-24 05:18:11",
            "unpublish_date": "2018-03-14 09:52:18",
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/97/100",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409"
                },
                {
                    "rel": "author",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/author"
                },
                {
                    "rel": "applications",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/applications"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/gallery"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/job_ads/409",
            "share_url": "https://bologna.mycity.api/job_ads/409/libero-rem-sint-rerum-odit-est-id",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 410,
            "type": "job_ads",
            "title": "Debitis aliquam omnis maiores eveniet",
            "permalink": "debitis-aliquam-omnis-maiores-eveniet",
            "abstract": "Omnis consequuntur esse cum modi. Tenetur in blanditiis dolorum harum assumenda est. Nihil pariatur dolores sunt praesentium dolores assumenda. Veniam voluptatem ut voluptates omnis rerum iusto.",
            "body": "Aperiam aut ut quo quaerat. At consectetur aut in magnam. Possimus provident voluptatem fuga vel laboriosam. Aut voluptatem sit quae velit velit nesciunt ab et. Qui eum nam non voluptas ullam enim. Nobis asperiores minima qui consequatur nihil deserunt. Aliquam officiis aliquam quisquam voluptatem doloribus inventore. Laudantium perspiciatis fugiat velit exercitationem quasi. Quis qui impedit laborum dolor ut animi. Inventore officiis veniam impedit.",
            "publish_date": "2017-12-24 02:14:00",
            "unpublish_date": "2018-04-19 21:18:34",
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/99/100",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/410"
                },
                {
                    "rel": "author",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/410/author"
                },
                {
                    "rel": "applications",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/410/applications"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/410/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/410/gallery"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/410/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/job_ads/410",
            "share_url": "https://bologna.mycity.api/job_ads/410/debitis-aliquam-omnis-maiores-eveniet",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 411,
            "type": "job_ads",
            "title": "Non magnam autem est sit",
            "permalink": "non-magnam-autem-est-sit",
            "abstract": "Libero voluptatibus maiores odio nesciunt. Non odio sapiente iusto tenetur autem eos ea. Ut doloremque dicta animi omnis. Rem accusamus sunt nulla et laboriosam incidunt.",
            "body": "Autem ab nihil vitae sunt. Deleniti et dignissimos sint nulla aliquam deleniti. Sit ea repudiandae eius dolorem eligendi beatae asperiores incidunt. Voluptatibus nostrum corporis eligendi vel. Numquam voluptas saepe vel in et. Minus soluta ipsum et qui provident pariatur. Voluptate laudantium occaecati commodi fuga. Sit facilis doloribus quae minima ut excepturi alias. Et et quaerat odio. Nulla illum temporibus quis qui quo. Id pariatur vel autem quas sunt id.",
            "publish_date": "2017-12-24 08:19:12",
            "unpublish_date": "2018-03-20 19:29:50",
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/100/100",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/411"
                },
                {
                    "rel": "author",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/411/author"
                },
                {
                    "rel": "applications",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/411/applications"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/411/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/411/gallery"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/411/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/job_ads/411",
            "share_url": "https://bologna.mycity.api/job_ads/411/non-magnam-autem-est-sit",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 414,
            "type": "job_ads",
            "title": "Consequatur et aliquid perferendis",
            "permalink": "consequatur-et-aliquid-perferendis",
            "abstract": "Culpa aut quia nisi similique magni. Voluptas eos occaecati illo dolorem. Ratione sit aperiam eligendi voluptatibus.",
            "body": "Quas debitis voluptas aut minus voluptatem blanditiis. Minus eos aspernatur architecto id. Laudantium architecto maiores vero sit. Reiciendis est dolore in ipsam similique voluptatem velit. Facilis molestiae et autem et sed alias. Qui quo rerum fugiat aut. Facere rem eligendi provident sunt et id. Qui adipisci facere iste reprehenderit. Sed sapiente quae non nemo incidunt qui.",
            "publish_date": "2017-12-23 15:14:03",
            "unpublish_date": "2018-02-26 07:00:23",
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/102/100",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/414"
                },
                {
                    "rel": "author",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/414/author"
                },
                {
                    "rel": "applications",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/414/applications"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/414/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/414/gallery"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/414/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/job_ads/414",
            "share_url": "https://bologna.mycity.api/job_ads/414/consequatur-et-aliquid-perferendis",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        },
        {
            "id": 415,
            "type": "job_ads",
            "title": "Est cum nostrum consectetur dolorum",
            "permalink": "est-cum-nostrum-consectetur-dolorum",
            "abstract": "Soluta sint omnis esse vitae molestiae sed sit quidem. Veritatis deleniti dolor dolor et. Voluptas quae molestias libero officia. Quidem porro provident et voluptas odit atque.",
            "body": "Dolor enim vero sequi cupiditate eum soluta labore. Fuga ut et qui eveniet libero commodi. Quas velit quae laudantium. Ratione soluta culpa illum modi ut unde corrupti. At qui eum numquam voluptatem qui tenetur. Deleniti qui nemo et delectus. Expedita aliquam magni atque reprehenderit qui ut repellat. Deserunt quia reprehenderit dolorem deleniti voluptas. Praesentium dolorum enim doloremque. Ut qui nihil facere. Est reprehenderit harum accusantium explicabo.",
            "publish_date": "2017-12-24 05:11:31",
            "unpublish_date": "2018-03-18 20:44:09",
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/103/100",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/415"
                },
                {
                    "rel": "author",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/415/author"
                },
                {
                    "rel": "applications",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/415/applications"
                },
                {
                    "rel": "category",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/415/category"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/415/gallery"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/415/attachments"
                }
            ],
            "deeplink": "mycity://scenarios/2/job_ads/415",
            "share_url": "https://bologna.mycity.api/job_ads/415/est-cum-nostrum-consectetur-dolorum",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/2/job_ads?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/2/job_ads?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/2/job_ads",
        "per_page": 10,
        "to": 5,
        "total": 5
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/job_ads

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get a specific Ad

This endpoint retrieves a specific Ad from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/job_ads/{ad}" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 409,
        "type": "job_ads",
        "title": "Libero rem sint rerum odit est id",
        "permalink": "libero-rem-sint-rerum-odit-est-id",
        "abstract": "Magnam sint praesentium aspernatur vero. Aliquam iusto delectus et quo doloribus odio asperiores nostrum. Id dolores modi adipisci maiores. Molestiae sit modi non sit aut.",
        "body": "Vero blanditiis quia sit. Rerum laudantium saepe consequuntur. Quod in explicabo esse ducimus in. Voluptatibus velit veritatis aut non sed debitis ut. Aut iste autem ex dolorem tempora repellendus non. Dolores aut pariatur harum in vero. Non incidunt aspernatur qui rem eligendi magni saepe. Illo praesentium aperiam facilis et. Ut consequuntur omnis deserunt perferendis quis dolores et voluptas.",
        "publish_date": "2017-12-24 05:18:11",
        "unpublish_date": "2018-03-14 09:52:18",
        "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/97/100",
        "links": [
            {
                "rel": "self",
                "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409"
            },
            {
                "rel": "author",
                "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/author"
            },
            {
                "rel": "applications",
                "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/applications"
            },
            {
                "rel": "category",
                "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/category"
            },
            {
                "rel": "gallery",
                "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/gallery"
            },
            {
                "rel": "attachments",
                "href": "http://api.mycity.api/api/v1/scenarios/2/job_ads/409/attachments"
            }
        ],
        "deeplink": "mycity://scenarios/2/job_ads/409",
        "share_url": "https://bologna.mycity.api/job_ads/409/libero-rem-sint-rerum-odit-est-id",
        "liked": false,
        "likes": 0,
        "shared": false,
        "shares": 0
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/job_ads/{ad}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
ad int The ID of the AD.

Get all Applications from an Ad

This endpoint retrieves all Applications belonging to an Ad from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/job_ads/{ad}/applications" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "description": "Nobis vel et vel qui. Delectus dolorum voluptas et. Non est eius dolores qui. Soluta id minima dolorum consectetur aliquid. Quidem rerum ullam repellendus id impedit debitis odio. Eius ex est ea tempora similique nihil aut.",
            "attachments": [
                {
                    "id": 86,
                    "collection_name": "attachments",
                    "name": "emergency plan",
                    "file_name": "test_pdf.pdf",
                    "mime_type": "application/pdf",
                    "size": 433994,
                    "order_column": 86,
                    "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/86/test_pdf.pdf",
                    "liked": false,
                    "likes": 0,
                    "shared": false,
                    "shares": 0,
                    "links": [
                        {
                            "rel": "self",
                            "href": "http://api.mycity.api/api/v1/scenarios/2/media/86"
                        }
                    ]
                },
                {
                    "id": 87,
                    "collection_name": "attachments",
                    "name": "emergency plan",
                    "file_name": "test_pdf.pdf",
                    "mime_type": "application/pdf",
                    "size": 433994,
                    "order_column": 87,
                    "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/87/test_pdf.pdf",
                    "liked": false,
                    "likes": 0,
                    "shared": false,
                    "shares": 0,
                    "links": [
                        {
                            "rel": "self",
                            "href": "http://api.mycity.api/api/v1/scenarios/2/media/87"
                        }
                    ]
                }
            ],
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/applications/1"
                }
            ]
        },
        {
            "id": 290,
            "description": "10 caratteri",
            "attachments": [
                {
                    "id": 86,
                    "collection_name": "attachments",
                    "name": "emergency plan",
                    "file_name": "test_pdf.pdf",
                    "mime_type": "application/pdf",
                    "size": 433994,
                    "order_column": 86,
                    "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/86/test_pdf.pdf",
                    "liked": false,
                    "likes": 0,
                    "shared": false,
                    "shares": 0,
                    "links": [
                        {
                            "rel": "self",
                            "href": "http://api.mycity.api/api/v1/scenarios/2/media/86"
                        }
                    ]
                },
                {
                    "id": 87,
                    "collection_name": "attachments",
                    "name": "emergency plan",
                    "file_name": "test_pdf.pdf",
                    "mime_type": "application/pdf",
                    "size": 433994,
                    "order_column": 87,
                    "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/87/test_pdf.pdf",
                    "liked": false,
                    "likes": 0,
                    "shared": false,
                    "shares": 0,
                    "links": [
                        {
                            "rel": "self",
                            "href": "http://api.mycity.api/api/v1/scenarios/2/media/87"
                        }
                    ]
                }
            ],
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/applications/290"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/job_ads/{ad}/applications

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
ad int The ID of the AD.

Apply to an Ad

This endpoint permits to apply to an Ad from a Scenario.

Example request:

curl -X POST https://api.mycitydemo.it/api/v1/scenarios/job_ads/{ad}/applications \
  -H 'accept: application/json' \
  -F 'description=10 caratteri' \
  -F ad_id=2606 \
  -F name=my_name \
  -F surname=my_surname \
  -F date_of_birth=26/06/1985 \
  -F email=me@example.com \
  -F phone_number=3339393939 \
  -F 'attachments[]=@/home/utente/Scrivania/test.pdf' \
  -F 'attachments[]=@/home/utente/Scrivania/prova.docx'

Example response:

{
    "data": {
        "id": 290,
        "description": "10 caratteri",
        "attachments": [
            {
                "id": 86,
                "collection_name": "attachments",
                "name": "emergency plan",
                "file_name": "test_pdf.pdf",
                "mime_type": "application/pdf",
                "size": 433994,
                "order_column": 86,
                "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/86/test_pdf.pdf",
                "liked": false,
                "likes": 0,
                "shared": false,
                "shares": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "http://api.mycity.api/api/v1/scenarios/2/media/86"
                    }
                ]
            },
            {
                "id": 87,
                "collection_name": "attachments",
                "name": "emergency plan",
                "file_name": "test_pdf.pdf",
                "mime_type": "application/pdf",
                "size": 433994,
                "order_column": 87,
                "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/87/test_pdf.pdf",
                "liked": false,
                "likes": 0,
                "shared": false,
                "shares": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "http://api.mycity.api/api/v1/scenarios/2/media/87"
                    }
                ]
            }
        ],
        "links": [
            {
                "rel": "self",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/applications/290"
            }
        ]
    }
}

HTTP Request

POST api/v1/scenarios/{scenario}/job_ads/{ad}/applications

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
ad int The ID of the AD.

POST Parameters

Parameter Type Description Required
ad_id int The ID of the AD. yes
description string The description of the application. yes
name string the applicant name. yes
surname string the applicant surname. yes
date_of_birth date the applicant date of birth. yes
email string the applicant email. yes
phone_number string the applicant phone number. yes
attachments[] array Array containing documents and files to attach to the application (eg: curriculum vitae).

Get a specific Application

This endpoint retrieves a specific Application from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/job_ads/{ad}/applications/{application}" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 290,
        "description": "10 caratteri",
        "attachments": [
            {
                "id": 86,
                "collection_name": "attachments",
                "name": "emergency plan",
                "file_name": "test_pdf.pdf",
                "mime_type": "application/pdf",
                "size": 433994,
                "order_column": 86,
                "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/86/test_pdf.pdf",
                "liked": false,
                "likes": 0,
                "shared": false,
                "shares": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "http://api.mycity.api/api/v1/scenarios/2/media/86"
                    }
                ]
            },
            {
                "id": 87,
                "collection_name": "attachments",
                "name": "emergency plan",
                "file_name": "test_pdf.pdf",
                "mime_type": "application/pdf",
                "size": 433994,
                "order_column": 87,
                "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/87/test_pdf.pdf",
                "liked": false,
                "likes": 0,
                "shared": false,
                "shares": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "http://api.mycity.api/api/v1/scenarios/2/media/87"
                    }
                ]
            }
        ],
        "links": [
            {
                "rel": "self",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/applications/290"
            }
        ]
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/job_ads/{ad}/applications/{application}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
ad int The ID of the AD.
application int The ID of the Application.

Surveys

Get all Surveys

This endpoint retrieves all Surveys from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/surveys" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 460,
            "type": "surveys",
            "title": "SURVEY Accusantium et quisquam nobis corrupti",
            "permalink": "accusantium-et-quisquam-nobis-corrupti",
            "abstract": "Natus ut nostrum est quasi. Quam possimus et reprehenderit voluptatem possimus aut et iusto. In excepturi nemo accusantium ipsum iste.",
            "body": "Maxime minus dolore qui sed cupiditate fugit numquam. Voluptas ut et libero. Nemo pariatur expedita inventore totam saepe. Est aut sint excepturi voluptatem praesentium. Id consequatur quidem ea repellendus cupiditate enim magni. Sed modi accusamus recusandae enim voluptatum aut commodi. Omnis aut deserunt dicta harum soluta. Molestiae facere facere officiis voluptatem rerum quo aut. Aut ea quo corrupti voluptas. Ea et amet officia. Culpa sed repellendus accusamus nulla qui.",
            "publish_date": null,
            "unpublish_date": null,
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/135/100",
            "open_at": "2017-12-23 15:18:42",
            "close_at": "2018-03-30 07:51:42",
            "authentication_required": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/surveys/460"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/surveys/460/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/surveys/460/menu"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/surveys/460/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/surveys/460/attachments"
                },
                {
                    "rel": "questions",
                    "href": "http://api.mycity.api/api/v1/scenarios/2/surveys/460/questions"
                }
            ],
            "deeplink": "mycity://scenarios/2/surveys/460",
            "share_url": "https://bologna.mycity.api/surveys/460/accusantium-et-quisquam-nobis-corrupti",
            "is_open": true,
            "status": "open",
            "user_has_voted": true,
            "answers_count": null,
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0
        }
    ],
    "links": {
        "first": "http://api.mycity.api/api/v1/scenarios/2/surveys?page=1",
        "last": "http://api.mycity.api/api/v1/scenarios/2/surveys?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://api.mycity.api/api/v1/scenarios/2/surveys",
        "per_page": 10,
        "to": 1,
        "total": 1
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/surveys

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: questions).
status string The survey status: incoming / opened / closed

Get a specific Survey

This endpoint retrieves a specific Survey from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/surveys/{survey}" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 460,
        "type": "surveys",
        "title": "SURVEY Accusantium et quisquam nobis corrupti",
        "permalink": "accusantium-et-quisquam-nobis-corrupti",
        "abstract": "Natus ut nostrum est quasi. Quam possimus et reprehenderit voluptatem possimus aut et iusto. In excepturi nemo accusantium ipsum iste.",
        "body": "Maxime minus dolore qui sed cupiditate fugit numquam. Voluptas ut et libero. Nemo pariatur expedita inventore totam saepe. Est aut sint excepturi voluptatem praesentium. Id consequatur quidem ea repellendus cupiditate enim magni. Sed modi accusamus recusandae enim voluptatum aut commodi. Omnis aut deserunt dicta harum soluta. Molestiae facere facere officiis voluptatem rerum quo aut. Aut ea quo corrupti voluptas. Ea et amet officia. Culpa sed repellendus accusamus nulla qui.",
        "publish_date": null,
        "unpublish_date": null,
        "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/135/100",
        "open_at": "2017-12-23 15:18:42",
        "close_at": "2018-03-30 07:51:42",
        "authentication_required": 0,
        "links": [
            {
                "rel": "self",
                "href": "http://api.mycity.api/api/v1/scenarios/2/surveys/460"
            },
            {
                "rel": "gallery",
                "href": "http://api.mycity.api/api/v1/scenarios/2/surveys/460/gallery"
            },
            {
                "rel": "menu",
                "href": "http://api.mycity.api/api/v1/scenarios/2/surveys/460/menu"
            },
            {
                "rel": "pois",
                "href": "http://api.mycity.api/api/v1/scenarios/2/surveys/460/pois"
            },
            {
                "rel": "attachments",
                "href": "http://api.mycity.api/api/v1/scenarios/2/surveys/460/attachments"
            },
            {
                "rel": "questions",
                "href": "http://api.mycity.api/api/v1/scenarios/2/surveys/460/questions"
            }
        ],
        "deeplink": "mycity://scenarios/2/surveys/460",
        "share_url": "https://bologna.mycity.api/surveys/460/accusantium-et-quisquam-nobis-corrupti",
        "is_open": true,
        "status": "open",
        "user_has_voted": true,
        "answers_count": null,
        "liked": false,
        "likes": 0,
        "shared": false,
        "shares": 0
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/surveys/{survey}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
survey int The ID of the Survey to retrieve.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: questions).

Get the Gallery of a Survey

This endpoint retrieves a list of Photos (survey) for a specific Survey of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/surveys/{survey}/gallery" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 206,
            "collection_name": "photos",
            "name": "Dolorem ut quia et et dolore repellat.",
            "file_name": "test_1.jpg",
            "mime_type": "image/png",
            "size": 1185,
            "order_column": 206,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/206/test_1.jpg",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/206"
                }
            ]
        },
        {
            "id": 207,
            "collection_name": "photos",
            "name": "Nesciunt laboriosam dolorem voluptas non consequuntur.",
            "file_name": "test_2.jpg",
            "mime_type": "image/png",
            "size": 1671,
            "order_column": 207,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/207/test_2.jpg",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/207"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/surveys/{survey}/gallery

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
survey int The ID of the Survey to retrieve.

Get the Attachments of a Survey

This endpoint retrieves a list of documents and files (attachments) for a specific Survey of a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/surveys/{survey}/attachments" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 206,
            "collection_name": "attachments",
            "name": "Dolorem ut quia et et dolore repellat.",
            "file_name": "test_1.pdf",
            "mime_type": "image/png",
            "size": 1185,
            "order_column": 206,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/206/test_1.pdf",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/206"
                }
            ]
        },
        {
            "id": 207,
            "collection_name": "attachments",
            "name": "Nesciunt laboriosam dolorem voluptas non consequuntur.",
            "file_name": "test_2.pdf",
            "mime_type": "image/png",
            "size": 1671,
            "order_column": 207,
            "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/207/test_2.pdf",
            "liked": false,
            "likes": 0,
            "shared": false,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/207"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/surveys/{survey}/attachments

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
survey int The ID of the Survey to retrieve.

Get all Questions from Survey

This endpoint retrieves all Questions belonging to a survey from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/surveys/{survey}/questions" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "text": "QUESTION Voluptates eos error doloremque sunt placeat voluptas veniam harum. Saepe aut dolores id accusamus accusantium rerum aperiam. Impedit quo veritatis reprehenderit asperiores. Aut sunt omnis et eum modi ullam.",
            "options": [
                {
                    "id": 1,
                    "text": "OPTION Quia beatae amet suscipit dolore est sit. Quod nostrum unde voluptas voluptates. Dolorem enim incidunt consectetur dolorem aut eveniet. Non nam in et enim animi nostrum error.",
                    "answers_count": null,
                    "answers_percentage": null,
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://api.mycitydemo.it/api/v1/scenarios/2/options/1"
                        }
                    ]
                },
                {
                    "id": 2,
                    "text": "OPTION Iure occaecati officia itaque voluptatem corrupti. Nihil sit eum aut cupiditate aspernatur. Eaque vel commodi laboriosam ipsa a laboriosam. Tempora hic aut error culpa veritatis et sunt excepturi.",
                    "answers_count": null,
                    "answers_percentage": null,
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://api.mycitydemo.it/api/v1/scenarios/2/options/2"
                        }
                    ]
                }
            ],
            "user_answer": {
                "id": 1,
                "text": "OPTION Quia beatae amet suscipit dolore est sit. Quod nostrum unde voluptas voluptates. Dolorem enim incidunt consectetur dolorem aut eveniet. Non nam in et enim animi nostrum error.",
                "answers_count": null,
                "answers_percentage": null,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://api.mycitydemo.it/api/v1/scenarios/2/options/1"
                    }
                ]
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/questions/1"
                }
            ]
        },
        {
            "id": 2,
            "text": "QUESTION Debitis tempore rerum architecto optio architecto illo ullam. Qui voluptas sit similique porro. Aliquid in et et ab. Ut vel amet aliquid rerum voluptate. Sit tempore quibusdam maxime porro explicabo quo sapiente.",
            "options": [
                {
                    "id": 3,
                    "text": "OPTION Sapiente qui quo ex fugiat totam rerum. Placeat eos rerum id repellat. Veritatis et enim accusamus similique nihil maxime consectetur. Quo quibusdam sunt architecto aspernatur suscipit optio. Possimus eius et odio quis et. Provident quae quis est.",
                    "answers_count": null,
                    "answers_percentage": null,
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://api.mycitydemo.it/api/v1/scenarios/2/options/3"
                        }
                    ]
                },
                {
                    "id": 4,
                    "text": "OPTION Libero fuga ea est iusto. Error repellat consequatur voluptatem a. Similique consequatur doloremque aliquam. Natus asperiores voluptatem cupiditate. Sed hic quis est provident dolorem non. Sit culpa sit velit sit a. Eos molestias sed veritatis tempore.",
                    "answers_count": null,
                    "answers_percentage": null,
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://api.mycitydemo.it/api/v1/scenarios/2/options/4"
                        }
                    ]
                }
            ],
            "user_answer": {
                "id": 3,
                "text": "OPTION Sapiente qui quo ex fugiat totam rerum. Placeat eos rerum id repellat. Veritatis et enim accusamus similique nihil maxime consectetur. Quo quibusdam sunt architecto aspernatur suscipit optio. Possimus eius et odio quis et. Provident quae quis est.",
                "answers_count": null,
                "answers_percentage": null,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://api.mycitydemo.it/api/v1/scenarios/2/options/3"
                    }
                ]
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/questions/2"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/surveys/{survey}/questions

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
survey int The ID of the Survey to retrieve.

Answer to an Survey

This endpoint permits to send answers to an Survey from a Scenario.

Example request:

curl -X POST https://api.mycitydemo.it/api/v1/scenarios/surveys/{survey}/answers \
  -H 'accept: application/json' \
  -F 'answers: [
        [
            "question_id": 1,
            "id": 1
        ],
        [
            "question_id": 2,
                "id": 3
        ]
    ]'
}'

Example response:

{
    "data": {
        "id": 3249,
        "type": "Survey",
        "title": "SURVEY Reprehenderit incidunt aliquam quidem",
        "permalink": "reprehenderit-incidunt-aliquam-quidem",
        "abstract": "Magnam facere ab et. Voluptas incidunt qui ipsum consequuntur ea. Quo placeat id id sequi cumque. Unde est soluta excepturi autem et. Voluptate dolorum deserunt sunt facilis sed asperiores eos.",
        "body": "Doloremque cum et dignissimos veritatis. Et voluptatem culpa est sed. Aperiam enim eos quis voluptas. Magni maxime voluptatem incidunt id. Excepturi ratione odio culpa aut ipsum repudiandae laboriosam nam. Ipsam nesciunt excepturi expedita quis minima possimus suscipit. Quod culpa culpa qui eaque. Est quo perferendis voluptas corrupti numquam consequatur labore. Distinctio expedita eaque laboriosam rerum. Voluptas est rerum reiciendis aut.",
        "attachment": null,
        "is_open": true,
        "status": "open",
        "user_has_voted": true,
        "answers_count": null,
        "liked": false,
        "likes": 0,
        "shared": true,
        "shares": 2,
        "open_at": "2017-12-02 13:44:06",
        "close_at": "2018-03-28 22:48:08",
        "questions": [
            {
                "id": 1,
                "text": "QUESTION Voluptates eos error doloremque sunt placeat voluptas veniam harum. Saepe aut dolores id accusamus accusantium rerum aperiam. Impedit quo veritatis reprehenderit asperiores. Aut sunt omnis et eum modi ullam.",
                "options": [
                    {
                        "id": 1,
                        "text": "OPTION Quia beatae amet suscipit dolore est sit. Quod nostrum unde voluptas voluptates. Dolorem enim incidunt consectetur dolorem aut eveniet. Non nam in et enim animi nostrum error.",
                        "answers_count": null,
                        "answers_percentage": null,
                        "links": [
                            {
                                "rel": "self",
                                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/options/1"
                            }
                        ]
                    },
                    {
                        "id": 2,
                        "text": "OPTION Iure occaecati officia itaque voluptatem corrupti. Nihil sit eum aut cupiditate aspernatur. Eaque vel commodi laboriosam ipsa a laboriosam. Tempora hic aut error culpa veritatis et sunt excepturi.",
                        "answers_count": null,
                        "answers_percentage": null,
                        "links": [
                            {
                                "rel": "self",
                                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/options/2"
                            }
                        ]
                    }
                ],
                "user_answer": {
                    "id": 1,
                    "text": "OPTION Quia beatae amet suscipit dolore est sit. Quod nostrum unde voluptas voluptates. Dolorem enim incidunt consectetur dolorem aut eveniet. Non nam in et enim animi nostrum error.",
                    "answers_count": null,
                    "answers_percentage": null,
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://api.mycitydemo.it/api/v1/scenarios/2/options/1"
                        }
                    ]
                },
                "links": [
                    {
                        "rel": "self",
                        "href": "https://api.mycitydemo.it/api/v1/scenarios/2/questions/1"
                    }
                ]
            },
            {
                "id": 2,
                "text": "QUESTION Debitis tempore rerum architecto optio architecto illo ullam. Qui voluptas sit similique porro. Aliquid in et et ab. Ut vel amet aliquid rerum voluptate. Sit tempore quibusdam maxime porro explicabo quo sapiente.",
                "options": [
                    {
                        "id": 3,
                        "text": "OPTION Sapiente qui quo ex fugiat totam rerum. Placeat eos rerum id repellat. Veritatis et enim accusamus similique nihil maxime consectetur. Quo quibusdam sunt architecto aspernatur suscipit optio. Possimus eius et odio quis et. Provident quae quis est.",
                        "answers_count": null,
                        "answers_percentage": null,
                        "links": [
                            {
                                "rel": "self",
                                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/options/3"
                            }
                        ]
                    },
                    {
                        "id": 4,
                        "text": "OPTION Libero fuga ea est iusto. Error repellat consequatur voluptatem a. Similique consequatur doloremque aliquam. Natus asperiores voluptatem cupiditate. Sed hic quis est provident dolorem non. Sit culpa sit velit sit a. Eos molestias sed veritatis tempore.",
                        "answers_count": null,
                        "answers_percentage": null,
                        "links": [
                            {
                                "rel": "self",
                                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/options/4"
                            }
                        ]
                    }
                ],
                "user_answer": {
                    "id": 3,
                    "text": "OPTION Sapiente qui quo ex fugiat totam rerum. Placeat eos rerum id repellat. Veritatis et enim accusamus similique nihil maxime consectetur. Quo quibusdam sunt architecto aspernatur suscipit optio. Possimus eius et odio quis et. Provident quae quis est.",
                    "answers_count": null,
                    "answers_percentage": null,
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://api.mycitydemo.it/api/v1/scenarios/2/options/3"
                        }
                    ]
                },
                "links": [
                    {
                        "rel": "self",
                        "href": "https://api.mycitydemo.it/api/v1/scenarios/2/questions/2"
                    }
                ]
            }
        ],
        "links": [
            {
                "rel": "self",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/surveys/2940"
            },
            {
                "rel": "gallery",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/surveys/2940/gallery"
            },
            {
                "rel": "menu",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/surveys/2940/menu"
            },
            {
                "rel": "pois",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/surveys/2940/pois"
            },
            {
                "rel": "questions",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/surveys/2940/questions"
            }
        ]
    }
}

HTTP Request

POST api/v1/scenarios/{scenario}/questions/{survey}/answers

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
survey int The ID of the SURVEY.

Istanze Online

Get all Forms

This endpoint retrieves all Forms from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/forms" \
-H "Accept: application/json"

Example response:

{
    {
        "data": [
            {
            "id": 1180,
            "type": "forms",
            "title": "Lorem Ipsum",
            "permalink": "lorem-ipsum",
            "abstract": "Lorem Ipsum",
            "body": "Lorem Ipsum",
            "publish_date": "2020-06-01 12:26:17",
            "unpublish_date": null,
            "pois": [],
            "gallery": [],
            "attachments": [],
            "related": [],
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1248/master.png",
            "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1248/conversions/thumb.png",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1180"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1180/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1180/menu"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1180/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1180/attachments"
                },
                {
                    "rel": "related",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1180/related"
                },
                {
                    "rel": "formdata",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1180/formdata"
                }
            ],
            "deeplink": "mycity://scenarios/5/forms/1180",
            "share_url": "http://localhost:8000/istanze-online/1180/lorem-ipsum",
            "liked": null,
            "likes": 0,
            "shared": null,
            "shares": 0
        },
        {
            "id": 1181,
            "type": "forms",
            "title": "Lorem Ipsum 2",
            "permalink": "lorem-ipsum-2",
            "abstract": "Lorem Ipsum 2",
            "body": "Lorem Ipsum 2",
            "publish_date": "2020-06-01 12:27:00",
            "unpublish_date": null,
            "pois": [],
            "gallery": [],
            "attachments": [],
            "related": [],
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1248/master.png",
            "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1248/conversions/thumb.png",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1181"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1181/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1181/menu"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1181/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1181/attachments"
                },
                {
                    "rel": "related",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1181/related"
                },
                {
                    "rel": "formdata",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1181/formdata"
                }
            ],
            "deeplink": "mycity://scenarios/5/forms/1181",
            "share_url": "http://localhost:8000/istanze-online/1181/lorem-ipsum-2",
            "liked": null,
            "likes": 0,
            "shared": null,
            "shares": 0
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/forms

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: formdata).

Get a specific Form

This endpoint retrieves a specific Form from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/forms/{form}" \
-H "Accept: application/json"

Example response:


    {
        "data": {
            "id": 1180,
            "type": "forms",
            "title": "Lorem Ipsum",
            "permalink": "lorem-ipsum",
            "abstract": "Lorem Ipsum",
            "body": "Lorem Ipsum",
            "publish_date": "2020-06-01 12:26:17",
            "unpublish_date": null,
            "pois": [],
            "gallery": [],
            "attachments": [],
            "related": [],
            "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1248/master.png",
            "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1248/conversions/thumb.png",
            "meta": [],
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1180"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1180/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1180/menu"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1180/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1180/attachments"
                },
                {
                    "rel": "related",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1180/related"
                },
                {
                    "rel": "formdata",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/1180/formdata"
                }
            ],
            "deeplink": "mycity://scenarios/5/forms/1180",
            "share_url": "http://localhost:8000/istanze-online/1180/lorem-ipsum",
            "liked": null,
            "likes": 0,
            "shared": null,
            "shares": 0
        }
    }

HTTP Request

GET api/v1/scenarios/{scenario}/forms/{form}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
form int The ID of the Form to retrieve.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: formdata).

Get a specific Form Structure

This endpoint retrieves a specific Form Structure from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/forms/{form}/form-structure" \
-H "Accept: application/json"

Example response:


{
    "data": {
        "structure":[
            {
                "type": "select",
                "name": "control_select_706121",
                "fieldName": "control_select_706121",
                "label": "Sesso",
                "order": 0,
                "defaultValue": "",
                "placeholder": "",
                "value": "",
                "className": "col-md-12",
                "readonly": false,
                "isUserData": false,
                "userDataType": "",
                "info": "",
                "labelBold": false,
                "labelItalic": false,
                "labelUnderline": false,
                "required": true,
                "isMultiLine": false,
                "isInteger": false,
                "decimalPlace": 0,
                "isTodayValue": false,
                "dateFormat": "dd/mm/yy",
                "isMultiple": false,
                "isAjax": false,
                "dataOptions": [
                    {
                        "id": "0",
                        "text": "maschio"
                    },
                    {
                        "id": "1",
                        "text": "femmina"
                    }
                ],
                "ajaxDataUrl": "",
                "isChecked": false
            },
            {
                "type": "text",
                "name": "control_text_100583",
                "fieldName": "control_text_100583",
                "label": "Codice Fiscale",
                "order": 0,
                "defaultValue": "",
                "placeholder": "",
                "value": "",
                "className": "col-md-12",
                "readonly": false,
                "isUserData": true,
                "userDataType": "fiscal_number",
                "info": "",
                "labelBold": false,
                "labelItalic": false,
                "labelUnderline": false,
                "required": false,
                "isMultiLine": false,
                "isInteger": false,
                "decimalPlace": 0,
                "isTodayValue": false,
                "dateFormat": "dd/mm/yy",
                "isMultiple": false,
                "isAjax": false,
                "dataOptions": [],
                "ajaxDataUrl": "",
                "isChecked": false
            },
            {
                "type": "email",
                "name": "control_email_585578",
                "fieldName": "control_email_585578",
                "label": "Email",
                "order": 0,
                "defaultValue": "",
                "placeholder": "",
                "value": "",
                "className": "col-md-12",
                "readonly": false,
                "isUserData": true,
                "userDataType": "email",
                "info": "",
                "labelBold": false,
                "labelItalic": false,
                "labelUnderline": false,
                "required": true,
                "isMultiLine": false,
                "isInteger": false,
                "decimalPlace": 0,
                "isTodayValue": false,
                "dateFormat": "dd/mm/yy",
                "isMultiple": false,
                "isAjax": false,
                "dataOptions": [],
                "ajaxDataUrl": "",
                "isChecked": false
            },
            {
                "type": "text",
                "name": "control_text_238990",
                "fieldName": "control_text_238990",
                "label": "Nome Cognome",
                "order": 0,
                "defaultValue": "",
                "placeholder": "",
                "value": "",
                "className": "col-md-12",
                "readonly": false,
                "isUserData": true,
                "userDataType": "name",
                "info": "",
                "labelBold": false,
                "labelItalic": false,
                "labelUnderline": false,
                "required": true,
                "isMultiLine": false,
                "isInteger": false,
                "decimalPlace": 0,
                "isTodayValue": false,
                "dateFormat": "dd/mm/yy",
                "isMultiple": false,
                "isAjax": false,
                "dataOptions": [],
                "ajaxDataUrl": "",
                "isChecked": false
            },
            {
                "type": "datepicker",
                "name": "control_datepicker_419122",
                "fieldName": "control_datepicker_419122",
                "label": "Data di nascita",
                "order": 0,
                "defaultValue": "",
                "placeholder": "",
                "value": "",
                "className": "col-md-12",
                "readonly": false,
                "isUserData": true,
                "userDataType": "birth_date",
                "info": "",
                "labelBold": false,
                "labelItalic": false,
                "labelUnderline": false,
                "required": true,
                "isMultiLine": false,
                "isInteger": false,
                "decimalPlace": 0,
                "isTodayValue": false,
                "dateFormat": "dd/mm/yy",
                "isMultiple": false,
                "isAjax": false,
                "dataOptions": [],
                "ajaxDataUrl": "",
                "isChecked": false
            },
            {
                "type": "number",
                "name": "control_number_331310",
                "fieldName": "control_number_331310",
                "label": "Numero di telefono",
                "order": 0,
                "defaultValue": "",
                "placeholder": "",
                "value": "",
                "className": "col-md-12",
                "readonly": false,
                "isUserData": true,
                "userDataType": "phone",
                "info": "",
                "labelBold": false,
                "labelItalic": false,
                "labelUnderline": false,
                "required": false,
                "isMultiLine": false,
                "isInteger": false,
                "decimalPlace": 0,
                "isTodayValue": false,
                "dateFormat": "dd/mm/yy",
                "isMultiple": false,
                "isAjax": false,
                "dataOptions": [],
                "ajaxDataUrl": "",
                "isChecked": false
            },
            {
                "type": "checkbox",
                "name": "control_checkbox_318870",
                "fieldName": "control_checkbox_318870",
                "label": "Accetta i termini della privacy?",
                "order": 0,
                "defaultValue": "",
                "placeholder": "",
                "value": "",
                "className": "col-md-12",
                "readonly": false,
                "isUserData": false,
                "userDataType": "",
                "info": "",
                "labelBold": false,
                "labelItalic": false,
                "labelUnderline": false,
                "required": false,
                "isMultiLine": false,
                "isInteger": false,
                "decimalPlace": 0,
                "isTodayValue": false,
                "dateFormat": "dd/mm/yy",
                "isMultiple": false,
                "isAjax": false,
                "dataOptions": [],
                "ajaxDataUrl": "",
                "isChecked": false
            },
            {
                "type": "info",
                "name": "control_info_847714",
                "fieldName": "control_info_847714",
                "label": "Informazione",
                "order": 0,
                "defaultValue": "",
                "placeholder": "",
                "value": "",
                "className": "col-md-12",
                "readonly": false,
                "isUserData": false,
                "userDataType": "",
                "info": "Informazioni Generali",
                "labelBold": false,
                "labelItalic": false,
                "labelUnderline": false,
                "required": false,
                "isMultiLine": false,
                "isInteger": false,
                "decimalPlace": 0,
                "isTodayValue": false,
                "dateFormat": "dd/mm/yy",
                "isMultiple": false,
                "isAjax": false,
                "dataOptions": [],
                "ajaxDataUrl": "",
                "isChecked": false
            },
            {
                "type": "file",
                "name": "control_file_965933",
                "fieldName": "control_file_965933",
                "label": "Allegare documento d’identità",
                "order": 0,
                "defaultValue": "",
                "placeholder": "",
                "value": "",
                "className": "col-md-12",
                "readonly": false,
                "isUserData": false,
                "userDataType": "",
                "info": "",
                "labelBold": false,
                "labelItalic": false,
                "labelUnderline": false,
                "required": false,
                "isMultiLine": false,
                "isInteger": false,
                "decimalPlace": 0,
                "isTodayValue": false,
                "dateFormat": "dd/mm/yy",
                "isMultiple": true,
                "isAjax": false,
                "dataOptions": [],
                "ajaxDataUrl": "",
                "isChecked": false,
                "min_files": "1",
                "max_files": "3",
                "file_types": ".jpg,.pdf"
            }
        ]
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/forms/{form}/form-structure

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
form int The ID of the Form to retrieve.

Send form user data

This endpoint permits to save the user form data.

Example request:

curl -X POST https://api.mycitydemo.it/api/v1/scenarios/{scenario}/forms/{form}/formuserdata \
    -H 'accept: application/json' \
    -F 'form_user_data={"data": [{"label": "Document","value": ["document.pdf","document1.pdf"],"type": "file"},{"label": "Accept the terms?","value": true,"type": "checkbox"}]}' \
    -F 'email_confirmation=mariorossi@mario.com' \
    -F 'attachments[]=@/home/utente/Scrivania/test.pdf'

Example response:


    {
        "data":{
            "success": "Istanza inviato con successo!"
        }
    }

HTTP Request

POST api/v1/scenarios/{scenario}/forms/{form}/formuserdata

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
form int The ID of the Form to retrieve.

Istanze Online V2

Get all Forms

This endpoint retrieves all Forms from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/forms/v2" \
-H "Accept: application/json"

Example response:


    {
        "data": [
            {
                "id": 8933,
                "type": "menus",
                "title": "Iuc",
                "abstract": "iuc",
                "icon_url": "https://api.mycitydemo.it/images/app_icons/30-moduli-suap.png",
                "icon": "30-moduli-suap",
                "as_map": 0,
                "menu_color": null,
                "contents": [
                    {
                        "id": 8934,
                        "type": "menus",
                        "title": "Iuc",
                        "abstract": null,
                        "icon_url": "http://mycity.local/images/app_icons/00-standard.png",
                        "icon": "00-standard",
                        "as_map": 0,
                        "menu_color": null,
                        "deeplink": "://scenarios/5/menus/8934",
                        "share_url": "http://mycity.local/menu/8934/Iuc"
                    },
                    {
                        "id": 9080,
                        "type": "forms",
                        "title": "Iuc Istanza",
                        "permalink": "iuc",
                        "abstract": null,
                        "body": null,
                        "publish_date": "2021-09-14 16:41:40",
                        "unpublish_date": null,
                        "liked": null,
                        "likes": 0,
                        "shared": null,
                        "shares": 0,
                        "links": [
                            {
                                "rel": "self",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/forms/9080"
                            },
                            {
                                "rel": "gallery",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/forms/9080/gallery"
                            },
                            {
                                "rel": "menu",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/forms/9080/menu"
                            },
                            {
                                "rel": "pois",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/forms/9080/pois"
                            },
                            {
                                "rel": "attachments",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/forms/9080/attachments"
                            },
                            {
                                "rel": "related",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/forms/9080/related"
                            },
                            {
                                "rel": "formdata",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/forms/9080/formdata"
                            }
                        ],
                        "deeplink": "://scenarios/5/forms/9080",
                        "share_url": "http://mycity.local/istanze-online/9080/iuc-istanza"
                    }
                ],
                "deeplink": "://scenarios/5/menus/8933",
                "share_url": "https://api.mycitydemo.it/menu/8933/iuc"
            },
            {
                "id": 8606,
                "type": "forms",
                "title": "Dichiarazione sostitutiva per accedere al fondo di solidarietà alimentare",
                "permalink": "dichiarazione-sostitutiva-accedere-fondo",
                "abstract": "test",
                "body": null,
                "publish_date": "2021-05-03 11:19:00",
                "unpublish_date": null,
                "formdata": {
                    "sections": [
                        {
                            "name": "Form",
                            "label": "Form",
                            "clientKey": "",
                            "order": 0,
                            "rows": [
                                {
                                    "name": "Form_row_383906",
                                    "label": "",
                                    "order": 0,
                                    "controls": [
                                        {
                                            "type": "select",
                                            "name": "control_select_706121",
                                            "fieldName": "control_select_706121",
                                            "label": "Sesso",
                                            "order": 0,
                                            "defaultValue": "",
                                            "placeholder": "",
                                            "value": "",
                                            "className": "col-md-12",
                                            "readonly": false,
                                            "isUserData": false,
                                            "userDataType": "",
                                            "info": "",
                                            "labelBold": false,
                                            "labelItalic": false,
                                            "labelUnderline": false,
                                            "required": true,
                                            "isMultiLine": false,
                                            "isInteger": false,
                                            "decimalPlace": 0,
                                            "isTodayValue": false,
                                            "dateFormat": "dd/mm/yy",
                                            "isMultiple": false,
                                            "isAjax": false,
                                            "dataOptions": [
                                                {
                                                    "id": "0",
                                                    "text": "maschio"
                                                },
                                                {
                                                    "id": "1",
                                                    "text": "femmina"
                                                }
                                            ],
                                            "ajaxDataUrl": "",
                                            "isChecked": false
                                        }
                                    ]
                                },
                                {
                                    "name": "Form_row_350494",
                                    "label": "",
                                    "order": 0,
                                    "controls": [
                                        {
                                            "type": "text",
                                            "name": "control_text_100583",
                                            "fieldName": "control_text_100583",
                                            "label": "Codice Fiscale",
                                            "order": 0,
                                            "defaultValue": "",
                                            "placeholder": "",
                                            "value": "",
                                            "className": "col-md-12",
                                            "readonly": false,
                                            "isUserData": true,
                                            "userDataType": "fiscal_number",
                                            "info": "",
                                            "labelBold": false,
                                            "labelItalic": false,
                                            "labelUnderline": false,
                                            "required": false,
                                            "isMultiLine": false,
                                            "isInteger": false,
                                            "decimalPlace": 0,
                                            "isTodayValue": false,
                                            "dateFormat": "dd/mm/yy",
                                            "isMultiple": false,
                                            "isAjax": false,
                                            "dataOptions": [],
                                            "ajaxDataUrl": "",
                                            "isChecked": false
                                        }
                                    ]
                                },
                                {
                                    "name": "Form_row_568289",
                                    "label": "",
                                    "order": 0,
                                    "controls": [
                                        {
                                            "type": "email",
                                            "name": "control_email_585578",
                                            "fieldName": "control_email_585578",
                                            "label": "Email",
                                            "order": 0,
                                            "defaultValue": "",
                                            "placeholder": "",
                                            "value": "",
                                            "className": "col-md-12",
                                            "readonly": false,
                                            "isUserData": true,
                                            "userDataType": "email",
                                            "info": "",
                                            "labelBold": false,
                                            "labelItalic": false,
                                            "labelUnderline": false,
                                            "required": true,
                                            "isMultiLine": false,
                                            "isInteger": false,
                                            "decimalPlace": 0,
                                            "isTodayValue": false,
                                            "dateFormat": "dd/mm/yy",
                                            "isMultiple": false,
                                            "isAjax": false,
                                            "dataOptions": [],
                                            "ajaxDataUrl": "",
                                            "isChecked": false
                                        }
                                    ]
                                },
                                {
                                    "name": "Form_row_442466",
                                    "label": "",
                                    "order": 0,
                                    "controls": [
                                        {
                                            "type": "text",
                                            "name": "control_text_238990",
                                            "fieldName": "control_text_238990",
                                            "label": "Nome Cognome",
                                            "order": 0,
                                            "defaultValue": "",
                                            "placeholder": "",
                                            "value": "",
                                            "className": "col-md-12",
                                            "readonly": false,
                                            "isUserData": true,
                                            "userDataType": "name",
                                            "info": "",
                                            "labelBold": false,
                                            "labelItalic": false,
                                            "labelUnderline": false,
                                            "required": true,
                                            "isMultiLine": false,
                                            "isInteger": false,
                                            "decimalPlace": 0,
                                            "isTodayValue": false,
                                            "dateFormat": "dd/mm/yy",
                                            "isMultiple": false,
                                            "isAjax": false,
                                            "dataOptions": [],
                                            "ajaxDataUrl": "",
                                            "isChecked": false
                                        }
                                    ]
                                },
                                {
                                    "name": "Form_row_777372",
                                    "label": "",
                                    "order": 0,
                                    "controls": [
                                        {
                                            "type": "datepicker",
                                            "name": "control_datepicker_419122",
                                            "fieldName": "control_datepicker_419122",
                                            "label": "Data di nascita",
                                            "order": 0,
                                            "defaultValue": "",
                                            "placeholder": "",
                                            "value": "",
                                            "className": "col-md-12",
                                            "readonly": false,
                                            "isUserData": true,
                                            "userDataType": "birth_date",
                                            "info": "",
                                            "labelBold": false,
                                            "labelItalic": false,
                                            "labelUnderline": false,
                                            "required": true,
                                            "isMultiLine": false,
                                            "isInteger": false,
                                            "decimalPlace": 0,
                                            "isTodayValue": false,
                                            "dateFormat": "dd/mm/yy",
                                            "isMultiple": false,
                                            "isAjax": false,
                                            "dataOptions": [],
                                            "ajaxDataUrl": "",
                                            "isChecked": false
                                        }
                                    ]
                                },
                                {
                                    "name": "Form_row_337686",
                                    "label": "",
                                    "order": 0,
                                    "controls": [
                                        {
                                            "type": "number",
                                            "name": "control_number_331310",
                                            "fieldName": "control_number_331310",
                                            "label": "Numero di telefono",
                                            "order": 0,
                                            "defaultValue": "",
                                            "placeholder": "",
                                            "value": "",
                                            "className": "col-md-12",
                                            "readonly": false,
                                            "isUserData": true,
                                            "userDataType": "phone",
                                            "info": "",
                                            "labelBold": false,
                                            "labelItalic": false,
                                            "labelUnderline": false,
                                            "required": false,
                                            "isMultiLine": false,
                                            "isInteger": false,
                                            "decimalPlace": 0,
                                            "isTodayValue": false,
                                            "dateFormat": "dd/mm/yy",
                                            "isMultiple": false,
                                            "isAjax": false,
                                            "dataOptions": [],
                                            "ajaxDataUrl": "",
                                            "isChecked": false
                                        }
                                    ]
                                },
                                {
                                    "name": "Form_row_3760",
                                    "label": "",
                                    "order": 0,
                                    "controls": [
                                        {
                                            "type": "checkbox",
                                            "name": "control_checkbox_318870",
                                            "fieldName": "control_checkbox_318870",
                                            "label": "Accetta i termini della privacy?",
                                            "order": 0,
                                            "defaultValue": "",
                                            "placeholder": "",
                                            "value": "",
                                            "className": "col-md-12",
                                            "readonly": false,
                                            "isUserData": false,
                                            "userDataType": "",
                                            "info": "",
                                            "labelBold": false,
                                            "labelItalic": false,
                                            "labelUnderline": false,
                                            "required": false,
                                            "isMultiLine": false,
                                            "isInteger": false,
                                            "decimalPlace": 0,
                                            "isTodayValue": false,
                                            "dateFormat": "dd/mm/yy",
                                            "isMultiple": false,
                                            "isAjax": false,
                                            "dataOptions": [],
                                            "ajaxDataUrl": "",
                                            "isChecked": false
                                        }
                                    ]
                                },
                                {
                                    "name": "Form_row_288848",
                                    "label": "",
                                    "order": 0,
                                    "controls": [
                                        {
                                            "type": "info",
                                            "name": "control_info_847714",
                                            "fieldName": "control_info_847714",
                                            "label": "Informazione",
                                            "order": 0,
                                            "defaultValue": "",
                                            "placeholder": "",
                                            "value": "",
                                            "className": "col-md-12",
                                            "readonly": false,
                                            "isUserData": false,
                                            "userDataType": "",
                                            "info": "Informazione generale",
                                            "labelBold": false,
                                            "labelItalic": false,
                                            "labelUnderline": false,
                                            "required": false,
                                            "isMultiLine": false,
                                            "isInteger": false,
                                            "decimalPlace": 0,
                                            "isTodayValue": false,
                                            "dateFormat": "dd/mm/yy",
                                            "isMultiple": false,
                                            "isAjax": false,
                                            "dataOptions": [],
                                            "ajaxDataUrl": "",
                                            "isChecked": false
                                        }
                                    ]
                                },
                                {
                                    "name": "Form_row_682354",
                                    "label": "",
                                    "order": 0,
                                    "controls": [
                                        {
                                            "type": "file",
                                            "name": "control_file_965933",
                                            "fieldName": "control_file_965933",
                                            "label": "Allegare documento d’identità",
                                            "order": 0,
                                            "defaultValue": "",
                                            "placeholder": "",
                                            "value": "",
                                            "className": "col-md-12",
                                            "readonly": false,
                                            "isUserData": false,
                                            "userDataType": "",
                                            "info": "",
                                            "labelBold": false,
                                            "labelItalic": false,
                                            "labelUnderline": false,
                                            "required": false,
                                            "isMultiLine": false,
                                            "isInteger": false,
                                            "decimalPlace": 0,
                                            "isTodayValue": false,
                                            "dateFormat": "dd/mm/yy",
                                            "isMultiple": true,
                                            "isAjax": false,
                                            "dataOptions": [],
                                            "ajaxDataUrl": "",
                                            "isChecked": false,
                                            "min_files": "1",
                                            "max_files": "3",
                                            "file_types": ".jpg,.pdf"
                                        }
                                    ]
                                }
                            ],
                            "labelPosition": "left",
                            "isDynamic": false,
                            "minInstance": 1,
                            "maxInstance": 0,
                            "instances": [],
                            "title": "Sez. 1",
                            "collapse": true
                        },
                        {
                            "name": "section_30625",
                            "label": "",
                            "conditions": [
                                {
                                    "id": "control_checkbox_318870",
                                    "title": "Accetta i termini della privacy?",
                                    "value": "true",
                                    "type": "checkbox"
                                },
                                {
                                    "id": "control_select_706121",
                                    "title": "Sesso",
                                    "value": ["femmina","non specificato"],
                                    "type": "select"
                                }
                            ],
                            "condition_name": "",
                            "condition_value": "",
                            "clientKey": "section_30625",
                            "order": 1,
                            "rows": [
                                {
                                    "name": "section_30625_row_980074",
                                    "label": "",
                                    "order": 0,
                                    "controls": [
                                        {
                                            "type": "datepicker",
                                            "name": "control_datepicker_990080",
                                            "fieldName": "control_datepicker_990080",
                                            "label": "Data",
                                            "order": 0,
                                            "defaultValue": "",
                                            "placeholder": "",
                                            "value": "",
                                            "className": "col-md-12",
                                            "readonly": false,
                                            "isUserData": false,
                                            "userDataType": "",
                                            "info": "",
                                            "labelBold": false,
                                            "labelItalic": false,
                                            "labelUnderline": false,
                                            "required": false,
                                            "isMultiLine": false,
                                            "isInteger": false,
                                            "decimalPlace": 0,
                                            "isTodayValue": false,
                                            "dateFormat": "dd/mm/yy",
                                            "isMultiple": false,
                                            "isAjax": false,
                                            "dataOptions": [],
                                            "ajaxDataUrl": "",
                                            "isChecked": false
                                        }
                                    ]
                                }
                            ],
                            "labelPosition": "left",
                            "isDynamic": false,
                            "minInstance": 1,
                            "maxInstance": 0,
                            "instances": [],
                            "title": "Sez. 2",
                            "collapse": false
                        },
                        {
                            "name": "section_159641",
                            "label": "",
                            "conditions": [],
                            "condition_name": "",
                            "condition_value": "",
                            "clientKey": "section_159641",
                            "order": 2,
                            "rows": [
                                {
                                    "name": "section_159641_row_743390",
                                    "label": "",
                                    "order": 0,
                                    "controls": [
                                        {
                                            "type": "checkbox",
                                            "name": "control_checkbox_982449",
                                            "fieldName": "control_checkbox_982449",
                                            "label": "Accetta?",
                                            "order": 0,
                                            "defaultValue": "",
                                            "placeholder": "",
                                            "value": "",
                                            "className": "col-md-12",
                                            "readonly": false,
                                            "isUserData": false,
                                            "userDataType": "",
                                            "info": "",
                                            "labelBold": false,
                                            "labelItalic": false,
                                            "labelUnderline": false,
                                            "required": false,
                                            "isMultiLine": false,
                                            "isInteger": false,
                                            "decimalPlace": 0,
                                            "isTodayValue": false,
                                            "dateFormat": "dd/mm/yy",
                                            "isMultiple": false,
                                            "isAjax": false,
                                            "dataOptions": [],
                                            "ajaxDataUrl": "",
                                            "isChecked": false
                                        }
                                    ]
                                },
                                {
                                    "name": "section_159641_row_276234",
                                    "label": "",
                                    "order": 0,
                                    "controls": [
                                        {
                                            "type": "datepicker",
                                            "name": "control_datepicker_207282",
                                            "fieldName": "control_datepicker_207282",
                                            "label": "Data",
                                            "order": 0,
                                            "defaultValue": "",
                                            "placeholder": "",
                                            "value": "",
                                            "className": "col-md-12",
                                            "readonly": false,
                                            "isUserData": false,
                                            "userDataType": "",
                                            "info": "",
                                            "labelBold": false,
                                            "labelItalic": false,
                                            "labelUnderline": false,
                                            "required": false,
                                            "isMultiLine": false,
                                            "isInteger": false,
                                            "decimalPlace": 0,
                                            "isTodayValue": false,
                                            "dateFormat": "dd/mm/yy",
                                            "isMultiple": false,
                                            "isAjax": false,
                                            "dataOptions": [],
                                            "ajaxDataUrl": "",
                                            "isChecked": false
                                        }
                                    ]
                                }
                            ],
                            "labelPosition": "left",
                            "isDynamic": false,
                            "minInstance": 1,
                            "maxInstance": 0,
                            "instances": [],
                            "title": "Sez. 3"
                        }
                    ],
                    "layout": "collapse",
                    "_uniqueId": 0.6242151290232067
                },
                "liked": null,
                "likes": 0,
                "shared": null,
                "shares": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "http://api.mycity.social/api/v1/scenarios/5/forms/8606"
                    },
                    {
                        "rel": "gallery",
                        "href": "http://api.mycity.social/api/v1/scenarios/5/forms/8606/gallery"
                    },
                    {
                        "rel": "menu",
                        "href": "http://api.mycity.social/api/v1/scenarios/5/forms/8606/menu"
                    },
                    {
                        "rel": "pois",
                        "href": "http://api.mycity.social/api/v1/scenarios/5/forms/8606/pois"
                    },
                    {
                        "rel": "attachments",
                        "href": "http://api.mycity.social/api/v1/scenarios/5/forms/8606/attachments"
                    },
                    {
                        "rel": "related",
                        "href": "http://api.mycity.social/api/v1/scenarios/5/forms/8606/related"
                    },
                    {
                        "rel": "formdata",
                        "href": "http://api.mycity.social/api/v1/scenarios/5/forms/8606/formdata"
                    }
                ],
                "deeplink": "://scenarios/5/forms/8606",
                "share_url": "http://mycity.local/istanze-online/8606/dichiarazione-sostitutiva-accedere-fondo"
            }
        ]
    }

HTTP Request

GET api/v1/scenarios/{scenario}/forms/v2

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: contents, formdata_v2).

Get a specific Form

This endpoint retrieves a specific Form from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/forms/v2/{form}" \
-H "Accept: application/json"

Example response:


    {
        "data": {
            "id": 8606,
            "type": "forms",
            "title": "Dichiarazione sostitutiva per accedere al fondo di solidarietà alimentare",
            "permalink": "dichiarazione-sostitutiva-accedere-fondo",
            "abstract": "test",
            "body": null,
            "publish_date": "2021-05-03 11:19:00",
            "unpublish_date": null,
            "formdata": {
                "sections": [
                    {
                        "name": "Form",
                        "label": "Form",
                        "clientKey": "",
                        "order": 0,
                        "rows": [
                            {
                                "name": "Form_row_383906",
                                "label": "",
                                "order": 0,
                                "controls": [
                                    {
                                        "type": "select",
                                        "name": "control_select_706121",
                                        "fieldName": "control_select_706121",
                                        "label": "Sesso",
                                        "order": 0,
                                        "defaultValue": "",
                                        "placeholder": "",
                                        "value": "",
                                        "className": "col-md-12",
                                        "readonly": false,
                                        "isUserData": false,
                                        "userDataType": "",
                                        "info": "",
                                        "labelBold": false,
                                        "labelItalic": false,
                                        "labelUnderline": false,
                                        "required": true,
                                        "isMultiLine": false,
                                        "isInteger": false,
                                        "decimalPlace": 0,
                                        "isTodayValue": false,
                                        "dateFormat": "dd/mm/yy",
                                        "isMultiple": false,
                                        "isAjax": false,
                                        "dataOptions": [
                                            {
                                                "id": "0",
                                                "text": "maschio"
                                            },
                                            {
                                                "id": "1",
                                                "text": "femmina"
                                            }
                                        ],
                                        "ajaxDataUrl": "",
                                        "isChecked": false
                                    }
                                ]
                            },
                            {
                                "name": "Form_row_350494",
                                "label": "",
                                "order": 0,
                                "controls": [
                                    {
                                        "type": "text",
                                        "name": "control_text_100583",
                                        "fieldName": "control_text_100583",
                                        "label": "Codice Fiscale",
                                        "order": 0,
                                        "defaultValue": "",
                                        "placeholder": "",
                                        "value": "",
                                        "className": "col-md-12",
                                        "readonly": false,
                                        "isUserData": true,
                                        "userDataType": "fiscal_number",
                                        "info": "",
                                        "labelBold": false,
                                        "labelItalic": false,
                                        "labelUnderline": false,
                                        "required": false,
                                        "isMultiLine": false,
                                        "isInteger": false,
                                        "decimalPlace": 0,
                                        "isTodayValue": false,
                                        "dateFormat": "dd/mm/yy",
                                        "isMultiple": false,
                                        "isAjax": false,
                                        "dataOptions": [],
                                        "ajaxDataUrl": "",
                                        "isChecked": false
                                    }
                                ]
                            },
                            {
                                "name": "Form_row_568289",
                                "label": "",
                                "order": 0,
                                "controls": [
                                    {
                                        "type": "email",
                                        "name": "control_email_585578",
                                        "fieldName": "control_email_585578",
                                        "label": "Email",
                                        "order": 0,
                                        "defaultValue": "",
                                        "placeholder": "",
                                        "value": "",
                                        "className": "col-md-12",
                                        "readonly": false,
                                        "isUserData": true,
                                        "userDataType": "email",
                                        "info": "",
                                        "labelBold": false,
                                        "labelItalic": false,
                                        "labelUnderline": false,
                                        "required": true,
                                        "isMultiLine": false,
                                        "isInteger": false,
                                        "decimalPlace": 0,
                                        "isTodayValue": false,
                                        "dateFormat": "dd/mm/yy",
                                        "isMultiple": false,
                                        "isAjax": false,
                                        "dataOptions": [],
                                        "ajaxDataUrl": "",
                                        "isChecked": false
                                    }
                                ]
                            },
                            {
                                "name": "Form_row_442466",
                                "label": "",
                                "order": 0,
                                "controls": [
                                    {
                                        "type": "text",
                                        "name": "control_text_238990",
                                        "fieldName": "control_text_238990",
                                        "label": "Nome Cognome",
                                        "order": 0,
                                        "defaultValue": "",
                                        "placeholder": "",
                                        "value": "",
                                        "className": "col-md-12",
                                        "readonly": false,
                                        "isUserData": true,
                                        "userDataType": "name",
                                        "info": "",
                                        "labelBold": false,
                                        "labelItalic": false,
                                        "labelUnderline": false,
                                        "required": true,
                                        "isMultiLine": false,
                                        "isInteger": false,
                                        "decimalPlace": 0,
                                        "isTodayValue": false,
                                        "dateFormat": "dd/mm/yy",
                                        "isMultiple": false,
                                        "isAjax": false,
                                        "dataOptions": [],
                                        "ajaxDataUrl": "",
                                        "isChecked": false
                                    }
                                ]
                            },
                            {
                                "name": "Form_row_777372",
                                "label": "",
                                "order": 0,
                                "controls": [
                                    {
                                        "type": "datepicker",
                                        "name": "control_datepicker_419122",
                                        "fieldName": "control_datepicker_419122",
                                        "label": "Data di nascita",
                                        "order": 0,
                                        "defaultValue": "",
                                        "placeholder": "",
                                        "value": "",
                                        "className": "col-md-12",
                                        "readonly": false,
                                        "isUserData": true,
                                        "userDataType": "birth_date",
                                        "info": "",
                                        "labelBold": false,
                                        "labelItalic": false,
                                        "labelUnderline": false,
                                        "required": true,
                                        "isMultiLine": false,
                                        "isInteger": false,
                                        "decimalPlace": 0,
                                        "isTodayValue": false,
                                        "dateFormat": "dd/mm/yy",
                                        "isMultiple": false,
                                        "isAjax": false,
                                        "dataOptions": [],
                                        "ajaxDataUrl": "",
                                        "isChecked": false
                                    }
                                ]
                            },
                            {
                                "name": "Form_row_337686",
                                "label": "",
                                "order": 0,
                                "controls": [
                                    {
                                        "type": "number",
                                        "name": "control_number_331310",
                                        "fieldName": "control_number_331310",
                                        "label": "Numero di telefono",
                                        "order": 0,
                                        "defaultValue": "",
                                        "placeholder": "",
                                        "value": "",
                                        "className": "col-md-12",
                                        "readonly": false,
                                        "isUserData": true,
                                        "userDataType": "phone",
                                        "info": "",
                                        "labelBold": false,
                                        "labelItalic": false,
                                        "labelUnderline": false,
                                        "required": false,
                                        "isMultiLine": false,
                                        "isInteger": false,
                                        "decimalPlace": 0,
                                        "isTodayValue": false,
                                        "dateFormat": "dd/mm/yy",
                                        "isMultiple": false,
                                        "isAjax": false,
                                        "dataOptions": [],
                                        "ajaxDataUrl": "",
                                        "isChecked": false
                                    }
                                ]
                            },
                            {
                                "name": "Form_row_3760",
                                "label": "",
                                "order": 0,
                                "controls": [
                                    {
                                        "type": "checkbox",
                                        "name": "control_checkbox_318870",
                                        "fieldName": "control_checkbox_318870",
                                        "label": "Accetta i termini della privacy?",
                                        "order": 0,
                                        "defaultValue": "",
                                        "placeholder": "",
                                        "value": "",
                                        "className": "col-md-12",
                                        "readonly": false,
                                        "isUserData": false,
                                        "userDataType": "",
                                        "info": "",
                                        "labelBold": false,
                                        "labelItalic": false,
                                        "labelUnderline": false,
                                        "required": false,
                                        "isMultiLine": false,
                                        "isInteger": false,
                                        "decimalPlace": 0,
                                        "isTodayValue": false,
                                        "dateFormat": "dd/mm/yy",
                                        "isMultiple": false,
                                        "isAjax": false,
                                        "dataOptions": [],
                                        "ajaxDataUrl": "",
                                        "isChecked": false
                                    }
                                ]
                            },
                            {
                                "name": "Form_row_288848",
                                "label": "",
                                "order": 0,
                                "controls": [
                                    {
                                        "type": "info",
                                        "name": "control_info_847714",
                                        "fieldName": "control_info_847714",
                                        "label": "Informazione",
                                        "order": 0,
                                        "defaultValue": "",
                                        "placeholder": "",
                                        "value": "",
                                        "className": "col-md-12",
                                        "readonly": false,
                                        "isUserData": false,
                                        "userDataType": "",
                                        "info": "Informazione generale",
                                        "labelBold": false,
                                        "labelItalic": false,
                                        "labelUnderline": false,
                                        "required": false,
                                        "isMultiLine": false,
                                        "isInteger": false,
                                        "decimalPlace": 0,
                                        "isTodayValue": false,
                                        "dateFormat": "dd/mm/yy",
                                        "isMultiple": false,
                                        "isAjax": false,
                                        "dataOptions": [],
                                        "ajaxDataUrl": "",
                                        "isChecked": false
                                    }
                                ]
                            },
                            {
                                "name": "Form_row_682354",
                                "label": "",
                                "order": 0,
                                "controls": [
                                    {
                                        "type": "file",
                                        "name": "control_file_965933",
                                        "fieldName": "control_file_965933",
                                        "label": "Allegare documento d’identità",
                                        "order": 0,
                                        "defaultValue": "",
                                        "placeholder": "",
                                        "value": "",
                                        "className": "col-md-12",
                                        "readonly": false,
                                        "isUserData": false,
                                        "userDataType": "",
                                        "info": "",
                                        "labelBold": false,
                                        "labelItalic": false,
                                        "labelUnderline": false,
                                        "required": false,
                                        "isMultiLine": false,
                                        "isInteger": false,
                                        "decimalPlace": 0,
                                        "isTodayValue": false,
                                        "dateFormat": "dd/mm/yy",
                                        "isMultiple": true,
                                        "isAjax": false,
                                        "dataOptions": [],
                                        "ajaxDataUrl": "",
                                        "isChecked": false,
                                        "min_files": "1",
                                        "max_files": "3",
                                        "file_types": ".jpg,.pdf"
                                    }
                                ]
                            }
                        ],
                        "labelPosition": "left",
                        "isDynamic": false,
                        "minInstance": 1,
                        "maxInstance": 0,
                        "instances": [],
                        "title": "Sez. 1",
                        "collapse": true
                    },
                    {
                        "name": "section_30625",
                        "label": "",
                        "conditions": [
                            {
                                "id": "control_checkbox_318870",
                                "title": "Accetta i termini della privacy?",
                                "value": "true",
                                "type": "checkbox"
                            },
                            {
                                "id": "control_select_706121",
                                "title": "Sesso",
                                "value": ["femmina","non specificato"],
                                "type": "select"
                            }
                        ],
                        "condition_name": "",
                        "condition_value": "",
                        "clientKey": "section_30625",
                        "order": 1,
                        "rows": [
                            {
                                "name": "section_30625_row_980074",
                                "label": "",
                                "order": 0,
                                "controls": [
                                    {
                                        "type": "datepicker",
                                        "name": "control_datepicker_990080",
                                        "fieldName": "control_datepicker_990080",
                                        "label": "Data",
                                        "order": 0,
                                        "defaultValue": "",
                                        "placeholder": "",
                                        "value": "",
                                        "className": "col-md-12",
                                        "readonly": false,
                                        "isUserData": false,
                                        "userDataType": "",
                                        "info": "",
                                        "labelBold": false,
                                        "labelItalic": false,
                                        "labelUnderline": false,
                                        "required": false,
                                        "isMultiLine": false,
                                        "isInteger": false,
                                        "decimalPlace": 0,
                                        "isTodayValue": false,
                                        "dateFormat": "dd/mm/yy",
                                        "isMultiple": false,
                                        "isAjax": false,
                                        "dataOptions": [],
                                        "ajaxDataUrl": "",
                                        "isChecked": false
                                    }
                                ]
                            }
                        ],
                        "labelPosition": "left",
                        "isDynamic": false,
                        "minInstance": 1,
                        "maxInstance": 0,
                        "instances": [],
                        "title": "Sez. 2",
                        "collapse": false
                    },
                    {
                        "name": "section_159641",
                        "label": "",
                        "conditions": [],
                        "condition_name": "",
                        "condition_value": "",
                        "clientKey": "section_159641",
                        "order": 2,
                        "rows": [
                            {
                                "name": "section_159641_row_743390",
                                "label": "",
                                "order": 0,
                                "controls": [
                                    {
                                        "type": "checkbox",
                                        "name": "control_checkbox_982449",
                                        "fieldName": "control_checkbox_982449",
                                        "label": "Accetta?",
                                        "order": 0,
                                        "defaultValue": "",
                                        "placeholder": "",
                                        "value": "",
                                        "className": "col-md-12",
                                        "readonly": false,
                                        "isUserData": false,
                                        "userDataType": "",
                                        "info": "",
                                        "labelBold": false,
                                        "labelItalic": false,
                                        "labelUnderline": false,
                                        "required": false,
                                        "isMultiLine": false,
                                        "isInteger": false,
                                        "decimalPlace": 0,
                                        "isTodayValue": false,
                                        "dateFormat": "dd/mm/yy",
                                        "isMultiple": false,
                                        "isAjax": false,
                                        "dataOptions": [],
                                        "ajaxDataUrl": "",
                                        "isChecked": false
                                    }
                                ]
                            },
                            {
                                "name": "section_159641_row_276234",
                                "label": "",
                                "order": 0,
                                "controls": [
                                    {
                                        "type": "datepicker",
                                        "name": "control_datepicker_207282",
                                        "fieldName": "control_datepicker_207282",
                                        "label": "Data",
                                        "order": 0,
                                        "defaultValue": "",
                                        "placeholder": "",
                                        "value": "",
                                        "className": "col-md-12",
                                        "readonly": false,
                                        "isUserData": false,
                                        "userDataType": "",
                                        "info": "",
                                        "labelBold": false,
                                        "labelItalic": false,
                                        "labelUnderline": false,
                                        "required": false,
                                        "isMultiLine": false,
                                        "isInteger": false,
                                        "decimalPlace": 0,
                                        "isTodayValue": false,
                                        "dateFormat": "dd/mm/yy",
                                        "isMultiple": false,
                                        "isAjax": false,
                                        "dataOptions": [],
                                        "ajaxDataUrl": "",
                                        "isChecked": false
                                    }
                                ]
                            }
                        ],
                        "labelPosition": "left",
                        "isDynamic": false,
                        "minInstance": 1,
                        "maxInstance": 0,
                        "instances": [],
                        "title": "Sez. 3"
                    }
                ],
                "layout": "collapse",
                "_uniqueId": 0.6242151290232067
            },
            "liked": null,
            "likes": 0,
            "shared": null,
            "shares": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/8606"
                },
                {
                    "rel": "gallery",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/8606/gallery"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/8606/menu"
                },
                {
                    "rel": "pois",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/8606/pois"
                },
                {
                    "rel": "attachments",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/8606/attachments"
                },
                {
                    "rel": "related",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/8606/related"
                },
                {
                    "rel": "formdata",
                    "href": "http://api.mycity.social/api/v1/scenarios/5/forms/8606/formdata"
                }
            ],
            "deeplink": "://scenarios/5/forms/8606",
            "share_url": "http://mycity.local/istanze-online/8606/dichiarazione-sostitutiva-accedere-fondo"
        }
    }

HTTP Request

GET api/v1/scenarios/{scenario}/forms/v2/{form}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
form int The ID of the Form to retrieve.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: formdata_v2).

Get a specific Form Structure

This endpoint retrieves a specific Form Structure from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/forms/v2/{form}/form-structure" \
-H "Accept: application/json"

Example response:


{
    "data": {
        "structure": {
            "sections": [
                {
                    "name": "Form",
                    "label": "Form",
                    "clientKey": "",
                    "order": 0,
                    "rows": [
                        {
                            "name": "Form_row_383906",
                            "label": "",
                            "order": 0,
                            "controls": [
                                {
                                    "type": "select",
                                    "name": "control_select_706121",
                                    "fieldName": "control_select_706121",
                                    "label": "Sesso",
                                    "order": 0,
                                    "defaultValue": "",
                                    "placeholder": "",
                                    "value": "",
                                    "className": "col-md-12",
                                    "readonly": false,
                                    "isUserData": false,
                                    "userDataType": "",
                                    "info": "",
                                    "labelBold": false,
                                    "labelItalic": false,
                                    "labelUnderline": false,
                                    "required": true,
                                    "isMultiLine": false,
                                    "isInteger": false,
                                    "decimalPlace": 0,
                                    "isTodayValue": false,
                                    "dateFormat": "dd/mm/yy",
                                    "isMultiple": false,
                                    "isAjax": false,
                                    "dataOptions": [
                                        {
                                            "id": "0",
                                            "text": "maschio"
                                        },
                                        {
                                            "id": "1",
                                            "text": "femmina"
                                        }
                                    ],
                                    "ajaxDataUrl": "",
                                    "isChecked": false
                                }
                            ]
                        },
                        {
                            "name": "Form_row_350494",
                            "label": "",
                            "order": 0,
                            "controls": [
                                {
                                    "type": "text",
                                    "name": "control_text_100583",
                                    "fieldName": "control_text_100583",
                                    "label": "Codice Fiscale",
                                    "order": 0,
                                    "defaultValue": "",
                                    "placeholder": "",
                                    "value": "",
                                    "className": "col-md-12",
                                    "readonly": false,
                                    "isUserData": true,
                                    "userDataType": "fiscal_number",
                                    "info": "",
                                    "labelBold": false,
                                    "labelItalic": false,
                                    "labelUnderline": false,
                                    "required": false,
                                    "isMultiLine": false,
                                    "isInteger": false,
                                    "decimalPlace": 0,
                                    "isTodayValue": false,
                                    "dateFormat": "dd/mm/yy",
                                    "isMultiple": false,
                                    "isAjax": false,
                                    "dataOptions": [],
                                    "ajaxDataUrl": "",
                                    "isChecked": false
                                }
                            ]
                        },
                        {
                            "name": "Form_row_568289",
                            "label": "",
                            "order": 0,
                            "controls": [
                                {
                                    "type": "email",
                                    "name": "control_email_585578",
                                    "fieldName": "control_email_585578",
                                    "label": "Email",
                                    "order": 0,
                                    "defaultValue": "",
                                    "placeholder": "",
                                    "value": "",
                                    "className": "col-md-12",
                                    "readonly": false,
                                    "isUserData": true,
                                    "userDataType": "email",
                                    "info": "",
                                    "labelBold": false,
                                    "labelItalic": false,
                                    "labelUnderline": false,
                                    "required": true,
                                    "isMultiLine": false,
                                    "isInteger": false,
                                    "decimalPlace": 0,
                                    "isTodayValue": false,
                                    "dateFormat": "dd/mm/yy",
                                    "isMultiple": false,
                                    "isAjax": false,
                                    "dataOptions": [],
                                    "ajaxDataUrl": "",
                                    "isChecked": false
                                }
                            ]
                        },
                        {
                            "name": "Form_row_442466",
                            "label": "",
                            "order": 0,
                            "controls": [
                                {
                                    "type": "text",
                                    "name": "control_text_238990",
                                    "fieldName": "control_text_238990",
                                    "label": "Nome Cognome",
                                    "order": 0,
                                    "defaultValue": "",
                                    "placeholder": "",
                                    "value": "",
                                    "className": "col-md-12",
                                    "readonly": false,
                                    "isUserData": true,
                                    "userDataType": "name",
                                    "info": "",
                                    "labelBold": false,
                                    "labelItalic": false,
                                    "labelUnderline": false,
                                    "required": true,
                                    "isMultiLine": false,
                                    "isInteger": false,
                                    "decimalPlace": 0,
                                    "isTodayValue": false,
                                    "dateFormat": "dd/mm/yy",
                                    "isMultiple": false,
                                    "isAjax": false,
                                    "dataOptions": [],
                                    "ajaxDataUrl": "",
                                    "isChecked": false
                                }
                            ]
                        },
                        {
                            "name": "Form_row_777372",
                            "label": "",
                            "order": 0,
                            "controls": [
                                {
                                    "type": "datepicker",
                                    "name": "control_datepicker_419122",
                                    "fieldName": "control_datepicker_419122",
                                    "label": "Data di nascita",
                                    "order": 0,
                                    "defaultValue": "",
                                    "placeholder": "",
                                    "value": "",
                                    "className": "col-md-12",
                                    "readonly": false,
                                    "isUserData": true,
                                    "userDataType": "birth_date",
                                    "info": "",
                                    "labelBold": false,
                                    "labelItalic": false,
                                    "labelUnderline": false,
                                    "required": true,
                                    "isMultiLine": false,
                                    "isInteger": false,
                                    "decimalPlace": 0,
                                    "isTodayValue": false,
                                    "dateFormat": "dd/mm/yy",
                                    "isMultiple": false,
                                    "isAjax": false,
                                    "dataOptions": [],
                                    "ajaxDataUrl": "",
                                    "isChecked": false
                                }
                            ]
                        },
                        {
                            "name": "Form_row_337686",
                            "label": "",
                            "order": 0,
                            "controls": [
                                {
                                    "type": "number",
                                    "name": "control_number_331310",
                                    "fieldName": "control_number_331310",
                                    "label": "Numero di telefono",
                                    "order": 0,
                                    "defaultValue": "",
                                    "placeholder": "",
                                    "value": "",
                                    "className": "col-md-12",
                                    "readonly": false,
                                    "isUserData": true,
                                    "userDataType": "phone",
                                    "info": "",
                                    "labelBold": false,
                                    "labelItalic": false,
                                    "labelUnderline": false,
                                    "required": false,
                                    "isMultiLine": false,
                                    "isInteger": false,
                                    "decimalPlace": 0,
                                    "isTodayValue": false,
                                    "dateFormat": "dd/mm/yy",
                                    "isMultiple": false,
                                    "isAjax": false,
                                    "dataOptions": [],
                                    "ajaxDataUrl": "",
                                    "isChecked": false
                                }
                            ]
                        },
                        {
                            "name": "Form_row_3760",
                            "label": "",
                            "order": 0,
                            "controls": [
                                {
                                    "type": "checkbox",
                                    "name": "control_checkbox_318870",
                                    "fieldName": "control_checkbox_318870",
                                    "label": "Accetta i termini della privacy?",
                                    "order": 0,
                                    "defaultValue": "",
                                    "placeholder": "",
                                    "value": "",
                                    "className": "col-md-12",
                                    "readonly": false,
                                    "isUserData": false,
                                    "userDataType": "",
                                    "info": "",
                                    "labelBold": false,
                                    "labelItalic": false,
                                    "labelUnderline": false,
                                    "required": false,
                                    "isMultiLine": false,
                                    "isInteger": false,
                                    "decimalPlace": 0,
                                    "isTodayValue": false,
                                    "dateFormat": "dd/mm/yy",
                                    "isMultiple": false,
                                    "isAjax": false,
                                    "dataOptions": [],
                                    "ajaxDataUrl": "",
                                    "isChecked": false
                                }
                            ]
                        },
                        {
                            "name": "Form_row_288848",
                            "label": "",
                            "order": 0,
                            "controls": [
                                {
                                    "type": "info",
                                    "name": "control_info_847714",
                                    "fieldName": "control_info_847714",
                                    "label": "Informazione",
                                    "order": 0,
                                    "defaultValue": "",
                                    "placeholder": "",
                                    "value": "",
                                    "className": "col-md-12",
                                    "readonly": false,
                                    "isUserData": false,
                                    "userDataType": "",
                                    "info": "Informazione generale",
                                    "labelBold": false,
                                    "labelItalic": false,
                                    "labelUnderline": false,
                                    "required": false,
                                    "isMultiLine": false,
                                    "isInteger": false,
                                    "decimalPlace": 0,
                                    "isTodayValue": false,
                                    "dateFormat": "dd/mm/yy",
                                    "isMultiple": false,
                                    "isAjax": false,
                                    "dataOptions": [],
                                    "ajaxDataUrl": "",
                                    "isChecked": false
                                }
                            ]
                        },
                        {
                            "name": "Form_row_682354",
                            "label": "",
                            "order": 0,
                            "controls": [
                                {
                                    "type": "file",
                                    "name": "control_file_965933",
                                    "fieldName": "control_file_965933",
                                    "label": "Allegare documento d’identità",
                                    "order": 0,
                                    "defaultValue": "",
                                    "placeholder": "",
                                    "value": "",
                                    "className": "col-md-12",
                                    "readonly": false,
                                    "isUserData": false,
                                    "userDataType": "",
                                    "info": "",
                                    "labelBold": false,
                                    "labelItalic": false,
                                    "labelUnderline": false,
                                    "required": false,
                                    "isMultiLine": false,
                                    "isInteger": false,
                                    "decimalPlace": 0,
                                    "isTodayValue": false,
                                    "dateFormat": "dd/mm/yy",
                                    "isMultiple": true,
                                    "isAjax": false,
                                    "dataOptions": [],
                                    "ajaxDataUrl": "",
                                    "isChecked": false,
                                    "min_files": "1",
                                    "max_files": "3",
                                    "file_types": ".jpg,.pdf"
                                }
                            ]
                        }
                    ],
                    "labelPosition": "left",
                    "isDynamic": false,
                    "minInstance": 1,
                    "maxInstance": 0,
                    "instances": [],
                    "title": "Sez. 1",
                    "collapse": true
                },
                {
                    "name": "section_30625",
                    "label": "",
                    "conditions": [
                        {
                            "id": "control_checkbox_318870",
                            "title": "Accetta i termini della privacy?",
                            "value": "true",
                            "type": "checkbox"
                        },
                        {
                            "id": "control_select_706121",
                            "title": "Sesso",
                            "value": ["femmina","non specificato"],
                            "type": "select"
                        }
                    ],
                    "condition_name": "",
                    "condition_value": "",
                    "clientKey": "section_30625",
                    "order": 1,
                    "rows": [
                        {
                            "name": "section_30625_row_980074",
                            "label": "",
                            "order": 0,
                            "controls": [
                                {
                                    "type": "datepicker",
                                    "name": "control_datepicker_990080",
                                    "fieldName": "control_datepicker_990080",
                                    "label": "Data",
                                    "order": 0,
                                    "defaultValue": "",
                                    "placeholder": "",
                                    "value": "",
                                    "className": "col-md-12",
                                    "readonly": false,
                                    "isUserData": false,
                                    "userDataType": "",
                                    "info": "",
                                    "labelBold": false,
                                    "labelItalic": false,
                                    "labelUnderline": false,
                                    "required": false,
                                    "isMultiLine": false,
                                    "isInteger": false,
                                    "decimalPlace": 0,
                                    "isTodayValue": false,
                                    "dateFormat": "dd/mm/yy",
                                    "isMultiple": false,
                                    "isAjax": false,
                                    "dataOptions": [],
                                    "ajaxDataUrl": "",
                                    "isChecked": false
                                }
                            ]
                        }
                    ],
                    "labelPosition": "left",
                    "isDynamic": false,
                    "minInstance": 1,
                    "maxInstance": 0,
                    "instances": [],
                    "title": "Sez. 2",
                    "collapse": false
                },
                {
                    "name": "section_159641",
                    "label": "",
                    "conditions": [],
                    "condition_name": "",
                    "condition_value": "",
                    "clientKey": "section_159641",
                    "order": 2,
                    "rows": [
                        {
                            "name": "section_159641_row_743390",
                            "label": "",
                            "order": 0,
                            "controls": [
                                {
                                    "type": "checkbox",
                                    "name": "control_checkbox_982449",
                                    "fieldName": "control_checkbox_982449",
                                    "label": "Accetta?",
                                    "order": 0,
                                    "defaultValue": "",
                                    "placeholder": "",
                                    "value": "",
                                    "className": "col-md-12",
                                    "readonly": false,
                                    "isUserData": false,
                                    "userDataType": "",
                                    "info": "",
                                    "labelBold": false,
                                    "labelItalic": false,
                                    "labelUnderline": false,
                                    "required": false,
                                    "isMultiLine": false,
                                    "isInteger": false,
                                    "decimalPlace": 0,
                                    "isTodayValue": false,
                                    "dateFormat": "dd/mm/yy",
                                    "isMultiple": false,
                                    "isAjax": false,
                                    "dataOptions": [],
                                    "ajaxDataUrl": "",
                                    "isChecked": false
                                }
                            ]
                        },
                        {
                            "name": "section_159641_row_276234",
                            "label": "",
                            "order": 0,
                            "controls": [
                                {
                                    "type": "datepicker",
                                    "name": "control_datepicker_207282",
                                    "fieldName": "control_datepicker_207282",
                                    "label": "Data",
                                    "order": 0,
                                    "defaultValue": "",
                                    "placeholder": "",
                                    "value": "",
                                    "className": "col-md-12",
                                    "readonly": false,
                                    "isUserData": false,
                                    "userDataType": "",
                                    "info": "",
                                    "labelBold": false,
                                    "labelItalic": false,
                                    "labelUnderline": false,
                                    "required": false,
                                    "isMultiLine": false,
                                    "isInteger": false,
                                    "decimalPlace": 0,
                                    "isTodayValue": false,
                                    "dateFormat": "dd/mm/yy",
                                    "isMultiple": false,
                                    "isAjax": false,
                                    "dataOptions": [],
                                    "ajaxDataUrl": "",
                                    "isChecked": false
                                }
                            ]
                        }
                    ],
                    "labelPosition": "left",
                    "isDynamic": false,
                    "minInstance": 1,
                    "maxInstance": 0,
                    "instances": [],
                    "title": "Sez. 3"
                }
            ],
            "layout": "collapse",
            "_uniqueId": 0.6242151290232067
        }
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/forms/v2/{form}/form-structure

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
form int The ID of the Form to retrieve.

Save Form Draft

This endpoint saves a Form Draft.

Example request:

curl -X POST https://api.mycitydemo.it/api/v1/scenarios/{scenario}/forms/v2/{form}/draft/save \
    -H 'accept: application/json' \
    -F 'draft_data= [
        {"control":"control_text_831504","value":"Mario"},
        {"control":"control_datepicker_768970","value":"08/08/1997"},
        {"control":"control_select_789470","value":"Maschio"},
        {"control":"control_email_496703","value":"mariorossi@mycity.it"},
        {"control":"control_number_609668","value":"1234567899"},
        {"control":"control_file_400955","value":["mycity.jpeg", "scuola.jpeg"]},
        {"control":"control_checkbox_221157","value":true}]' \
    -F 'attachments[]=@/home/utente/Scrivania/scuola.jpeg'

Example response:


    {
        "data": {
            "id": 33,
            "type": "draft",
            "data": [
                {
                    "control": "control_select_706121",
                    "value": "1"
                },
                {
                    "control": "control_text_100583",
                    "value": "MRARSI97M07Z100L"
                },
                {
                    "control": "control_email_585578",
                    "value": "mariorossi@mycity.it"
                },
                {
                    "control": "control_text_238990",
                    "value": "Mario"
                },
                {
                    "control": "control_datepicker_419122",
                    "value": "05/01/2022"
                },
                {
                    "control": "control_number_331310",
                    "value": "1234567889"
                },
                {
                    "control": "control_checkbox_318870",
                    "value": true
                },
                {
                    "control": "control_file_965933",
                    "value": [
                        {
                            "id": 3233,
                            "collection_name": "attachments",
                            "name": "lorem",
                            "file_name": "lorem.jpg",
                            "mime_type": "image/jpeg",
                            "size": 437243,
                            "human_readable_size": "427 KB",
                            "order_column": 2833,
                            "file_type": "image",
                            "url": "https://bussola-dev.s3.eu-west-1.amazonaws.com/3233/lorem.jpg",
                            "thumb_url": null,
                            "created_at": "2021-09-15 14:13:27",
                            "liked": null,
                            "likes": 0,
                            "shared": null,
                            "shares": 0,
                            "links": [
                                {
                                    "rel": "self",
                                    "href": "http://api.mycity.social/api/v1/media/3233"
                                }
                            ]
                        },
                        {
                            "id": 3234,
                            "collection_name": "attachments",
                            "name": "lorem",
                            "file_name": "lorem.jpg",
                            "mime_type": "image/jpeg",
                            "size": 888541,
                            "human_readable_size": "867.72 KB",
                            "order_column": 2834,
                            "file_type": "image",
                            "url": "https://bussola-dev.s3.eu-west-1.amazonaws.com/3234/lorem.jpg",
                            "thumb_url": null,
                            "created_at": "2021-09-15 14:13:34",
                            "liked": null,
                            "likes": 0,
                            "shared": null,
                            "shares": 0,
                            "links": [
                                {
                                    "rel": "self",
                                    "href": "http://api.mycity.social/api/v1/media/3234"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    }

HTTP Request

POST api/v1/scenarios/{scenario}/forms/v2/{form}/draft/save

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
form int The ID of the Form to retrieve.

Get Form Draft

This endpoint retrieves a Draft.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/forms/v2/{form}/draft/{draft}" \
-H "Accept: application/json"

Example response:


    {
        "data": {
            "id": 33,
            "type": "draft",
            "data": [
                {
                    "control": "control_select_706121",
                    "value": "1"
                },
                {
                    "control": "control_text_100583",
                    "value": "MRARSI97M07Z100L"
                },
                {
                    "control": "control_email_585578",
                    "value": "mariorossi@mycity.it"
                },
                {
                    "control": "control_text_238990",
                    "value": "Mario"
                },
                {
                    "control": "control_datepicker_419122",
                    "value": "05/01/2022"
                },
                {
                    "control": "control_number_331310",
                    "value": "1234567889"
                },
                {
                    "control": "control_checkbox_318870",
                    "value": true
                },
                {
                    "control": "control_file_965933",
                    "value": [
                        {
                            "id": 3233,
                            "collection_name": "attachments",
                            "name": "lorem",
                            "file_name": "lorem.jpg",
                            "mime_type": "image/jpeg",
                            "size": 437243,
                            "human_readable_size": "427 KB",
                            "order_column": 2833,
                            "file_type": "image",
                            "url": "https://bussola-dev.s3.eu-west-1.amazonaws.com/3233/lorem.jpg",
                            "thumb_url": null,
                            "created_at": "2021-09-15 14:13:27",
                            "liked": null,
                            "likes": 0,
                            "shared": null,
                            "shares": 0,
                            "links": [
                                {
                                    "rel": "self",
                                    "href": "http://api.mycity.social/api/v1/media/3233"
                                }
                            ]
                        },
                        {
                            "id": 3234,
                            "collection_name": "attachments",
                            "name": "lorem",
                            "file_name": "lorem.jpg",
                            "mime_type": "image/jpeg",
                            "size": 888541,
                            "human_readable_size": "867.72 KB",
                            "order_column": 2834,
                            "file_type": "image",
                            "url": "https://bussola-dev.s3.eu-west-1.amazonaws.com/3234/lorem.jpg",
                            "thumb_url": null,
                            "created_at": "2021-09-15 14:13:34",
                            "liked": null,
                            "likes": 0,
                            "shared": null,
                            "shares": 0,
                            "links": [
                                {
                                    "rel": "self",
                                    "href": "http://api.mycity.social/api/v1/media/3234"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    }

HTTP Request

GET api/v1/scenarios/{scenario}/forms/v2/{form}/draft

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
form int The ID of the Form to retrieve.

Get Draft

This endpoint retrieves a Form Draft.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/forms/v2/{form}/draft/{draft}" \
-H "Accept: application/json"

Example response:


    {
        "data": {
            "id": 33,
            "type": "draft",
            "data": [
                {
                    "control": "control_select_706121",
                    "value": "1"
                },
                {
                    "control": "control_text_100583",
                    "value": "MRARSI97M07Z100L"
                },
                {
                    "control": "control_email_585578",
                    "value": "mariorossi@mycity.it"
                },
                {
                    "control": "control_text_238990",
                    "value": "Mario"
                },
                {
                    "control": "control_datepicker_419122",
                    "value": "05/01/2022"
                },
                {
                    "control": "control_number_331310",
                    "value": "1234567889"
                },
                {
                    "control": "control_checkbox_318870",
                    "value": true
                },
                {
                    "control": "control_file_965933",
                    "value": [
                        {
                            "id": 3233,
                            "collection_name": "attachments",
                            "name": "lorem",
                            "file_name": "lorem.jpg",
                            "mime_type": "image/jpeg",
                            "size": 437243,
                            "human_readable_size": "427 KB",
                            "order_column": 2833,
                            "file_type": "image",
                            "url": "https://bussola-dev.s3.eu-west-1.amazonaws.com/3233/lorem.jpg",
                            "thumb_url": null,
                            "created_at": "2021-09-15 14:13:27",
                            "liked": null,
                            "likes": 0,
                            "shared": null,
                            "shares": 0,
                            "links": [
                                {
                                    "rel": "self",
                                    "href": "http://api.mycity.social/api/v1/media/3233"
                                }
                            ]
                        },
                        {
                            "id": 3234,
                            "collection_name": "attachments",
                            "name": "lorem",
                            "file_name": "lorem.jpg",
                            "mime_type": "image/jpeg",
                            "size": 888541,
                            "human_readable_size": "867.72 KB",
                            "order_column": 2834,
                            "file_type": "image",
                            "url": "https://bussola-dev.s3.eu-west-1.amazonaws.com/3234/lorem.jpg",
                            "thumb_url": null,
                            "created_at": "2021-09-15 14:13:34",
                            "liked": null,
                            "likes": 0,
                            "shared": null,
                            "shares": 0,
                            "links": [
                                {
                                    "rel": "self",
                                    "href": "http://api.mycity.social/api/v1/media/3234"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    }

HTTP Request

GET api/v1/scenarios/{scenario}/forms/v2/{form}/draft/{draft}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
form int The ID of the Form to retrieve.
draft int The ID of the draft to retrieve.

Send form user data

This endpoint permits to save the user form data.

Example request:

curl -X POST https://api.mycitydemo.it/api/v1/scenarios/{scenario}/forms/v2/{form}/formuserdata \
    -H 'accept: application/json' \
    -F 'form_user_data=
    {
        "data": 
            "sections": [
                {
                "title": "Section 1",
                "items": [
                    {
                    "label": "Document",
                    "value": ["document.pdf","document1.pdf"],
                    "type": "file"
                    },
                    {
                    "label": "Accept the terms?",
                    "value": true,
                    "type": "checkbox"
                    }
                ]
                },
                {
                "title": "Section 2",
                "items": [
                    {
                    "label": "Lorem",
                    "value": "Ipsum",
                    "type": "text"
                    },
                    {
                    "label": "Gender",
                    "value": "Female",
                    "type": "select"
                    },
                    {
                    "label": "Information about lorem ipsum",
                    "value": "",
                    "type": "info"
                    }
                ]
            }
        ]
    }' \
    -F 'email_confirmation=mariorossi@mario.com' \
    -F 'attachments[]=@/home/utente/Scrivania/test.pdf'

Example response:


    {
        "data":{
            "success": "Istanza inviato con successo!"
        }
    }

HTTP Request

POST api/v1/scenarios/{scenario}/forms/v2/{form}/formuserdata

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
form int The ID of the Form to retrieve.

Send form user data to get the preview pdf file

This endpoint permits to get the preview pdf file of form user data.

Example request:

curl -X POST https://api.mycitydemo.it/api/v1/scenarios/{scenario}/forms/v2/{form}/formuserdata/preview \
    -H 'accept: application/json' \
    -F 'form_user_data=
    {
        "data": 
            "sections": [
                {
                "title": "Section 1",
                "items": [
                    {
                    "label": "Document",
                    "value": ["document.pdf","document1.pdf"],
                    "type": "file"
                    },
                    {
                    "label": "Accept the terms?",
                    "value": true,
                    "type": "checkbox"
                    }
                ]
                },
                {
                "title": "Section 2",
                "items": [
                    {
                    "label": "Lorem",
                    "value": "Ipsum",
                    "type": "text"
                    },
                    {
                    "label": "Gender",
                    "value": "Female",
                    "type": "select"
                    },
                    {
                    "label": "Information about lorem ipsum",
                    "value": "",
                    "type": "info"
                    }
                ]
            }
        ]
    }'

Example response:


    Pdf file

HTTP Request

POST api/v1/scenarios/{scenario}/forms/v2/{form}/formuserdata/preview

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
form int The ID of the Form to retrieve.

Agendas

Get all Agendas

This endpoint retrieves all Agendas from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/agendas" \
-H "Accept: application/json"

Example response:

{
    {
        "data":[
           {
              "id":1098,
              "type":"agendas",
              "title":"Lorem Ipsum",
              "permalink":"florem-ipsum",
              "abstract":"Lorem Ipsum un testo segnaposto utilizzato nel settore della tipografia e della stampa.",
              "body":"Lorem Ipsum un testo segnaposto utilizzato nel settore della tipografia e della stampa. Lorem Ipsum considerato il testo segnaposto standard sin dal sedicesimo secolo, quando un anonimo tipografo prese una cassetta di caratteri e li assembl per preparare un testo campione.",
              "publish_date":"2020-05-15 18:20:00",
              "unpublish_date":null,
              "pois":[],
              "gallery":[],
              "attachments":[],
              "services": [],
              "related":[],
              "image_url":null,
              "created_at":null,
              "updated_at":null,
              "deleted_at":null,
              "links":[
                 {
                    "rel":"self",
                    "href":"http://api.mycity.social/api/v1/scenarios/5/agendas/1098"
                 },
                 {
                    "rel":"gallery",
                    "href":"http://api.mycity.social/api/v1/scenarios/5/agendas/1098/gallery"
                 },
                 {
                    "rel":"menu",
                    "href":"http://api.mycity.social/api/v1/scenarios/5/agendas/1098/menu"
                 },
                 {
                    "rel":"pois",
                    "href":"http://api.mycity.social/api/v1/scenarios/5/agendas/1098/pois"
                 },
                 {
                    "rel":"attachments",
                    "href":"http://api.mycity.social/api/v1/scenarios/5/agendas/1098/attachments"
                 },
                 {
                    "rel":"related",
                    "href":"http://api.mycity.social/api/v1/scenarios/5/agendas/1098/related"
                 }
              ],
              "deeplink":"mycity://scenarios/5/agendas/1098",
              "share_url":"http://istituzionale.mycity.local/agenda-smart/1098/lorem-ipsum",
              "liked":null,
              "likes":1,
              "shared":null,
              "shares":0
           },
           {
              "id":1101,
              "type":"agendas",
              "title":"Ipsum Lorem",
              "permalink":"ipsum-lorem",
              "abstract":"Lorem ipsum",
              "body":"Lorem Ipsum un testo segnaposto utilizzato nel settore della tipografia e della stampa. Lorem Ipsum considerato il testo segnaposto standard sin dal sedicesimo secolo, quando un anonimo tipografo prese una cassetta di caratteri e li assembl per preparare un testo campione.",
              "publish_date":"2020-05-25 15:04:00",
              "unpublish_date":null,
              "pois":[],
              "gallery":[],
              "attachments":[],
              "services": [],
              "related":[],
              "image_url":null,
              "created_at":null,
              "updated_at":null,
              "deleted_at":null,
              "links":[
                 {
                    "rel":"self",
                    "href":"http://api.mycity.social/api/v1/scenarios/5/agendas/1101"
                 },
                 {
                    "rel":"gallery",
                    "href":"http://api.mycity.social/api/v1/scenarios/5/agendas/1101/gallery"
                 },
                 {
                    "rel":"menu",
                    "href":"http://api.mycity.social/api/v1/scenarios/5/agendas/1101/menu"
                 },
                 {
                    "rel":"pois",
                    "href":"http://api.mycity.social/api/v1/scenarios/5/agendas/1101/pois"
                 },
                 {
                    "rel":"attachments",
                    "href":"http://api.mycity.social/api/v1/scenarios/5/agendas/1101/attachments"
                 },
                 {
                    "rel":"related",
                    "href":"http://api.mycity.social/api/v1/scenarios/5/agendas/1101/related"
                 }
              ],
              "deeplink":"mycity://scenarios/5/agendas/1101",
              "share_url":"http://istituzionale.mycity.local/agenda-smart/1101/tetstst-tst",
              "liked":null,
              "likes":0,
              "shared":null,
              "shares":0
           }
        ],
        "links":{
           "first":"http://istituzionale.mycity.local/api/v1/scenarios/5/agendas?page=1",
           "last":"http://istituzionale.mycity.local/api/v1/scenarios/5/agendas?page=1",
           "prev":null,
           "next":null
        },
        "meta":{
           "current_page":1,
           "from":1,
           "last_page":1,
           "path":"http://istituzionale.mycity.local/api/v1/scenarios/5/agendas",
           "per_page":50,
           "to":2,
           "total":2
        }
     }
}

HTTP Request

GET api/v1/scenarios/{scenario}/agendas

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: pois, services).

Get all Agendas V2

This endpoint retrieves Agendas tree from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/agendas/v2" \
-H "Accept: application/json"

Example response:

{
    {
        "data": [
            {
                "id": 705023,
                "type": "menus",
                "title": "Prenotazioni Uffici",
                "abstract": null,
                "icon_url": "http://api.mycity.social/images/app_icons/30-moduli-comune.png",
                "icon": "30-moduli-comune",
                "as_map": 0,
                "menu_color": null,
                "contents": [
                    {
                        "id": 258175,
                        "type": "agendas",
                        "title": "Ufficio Relazioni con il Pubblico",
                        "permalink": "carta-d-identita-elettronica",
                        "abstract": "",
                        "body": "

N.B. PER CARTE D'IDENTITA' E VOLTURA VEICOLI E' OBBLIGATORIO FISSARE UN APPUNTAMENTO.

\r\n\r\n

Per tutte le altre tipologie è possibile prenotare un appuntamento oppure utilizzare gli orari di apertura libera:

\r\n\r\n

da lunedì a giovedì dalle ore 10.00 alle ore 13.00

\r\n\r\n

venerdì dalle ore 8.30 alle ore 10.00

", "icon_url": "http://api.mycity.social/images/app_icons/40-persone-comunita.png", "icon": "40-persone-comunita", "publish_date": "2020-09-07 08:59:00", "unpublish_date": null, "pois": [], "services": [], "liked": null, "likes": 0, "shared": null, "shares": 0, "links": [ { "rel": "self", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/258175" }, { "rel": "gallery", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/258175/gallery" }, { "rel": "menu", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/258175/menu" }, { "rel": "pois", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/258175/pois" }, { "rel": "attachments", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/258175/attachments" }, { "rel": "related", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/258175/related" }, { "rel": "pois", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/258175/pois" } ], "deeplink": "myviadana://scenarios/287/agendas/258175", "share_url": "http://api.mycity.social/agenda-smart/258175/carta-d-identita-elettronica" }, { "id": 704965, "type": "agendas", "title": "Ufficio Anagrafe", "permalink": "ufficio-anagrafe", "abstract": null, "body": null, "icon_url": "http://api.mycity.social/images/app_icons/00-standard.png", "icon": "00-standard", "publish_date": "2022-02-11 15:28:59", "unpublish_date": null, "pois": [], "services": [], "liked": null, "likes": 0, "shared": null, "shares": 0, "links": [ { "rel": "self", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/704965" }, { "rel": "gallery", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/704965/gallery" }, { "rel": "menu", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/704965/menu" }, { "rel": "pois", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/704965/pois" }, { "rel": "attachments", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/704965/attachments" }, { "rel": "related", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/704965/related" }, { "rel": "pois", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/704965/pois" } ], "deeplink": "myviadana://scenarios/287/agendas/704965", "share_url": "http://api.mycity.social/agenda-smart/704965/ufficio-anagrafe" } ], "deeplink": "myviadana://scenarios/287/menus/705023", "share_url": "http://api.mycity.social/menu/705023/prenotazioni-uffici" }, { "id": 705022, "type": "menus", "title": "Eventi", "abstract": null, "icon_url": "http://api.mycity.social/images/app_icons/150-svago-cinema.png", "icon": "150-svago-cinema", "as_map": 0, "menu_color": null, "contents": [ { "id": 258196, "type": "agendas", "title": "Mostra del pittore", "permalink": "mostra-pittore", "abstract": "", "body": "

Descrizione dell'evento

", "icon_url": "http://api.mycity.social/images/app_icons/200-lavori-imbianchino.png", "icon": "200-lavori-imbianchino", "publish_date": "2020-09-07 09:28:01", "unpublish_date": null, "pois": [], "services": [], "liked": null, "likes": 0, "shared": null, "shares": 0, "links": [ { "rel": "self", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/258196" }, { "rel": "gallery", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/258196/gallery" }, { "rel": "menu", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/258196/menu" }, { "rel": "pois", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/258196/pois" }, { "rel": "attachments", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/258196/attachments" }, { "rel": "related", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/258196/related" }, { "rel": "pois", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/258196/pois" } ], "deeplink": "myviadana://scenarios/287/agendas/258196", "share_url": "http://api.mycity.social/agenda-smart/258196/mostra-pittore" }, { "id": 704971, "type": "agendas", "title": "Concerto di The Weeknd", "permalink": "concerto-the-weeknd", "abstract": "Concerto di The Weeknd", "body": "

Concerto di The Weeknd

", "icon_url": "http://api.mycity.social/images/app_icons/150-svago-musica.png", "icon": "150-svago-musica", "publish_date": "2022-02-17 12:51:15", "unpublish_date": null, "pois": [], "services": [], "liked": null, "likes": 0, "shared": null, "shares": 0, "links": [ { "rel": "self", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/704971" }, { "rel": "gallery", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/704971/gallery" }, { "rel": "menu", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/704971/menu" }, { "rel": "pois", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/704971/pois" }, { "rel": "attachments", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/704971/attachments" }, { "rel": "related", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/704971/related" }, { "rel": "pois", "href": "http://api.mycity.social/api/v1/scenarios/287/agendas/704971/pois" } ], "deeplink": "myviadana://scenarios/287/agendas/704971", "share_url": "http://api.mycity.social/agenda-smart/704971/concerto-the-weeknd" } ], "deeplink": "myviadana://scenarios/287/menus/705022", "share_url": "http://api.mycity.social/menu/705022/eventi" } ] }

HTTP Request

GET api/v1/scenarios/{scenario}/agendas/v2

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: pois, services).

Get a specific Agenda

This endpoint retrieves a specific Agenda from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/agendas/{agenda}" \
-H "Accept: application/json"

Example response:


    {
        "data":{
           "id":1098,
           "type":"agendas",
           "title":"Lorem Ipsum",
           "permalink":"lorem-ipsum",
           "abstract":"Lorem Ipsum un testo segnaposto utilizzato nel settore della tipografia e della stampa.",
           "body":"Lorem Ipsum un testo segnaposto utilizzato nel settore della tipografia e della stampa. Lorem Ipsum considerato il testo segnaposto standard sin dal sedicesimo secolo, quando un anonimo tipografo prese una cassetta di caratteri e li assembl per preparare un testo campione. sopravvissuto non solo a pi di cinque secoli, ma anche al passaggio alla videoimpaginazione, pervenendoci sostanzialmente inalterato. Fu reso popolare, negli anni 60, con la diffusione dei fogli di caratteri trasferibili Letraset, che contenevano passaggi del Lorem Ipsum, e pi recentemente da software di impaginazione come Aldus PageMaker, che includeva versioni del Lorem Ipsum.",
           "publish_date":"2020-05-15 18:20:00",
           "unpublish_date":null,
           "pois":[
     
           ],
           "gallery":[
     
           ],
           "attachments":[
     
           ],
           "services": [
           
           ],
           "related":[
     
           ],
           "image_url":null,
           "created_at":null,
           "updated_at":null,
           "deleted_at":null,
           "meta":[
     
           ],
           "links":[
              {
                 "rel":"self",
                 "href":"http://api.mycity.social/api/v1/scenarios/5/agendas/1098"
              },
              {
                 "rel":"gallery",
                 "href":"http://api.mycity.social/api/v1/scenarios/5/agendas/1098/gallery"
              },
              {
                 "rel":"menu",
                 "href":"http://api.mycity.social/api/v1/scenarios/5/agendas/1098/menu"
              },
              {
                 "rel":"pois",
                 "href":"http://api.mycity.social/api/v1/scenarios/5/agendas/1098/pois"
              },
              {
                 "rel":"attachments",
                 "href":"http://api.mycity.social/api/v1/scenarios/5/agendas/1098/attachments"
              },
              {
                 "rel":"related",
                 "href":"http://api.mycity.social/api/v1/scenarios/5/agendas/1098/related"
              }
           ],
           "deeplink":"mycity://scenarios/5/agendas/1098",
           "share_url":"http://istituzionale.mycity.local/agenda-smart/1098/lorem-ipsum",
           "liked":null,
           "likes":1,
           "shared":null,
           "shares":0
        }
     }

HTTP Request

GET api/v1/scenarios/{scenario}/agendas/{agenda}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
agenda int The ID of the Agenda to retrieve.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: pois, services).

Get all Services from Agenda

This endpoint retrieves all Services belonging to an agenda from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/agendas/{agenda}/services" \
-H "Accept: application/json"

Example response:


   {
       "data": [
        {
            "id": 1,
            "type": "agendaservices",
            "agenda_id": 1256,
            "scenario_id": 5,
            "title": "Lorem Ipsum",
            "description": "Lorem ipsum ipsum lorem",
            "show_online": 1,
            "with_authentication": 0,
            "required_attachments": 0,
            "required_privacy": 0,
            "custom_input_fields": [
                {
                    "id": "3BKq5h9IXlzjp53Y",
                    "label": "Telefono",
                    "required": false,
                    "multiline": false,
                    "default": ""
                },
                {
                    "id": "hC2yoseqgEiqbFJm",
                    "label": "Messaggio",
                    "required": false,
                    "multiline": true,
                    "default": ""
                }
            ],
            "has_max_days": 0,
            "has_min_days": 0,
            "max_days": 1,
            "min_days": 1,
            "type_event": 0,
            "date": "0000-00-00 00:00:00",
            "available_places": 0,
            "max_total_places": 1,
            "attachments": [
                {
                    "id": 1133,
                    "collection_name": "attachments",
                    "name": "covid19",
                    "file_name": "covid19.jpg",
                    "mime_type": "image/jpeg",
                    "size": 63787,
                    "human_readable_size": "62.29 KB",
                    "order_column": 988,
                    "file_type": "image",
                    "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1133/covid19.jpg",
                    "thumb_url": null,
                    "created_at": "2020-05-21 10:52:19",
                    "liked": null,
                    "likes": 0,
                    "shared": null,
                    "shares": 0,
                    "links": [
                        {
                            "rel": "self",
                            "href": "http://api.mycity.social/api/v1/scenarios/5/media/1133"
                        }
                    ]
                },
                {
                    "id": 1135,
                    "collection_name": "attachments",
                    "name": "test",
                    "file_name": "test.jpg",
                    "mime_type": "image/jpeg",
                    "size": 194991,
                    "human_readable_size": "190.42 KB",
                    "order_column": 990,
                    "file_type": "image",
                    "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1135/1440-5_test.jpg",
                    "thumb_url": null,
                    "created_at": "2020-05-22 14:13:18",
                    "liked": null,
                    "likes": 0,
                    "shared": null,
                    "shares": 0,
                    "links": [
                        {
                            "rel": "self",
                            "href": "http://api.mycity.social/api/v1/scenarios/5/media/1135"
                        }
                    ]
                }
            ]
        },
        {
            "id": 2,
            "type": "agendaservices",
            "agenda_id": 1256,
            "scenario_id": 5,
            "title": "Event",
            "description": "Evento comunale",
            "show_online": 1,
            "with_authentication": 0,
            "required_attachments": 0,
            "required_privacy": 0,
            "custom_input_fields": [
                {
                    "id": "3BKq5h9IXlzjp53Y",
                    "label": "Telefono",
                    "required": false,
                    "multiline": false,
                    "default": ""
                },
                {
                    "id": "hC2yoseqgEiqbFJm",
                    "label": "Messaggio",
                    "required": false,
                    "multiline": true,
                    "default": ""
                }
            ],
            "has_max_days": 0,
            "has_min_days": 0,
            "max_days": 1,
            "min_days": 1,
            "type_event": 1,
            "date": "2020-09-10 23:07:00",
            "available_places": 10,
            "max_total_places": 3,
            "attachments": [
                {
                    "id": 1132,
                    "collection_name": "attachments",
                    "name": "1440-5_test",
                    "file_name": "1440-5_test.jpg",
                    "mime_type": "image/jpeg",
                    "size": 194991,
                    "human_readable_size": "190.42 KB",
                    "order_column": 987,
                    "file_type": "image",
                    "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/1132/1440-5_test.jpg",
                    "thumb_url": null,
                    "created_at": "2020-05-21 10:52:01",
                    "liked": null,
                    "likes": 0,
                    "shared": null,
                    "shares": 0,
                    "links": [
                        {
                            "rel": "self",
                            "href": "http://api.mycity.social/api/v1/scenarios/5/media/1132"
                        }
                    ]
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/agendas/{agenda}/services

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
agenda int The ID of the Agenda to retrieve.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: attachments).

Get a specific Agenda Service

This endpoint retrieves a specific Agenda Service from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/agendas/{agenda}/services/{service}" \
-H "Accept: application/json"

Example response:


    {
        "data":
           {
            "id": 1,
            "type": "agendaservices",
            "agenda_id": 1256,
            "scenario_id": 5,
            "title": "Lorem Ipsum",
            "description": "Lorem ipsum ipsum lorem",
            "show_online": 1,
            "with_authentication": 0,
            "required_attachments": 0,
            "required_privacy": 0,
            "custom_input_fields": [
                {
                    "id": "3BKq5h9IXlzjp53Y",
                    "label": "Telefono",
                    "required": false,
                    "multiline": false,
                    "default": ""
                },
                {
                    "id": "hC2yoseqgEiqbFJm",
                    "label": "Messaggio",
                    "required": false,
                    "multiline": true,
                    "default": ""
                }
            ],
            "has_max_days": 0,
            "has_min_days": 0,
            "max_days": 1,
            "min_days": 1,
            "type_event": 0,
            "date": "0000-00-00 00:00:00",
            "available_places": 0,
            "max_total_places": 1
           }
     }

HTTP Request

GET api/v1/scenarios/{scenario}/agendas/{agenda}/services/{service}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
agenda int The ID of the Agenda to retrieve.
service int The ID of the Service to retrieve.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: attachments).

Get Service, free slots by specific date

This endpoint retrieves Service specific date available time slots.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/agendas/{agenda}/services/{service}/timetables/date/{date}" \
-H "Accept: application/json"

Example response:


{
    "data": {
        "timetables":[
           "11:35",
           "12:10",
           "14:35",
           "15:10",
           "15:45"
        ],
        "duration":35
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/agendas/{agenda}/services/{service}/timetables/date/{date}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
agenda int The ID of the Agenda to retrieve.
service int The ID of the Service to retrieve.
date date The date in which to retrive available time slots (format: "dd-mm-yyyy").

Get Service, free slots by date range

This endpoint retrieves Service available time slots by date range.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/agendas/{agenda}/services/{service}/timetables-by-range?start_date={start}&end_date={end}" \
-H "Accept: application/json"

Example response:


{
    "data": {
    [
        {
            "date": "2020-09-21",
            "timetables": [
                "08:00",
                "08:05",
                "08:10"
            ],
            "duration": 5
        },
        {
            "date": "2020-09-28",
            "timetables": [
                "14:10",
                "14:15",
                "14:20",
                "14:25",
                "14:30",
                "14:35",
                "14:40",
                "14:45",
                "14:50",
                "14:55",
                "15:00",
                "15:05",
                "15:10"
            ],
            "duration": 5
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/agendas/{agenda}/services/{service}/timetables-by-range?start_date={start}&end_date={end}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
agenda int The ID of the Agenda to retrieve.
service int The ID of the Service to retrieve.

Get Parameters

Parameter Type Description
start_date date Starting date (format: "dd-mm-yyyy").
end_date date Ending date (format: "dd-mm-yyyy").

Get Service first free date

This endpoint retrieves a specific Agenda Service first available date.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/agendas/{agenda}/services/{service}/first-free" \
-H "Accept: application/json"

Example response:


{
    "data": {
        "date":"2020-06-29",
        "timetables":[
        "08:05",
        "08:10",
        "08:15",
        "08:20",
        "08:25",
        "08:30",
        "08:35",
        "08:40",
        "08:45",
        "08:50"
        ]
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/agendas/{agenda}/services/{service}/first-free

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
agenda int The ID of the Agenda to retrieve.
service int The ID of the Service to retrieve.

Add appointment to the agenda

This endpoint permits to add an appointment to the specific agenda.

Example request for service appointments:

curl -X POST https://api.mycitydemo.it/api/v1/scenarios/{scenario}/agendas/book \
    -H 'accept: application/json' \
    -F scenario_id=5 \
    -F service_id=3 \
    -F agenda_id=1098 \
    -F 'name=Mario Rossi' \
    -F email=mariorossi@mario.com \
    -F date=29-06-2020 \
    -F time=08:30 \
    -F custom_input_fields=[{"id":"3BKq5h9IXlzjp53Y","label":"Telefono","required":false,"multiline":false,"value":"3383063123"},{"id":"5w9TvkZoXIAxvwg6","label":"Messaggio","required":false,"multiline":true,"value":"Lorem Ipsum"}] \
    -F 'attachments[]=@/home/utente/Scrivania/test.pdf'

Example response:


    {
        "data": {
            "success":"Prenotato con successo!"
        }
    }

Example request for event appointment:

curl -X POST https://api.mycitydemo.it/api/v1/scenarios/{scenario}/agendas/book \
    -H 'accept: application/json' \
    -F scenario_id=5 \
    -F service_id=3 \
    -F info_id=1098 \
    -F 'name=Mario Rossi' \
    -F email=mariorossi@mario.com \
    -F posti=2 \
    -F custom_input_fields=[{"id":"3BKq5h9IXlzjp53Y","label":"Telefono","required":false,"multiline":false,"value":"3383063123"},{"id":"5w9TvkZoXIAxvwg6","label":"Messaggio","required":false,"multiline":true,"value":"Lorem Ipsum"}] \
    -F 'attachments[]=@/home/utente/Scrivania/test.pdf'

Example response:


    {
        "success":"Prenotato con successo!"
    }

HTTP Request

POST api/v1/scenarios/{scenario}/agendas/book

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Cancel appointment

This endpoint permits to cancel an appointment.

Example request:

curl -X POST https://api.mycitydemo.it/api/v1/scenarios/{scenario}/agendas/{appointment}/cancel \
    -H 'accept: application/json' \
    -F 'token=kTSPlOSoTSjZvGtl'

Example response:


    {
        "data": {
            "success":"Prenotazione disdetta con successo!"
        }
    }

HTTP Request

POST api/v1/scenarios/{scenario}/agendas/{appointment}/cancel

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
appointment int The ID of the Appointment.

Modulistica

Get modulistica tree

This endpoint retrieves the modulistica tree (only first level or all the tree).

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/modulistica" \
-H "Accept: application/json"

Example response:


    {
        "data": [
            {
                "id": 5134,
                "type": "menus",
                "title": "Lorem ipsum",
                "permalink": "lorem-ipsum",
                "abstract": "Where can I get some?",
                "body": "There are many variations of passages of Lorem Ipsum available.",
                "icon_url": "https://api.mycitydemo.it/images/app_icons/00-standard.png",
                "icon": "00-standard",
                "publish_date": null,
                "unpublish_date": null,
                "contents": [],
                "contacts": [
                    {
                        "id": 222,
                        "type": "employees",
                        "title": "Fernando Parisi",
                        "permalink": "fernando-parisi",
                        "abstract": "Omnis labore ratione vel temporibus. Ut reiciendis autem a. Reprehenderit quas nemo dolore provident soluta quod veritatis.",
                        "body": "Harum consequatur vitae ut reprehenderit fuga. Ipsa voluptatibus cumque vero architecto omnis rerum repellendus nobis. Vel ut ut dolore. Deserunt et eos vero animi accusamus odio.\n\nSed aspernatur voluptatem et laudantium esse. Sint omnis magnam expedita dolores inventore eius beatae. Dicta consectetur eius blanditiis exercitationem ea dolore.\n\nRepellat nihil cumque ex ut et error facilis. Possimus dolor ut aut sint eum qui. Sit sunt aliquam excepturi dolorem est in. Labore libero quas accusamus in eum natus.",
                        "publish_date": "2019-01-07 15:22:49",
                        "unpublish_date": null,
                        "gallery": [],
                        "attachments": [],
                        "related": [],
                        "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/85/generic-person.jpg",
                        "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/85/conversions/thumb.jpg",
                        "links": [
                            {
                                "rel": "self",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/222"
                            },
                            {
                                "rel": "gallery",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/222/gallery"
                            },
                            {
                                "rel": "menu",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/222/menu"
                            },
                            {
                                "rel": "attachments",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/222/attachments"
                            },
                            {
                                "rel": "offices",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/222/offices"
                            },
                            {
                                "rel": "administrations",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/222/administrations"
                            },
                            {
                                "rel": "related",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/222/related"
                            }
                        ],
                        "deeplink": "mycity://scenarios/5/employees/222",
                        "share_url": "https://api.mycitydemo.it/personale/222/fernando-parisi",
                        "table": []
                    },
                    {
                        "id": 229,
                        "type": "employees",
                        "title": "Elda Serra",
                        "permalink": "elda-serra",
                        "abstract": "Ut error maxime omnis exercitationem dignissimos. Qui sapiente sunt ut ut consectetur sed aut. Rerum corporis sit blanditiis ut.",
                        "body": "Tempora eaque error et tempora aperiam ad. Voluptatem est et nobis nisi labore ut. Necessitatibus sit consequuntur et.\n\nEum consequatur neque praesentium qui commodi eos. Dolore fugiat aut libero autem. Quia voluptatem similique sed minus delectus est aut. Aspernatur qui inventore eos minima et eligendi aut. Ipsa repellat iste aut quisquam velit.\n\nEsse tempora molestiae aut eum et. Rerum et incidunt eaque qui. Voluptas quo dolorum autem dolorem. Deserunt aut ipsam fugit vel deleniti dolor soluta.",
                        "publish_date": "2019-01-07 15:22:50",
                        "unpublish_date": null,
                        "gallery": [],
                        "attachments": [],
                        "related": [],
                        "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/90/generic-person.jpg",
                        "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/90/conversions/thumb.jpg",
                        "links": [
                            {
                                "rel": "self",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/229"
                            },
                            {
                                "rel": "gallery",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/229/gallery"
                            },
                            {
                                "rel": "menu",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/229/menu"
                            },
                            {
                                "rel": "attachments",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/229/attachments"
                            },
                            {
                                "rel": "offices",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/229/offices"
                            },
                            {
                                "rel": "administrations",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/229/administrations"
                            },
                            {
                                "rel": "related",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/229/related"
                            }
                        ],
                        "deeplink": "mycity://scenarios/5/employees/229",
                        "share_url": "https://api.mycitydemo.it/personale/229/elda-serra",
                        "table": []
                    }
                ],
                "shared": null,
                "shares": 0,
                "deeplink": "mycity://scenarios/5/menus/5134",
                "share_url": "https://api.mycitydemo.it/menu/5134/mamam"
            },
            {
                "id": 4970,
                "type": "menus",
                "title": "Sic mundus",
                "permalink": "sic-mundus",
                "abstract": "Sic mundus creatus est",
                "body": "",
                "icon_url": "https://api.mycitydemo.it/images/app_icons/20-generica-social.png",
                "icon": "20-generica-social",
                "publish_date": "2021-02-18 16:21:54",
                "unpublish_date": null,
                "contents": [
                {
                    "id": 4971,
                    "type": "menus",
                    "title": "Lorem",
                    "permalink": "lorem",
                    "abstract": "We are here lorem",
                    "body": "",
                    "icon_url": "https://api.mycitydemo.it/images/app_icons/20-generica-like.png",
                    "icon": "20-generica-like",
                    "publish_date": "2021-02-18 16:22:41",
                    "unpublish_date": null,
                    "contents": [
                            {
                                "id": 5086,
                                "type": "sheets",
                                "title": "Sheet 1",
                                "permalink": "sheet-1",
                                "abstract": "This is sheet 1",
                                "body": "",
                                "icon_url": "https://api.mycitydemo.it/images/app_icons/.png",
                                "icon": null,
                                "publish_date": "2021-02-19 09:35:48",
                                "unpublish_date": null,
                                "contacts": [
                                    {
                                        "id": 222,
                                        "type": "employees",
                                        "title": "Fernando Parisi",
                                        "permalink": "fernando-parisi",
                                        "abstract": "Omnis labore ratione vel temporibus. Ut reiciendis autem a. Reprehenderit quas nemo dolore provident soluta quod veritatis.",
                                        "body": "Harum consequatur vitae ut reprehenderit fuga. Ipsa voluptatibus cumque vero architecto omnis rerum repellendus nobis. Vel ut ut dolore. Deserunt et eos vero animi accusamus odio.\n\nSed aspernatur voluptatem et laudantium esse. Sint omnis magnam expedita dolores inventore eius beatae. Dicta consectetur eius blanditiis exercitationem ea dolore.\n\nRepellat nihil cumque ex ut et error facilis. Possimus dolor ut aut sint eum qui. Sit sunt aliquam excepturi dolorem est in. Labore libero quas accusamus in eum natus.",
                                        "publish_date": "2019-01-07 15:22:49",
                                        "unpublish_date": null,
                                        "gallery": [],
                                        "attachments": [],
                                        "related": [],
                                        "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/85/generic-person.jpg",
                                        "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/85/conversions/thumb.jpg",
                                        "links": [
                                            {
                                                "rel": "self",
                                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/222"
                                            },
                                            {
                                                "rel": "gallery",
                                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/222/gallery"
                                            },
                                            {
                                                "rel": "menu",
                                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/222/menu"
                                            },
                                            {
                                                "rel": "attachments",
                                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/222/attachments"
                                            },
                                            {
                                                "rel": "offices",
                                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/222/offices"
                                            },
                                            {
                                                "rel": "administrations",
                                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/222/administrations"
                                            },
                                            {
                                                "rel": "related",
                                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/222/related"
                                            }
                                        ],
                                        "deeplink": "mycity://scenarios/5/employees/222",
                                        "share_url": "https://api.mycitydemo.it/personale/222/fernando-parisi",
                                        "table": []
                                    },
                                    {
                                        "id": 229,
                                        "type": "employees",
                                        "title": "Elda Serra",
                                        "permalink": "elda-serra",
                                        "abstract": "Ut error maxime omnis exercitationem dignissimos. Qui sapiente sunt ut ut consectetur sed aut. Rerum corporis sit blanditiis ut.",
                                        "body": "Tempora eaque error et tempora aperiam ad. Voluptatem est et nobis nisi labore ut. Necessitatibus sit consequuntur et.\n\nEum consequatur neque praesentium qui commodi eos. Dolore fugiat aut libero autem. Quia voluptatem similique sed minus delectus est aut. Aspernatur qui inventore eos minima et eligendi aut. Ipsa repellat iste aut quisquam velit.\n\nEsse tempora molestiae aut eum et. Rerum et incidunt eaque qui. Voluptas quo dolorum autem dolorem. Deserunt aut ipsam fugit vel deleniti dolor soluta.",
                                        "publish_date": "2019-01-07 15:22:50",
                                        "unpublish_date": null,
                                        "gallery": [],
                                        "attachments": [],
                                        "related": [],
                                        "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/90/generic-person.jpg",
                                        "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/90/conversions/thumb.jpg",
                                        "links": [
                                            {
                                                "rel": "self",
                                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/229"
                                            },
                                            {
                                                "rel": "gallery",
                                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/229/gallery"
                                            },
                                            {
                                                "rel": "menu",
                                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/229/menu"
                                            },
                                            {
                                                "rel": "attachments",
                                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/229/attachments"
                                            },
                                            {
                                                "rel": "offices",
                                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/229/offices"
                                            },
                                            {
                                                "rel": "administrations",
                                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/229/administrations"
                                            },
                                            {
                                                "rel": "related",
                                                "href": "http://api.mycity.social/api/v1/scenarios/5/employees/229/related"
                                            }
                                        ],
                                        "deeplink": "mycity://scenarios/5/employees/229",
                                        "share_url": "https://api.mycitydemo.it/personale/229/elda-serra",
                                        "table": []
                                    }
                                ],
                                "models": [],
                                "digital_form": "false",
                                "shared": null,
                                "shares": 0,
                                "deeplink": "mycity://scenarios/1/modulistica_schede/5086"
                            },
                            {
                                "id": 5155,
                                "type": "sheets",
                                "title": "Sheet 2",
                                "permalink": "sheet-2",
                                "abstract": "This is sheet 2",
                                "body": "",
                                "icon_url": "https://api.mycitydemo.it/images/app_icons/.png",
                                "icon": null,
                                "publish_date": null,
                                "unpublish_date": null,
                                "contacts": [],
                                "models": [
                                {
                                    "id": 5169,
                                    "type": "forms",
                                    "title": "Model 1",
                                    "attachment": {
                                        "id": 2673,
                                        "collection_name": "forms",
                                        "name": "lorem",
                                        "file_name": "lorem.jpg",
                                        "mime_type": "image/jpeg",
                                        "size": "63787",
                                        "human_readable_size": "62.29 KB",
                                        "order_column": "2315",
                                        "file_type": "image",
                                        "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/2673/lorem.jpg",
                                        "thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/2673/conversions/thumb.jpg",
                                        "created_at": "2021-03-09 11:09:41",
                                        "liked": null,
                                        "likes": 0,
                                        "shared": null,
                                        "shares": 0,
                                        "links": [
                                            {
                                                "rel": "self",
                                                "href": "http://api.mycity.social/api/v1/scenarios/5/media/2673"
                                            }
                                        ]
                                    },
                                    "form": {
                                        "id": 5168,
                                        "type": "forms",
                                        "title": "Digital Form",
                                        "abstract": "This is the digital version of the form",
                                        "body": "",
                                        "formdata": [
                                            {
                                                "type": "number",
                                                "name": "control_number_871467",
                                                "fieldName": "control_number_871467",
                                                "label": "Numero",
                                                "order": 0,
                                                "defaultValue": "",
                                                "placeholder": "",
                                                "value": "",
                                                "className": "col-md-9",
                                                "readonly": false,
                                                "info": "",
                                                "labelBold": false,
                                                "labelItalic": false,
                                                "labelUnderline": false,
                                                "required": false,
                                                "isMultiLine": false,
                                                "isInteger": false,
                                                "decimalPlace": 0,
                                                "isTodayValue": false,
                                                "dateFormat": "dd/mm/yy",
                                                "isMultiple": false,
                                                "isAjax": false,
                                                "dataOptions": [],
                                                "ajaxDataUrl": "",
                                                "isChecked": false
                                            }
                                        ]
                                    }
                                },
                                "digital_form": "true",
                                "shared": null,
                                "shares": 0,
                                "deeplink": "mycity://scenarios/5/modulistica_schede/5155"
                            }
                        ],
                        "contacts": [],
                        "shared": null,
                        "shares": 0,
                        "deeplink": "mycity://scenarios/1/menus/4971",
                        "share_url": "https://api.mycitydemo.it/menu/4971/inside-personal"
                    }
                ],
                "contacts": [],
                "shared": null,
                "shares": 0,
                "deeplink": "mycity://scenarios/1/menus/4970",
                "share_url": "https://api.mycitydemo.it/menu/4970/personal"
            }
        ]
    }

HTTP Request

GET api/v1/scenarios/{scenario}/modulistica

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: contents, contacts, models).

Get a specific Content (Category or Sheet)

This endpoint retrieves a specific Category or Sheet from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/modulistica/content/{content}" \
-H "Accept: application/json"

Example response:


    {
        "data": [
            {
                "id": 5155,
                "type": "sheets",
                "title": "Sheet 2",
                "permalink": "sheet-2",
                "abstract": "This is sheet 2",
                "body": "",
                "icon_url": "https://api.mycitydemo.it/images/app_icons/.png",
                "icon": null,
                "publish_date": null,
                "unpublish_date": null,
                "contacts": [],
                "models": [
                {
                    "id": 5169,
                    "type": "forms",
                    "title": "Model 1",
                    "attachment": {
                        "id": 2673,
                        "collection_name": "forms",
                        "name": "lorem",
                        "file_name": "lorem.jpg",
                        "mime_type": "image/jpeg",
                        "size": "63787",
                        "human_readable_size": "62.29 KB",
                        "order_column": "2315",
                        "file_type": "image",
                        "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/2673/lorem.jpg",
                        "thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/2673/conversions/thumb.jpg",
                        "created_at": "2021-03-09 11:09:41",
                        "liked": null,
                        "likes": 0,
                        "shared": null,
                        "shares": 0,
                        "links": [
                            {
                                "rel": "self",
                                "href": "http://api.mycity.social/api/v1/scenarios/5/media/2673"
                            }
                        ]
                    },
                    "form": {
                        "id": 5168,
                        "type": "forms",
                        "title": "Digital Form",
                        "abstract": "This is the digital version of the form",
                        "body": "",
                        "formdata": [
                            {
                                "type": "number",
                                "name": "control_number_871467",
                                "fieldName": "control_number_871467",
                                "label": "Numero",
                                "order": 0,
                                "defaultValue": "",
                                "placeholder": "",
                                "value": "",
                                "className": "col-md-9",
                                "readonly": false,
                                "info": "",
                                "labelBold": false,
                                "labelItalic": false,
                                "labelUnderline": false,
                                "required": false,
                                "isMultiLine": false,
                                "isInteger": false,
                                "decimalPlace": 0,
                                "isTodayValue": false,
                                "dateFormat": "dd/mm/yy",
                                "isMultiple": false,
                                "isAjax": false,
                                "dataOptions": [],
                                "ajaxDataUrl": "",
                                "isChecked": false
                            }
                        ]
                    }
                },
                "digital_form": "true",
                "shared": null,
                "shares": 0,
                "deeplink": "mycity://scenarios/5/modulistica_schede/5155"
            }
        ]
    }

HTTP Request

GET api/v1/scenarios/{scenario}/modulistica/content/{content}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
content int The ID of the content to retrieve.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: contents, contacts, models).

Download a specific Model attachment

This endpoint retrieves a specific Model attachment from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/modulistica/model/{id}/download/{format?}" \
-H "Accept: application/json"

HTTP Request

GET api/v1/scenarios/{scenario}/modulistica/model/{id}/download/{format?}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
id int The ID of the models attachment to download.
format string The format of the attachment to download.

Send digital form of a Model

This endpoint permits to save the user digital form of a model.

Example request:

curl -X POST https://api.mycitydemo.it/api/v1/scenarios/{scenario}/modulistica/sheet/{sheet}/model/{model}/istanza/{istanza}/send-model-digital-form \
    -H 'accept: application/json' \
    -F 'form_user_data={"data": [{"label": "Document","value": "document.pdf","type": "file"},{"label": "Accept the terms?","value": true,"type": "checkbox"}]}' \
    -F 'attachments[]=@/home/utente/Scrivania/test.pdf'

Example response:


    {
        "data":{
            "success": "Pratica inviato con successo!"
        }
    }

HTTP Request

POST api/v1/scenarios/{scenario}/modulistica/sheet/{sheet}/model/{model}/istanza/{istanza}/send-model-digital-form

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
sheet int The ID of the Sheet.
model int The ID of the Model.
istanza int The ID of the digital Form of the Model.

Send the compiled document of a Model

This endpoint permits to save the user compiled document of a model.

Example request:

curl -X POST https://api.mycitydemo.it/api/v1/scenarios/{scenario}/modulistica/sheet/{sheet}/model/{model}/send-model-document \
    -H 'accept: application/json' \
    -F 'name=Mario' \
    -F 'surname=Rossi' \
    -F 'body=Lorem Ipsum lorem.' \
    -F 'fiscal_number=RSSFLV95C12H118C' \
    -F 'privacy_acceptance=1' \
    -F 'attachments[]=@/home/utente/Scrivania/test.pdf'

Example response:


    {
        "data":{
            "success": "Pratica inviato con successo!"
        }
    }

HTTP Request

POST api/v1/scenarios/{scenario}/modulistica/sheet/{sheet}/model/{model}/send-model-document

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
sheet int The ID of the Sheet.
model int The ID of the Model.

MyCard

Get Sellers in Category

This endpoint retrieves Sellers in a specific Category

Example request:

curl -X GET "http://demo.mycitydemo.it/api/v1/scenarios/296/mycard/categories/1/sellers" \
-H "Accept: application/json"

Example response:


    {
        "data": [
            {
                "id": 1,
                "name": "Primo Esercente",
                "business_name": "",
                "fiscal_code": "",
                "head_office": "",
                "iban": "IT60X0542811101000000123456",
                "is_active": 1,
                "preset_amount": 33,
                "mandatory_receipt": 1,
                "aggregaed_by_date": 1,
                "pin": "000001",
                "category": {
                    "id": 1,
                    "name": "Buoni spesa 2021",
                    "description": "Test Buoni spesa 2021",
                    "category_type": "Mensa scolastica"
                }
            },
            {
                "id": 2,
                "name": "Secondo Esercente",
                "business_name": "",
                "fiscal_code": "",
                "head_office": "",
                "iban": "",
                "is_active": 1,
                "preset_amount": 33,
                "mandatory_receipt": 1,
                "aggregaed_by_date": 0,
                "pin": "000002",
                "category": {
                    "id": 1,
                    "name": "Buoni spesa 2021",
                    "description": "Test Buoni spesa 2021",
                    "category_type": "Bonus alimentare"
                }
            }
        ]
    }

HTTP Request

GET api/v1/scenarios/{scenario}/mycard/categories/{category}/sellers

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
category int The ID of the Category.

Verify a Seller using the pin

This endpoint verifies the Seller using the pin and returns only active Sellers.

Example request:

curl -X POST http://demo.mycitydemo.it/api/v1/scenarios/296/mycard/sellers/verify \
    -H 'accept: application/json' \
    -F 'pin="000001"' \

Example response:


    {
        "data": {
            "id": 1,
            "name": "Primo Esercente",
            "business_name": "",
            "fiscal_code": "",
            "head_office": "",
            "iban": "IT60X0542811101000000123456",
            "is_active": 1,
            "preset_amount": 33,
            "mandatory_receipt": 1,
            "aggregaed_by_date": 1,
            "pin": "000001",
            "category": {
                "id": 1,
                "name": "Buoni spesa 2021",
                "description": "Test Buoni spesa 2021",
                "category_type": "Cedole librarie"
            }
        }
    }

HTTP Request

POST api/v1/scenarios/{scenario}/mycard/sellers/verify

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

POST Parameters

Parameter Type Description Required
pin string Pin of the Seller. yes

Get Card in a Category by Fiscal Code

This endpoint retrieves all the Cards with a specific Fiscal Code.

Example request:

curl -X POST http://demo.mycitydemo.it/api/v1/scenarios/296/mycard/categories/1/cards?include=contacts,deadlines,transactions \
    -H 'accept: application/json' \
    -F 'fiscal_code="FRNSST75D50A717N"' \

Example response:


    {
        "data": [
            {
                "id": 2,
                "code": "E8292",
                "name": "Francesco",
                "surname": "Sesto",
                "fiscal_code": "FRNSST75D50A717N",
                "amount": 80,
                "assigned_at": "",
                "is_active": 1,
                "is_lost": 0,
                "preset_amount": 0,
                "negative_amount": 0,
                "charge_type": "Ricarico a consumo",
                "amount_payement": 12,
                "notes": null,
                "category": {
                    "id": 1,
                    "name": "Mensa scolastica 2022",
                    "description": "ok!!",
                    "category_type": "Mensa scolastica"
                },
                "contacts": [
                    {
                        "id": 110,
                        "fullname": "Valentino Rossi",
                        "email": "paolazzienrico@gmail.com",
                        "fiscal_code": "MLDYCL29R63I673S",
                        "pin": "728762"
                    }
                ],
                "deadlines": [
                    {
                        "id": 77,
                        "deadline_date": "2022-09-09",
                        "amount": 38,
                        "status": "Pagata",
                        "payement_date": "2022-09-08"
                    }
                ],                
                "transactions": [
                    {
                        "id": 190,
                        "amount": 12,
                        "type": "spesa",
                        "executed_at": "05-09-2022 11:16",
                        "executed_via": "web",
                        "executed_by_model": "App\\Models\\Mycard\\Seller",
                        "executed_by_id": 1,
                        "images": [
                            {
                                "id": 499,
                                "collection_name": "images",
                                "name": "tentativo_2",
                                "file_name": "tentativo_2.png",
                                "mime_type": "image/png",
                                "size": 37370,
                                "human_readable_size": "36.49 KB",
                                "order_column": 398,
                                "file_type": "image",
                                "url": "https://bussola-dev.s3.eu-west-1.amazonaws.com/499/tentativo_2.png",
                                "thumb_url": null,
                                "created_at": "2022-09-05 11:16:21",
                                "attachment_group_id": null,
                                "visibility": 1,
                                "expiration_date": null,
                                "liked": null,
                                "likes": 0,
                                "shared": null,
                                "shares": 0,
                                "links": [
                                    {
                                        "rel": "self",
                                        "href": "http://api.mycity.social/api/v1/scenarios/2/media/499"
                                    }
                                ]
                            }
                        ],
                        "refunded_at": "",
                        "seller": {
                            "id": 1,
                            "name": "Lino il salumiere",
                            "business_name": "Lino il salumiere  Snc",
                            "fiscal_code": "PLZNRC98C11D548E",
                            "head_office": "Corso della Giovecca 50",
                            "iban": "",
                            "is_active": 1,
                            "preset_amount": 0,
                            "aggregaed_by_date": 1,
                            "mandatory_receipt": 1,
                            "pin": "296611",
                            "category": {
                                "id": 1,
                                "name": "Mensa scolatica 2022",
                                "description": "ok!!",
                                "category_type": "Mensa scolastica"
                            }
                        }
                    },
                ]
            }
        ]
    }

HTTP Request

POST api/v1/scenarios/{scenario}/mycard/categories/{category}/cards

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
category int The ID of the Category.

Query Parameters

Parameter Type Description Required
include string List of entities to include in the response. Options are: 'contacts', 'deadlines', 'transactions'. no

POST Parameters

Parameter Type Description Required
fiscal_code string Fiscal code of the User. yes

Get Transactions by Seller ID

This endpoint retrieves Transactions using the Seller ID

Example request:

curl -X GET "http://demo.mycitydemo.it/api/v1/scenarios/296/mycard/sellers/1/transactions" \
-H "Accept: application/json"

Example response:


    {
        "data": [
            {
                "id": 190,
                "amount": 12,
                "type": "spesa",
                "executed_at": "05-09-2022 11:16",
                "executed_via": "web",
                "executed_by_model": "App\\Models\\Mycard\\Seller",
                "executed_by_id": 1,
                "images": [
                    {
                        "id": 499,
                        "collection_name": "images",
                        "name": "tentativo_2",
                        "file_name": "tentativo_2.png",
                        "mime_type": "image/png",
                        "size": 37370,
                        "human_readable_size": "36.49 KB",
                        "order_column": 398,
                        "file_type": "image",
                        "url": "https://bussola-dev.s3.eu-west-1.amazonaws.com/499/tentativo_2.png",
                        "thumb_url": null,
                        "created_at": "2022-09-05 11:16:21",
                        "attachment_group_id": null,
                        "visibility": 1,
                        "expiration_date": null,
                        "liked": null,
                        "likes": 0,
                        "shared": null,
                        "shares": 0,
                        "links": [
                            {
                                "rel": "self",
                                "href": "http://api.mycity.social/api/v1/scenarios/2/media/499"
                            }
                        ]
                    }
                ],
                "refunded_at": "",
                "seller": {
                    "id": 1,
                    "name": "Lino il salumiere",
                    "business_name": "Lino il salumiere  Snc",
                    "fiscal_code": "PLZNRC98C11D548E",
                    "head_office": "Corso della Giovecca 50",
                    "iban": "",
                    "is_active": 1,
                    "preset_amount": 33,
                    "aggregaed_by_date": 1,
                    "mandatory_receipt": 1,
                    "pin": "296611",
                    "category": {
                        "id": 1,
                        "name": "Mensa scolatica",
                        "description": "ok!!",
                        "category_type": "Mensa scolastica"
                    }
                },
                "card": {
                    "id": 93,
                    "code": "A12323",
                    "name": "Enrico",
                    "surname": "Paolazzi",
                    "fiscal_code": "PLZNRC98C11D548E",
                    "pin": "874348",
                    "amount": 430.95,
                    "assigned_at": "2022-08-31 11:02:20",
                    "is_active": 1,
                    "is_lost": 0,
                    "preset_amount": null,
                    "negative_amount": 0,
                    "charge_type": "Ricarico a consumo",
                    "amount_payement": 11,
                    "notes": null,
                    "category": {
                        "id": 1,
                        "name": "Mensa scolatica",
                        "description": "ok!!",
                        "category_type": "Mensa scolastica"
                    }
                }
            },
        ]
    }

HTTP Request

GET api/v1/scenarios/{scenario}/mycard/sellers/{seller}/transactions

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
seller int The ID of the Seller.

Get Transactions by Card ID

This endpoint retrieves Transactions using the Card ID

Example request:

curl -X GET "http://demo.mycitydemo.it/api/v1/scenarios/296/mycard/cards/1/transactions?pin=874348&include=card,seller" \
-H "Accept: application/json"

Example response:


    {
        "data": [
            {
                "id": 216,
                "amount": 1.49,
                "type": "ricarica",
                "executed_at": "08-09-2022 09:34",
                "executed_via": "web",
                "executed_by_model": null,
                "executed_by_id": null,
                "images": [],
                "refunded_at": "",
                "seller": null,
                "card": {
                    "id": 93,
                    "code": "A12323",
                    "name": "Enrico",
                    "surname": "Paolazzi",
                    "fiscal_code": "PLZNRC98C11D548E",
                    "pin": "874348",
                    "amount": 430.95,
                    "assigned_at": "2022-08-31 11:02:20",
                    "is_active": 1,
                    "is_lost": 0,
                    "preset_amount": 0,
                    "negative_amount": 0,
                    "charge_type": "Ricarico a consumo",
                    "amount_payement": 10,
                    "notes": null,
                    "category": {
                        "id": 1,
                        "name": "Mensa scolatica",
                        "description": "ok!!",
                        "category_type": "Mensa scolastica"
                    }
                }
            },
            {
                "id": 201,
                "amount": -40,
                "type": "spesa",
                "executed_at": "05-09-2022 15:51",
                "executed_via": "web",
                "executed_by_model": "App\\Models\\Mycard\\Seller",
                "executed_by_id": 7,
                "images": [
                    {
                        "id": 508,
                        "collection_name": "images",
                        "name": "tentativo_2",
                        "file_name": "tentativo_2.png",
                        "mime_type": "image/png",
                        "size": 37370,
                        "human_readable_size": "36.49 KB",
                        "order_column": 407,
                        "file_type": "image",
                        "url": "https://bussola-dev.s3.eu-west-1.amazonaws.com/508/tentativo_2.png",
                        "thumb_url": null,
                        "created_at": "2022-09-05 15:51:54",
                        "attachment_group_id": null,
                        "visibility": 1,
                        "expiration_date": null,
                        "liked": null,
                        "likes": 0,
                        "shared": null,
                        "shares": 0,
                        "links": [
                            {
                                "rel": "self",
                                "href": "http://api.mycity.social/api/v1/scenarios/2/media/508"
                            }
                        ]
                    }
                ],
                "refunded_at": "",
                "seller": {
                    "id": 7,
                    "name": "Ipermarket Bianchi",
                    "business_name": "Ipermarket Bianchi S.r.l.",
                    "fiscal_code": "MLDYCL29R63I673S",
                    "head_office": "Via Mazzini 18",
                    "iban": "IT98C0300203280577532356922",
                    "is_active": 1,
                    "preset_amount": 100,
                    "aggregaed_by_date": 1,
                    "mandatory_receipt": 0,
                    "pin": "357814",
                    "category": {
                        "id": 1,
                        "name": "Mensa scolatica",
                        "description": "ok!!",
                        "category_type": "Mensa scolastica"
                    }
                },
                "card": {
                    "id": 93,
                    "code": "A12323",
                    "name": "Enrico",
                    "surname": "Paolazzi",
                    "fiscal_code": "PLZNRC98C11D548E",
                    "pin": "874348",
                    "amount": 430.95,
                    "assigned_at": "2022-08-31 11:02:20",
                    "is_active": 1,
                    "is_lost": 0,
                    "preset_amount": 0,
                    "negative_amount": 0,
                    "charge_type": "Ricarico a consumo",
                    "amount_payement": null,
                    "notes": null,
                    "category": {
                        "id": 1,
                        "name": "Mensa scolatica",
                        "description": "ok!!",
                        "category_type": "Mensa scolastica"
                    }
                }
            },
        ]
    }

HTTP Request

GET api/v1/scenarios/{scenario}/mycard/cards/{card}/transactions

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
card int The ID of the Card.

Query Parameters

Parameter Type Description Required
pin string The PIN of the Card. yes
include string List of entities to include in the response. Options are: 'card', 'seller'. no

Create a Transaction

This endpoint permits to create a single Transaction.

Example request:

curl -X POST http://demo.mycitydemo.it/api/v1/scenarios/296/mycard/categories/1/transactions/create \
    -H 'accept: application/json' \
    -F 'seller=1'
    -F 'card=2'
    -F 'amount=10.5'
    -F 'images[]=@/user/device/path/test.jpg'

Example response:


    {
        "data":{
            "Transazione eseguita con successo"
        }
    }

HTTP Request

POST api/v1/scenarios/{scenario}/mycard/categories/{category}/transactions/create

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
category int The ID of the Category.

POST Parameters

Parameter Type Description Required
seller int The ID of the Seller making the Transaction. yes
card int The ID of the Card making the Transaction. yes
amount float The amount of the Transaction. yes
images[] array Array containing images attached to the Transaction. yes

Get Cards by Fiscal Code

This endpoint retrieves all the Cards with a specific Fiscal Code.

Example request:

curl -X POST http://demo.mycitydemo.it/api/v1/scenarios/296/mycard/cards?include=contacts,deadlines \
    -H 'accept: application/json' \
    -F 'fiscal_code="PLZNRC98C11D548E"' \

Example response:


    {
        "data": [
            {
                "id": 93,
                "code": "A12323",
                "name": "Enrico",
                "surname": "Paolazzi",
                "fiscal_code": "PLZNRC98C11D548E",
                "pin": "874348",
                "amount": 430.95,
                "assigned_at": "2022-08-31 11:02:20",
                "is_active": 1,
                "is_lost": 0,
                "preset_amount": 0,
                "negative_amount": 0,
                "charge_type": "Ricarico a consumo",
                "amount_payement": 0,
                "notes": null,
                "category": {
                    "id": 1,
                    "name": "Mensa scolatica",
                    "description": "ok!!",
                    "category_type": "Mensa scolastica"
                },
                "contacts": [
                    {
                        "id": 110,
                        "fullname": "Valentino Rossi",
                        "email": "paolazzienrico@gmail.com",
                        "fiscal_code": "MLDYCL29R63I673S",
                        "pin": "728762"
                    }
                ],
                "deadlines": [
                    {
                        "id": 77,
                        "deadline_date": "2022-09-09",
                        "amount": 38,
                        "status": "Pagata",
                        "payement_date": "2022-09-08"
                    }
                ]
            }
        ]
    }

HTTP Request

POST api/v1/scenarios/{scenario}/mycard/cards

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

POST Parameters

Parameter Type Description Required
fiscal_code string Fiscal code of the User. yes

Query Parameters

Parameter Type Description Required
include string List of entities to include in the response. Options are: 'contacts', 'deadlines', 'transactions'. no

Create payement

Funzione per creare il pagamento. Restituisce i dati necessari ad entrare su servizio PileaPay Web App

Example request:

curl -X POST "http://demo.mycitydemo.it/api/v1/scenarios/2/mycard/cards/93/payement/card" \
-H "Accept: application/json"
-F 'fiscal_code="PLZNRC98C11D548E"' \
-F 'pin="874348"' \
-F 'deadline_id="null"' \
-F 'codice="PLZNRC98C11D548E"' \
-F 'tipo="F"' \
-F 'anagrafica="Enrico Paolazzi"' \
-F 'email="enrico.paolazzi@mycity.it"' \
-F 'indirizzo="Via San Vitale 7"' \
-F 'cap="44121"' \
-F 'localita="Bologna"' \
-F 'provincia="BO"' \
-F 'nazione="IT"' \
-F 'importo="33"' \

Example response:


    {
        {
            "success": true,
            "data": {
                "ticket": "305e1e09-c607-4acb-9517-d275e3c74648",
                "idOperazione": "Ferrara_payement_207_6na",
                "numeroAvviso": "302000000052950546",
                "urlRedirectOK": "http://mycity.local/mycard",
                "urlRedirectKO": "http://mycity.local/mycard/cittadino/carta/93/pagamento/card/redirect-error-callback?data=PLZNRC98C11D548E_874348_card",
                "urlRedirectCANCEL": "http://mycity.local/mycard/cittadino/carta/93/pagamento/card/redirect-error-callback?data=PLZNRC98C11D548E_874348_card",
                "urlRedirectERROR": "http://mycity.local/mycard/cittadino/carta/93/pagamento/card/redirect-error-callback?data=PLZNRC98C11D548E_874348_card",
                "codiceIdentificativoEnte": "02195410697",
                "importo": "33"
            },
            "complete_redirect_url": "https://service.pileapay.it/web/ext-pay?ticket=305e1e09-c607-4acb-9517-d275e3c74648&idOperazione=Ferrara_payement_207_6na&numeroAvviso=302000000052950546&urlRedirectOK=http://mycity.local/mycard&urlRedirectKO=http://mycity.local/mycard/cittadino/carta/93/pagamento/card/redirect-error-callback?data=PLZNRC98C11D548E_874348_card&urlRedirectCANCEL=http://mycity.local/mycard/cittadino/carta/93/pagamento/card/redirect-error-callback?data=PLZNRC98C11D548E_874348_card&urlRedirectERROR=http://mycity.local/mycard/cittadino/carta/93/pagamento/card/redirect-error-callback?data=PLZNRC98C11D548E_874348_card&codiceIdentificativoEnte=02195410697&importo=33"
        }
    }

HTTP Request

GET api/v1/scenarios/{scenario}/mycard/cards/{card}/payement/{type}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
category int The ID of the Category.
type string The type of user. Options are: 'card' or 'contact'.

POST Parameters

Parameter Type Description Required
fiscal_code string Fiscal code of the User. yes
pin string The PIN of the User. yes
deadline_id string ID of the deadline. Used when you want to pay a deadline. Only for "scadenza" charge_type of card. no
codice string Fiscal code of the User yes
tipo string Type of Fiscal code of the User. Options are: "G" (persona giuridica), "F" (persona fisica). yes
anagrafica string Fullname of the User. yes
email string Email of the User. no
indirizzo string Address of the User.. no
cap string Postal code of the User's address. no
localita string Name of the place/city of the User. no
provincia string Abbreviazione provincia (es: 'BO'), validazione regex:/[A-Z]{2,2}/. no
nazione string Abbreviazione nazione (es: 'IT'), validazione regex:/[A-Z]{2,2}/. no
importo float Amount of the payement. if deadline_id is defined -> no. All other cases -> yes.

Get Next Deadline to pay

This endpoint retrieves the next deadline to pay. Returns null if there's no deadline to pay.

Example request:

curl -X GET "http://demo.mycitydemo.it/api/v1/scenarios/296/mycard/cards/93/next-deadline-to-pay?fiscal_code=PLZNRC98C11D548E&pin=874348" \
-H "Accept: application/json"

Example response:


    {
        "data": {
            "id": 77,
            "deadline_date": "2022-09-09",
            "amount": 38,
            "status": "Da pagare",
            "payement_date": null
        }
    }

HTTP Request

GET api/v1/scenarios/{scenario}/mycard/cards/{card}/next-deadline-to-pay

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
card int The ID of the Card.

Query Parameters

Parameter Type Description Required
fiscal_code string Fiscal code of the Card. yes
pin string PIN of the Card. yes

Communications

Get all communication groups

This endpoint retrieves all groups from a Scenario for a specific user.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/newsletter" \
-H "Accept: application/json"

Example response:


{
    "data":[
        {
            "id": 1098,
            "type":"communications",
            "name": "Lorem Ipsum",
            "public": true,
            "user_checked": 1
        },
        {
            "id": 1099,
            "type":"communications",
            "name": "Ipsum Lorem",
            "public": false,
            "user_checked": 0
        },
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/newsletter

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Group subscriptions

This endpoint permits to subscribe & unsubscribe user to communication groups.

Example request for service appointments:

curl -X POST https://api.mycitydemo.it/api/v1/scenarios/{scenario}/newsletter \
    -H 'accept: application/json' \
    -F 'groups: {"groups": ["1088","3012","4231"]}' \

Example response:


    {
        "data":[
            {
                "id": 1098,
                "type":"communications",
                "name": "Lorem Ipsum",
                "public": true,
                "user_checked": 1
            },
            {
                "id": 1099,
                "type":"communications",
                "name": "Ipsum Lorem",
                "public": false,
                "user_checked": 0
            },
        ]
    }

HTTP Request

POST api/v1/scenarios/{scenario}/newsletter

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Feed (aka Diario)

Get the Feed

This endpoint retrieves the Feed of a Scenario.
Every feed have its own title & comment, different from the shareable object.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/feeds" \
-H "Accept: application/json"

Example response:

{
    "data": [
        {
            "year_month": "2018-02",
            "feeds": [
                {
                    "id": 4,
                    "title": "Reiciendis voluptate labore magnam fugiat vel et.",
                    "comment": "Qui ut ab aut cum molestias. Ullam recusandae voluptates modi. Ut voluptatem provident itaque dolores eius. Laborum nobis qui soluta blanditiis et.",
                    "created_at": "2018-02-21 10:34:25",
                    "shareable": {
                        "id": 1,
                        "type": "reports",
                        "title": "A minus eos non quam.",
                        "body": "Necessitatibus quam quia ducimus voluptatem quae ea. Quia quae consequuntur vero doloremque vero. Placeat nisi unde quisquam iusto quisquam soluta beatae. Aliquam quia numquam libero. Molestiae expedita sunt eos nihil aut commodi ab.",
                        "result_text": "",
                        "taken_over_at": null,
                        "completed_at": null,
                        "rejected_at": null,
                        "created_at": "2018-02-21 10:32:31",
                        "category_id": 198,
                        "liked": false,
                        "likes": 0,
                        "shared": false,
                        "shares": 0,
                        "links": [
                            {
                                "rel": "self",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1"
                            },
                            {
                                "rel": "gallery",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1/gallery"
                            },
                            {
                                "rel": "category",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1/category"
                            },
                            {
                                "rel": "pois",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1/pois"
                            },
                            {
                                "rel": "attachments",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/reports/1/attachments"
                            }
                        ],
                        "deeplink": "mycity://scenarios/2/reports/1",
                        "share_url": "https://bologna.mycity.api/reports/1/"
                    }
                },
                {
                    "id": 3,
                    "title": "Nemo et qui distinctio exercitationem fuga blanditiis similique.",
                    "comment": "Aut sequi praesentium quae ut. Neque nemo quae aut quas molestias. Ut dicta qui voluptatem impedit dicta ratione.",
                    "created_at": "2018-02-21 10:34:25",
                    "shareable": {
                        "id": 113,
                        "type": "pages",
                        "title": "Eos dolor corrupti ipsum et ipsam",
                        "permalink": "eos-dolor-corrupti-ipsum-et-ipsam",
                        "abstract": "Quod enim quia sunt voluptatem non consequatur sed. Quia mollitia porro molestiae sit non sapiente autem. Pariatur tenetur aperiam corrupti rerum accusantium adipisci repellat eos.",
                        "body": "Fuga quia quia iure repellendus sit voluptatem. Delectus dicta rem ea. At aperiam quia quasi ut natus nemo. Nemo voluptas sint voluptatem hic. Aliquid sit velit et consequuntur fugiat optio soluta. Quis adipisci quis natus ducimus est consequuntur aliquid. Quasi eligendi est magni et voluptas facilis earum.",
                        "publish_date": null,
                        "unpublish_date": null,
                        "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/11/100",
                        "links": [
                            {
                                "rel": "self",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/pages/113"
                            },
                            {
                                "rel": "gallery",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/pages/113/gallery"
                            },
                            {
                                "rel": "menu",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/pages/113/menu"
                            },
                            {
                                "rel": "pois",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/pages/113/pois"
                            },
                            {
                                "rel": "attachments",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/pages/113/attachments"
                            }
                        ],
                        "deeplink": "mycity://scenarios/2/pages/113",
                        "share_url": "https://bologna.mycity.api/pages/113/eos-dolor-corrupti-ipsum-et-ipsam",
                        "liked": false,
                        "likes": 0,
                        "shared": false,
                        "shares": 0
                    }
                },
                {
                    "id": 2,
                    "title": "Vero labore vitae sint quisquam.",
                    "comment": "Consectetur labore est tenetur quo fuga quo. Sequi placeat iusto et eveniet magnam quia amet. Dolorem est sunt itaque autem corporis corrupti dolorem. Ut repellat facere non quo fugit expedita corrupti.",
                    "created_at": "2018-02-21 10:34:25",
                    "shareable": {
                        "id": 143,
                        "type": "news",
                        "title": "Ea excepturi ullam nostrum",
                        "permalink": "ea-excepturi-ullam-nostrum",
                        "abstract": "Et et non at tenetur. Et voluptatibus id natus iure qui voluptas. Error aut consequatur suscipit dolor et.",
                        "body": "Error placeat ut vero alias. Voluptatem omnis tenetur sed aut ut officiis quam aliquid. Dolorem sit harum perspiciatis dicta. Facere sequi ut dolores. Incidunt et assumenda quidem aut ratione vero. Quo molestias in et. Sunt ex delectus quod et facilis laboriosam est quasi. Architecto dolorem rerum veritatis molestiae voluptates accusamus.",
                        "publish_date": "1996-02-22 00:16:38",
                        "unpublish_date": null,
                        "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/41/100",
                        "links": [
                            {
                                "rel": "self",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/news/143"
                            },
                            {
                                "rel": "gallery",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/news/143/gallery"
                            },
                            {
                                "rel": "menu",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/news/143/menu"
                            },
                            {
                                "rel": "pois",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/news/143/pois"
                            },
                            {
                                "rel": "attachments",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/news/143/attachments"
                            }
                        ],
                        "deeplink": "mycity://scenarios/2/news/143",
                        "share_url": "https://bologna.mycity.api/news/143/ea-excepturi-ullam-nostrum",
                        "liked": false,
                        "likes": 0,
                        "shared": false,
                        "shares": 0
                    }
                },
                {
                    "id": 1,
                    "title": "Odit porro velit suscipit adipisci numquam quo.",
                    "comment": "Dolor iste sit quisquam quasi odio explicabo qui soluta. Doloribus excepturi nostrum ea ut aut. Molestiae facilis ut omnis temporibus dicta cupiditate officiis et. Rem deserunt deleniti voluptate aut.",
                    "created_at": "2018-02-21 10:34:25",
                    "shareable": {
                        "id": 128,
                        "type": "events",
                        "title": "Eius eveniet incidunt rerum",
                        "permalink": "eius-eveniet-incidunt-rerum",
                        "abstract": "Tempora officiis aspernatur ratione sed. Ex nihil vel maxime harum sequi omnis esse. Aut doloribus ad qui laborum. Quaerat sed rerum et quos ullam sit.",
                        "body": "Sunt ipsam tempora iure ut incidunt. Aspernatur earum doloribus itaque totam non numquam corporis. Sunt quia aliquam necessitatibus dolor quisquam laboriosam fugit. Dolorum tenetur laudantium enim assumenda tenetur. Ullam est at aut natus suscipit deleniti. Recusandae est in quis accusantium est aperiam iure. Est consequatur ab et. Consequatur et consequuntur accusamus in. Consequatur perspiciatis quo veniam ut vel qui dolores voluptatem.",
                        "publish_date": null,
                        "unpublish_date": null,
                        "pois": [
                            {
                                "id": 1,
                                "title": "Iste sint occaecati occaecati cum quas",
                                "latitude": "18.8989840",
                                "longitude": "13.1164270",
                                "address": "Borgo Leone 6\nMoretti lido, 68519 Bologna (MT)"
                            }
                        ],
                        "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/26/100",
                        "links": [
                            {
                                "rel": "self",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/events/128"
                            },
                            {
                                "rel": "gallery",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/events/128/gallery"
                            },
                            {
                                "rel": "menu",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/events/128/menu"
                            },
                            {
                                "rel": "pois",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/events/128/pois"
                            },
                            {
                                "rel": "attachments",
                                "href": "http://api.mycity.api/api/v1/scenarios/2/events/128/attachments"
                            }
                        ],
                        "deeplink": "mycity://scenarios/2/events/128",
                        "share_url": "https://bologna.mycity.api/events/128/eius-eveniet-incidunt-rerum",
                        "liked": false,
                        "likes": 0,
                        "shared": false,
                        "shares": 0
                    }
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/feeds

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Include

This parameter permits to include relationships in the response, simply adding parameter include=[comma_separated_relationships] on the url

Example object with Include parameter

Example request Report with include=gallery,pois:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/reports/{report}?include=gallery,pois" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 33,
        "type": "Report",
        "title": "segnalazione importante",
        "body": "uscendo di casa mi ritrovai in una selva oscura che la dritta via era smarrita",
        "result_text": "",
        "taken_over_at": null,
        "completed_at": null,
        "rejected_at": null,
        "created_at": "2018-02-12 17:11:26",
        "category_id": 781,
        "pois": [
            {
                "id": 356,
                "title": null,
                "latitude": "12.0000000",
                "longitude": "13.0000000",
                "address": null
            },
            {
                "id": 357,
                "title": null,
                "latitude": "14.0000000",
                "longitude": "15.0000000",
                "address": null
            }
        ],
        "gallery": [
            {
                "id": 142,
                "collection_name": "photos",
                "name": "test",
                "file_name": "test.pdf",
                "mime_type": "application/pdf",
                "size": 901422,
                "order_column": 142,
                "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/142/test.pdf",
                "liked": false,
                "likes": 0,
                "shared": false,
                "shares": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/142"
                    }
                ]
            },
            {
                "id": 143,
                "collection_name": "photos",
                "name": "prova",
                "file_name": "prova.png",
                "mime_type": "image/png",
                "size": 890,
                "order_column": 143,
                "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/143/prova.png",
                "liked": false,
                "likes": 0,
                "shared": false,
                "shares": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://api.mycitydemo.it/api/v1/scenarios/2/media/143"
                    }
                ]
            }
        ],
        "links": [
            {
                "rel": "self",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/reports/33"
            },
            {
                "rel": "gallery",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/reports/33/gallery"
            },
            {
                "rel": "category",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/reports/33/category"
            },
            {
                "rel": "pois",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/reports/33/pois"
            }
        ]
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/{type}/{type_id}?include={includes}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
type string The type of the object (eg. news).
type_id int The ID of the object.
includes string comma separated relationships eg: pois,gallery

Likes

Example object with likes

This is a News

    {
            "id": 798,
            "type": "news",
            "liked": false,
            "likes": 0,
            "title": "Sint quod eos veritatis qui",
            "permalink": "sint-quod-eos-veritatis-qui",
            "abstract": "Voluptatem soluta itaque ab nostrum nihil. Consectetur et facere culpa dicta rem...",
            "body": "Cum laudantium facilis nemo repellat enim minima ipsam. Sed minima sunt est suscipit a..",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798"
                },
                {
                    "rel": "gallery",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798/gallery"
                },
                {
                    "rel": "menu",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798/menu"
                },
                {
                    "rel": "pois",
                    "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798/pois"
                }
            ],
            "publish_date": "2013-09-22 16:37:39",
            "shared": true,
            "shares": 10
        }

Models having likes:

Like attributes

Attribute Type Description
likes int Likes counter with the number of likes received from the news
liked boolean / null true if user has already liked the object, false if user has not liked the object, null if user is not authenticated

HTTP Request

GET api/v1/scenarios/{scenario}/{type}/{type_id}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
type string The type of the object (eg. news).
type_id int The ID of the object.

Liking an object

This endpoint permits to authenticated user to like an object.

Example request:

curl -X POST "https://api.mycitydemo.it/api/v1/scenarios/2/news/798/like" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 798,
        "type": "news",
        "liked": true,
        "likes": 1,
        "title": "Sint quod eos veritatis qui",
        "permalink": "sint-quod-eos-veritatis-qui",
        "abstract": "Voluptatem soluta itaque ab nostrum nihil. Consectetur et facere culpa dicta rem quia ea. Non sint et iure nihil. Ut vel animi labore voluptatem ipsum vero ipsa velit.",
        "body": "Cum laudantium facilis nemo repellat enim minima ipsam. Sed minima sunt est suscipit a. Quo aliquam libero mollitia sed quam voluptatem excepturi aut. Necessitatibus sunt quis eos amet est quae. Provident quia et eum neque et. Magni est aperiam quae quidem magnam. Ducimus earum similique architecto architecto explicabo.",
        "links": [
            {
                "rel": "self",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798"
            },
            {
                "rel": "gallery",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798/gallery"
            },
            {
                "rel": "menu",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798/menu"
            },
            {
                "rel": "pois",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798/pois"
            }
        ],
        "publish_date": "2013-09-22 16:37:39",
        "shared": true,
        "shares": 10
    }
}

HTTP Request

POST api/v1/scenarios/{scenario}/{type}/{type_id}/like

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
type string The type of the object (eg. news).
type_id int The ID of the object.

Unliking an object

This endpoint permits to authenticated user to unlike a liked object.

Example request:

curl -X POST "https://api.mycitydemo.it/api/v1/scenarios/2/news/798/unlike" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 798,
        "type": "news",
        "liked": false,
        "likes": 0,
        "title": "Sint quod eos veritatis qui",
        "permalink": "sint-quod-eos-veritatis-qui",
        "abstract": "Voluptatem soluta itaque ab nostrum nihil. Consectetur et facere culpa dicta rem quia ea. Non sint et iure nihil. Ut vel animi labore voluptatem ipsum vero ipsa velit.",
        "body": "Cum laudantium facilis nemo repellat enim minima ipsam. Sed minima sunt est suscipit a. Quo aliquam libero mollitia sed quam voluptatem excepturi aut. Necessitatibus sunt quis eos amet est quae. Provident quia et eum neque et. Magni est aperiam quae quidem magnam. Ducimus earum similique architecto architecto explicabo.",
        "links": [
            {
                "rel": "self",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798"
            },
            {
                "rel": "gallery",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798/gallery"
            },
            {
                "rel": "menu",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798/menu"
            },
            {
                "rel": "pois",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798/pois"
            }
        ],
        "publish_date": "2013-09-22 16:37:39",
        "shared": true,
        "shares": 10
    }
}

HTTP Request

POST api/v1/scenarios/{scenario}/{type}/{type_id}/unlike

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
type string The type of the object (eg. news).
type_id int The ID of the object.

User Shares

Example object with shares

This is a News

{
    "data": {
        "id": 798,
        "type": "news",
        "shared": false,
        "shares": 11,
        "title": "Sint quod eos veritatis qui",
        "permalink": "sint-quod-eos-veritatis-qui",
        "abstract": "Voluptatem soluta itaque ab nostrum nihil. Consectetur et facere culpa dicta rem quia ea. Non sint et iure nihil. Ut vel animi labore voluptatem ipsum vero ipsa velit.",
        "body": "Cum laudantium facilis nemo repellat enim minima ipsam. Sed minima sunt est suscipit a. Quo aliquam libero mollitia sed quam voluptatem excepturi aut. Necessitatibus sunt quis eos amet est quae. Provident quia et eum neque et. Magni est aperiam quae quidem magnam. Ducimus earum similique architecto architecto explicabo.",
        "links": [
            {
                "rel": "self",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798"
            },
            {
                "rel": "gallery",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798/gallery"
            },
            {
                "rel": "menu",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798/menu"
            },
            {
                "rel": "pois",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798/pois"
            }
        ],
        "publish_date": "2013-09-22 16:37:39",
        "liked": false,
        "likes": 1
    }
}

Models having user shares:

Share attributes

Attribute Type Description
shares int Shares counter with the number of shares received from the object
shared boolean / null true if user has already shared the object, false if user has never shared the object, null if user is not authenticated

HTTP Request

GET api/v1/scenarios/{scenario}/{type}/{type_id}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
type string The type of the object (eg. news).
type_id int The ID of the object.

User share callback

After sharing the object on social network you should call this callback. This endpoint is used both autheticated than anonymous user,

Example request:

curl -X POST "https://api.mycitydemo.it/api/v1/scenarios/2/news/798/share_callback" \
-d '{
    "source": "site",
    "destination": "dacebook",
    "data": {
        "facebook_post_id": 228228222110
    }
}' \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 798,
        "type": "news",
        "shared": true,
        "shares": 12,
        "title": "Sint quod eos veritatis qui",
        "permalink": "sint-quod-eos-veritatis-qui",
        "abstract": "Voluptatem soluta itaque ab nostrum nihil. Consectetur et facere culpa dicta rem quia ea. Non sint et iure nihil. Ut vel animi labore voluptatem ipsum vero ipsa velit.",
        "body": "Cum laudantium facilis nemo repellat enim minima ipsam. Sed minima sunt est suscipit a. Quo aliquam libero mollitia sed quam voluptatem excepturi aut. Necessitatibus sunt quis eos amet est quae. Provident quia et eum neque et. Magni est aperiam quae quidem magnam. Ducimus earum similique architecto architecto explicabo.",
        "links": [
            {
                "rel": "self",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798"
            },
            {
                "rel": "gallery",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798/gallery"
            },
            {
                "rel": "menu",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798/menu"
            },
            {
                "rel": "pois",
                "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news/798/pois"
            }
        ],
        "publish_date": "2013-09-22 16:37:39",
        "liked": false,
        "likes": 1
    }
}

HTTP Request

POST api/v1/scenarios/{scenario}/{type}/{type_id}/share_callback

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
type string The type of the object (eg. news).
type_id int The ID of the object.

Post Json Parameters

Parameter Type Description Status
source string How user arrives to object (eg: facebook, twitter, site, android, iphone) TO BE DEFINED
destination string Where user has shared the object (eg: facebook, twitter) TO BE DEFINED
data json Containing share information, like facebook post id etc. TO BE DEFINED

Scenarios

Get all Scenarios

This endpoint retrieves all Scenarios.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios" \
-H "Accept: application/json"

Example response:

{
  "data": [
    {
      "id": 3,
      "site_name": "Comune di Lake Mekhi",
      "name": "Lake Mekhi",
      "url": "lake-mekhi.mycitydemo.it",
      "description": "Nisi voluptas officia hic facilis autem et dolorum. Quisquam ad sed provident minima. Culpa labore enim porro debitis laborum veniam. Dignissimos quia similique ullam autem aut illum.",
      "address": "14732 Napoleon Ramp\nSouth Nathanburgh, DC 49859",
      "zip_code": "7807",
      "latitude": "-60.3945620",
      "longitude": "-164.4730650",
      "cadastre_code": "L039",
      "phone": "1-289-568-1952",
      "fax": "1-678-755-6755 x0001",
      "email": "reymundo.jakubowski@example.org",
      "pec": "oheidenreich@example.net",
      "is_active": 1,
      "type": 1,
      "facebook_url": null,
      "youtube_url": null,
      "twitter_url": null,
      "instagram_url": null,
      "telegram_url": null,
      "fiscal_code": null,
      "vat_code": null,
      "web_style": 1,
      "web_color": 1,
      "links": [
        {
          "rel": "self",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3"
        },
        {
          "rel": "pages",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/pages"
        },
        {
          "rel": "employees",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/employees"
        },
        {
          "rel": "events",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/events"
        },
        {
          "rel": "infos",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/infos"
        },
        {
          "rel": "menus",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/menus"
        },
        {
          "rel": "modules",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/modules"
        },
        {
          "rel": "news",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/news"
        },
        {
          "rel": "offices",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/offices"
        },
        {
          "rel": "reports",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/reports"
        },
        {
          "rel": "report_categories",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/3/report_categories"
        }
      ]
    },
    {
      "id": 4,
      "site_name": "Comune di Schummport",
      "name": "Schummport",
      "url": "schummport.mycitydemo.it",
      "description": "Cumque quibusdam eius ut id. Qui voluptatem ut at quo optio. Soluta et qui quod iusto. Fugit velit aspernatur consequatur. Magni quo dolorem molestiae nam sapiente.",
      "address": "89727 Elenora Manor Apt. 026\nWest Mohammad, MS 87388",
      "zip_code": "20509",
      "latitude": "-69.5954350",
      "longitude": "-44.4971730",
      "cadastre_code": "L657",
      "phone": "1-767-717-0424 x69029",
      "fax": "780.863.0986",
      "email": "xoconnell@example.org",
      "pec": "gay.botsford@example.com",
      "is_active": 1,
      "type": 1,
      "facebook_url": null,
      "youtube_url": null,
      "twitter_url": null,
      "instagram_url": null,
      "telegram_url": null,
      "fiscal_code": null,
      "vat_code": null,
      "web_style": 1,
      "web_color": 1,
      "links": [
        {
          "rel": "self",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/4"
        },
        {
          "rel": "pages",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/4/pages"
        },
        {
          "rel": "employees",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/4/employees"
        },
        {
          "rel": "events",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/4/events"
        },
        {
          "rel": "infos",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/4/infos"
        },
        {
          "rel": "menus",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/4/menus"
        },
        {
          "rel": "modules",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/4/modules"
        },
        {
          "rel": "news",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/4/news"
        },
        {
          "rel": "offices",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/4/offices"
        },
        {
          "rel": "reports",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/4/reports"
        },
        {
          "rel": "report_categories",
          "href": "https://api.mycitydemo.it/api/v1/scenarios/4/report_categories"
        }
      ]
    }
  ],
  "links": {
    "first": "https://api.mycitydemo.it/api/v1/scenarios?page=1",
    "last": "https://api.mycitydemo.it/api/v1/scenarios?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.mycitydemo.it/api/v1/scenarios",
    "per_page": 10,
    "to": 2,
    "total": 10
  }
}

HTTP Request

GET api/v1/scenarios

Get a specific Scenario

This endpoint retrieves a specific scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}" \
-H "Accept: application/json"

Example response:

{
  "data": {
    "id": 2,
    "site_name": "Comune di Bologna",
    "name": "Bologna",
    "url": "bologna.mycitydemo.it",
    "description": "Lorem Fabio dolor sit amet.",
    "address": "Palazzo d'Accursio, 1",
    "zip_code": "40100",
    "latitude": "44.4833330",
    "longitude": "11.3333330",
    "cadastre_code": "A944",
    "phone": "051-763201",
    "fax": "051-6065611",
    "email": "bologna@egaspari.net",
    "pec": "bologna@pec.egaspari.net",
    "is_active": 1,
    "type": 1,
    "facebook_url": null,
    "youtube_url": null,
    "twitter_url": null,
    "instagram_url": null,
    "telegram_url": null,
    "fiscal_code": null,
    "vat_code": null,
    "web_style": 1,
    "web_color": 1,
    "links": [
      {
        "rel": "self",
        "href": "https://api.mycitydemo.it/api/v1/scenarios/2"
      },
      {
        "rel": "pages",
        "href": "https://api.mycitydemo.it/api/v1/scenarios/2/pages"
      },
      {
        "rel": "employees",
        "href": "https://api.mycitydemo.it/api/v1/scenarios/2/employees"
      },
      {
        "rel": "events",
        "href": "https://api.mycitydemo.it/api/v1/scenarios/2/events"
      },
      {
        "rel": "infos",
        "href": "https://api.mycitydemo.it/api/v1/scenarios/2/infos"
      },
      {
        "rel": "menus",
        "href": "https://api.mycitydemo.it/api/v1/scenarios/2/menus"
      },
      {
        "rel": "modules",
        "href": "https://api.mycitydemo.it/api/v1/scenarios/2/modules"
      },
      {
        "rel": "news",
        "href": "https://api.mycitydemo.it/api/v1/scenarios/2/news"
      },
      {
        "rel": "offices",
        "href": "https://api.mycitydemo.it/api/v1/scenarios/2/offices"
      },
      {
        "rel": "reports",
        "href": "https://api.mycitydemo.it/api/v1/scenarios/2/reports"
      },
      {
        "rel": "report_categories",
        "href": "https://api.mycitydemo.it/api/v1/scenarios/2/report_categories"
      }
    ]
  }
}

HTTP Request

GET api/v1/scenarios/{scenario}

Get all active modules of a Scenario

This endpoint retrieves all active modules of a scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/modules" \
-H "Accept: application/json"

Example response:

{
  "data": [
    {
      "id": 1,
      "name": "CMS"
    },
    {
      "id": 4,
      "name": "Modulistica"
    },
    {
      "id": 11,
      "name": "Sondaggi"
    }
  ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/modules

Users

Register User

This endpoint registers a new User in the system.

Example request:

curl -X POST "https://api.mycitydemo.it/api/v1/users" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "id": 48,
        "email": "mrossi@egaspari.net",
        "name": "Mario",
        "surname": "Rossi",
        "scenarios": [
            5
        ]
    }
}

HTTP Request

POST api/v1/users

Parameters

Parameter Type Description
name string The name of the User. required
surname string The surname of the User. required
email string The email of the User. required
password string The password of the User. required
scenarios array The list of user scenarios

Update User

This endpoint updates User data.

Example request:

curl -X POST "https://api.mycitydemo.it/api/v1/users/update" \
-H "Accept: application/json"

Example response:

{
    "data": {
        "success": "Modifiche salvate con successo!"
    }
}

HTTP Request

POST api/v1/users/update

Parameters

Parameter Type Description
name string The name of the User.
surname string The surname of the User.
email string The email of the User.
phone string The phone of the User.
fiscal_number string The fiscal number of the User.
address string The address of the User.
place_of_birth string The municipality of birth of the User. (e.g. Bologna)
country_of_birth string The district of birth of the User. (e.g. BO)
date_of_birth date The date of birth of the User.
gender string The gender of the User.
push_shares boolean Enables push notifications for the user.
sms_shares boolean Enables SMS notifications for the user.
email_shares boolean Enables Email notifications for the user.
new_password string The new password of the User.
current_password string The current password of the User.

Get newsletter groups

This endpoint retrieves newsletter groups.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/newsletter" \
-H "Accept: application/json"

Example response:


    {
        "data": [
            {"id":253,"name":"Public Group 1","public":true,"user_checked":0}, 
            {"id":254,"name":"Public Group 2","public":true,"user_checked":1}
        ]
    }

HTTP Request

GET api/v1/scenarios/{scenario}/newsletter

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Update newsletter groups

This endpoint updates newsletter groups subscription.

Example request:


    curl -X POST https://api.mycitydemo.it/api/v1/scenarios/{scenario}/newsletter \
        -H 'accept: application/json' \
        -F 'groups={"groups": [254]}'

Example response:


    {
        "data": [
            {"id":253,"name":"Public Group 1","public":true,"user_checked":0}, 
            {"id":254,"name":"Public Group 2","public":true,"user_checked":1}
        ]
    }

HTTP Request

POST api/v1/scenarios/{scenario}/newsletter

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get specific user practices and drafts

This endpoint retrieves specific user practices and drafts from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/activities/practices-drafts" \
-H "Accept: application/json"

Example response:


{
    "data": [
        {
            "id": 2269,
            "type": "practices",
            "form_id": 8606,
            "subject": "Dichiarazione sostitutiva per accedere al fondo di solidarietà alimentare",
            "status": "Inviata",
            "status_color": "#00cc00",
            "created_at": "2021-09-17T10:28:01.000000Z",
            "new_messages": 1,
            "messages": [
                {
                    "id": 2403,
                    "type": "messages",
                    "practice_id": 2269,
                    "protocol_number": null,
                    "body": "html_body",
                    "readed": 0,
                    "sender_type": "user",
                    "attachments": [
                        {
                            "id": 3241,
                            "collection_name": "attachments",
                            "name": "coronavirus",
                            "file_name": "coronavirus.jpg",
                            "mime_type": "image/jpeg",
                            "size": 437243,
                            "human_readable_size": "427 KB",
                            "order_column": 2841,
                            "file_type": "image",
                            "url": "https://bussola-dev.s3.eu-west-1.amazonaws.com/3241/coronavirus.jpg",
                            "thumb_url": "https://bussola-dev.s3.eu-west-1.amazonaws.com/3241/conversions/coronavirus-thumb.jpg",
                            "created_at": "2021-09-17 12:27:09",
                            "liked": null,
                            "likes": 0,
                            "shared": null,
                            "shares": 0,
                            "links": [
                                {
                                    "rel": "self",
                                    "href": "http://api.mycity.social/api/v1/scenarios/5/media/3241"
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        "summary_pdf_url": "https://mycity.it/istanze-online/istanza-dettaglio/2404/download/uOCYCuCEIBM7nFZB"
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/activities/practices-drafts

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: messages, attachments).

Get specific user practices

This endpoint retrieves specific user practices from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/activities/practices" \
-H "Accept: application/json"

Example response:


{
    "data": [
        {
            "id": 2269,
            "type": "practices",
            "form_id": 8606,
            "subject": "Dichiarazione sostitutiva per accedere al fondo di solidarietà alimentare",
            "status": "Inviata",
            "status_color": "#00cc00",
            "created_at": "2021-09-17T10:28:01.000000Z",
            "new_messages": 1,
            "messages": [
                {
                    "id": 2403,
                    "type": "messages",
                    "practice_id": 2269,
                    "protocol_number": null,
                    "body": "html_body",
                    "readed": 0,
                    "sender_type": "user",
                    "attachments": [
                        {
                            "id": 3241,
                            "collection_name": "attachments",
                            "name": "coronavirus",
                            "file_name": "coronavirus.jpg",
                            "mime_type": "image/jpeg",
                            "size": 437243,
                            "human_readable_size": "427 KB",
                            "order_column": 2841,
                            "file_type": "image",
                            "url": "https://bussola-dev.s3.eu-west-1.amazonaws.com/3241/coronavirus.jpg",
                            "thumb_url": "https://bussola-dev.s3.eu-west-1.amazonaws.com/3241/conversions/coronavirus-thumb.jpg",
                            "created_at": "2021-09-17 12:27:09",
                            "liked": null,
                            "likes": 0,
                            "shared": null,
                            "shares": 0,
                            "links": [
                                {
                                    "rel": "self",
                                    "href": "http://api.mycity.social/api/v1/scenarios/5/media/3241"
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        "summary_pdf_url": "https://mycity.it/istanze-online/istanza-dettaglio/2404/download/uOCYCuCEIBM7nFZB"
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/activities/practices

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: messages, attachments).

Get specific user practice

This endpoint retrieves specific user practice from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/activities/practices/{practice}" \
-H "Accept: application/json"

Example response:


{
    "data":
        {
            "id": 2269,
            "type": "practices",
            "form_id": 8606,
            "subject": "Dichiarazione sostitutiva per accedere al fondo di solidarietà alimentare",
            "status": "Inviata",
            "status_color": "#00cc00",
            "created_at": "2021-09-17T10:28:01.000000Z",
            "new_messages": 1,
            "messages": [
                {
                    "id": 2403,
                    "type": "messages",
                    "practice_id": 2269,
                    "protocol_number": null,
                    "body": "html_body",
                    "readed": 0,
                    "sender_type": "user",
                    "attachments": [
                        {
                            "id": 3241,
                            "collection_name": "attachments",
                            "name": "coronavirus",
                            "file_name": "coronavirus.jpg",
                            "mime_type": "image/jpeg",
                            "size": 437243,
                            "human_readable_size": "427 KB",
                            "order_column": 2841,
                            "file_type": "image",
                            "url": "https://bussola-dev.s3.eu-west-1.amazonaws.com/3241/coronavirus.jpg",
                            "thumb_url": "https://bussola-dev.s3.eu-west-1.amazonaws.com/3241/conversions/coronavirus-thumb.jpg",
                            "created_at": "2021-09-17 12:27:09",
                            "liked": null,
                            "likes": 0,
                            "shared": null,
                            "shares": 0,
                            "links": [
                                {
                                    "rel": "self",
                                    "href": "http://api.mycity.social/api/v1/scenarios/5/media/3241"
                                }
                            ]
                        }
                    ]
                }
            ],
            "summary_pdf_url": "https://mycity.it/istanze-online/istanza-dettaglio/2404/download/uOCYCuCEIBM7nFZB"
        },
}

HTTP Request

GET api/v1/scenarios/{scenario}/activities/practices/{practice}

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: messages, attachments).

Get specific user drafts

This endpoint retrieves specific user drafts from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/activities/drafts" \
-H "Accept: application/json"

Example response:


{
    "data": [
    {
        "id": 33,
        "type": "drafts",
        "form_id": 8606,
        "subject": "Dichiarazione sostitutiva per accedere al fondo di solidarietà alimentare",
        "data": [
            {
                "control": "control_select_706121",
                "value": "1"
            },
            {
                "control": "control_text_100583",
                "value": "TPCLDA97M07Z100L"
            },
            {
                "control": "control_email_585578",
                "value": "aldotopciu@gmail.com"
            },
            {
                "control": "control_text_238990",
                "value": "Aldoo"
            },
            {
                "control": "control_datepicker_419122",
                "value": "05/01/2022"
            },
            {
                "control": "control_number_331310",
                "value": "1234567889"
            },
            {
                "control": "control_checkbox_318870",
                "value": true
            },
            {
                "control": "control_file_965933",
                "value": [
                    {
                        "id": 3233,
                        "collection_name": "attachments",
                        "name": "coronavirus",
                        "file_name": "coronavirus.jpg",
                        "mime_type": "image/jpeg",
                        "size": 437243,
                        "human_readable_size": "427 KB",
                        "order_column": 2833,
                        "file_type": "image",
                        "url": "https://bussola-dev.s3.eu-west-1.amazonaws.com/3233/coronavirus.jpg",
                        "thumb_url": null,
                        "created_at": "2021-09-15 14:13:27",
                        "liked": null,
                        "likes": 0,
                        "shared": null,
                        "shares": 0,
                        "links": [
                            {
                                "rel": "self",
                                "href": "http://api.mycity.social/api/v1/media/3233"
                            }
                        ]
                    },
                    {
                        "id": 3234,
                        "collection_name": "attachments",
                        "name": "cerca questo",
                        "file_name": "cerca-questo.jpg",
                        "mime_type": "image/jpeg",
                        "size": 888541,
                        "human_readable_size": "867.72 KB",
                        "order_column": 2834,
                        "file_type": "image",
                        "url": "https://bussola-dev.s3.eu-west-1.amazonaws.com/3234/cerca-questo.jpg",
                        "thumb_url": null,
                        "created_at": "2021-09-15 14:13:34",
                        "liked": null,
                        "likes": 0,
                        "shared": null,
                        "shares": 0,
                        "links": [
                            {
                                "rel": "self",
                                "href": "http://api.mycity.social/api/v1/media/3234"
                            }
                        ]
                    }
                ]
            },
            {
                "control": "control_checkbox_694333",
                "value": false
            },
            {
                "control": "control_datepicker_990080",
                "value": ""
            },
            {
                "control": "control_checkbox_982449",
                "value": false
            },
            {
                "control": "control_datepicker_207282",
                "value": ""
            }
        ],
        "created_at": "2021-09-15T12:12:58.000000Z"
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/activities/drafts

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get specific user appointments

This endpoint retrieves specific user appointments from a Scenario.

Example request:

curl -X GET "https://api.mycitydemo.it/api/v1/scenarios/{scenario}/activities/appointments" \
-H "Accept: application/json"

Example response:


{
    "data": [
        {
            "id": 148,
            "type": "appointments",
            "agenda_id": 1256,
            "service_id": 22,
            "subject": "Event",
            "name": "mario rossi",
            "email": "mariorossi@mycity.it",
            "phone": "",
            "message": "Lorem Ipsum",
            "is_event": 1,
            "reserved_spots": 1,
            "start": "2021-09-18 12:10:00",
            "end": "0000-00-00 00:00:00",
            "status": "disdetto",
            "created_at": "2021-05-06T10:36:48.000000Z",
            "attachments": [
                {
                    "id": 2811,
                    "collection_name": "attachments",
                    "name": "doc",
                    "file_name": "doc.jpg",
                    "mime_type": "image/jpeg",
                    "size": 437243,
                    "human_readable_size": "427 KB",
                    "order_column": 2442,
                    "file_type": "image",
                    "url": "https://bussola-dev.s3.eu-west-1.amazonaws.com/2811/doc.jpg",
                    "thumb_url": null,
                    "created_at": "2021-05-06 12:36:48",
                    "liked": null,
                    "likes": 0,
                    "shared": null,
                    "shares": 0,
                    "links": [
                        {
                            "rel": "self",
                            "href": "http://api.mycity.social/api/v1/scenarios/5/media/2811"
                        }
                    ]
                }
            ]
        },
        {
            "id": 167,
            "type": "appointments",
            "agenda_id": 1256,
            "service_id": 1,
            "subject": "Lorem Ipsum",
            "name": "mario rossi",
            "email": "mariorossi@mycity.it",
            "phone": "",
            "message": "Lorem ipsum",
            "is_event": 0,
            "reserved_spots": null,
            "start": "2021-06-14 08:00:00",
            "end": "2021-06-14 08:05:00",
            "status": "in attesa",
            "created_at": "2021-06-11T07:50:33.000000Z",
            "attachments": []
        },
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/activities/appointments

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.

Get Parameters

Parameter Type Description
include string The comma separated relation names (eg: attachments).

Delete a specific draft

This endpoint permits to delete a user draft.

Example request:

curl -X POST https://api.mycitydemo.it/api/v1/scenarios/{scenario}/drafts/{draft}/delete \
    -H 'accept: application/json'

Example response:


    {
        "data": {
            "success_message": 'Bozza eliminata con successo!'
        }
    }

HTTP Request

POST api/v1/scenarios/{scenario}/drafts/{draft}/delete

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
draft int The ID of the draft to delete.

Send practice message

This endpoint permits to save a message sent by the user.

Example request:

curl -X POST https://api.mycitydemo.it/api/v1/scenarios/{scenario}/practices/{practice}/send-message \
    -H 'accept: application/json' \
    -F 'body=Lorem ipsum' \
    -F 'attachments[]=@/home/utente/Scrivania/test.pdf'

Example response:


    {
        "data": {
            "id": 31129,
            "type": "messages",
            "practice_id": 29371,
            "protocol_number": null,
            "body": "Lorem ipsum",
            "readed": null,
            "sender_type": "user",
            "attachments": []
        }
    }

HTTP Request

POST api/v1/scenarios/{scenario}/practice/{practice}/send-message

Url Parameters

Parameter Type Description
scenario int The ID of the Scenario.
practice int The ID of the practice where to send the message.

FCM Tokens

Store / update a Token

In order to correctly store a token, please provide and authenticated user (by bearer token) AND/OR a scenario_id (in post parameters). Any changes to token will update existing token, so you can send the token without the bearer's token header, and then send call again the endpoint.

Example request:

curl -X POST \
  https://api.mycitydemo.it/api/v1/devices \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer [Bearer] \
  -H 'Content-Type: application/json' \
  -d '{
    "push_key": "544hn98mvc54nmv349343fc34tf54tvbm4",
    "scenario_id": 5,
    "type": "ios",
    "provider": "fcm"
}'

Example response:

{
    "provider": "fcm",
    "push_key": "544hn98mvc54nmv349343fc34tf54tvbm4",
    "scenario_id": 5,
    "type": "android",
    "user_id": 9,
    "updated_at": "2018-03-07 19:55:20",
    "created_at": "2018-03-07 19:55:20",
    "id": 3
}

HTTP Request

POST api/v1/devices

Header Parameters

Parameter Type Description Required
Authorization string the Bearer token, only for authenticated user no

POST Parameters

Parameter Type Description Required
provider string by default is "fcm" no
push_key string the push token yes
type string the type of device: "android" or "ios" yes
scenario_id int The ID of the Scenario. no

Receive test push messages

To test push message receiving, use /random from a scenario using your browser:

HTTP Request

GET https://[URL_SCENARIO]/random


> Example request:

```shell
curl https://agid.mycitydemo.it/random

Totems

Index scenario's totems

Example request:

curl https://api.mycitydemo.it/api/v1/scenarios/{scenario}/totems \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer [Bearer]

Example response:

{
    "data": [
        {
            "id": 24,
            "name": "TOTEM 1",
            "menu_id": 703,
            "scenario_id": 5,
            "color": "porpora",
            "style": null,
            "type": "informativo",
            "content_type": "gallery",
            "background": "gallery",
            "standby": "video",
            "links": [
                {
                    "rel": "self",
                    "href": "http://api.mycity.api/api/v1/scenarios/5//24"
                },
                {
                    "rel": "menu",
                    "href": "http://api.mycity.api/api/v1/scenarios/5//24/menu"
                },
                {
                    "rel": "highlights",
                    "href": "http://api.mycity.api/api/v1/scenarios/5//24/highlights"
                },
                {
                    "rel": "media",
                    "href": "http://api.mycity.api/api/v1/scenarios/5//24/media"
                }
            ]
        }
    ]
}

HTTP Request

GET api/v1/scenarios/{scenario}/totems

Header Parameters

Parameter Type Description Required
Authorization string the Bearer token, only for authenticated user no

GET Parameters

Parameter Type Description Required
scenario string scenario id yes

Get a totem

Example request:

curl https://api.mycitydemo.it/api/v1/scenarios/{scenario}/totems/{totem} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer [Bearer]

Example response:

{
    "data": {
        "id": 24,
        "name": "TOTEM 1",
        "menu_id": 703,
        "scenario_id": 5,
        "color": "porpora",
        "style": null,
        "type": "informativo",
        "content_type": "gallery",
        "background": "gallery",
        "standby": "video",
        "menu": [
            {
                "id": 685,
                "type": "albums",
                "title": "Arte Fiera Bologna 2018, al via tra mercato e spettacolo",
                "abstract": "Repudiandae est non voluptate repellat. Ea officia blanditiis tempora cumque quia. Dolorem sint aut quam explicabo. Dolorem reiciendis corrupti earum.",
                "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/541/conversions/thumb.jpg",
                "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/541/conversions/thumb.jpg",
                "deeplink": "mycity://scenarios/5/albums/685",
                "share_url": "http://istituzionale.mycity.api/album/685/arte-fiera-bologna-2018-via-mercato-spettacolo"
            },
            {
                "id": 705,
                "type": "videos",
                "title": "Gattini video 3",
                "abstract": "Gattini",
                "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/584/conversions/thumb.jpg",
                "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/584/conversions/thumb.jpg",
                "deeplink": "mycity://scenarios/5/videos/705"
            },
            {
                "id": 706,
                "type": "menus",
                "title": "menu mappozzo",
                "abstract": "",
                "icon_url": "http://api.mycity.api/images/app_icons/00-standard.png",
                "icon": "00-standard",
                "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/565/conversions/thumb.jpg",
                "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/565/conversions/thumb.jpg",
                "deeplink": "mycity://scenarios/5/menus/706"
            },
            {
                "id": 707,
                "type": "menus",
                "title": "menu semplice",
                "abstract": "",
                "icon_url": "http://api.mycity.api/images/app_icons/00-standard.png",
                "icon": "00-standard",
                "deeplink": "mycity://scenarios/5/menus/707"
            },
            {
                "id": 727,
                "type": "videos",
                "title": "CIAo",
                "abstract": "VIDEO",
                "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/602/conversions/thumb.jpg",
                "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/602/conversions/thumb.jpg",
                "deeplink": "mycity://scenarios/5/videos/727"
            }
        ],
        "highlights": [
            {
                "id": 684,
                "type": "albums",
                "title": "Fontana del Nettuno: restauro finito, il Gigante ritorna a splendere",
                "abstract": "Incidunt et autem praesentium occaecati sapiente ipsam. Quam adipisci cupiditate quis nobis est. Et molestias labore animi tempora. Velit ab facere molestiae. Omnis est vitae officia alias autem.",
                "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/521/conversions/thumb.jpg",
                "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/521/conversions/thumb.jpg",
                "deeplink": "mycity://scenarios/5/albums/684",
                "share_url": "http://istituzionale.mycity.api/album/684/fontana-nettuno-restauro-finito-gigante-ritorna"
            },
            {
                "id": 649,
                "type": "news",
                "title": "Dal 1° marzo riprende il lavaggio notturno delle vie del centro",
                "abstract": "Riprende dal 1° marzo fino al 28 giugno l'operazione \"Strade pulite\", sospesa per la pausa\n                invernale. Il service prevede il lavaggio notturno delle vie del centro storico, nonché dei primi\n                tratti delle radiali ad esso collegate.",
                "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/342/conversions/thumb.jpg",
                "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/342/conversions/thumb.jpg",
                "deeplink": "mycity://scenarios/5/news/649",
                "share_url": "http://istituzionale.mycity.api/notizie/649/1-marzo-riprende-lavaggio-notturno-vie-centro"
            },
            {
                "id": 646,
                "type": "news",
                "title": "M'Illumino di meno, venerdì 23 si spengono il Nettuno e Palazzo d'Accursio",
                "abstract": "Il Comune di Bologna aderisce all’iniziativa M’Illumino di meno, promossa dalla trasmissione\n                Caterpillar di Radio Rai 2, prevista per domani, venerdì 23 febbraio: una giornata pensata per\n                sensibilizzare i cittadini su risparmio energetico e stili di vita sostenibili.",
                "image_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/324/conversions/thumb.jpg",
                "image_thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/324/conversions/thumb.jpg",
                "deeplink": "mycity://scenarios/5/news/646",
                "share_url": "http://istituzionale.mycity.api/notizie/646/m-illumino-meno-venerdi-23-si-spengono-nettuno"
            }
        ],
        "background_video": [],
        "background_gallery": [
            {
                "id": 599,
                "collection_name": "background_gallery",
                "name": "ala",
                "file_name": "ala.png",
                "mime_type": "image/png",
                "size": 196838,
                "human_readable_size": "192.22 KB",
                "order_column": 583,
                "file_type": "image",
                "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/599/ala.png",
                "thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/599/conversions/thumb.jpg",
                "created_at": "2018-12-13 11:43:35",
                "liked": null,
                "likes": 0,
                "shared": null,
                "shares": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "http://api.mycity.api/api/v1/scenarios/5/media/599"
                    }
                ]
            },
            {
                "id": 600,
                "collection_name": "background_gallery",
                "name": "CMN_MAAP_20181126_01M.dat.thumb",
                "file_name": "CMN_MAAP_20181126_01M.dat.thumb.png",
                "mime_type": "image/png",
                "size": 20124,
                "human_readable_size": "19.65 KB",
                "order_column": 584,
                "file_type": "image",
                "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/600/CMN_MAAP_20181126_01M.dat.thumb.png",
                "thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/600/conversions/thumb.jpg",
                "created_at": "2018-12-13 11:43:35",
                "liked": null,
                "likes": 0,
                "shared": null,
                "shares": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "http://api.mycity.api/api/v1/scenarios/5/media/600"
                    }
                ]
            },
            {
                "id": 601,
                "collection_name": "background_gallery",
                "name": "cat_mm16_take_care_kitten_1",
                "file_name": "cat_mm16_take_care_kitten_1.jpg",
                "mime_type": "image/jpeg",
                "size": 288641,
                "human_readable_size": "281.88 KB",
                "order_column": 585,
                "file_type": "image",
                "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/601/cat_mm16_take_care_kitten_1.jpg",
                "thumb_url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/601/conversions/thumb.jpg",
                "created_at": "2018-12-13 14:57:39",
                "liked": null,
                "likes": 0,
                "shared": null,
                "shares": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "http://api.mycity.api/api/v1/scenarios/5/media/601"
                    }
                ]
            }
        ],
        "standby_video": [
            {
                "id": 594,
                "collection_name": "standby_video",
                "name": "CAP_serviti",
                "file_name": "CAP_serviti.csv",
                "mime_type": "text/plain",
                "size": 96722,
                "human_readable_size": "94.46 KB",
                "order_column": 582,
                "file_type": "unknown",
                "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/594/CAP_serviti.csv",
                "thumb_url": null,
                "created_at": "2018-12-13 11:35:08",
                "liked": null,
                "likes": 0,
                "shared": null,
                "shares": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "http://api.mycity.api/api/v1/scenarios/5/media/594"
                    }
                ]
            }
        ],
        "standby_gallery": [],
        "content_type_video": [
            {
                "id": 594,
                "collection_name": "content_type_video",
                "name": "CAP_serviti",
                "file_name": "CAP_serviti.csv",
                "mime_type": "text/plain",
                "size": 96722,
                "human_readable_size": "94.46 KB",
                "order_column": 582,
                "file_type": "unknown",
                "url": "https://bussola-dev.s3-eu-west-1.amazonaws.com/594/CAP_serviti.csv",
                "thumb_url": null,
                "created_at": "2018-12-13 11:35:08",
                "liked": null,
                "likes": 0,
                "shared": null,
                "shares": 0,
                "links": [
                    {
                        "rel": "self",
                        "href": "http://api.mycity.api/api/v1/scenarios/5/media/594"
                    }
                ]
            }
        ],
        "content_type_gallery": [],
        "links": [
            {
                "rel": "self",
                "href": "http://api.mycity.api/api/v1/scenarios/5//24"
            },
            {
                "rel": "menu",
                "href": "http://api.mycity.api/api/v1/scenarios/5//24/menu"
            },
            {
                "rel": "highlights",
                "href": "http://api.mycity.api/api/v1/scenarios/5//24/highlights"
            },
            {
                "rel": "media",
                "href": "http://api.mycity.api/api/v1/scenarios/5//24/media"
            }
        ]
    }
}

HTTP Request

GET api/v1/scenarios/{scenario}/totems/{totem}?include=menu,media,highlights,modules

Header Parameters

Parameter Type Description Required
Authorization string the Bearer token, only for authenticated user no

GET Parameters

Parameter Type Description Required
scenario string scenario id yes
totem string totem yes
include string ?include=menu,media,highlights,modules no

Login totem

Login to a specific totem

Example request:

curl -X POST https://api.mycitydemo.it/api/v1/scenarios/{scenario}/totems/{totem}/login \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer [Bearer]

Example response:


{
    "data": "User logged in successfully!"
}

HTTP Request

POST api/v1/scenarios/{scenario}/totems/{totem}/login

Header Parameters

Parameter Type Description Required
Authorization string Authenticated user Bearer token yes

Logout totem

Logout from a specific totem

Example request:

curl -X POST https://api.mycitydemo.it/api/v1/scenarios/{scenario}/totems/{totem}/logout \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer [Bearer]

Example response:


{
    "data": "User logged out successfully!"
}

HTTP Request

POST api/v1/scenarios/{scenario}/totems/{totem}/logout

Header Parameters

Parameter Type Description Required
Authorization string Authenticated user Bearer token yes

Authenticated User

This endpoint checks if user is authenticated to a specific totem

Example request:

curl -X POST https://api.mycitydemo.it/api/v1/scenarios/{scenario}/totems/{totem}/authenticated \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer [Bearer]

Example response:


{
    "data": true
}

HTTP Request

POST api/v1/scenarios/{scenario}/totems/{totem}/authenticated

Header Parameters

Parameter Type Description Required
Authorization string Authenticated user Bearer token yes

Header & Footer

Dagli endpoint seguenti sarà possibile ottenere gli header e i footer di un sito web, sia in formato HTML già stilizzato, sia in formato JSON per compilare un proprio template.

Recupera l'HTML del solo header del sito

Example request:

curl https://demopnrr.mycity.it/partials/header

Example response:

                                    
                                    

HTTP Request

GET partials/header

Recupera l'HTML del solo footer del sito

Example request:

curl https://demopnrr.mycity.it/partials/footer

Example response:

                                                
                                                

HTTP Request

GET partials/footer

Recupera in formato JSON header e footer del sito

Example request:

curl https://demopnrr.mycity.it/partials/json

Example response:


            {
                "region": {
                    "title": "Regione Emilia-Romagna",
                    "href": "http://www.regione.emilia-romagna.it"
                },
                "site": {
                    "title": "Comune di MyCity",
                    "url": "https://demopnrr.mycity.it/home",
                    "favicon": "https://mycity.s3.sbg.io.cloud.ovh.net/1933314/pa.png",
                    "theme-color": "#3257A0",
                    "theme-darker-color": "#1e3560",
                    "description": null
                },
                "header": {
                    "it-brand-wrapper": {
                        "href": "https://demopnrr.mycity.it/home",
                        "icon": "https://mycity.s3.sbg.io.cloud.ovh.net/1928464/pa.png",
                        "it-brand-title": "Comune di MyCity"
                    },
                    "it-right-zone": {
                        "it-socials": [
                            {
                                "title": "Twitter",
                                "icon": "it-twitter",
                                "href": "PietroCalzolari"
                            },
                            {
                                "title": "Facebook",
                                "icon": "it-facebook",
                                "href": "ComunediMiglianico"
                            },
                            {
                                "title": "Telegram",
                                "icon": "it-telegram",
                                "href": "https://t.me/comune_di_demo"
                            }
                        ],
                        "search-link": "https://demopnrr.mycity.it/ricerca-avanzata"
                    },
                    "main-navigation": [
                        {
                            "title": "Amministrazione",
                            "href": "https://demopnrr.mycity.it/amministrazione",
                            "data-element": "management"
                        },
                        {
                            "title": "Novità",
                            "href": "https://demopnrr.mycity.it/novita",
                            "data-element": "news"
                        },
                        {
                            "title": "Servizi",
                            "href": "https://demopnrr.mycity.it/servizi",
                            "data-element": "all-services"
                        },
                        {
                            "title": "Vivere il comune",
                            "href": "https://demopnrr.mycity.it/vivere-il-comune",
                            "data-element": "live"
                        }
                    ],
                    "navbar-secondary": [
                        {
                            "title": "Accesso all'informazione",
                            "href": "https://demopnrr.mycity.it/argomenti/argomento-dettaglio/1456522"
                        },
                        {
                            "title": "j argo",
                            "href": "https://demopnrr.mycity.it/argomenti/argomento-dettaglio/1852656"
                        },
                        {
                            "title": "Acqua",
                            "href": "https://demopnrr.mycity.it/argomenti/argomento-dettaglio/1456523"
                        },
                        {
                            "title": "Tutti gli argomenti...",
                            "href": "/argomenti",
                            "data-element": "all-topics"
                        }
                    ]
                },
                "footer": {
                    "it-brand-wrapper": {
                        "href": "https://demopnrr.mycity.it/home",
                        "icon": "https://mycity.s3.sbg.io.cloud.ovh.net/1928464/pa.png",
                        "it-brand-title": "Comune di MyCity"
                    },
                    "rows": [
                        [
                            [
                                {
                                    "title": "Amministrazione",
                                    "href": "https://demopnrr.mycity.it/amministrazione",
                                    "items": [
                                        [
                                            {
                                                "title": "Organi di governo",
                                                "href": "https://demopnrr.mycity.it/organi-di-governo"
                                            },
                                            {
                                                "title": "Aree amministrative",
                                                "href": "https://demopnrr.mycity.it/aree-amministrative"
                                            },
                                            {
                                                "title": "Uffici",
                                                "href": "https://demopnrr.mycity.it/uffici"
                                            },
                                            {
                                                "title": "Enti e fondazioni",
                                                "href": "https://demopnrr.mycity.it/enti-e-fondazioni"
                                            },
                                            {
                                                "title": "Politici",
                                                "href": "https://demopnrr.mycity.it/politici"
                                            },
                                            {
                                                "title": "Personale amministrativo",
                                                "href": "https://demopnrr.mycity.it/personale-amministrativo"
                                            },
                                            {
                                                "title": "Documenti e dati",
                                                "href": "https://demopnrr.mycity.it/documenti-e-dati"
                                            }
                                        ]
                                    ]
                                }
                            ],
                            [
                                {
                                    "title": "Categorie di servizio",
                                    "href": "https://demopnrr.mycity.it/servizi",
                                    "items": [
                                        [
                                            {
                                                "title": "Anagrafe e stato civile",
                                                "href": "https://demopnrr.mycity.it/anagrafe-e-stato-civile"
                                            },
                                            {
                                                "title": "Cultura e tempo libero",
                                                "href": "https://demopnrr.mycity.it/cultura-e-tempo-libero"
                                            },
                                            {
                                                "title": "Vita lavorativa",
                                                "href": "https://demopnrr.mycity.it/vita-lavorativa"
                                            },
                                            {
                                                "title": "Imprese e commercio",
                                                "href": "https://demopnrr.mycity.it/imprese-e-commercio"
                                            },
                                            {
                                                "title": "Appalti pubblici",
                                                "href": "https://demopnrr.mycity.it/appalti-pubblici"
                                            },
                                            {
                                                "title": "Catasto e urbanistica",
                                                "href": "https://demopnrr.mycity.it/catasto-e-urbanistica"
                                            },
                                            {
                                                "title": "Turismo",
                                                "href": "https://demopnrr.mycity.it/turismo"
                                            },
                                            {
                                                "title": "Mobilità e trasporti",
                                                "href": "https://demopnrr.mycity.it/mobilita-e-trasporti"
                                            }
                                        ],
                                        [
                                            {
                                                "title": "Educazione e formazione",
                                                "href": "https://demopnrr.mycity.it/educazione-e-formazione"
                                            },
                                            {
                                                "title": "Giustizia e sicurezza pubblica",
                                                "href": "https://demopnrr.mycity.it/giustizia-e-sicurezza-pubblica"
                                            },
                                            {
                                                "title": "Tributi, finanze e contravvenzioni",
                                                "href": "https://demopnrr.mycity.it/tributi-finanze-e-contravvenzioni"
                                            },
                                            {
                                                "title": "Ambiente",
                                                "href": "https://demopnrr.mycity.it/ambiente"
                                            },
                                            {
                                                "title": "Salute, benessere e assistenza",
                                                "href": "https://demopnrr.mycity.it/salute-benessere-e-assistenza"
                                            },
                                            {
                                                "title": "Autorizzazioni",
                                                "href": "https://demopnrr.mycity.it/autorizzazioni"
                                            },
                                            {
                                                "title": "Agricoltura e pesca",
                                                "href": "https://demopnrr.mycity.it/agricoltura-e-pesca"
                                            }
                                        ]
                                    ]
                                }
                            ],
                            [
                                {
                                    "title": "Novità",
                                    "href": "https://demopnrr.mycity.it/novita",
                                    "items": [
                                        [
                                            {
                                                "title": "Notizie",
                                                "href": "https://demopnrr.mycity.it/notizie"
                                            },
                                            {
                                                "title": "Comunicati",
                                                "href": "https://demopnrr.mycity.it/comunicati"
                                            },
                                            {
                                                "title": "Avvisi",
                                                "href": "https://demopnrr.mycity.it/avvisi"
                                            }
                                        ]
                                    ]
                                },
                                {
                                    "title": "Vivere il comune",
                                    "href": "https://demopnrr.mycity.it/vivere-il-comune",
                                    "items": [
                                        [
                                            {
                                                "title": "Luoghi",
                                                "href": "https://demopnrr.mycity.it/luoghi"
                                            },
                                            {
                                                "title": "Eventi",
                                                "href": "https://demopnrr.mycity.it/eventi"
                                            }
                                        ]
                                    ]
                                }
                            ]
                        ],
                        [
                            [
                                {
                                    "title": "Contatti",
                                    "items": [
                                        [
                                            {
                                                "title": "Comune di MyCity

Via San Vitale, 7 - 40125, Bologna (BO)

\r\n\r\n

igygiygygiugiu

" }, { "title": "P.IVA: 000000000000000" }, { "title": "Tel: 051273588" }, { "title": "Email: info@mycity.it", "href": "mailto:info@mycity.it" } ], [ { "title": "Leggi le FAQ", "href": "/faq" }, { "title": "Prenotazione appuntamento", "href": "/agenda-smart" }, { "title": "Segnalazione disservizio", "href": "/segnalazioni/segnalazione-disservizio/crea" }, { "title": "Richiesta d'assistenza", "href": "/richiesta-assistenza" } ], [ { "title": "Amministrazione trasparente", "href": "/amministrazione-trasparente" }, { "title": "Informativa privacy", "href": "/privacy" }, { "title": "Note legali", "href": "https://demopnrr.mycity.it/note-legali" }, { "title": "Dichiarazione di accessibilità", "href": "https://form.agid.gov.it/view/c68164a7-1476-4bd1-b234-7c86096e005a/" }, { "title": "Piano di miglioramento del sito", "href": "https://demopnrr.mycity.it/piano-miglioramento" } ] ] } ], [ { "title": "Seguici su", "items": [ [ { "title": "Twitter", "icon": "it-twitter", "href": "PietroCalzolari" }, { "title": "Facebook", "icon": "it-facebook", "href": "ComunediMiglianico" }, { "title": "Telegram", "icon": "it-telegram", "href": "https://t.me/comune_di_demo" } ] ] } ] ] ], "footer-bottom": [ { "title": "Mappa del Sito", "href": "https://demopnrr.mycity.it/mappa-del-sito" }, { "title": "© MyCity", "href": "https://www.mycity.it/" } ] } }

HTTP Request

GET partials/json