Zencity Engage Public API Documentation for GET Engagement

API requests must be made with the Content-Type of application/vnd.api+json

Engagement

This endpoint returns a list with the specific properties (listed below e.g. hero image, engagement sort order) related to the specific engagement you have selected in your Zencity Engage instance.

GET /api/v1/engagement/:id

The following fields are available:

{
   "data":{
      "id": ID,
      "type": STRING,
      "attributes":{
         "title": STRING,
         "description": STRING,
         "start_time": DATETIME,
         "end_time": DATETIME,
         "public_status": STRING,
         "submissions_count": INTEGER
      },
      "relationships":{
         "project":{
            "data":{
               "id": ID,
               "type": STRING
            }
         }
      }
   },
   "included":[
      {
         "id": ID,
         "type": STRING,
         "attributes":{
            "title": STRING,
            "slug": STRING,
            "public": BOOLEAN
         },
         "relationships":{
            "hero_image":{
               "data":{
                  "id": ID,
                  "type": STRING
               }
            }
         },
         "meta":{
            "engagement_sort_order":[INTEGER]
         }
      }
   ]
}

Example

	{
   "data":{
      "id":"12",
      "type":"engagement",
      "attributes":{
         "title":"Transportation Survey",
         "description":"Elm Street is a critical transportation and development corridor linking to Highway 20 and beyond. This project is to improve pedestrian, bicycle, bus and motorist routes along Elm street to alleviate the challenges that we currently face. ",
         "start_time":"2019-11-17T16:00:00.000-08:00",
         "end_time":null,
         "public_status":"open",
         "submissions_count":8
      },
      "relationships":{
         "project":{
            "data":{
               "id":"5",
               "type":"project"
            }
         }
      }
   },
   "included":[
      {
         "id":"5",
         "type":"project",
         "attributes":{
            "title":"Templates",
            "slug":"templates",
            "public":false
         },
         "relationships":{
            "hero_image":{
               "data":null
            }
         },
         "meta":{
            "engagement_sort_order":[
               12,
               16,
               10,
               14,
               11,
               13,
               15,
               17,
               18,
               29
            ]
         }
      }
   ]
}