EventResource
The following resources are applicable:
/events
Mount Point: /../../../api/v1/events
GET
Returns an event list according to search parameters.
STATUS CODES :
200 - OK
Parameters
| name | description | type | default |
|---|---|---|---|
| modifiedSince | timestamp in millisecond after which a modification occurred | query | |
| count | the maximum number of events to be returned | query | |
| startIndex | the start index of the list | query | |
| query | search matching criteria in title, description, punchline, ... | query | |
| includePastEvents | (no documentation provided) | query |
Response Body
| element: | eventListResponse |
| media types: | application/xml application/json |
an event list according to search parameters
POST
Create an event.
Status of created event will be DRAFT
To actually publish the event, you shall first upload a picture then update the status to PUBLISHED
STATUS CODES :
200 - The event was created
400 - There was errors processing the request, the body will contain a message
Request Body
| element: | event |
| media types: | application/xml application/json |
event data
Response Body
| element: | eventResponse |
| media types: | application/xml application/json |
the created event or a message if the status is not 200
/events/{eventId}
Mount Point: /../../../api/v1/events/{eventId}
GET
Gets detailed event by sowprog id
STATUS CODES :
200 - The event is returned
404 - The id does not exist
Parameters
| name | description | type | default |
|---|---|---|---|
| eventId | sowprog event id | path |
Response Body
| element: | eventResponse |
| media types: | application/xml application/json |
the detailed event
PUT
Update an event .
Only fields that are provided are updated. If a field with an empty value is provided, checks are enforced.
Example : if title is not provided, it will not be updated. If it is provided as an empty value, you will get an error message saying it is mandatory.
STATUS CODES :
200 - The event was updated
404 - The id does not exist
400 - There was errors processing the request, the body will contain a message
Parameters
| name | description | type | default |
|---|---|---|---|
| eventId | sowprog event id | path |
Request Body
| element: | event |
| media types: | application/xml application/json |
event data
Response Body
| element: | eventResponse |
| media types: | application/xml application/json |
the created event or a message if the status is not 200
/events/{eventId}/picture
Mount Point: /../../../api/v1/events/{eventId}/picture
PUT
Defines event associated image.
The form must be encoded as a multipart/form-data and the data parameter key must be "file"
STATUS CODES :
200 - The event is returned
404 - The id does not exist
400 - error processing the file, the body will contain a message
Parameters
| name | description | type | default |
|---|---|---|---|
| eventId | sowprog event id | path | |
| fileInputStream | (no documentation provided) | formdata | |
| contentDispositionHeader | (no documentation provided) | formdata |
Response Body
| element: | eventResponse |
| media types: | application/xml application/json |
the updated event