Slide

Slide Service

Create Slide

POST /slides

Create a new slide with the specified characteristics.

Query Parameters:
NameTypeRequiredDescription
fieldsStringfalseFields to include in the returned Slide
Takes:
  • Slide describing the slide to be created
  • Retrieves:
  • Slide
  • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    400 (Bad Request)An input field is missing or malformed
    409 (Conflict)You attempt to add an slide to a non-place object, or to a place that does not support them
    403 (Forbidden)You are not allowed to create announcements in the specified place
    404 (Not Found)The specified parent place cannot be found

    Destroy Slide

    DELETE /slides/{slideID}

    Delete the specified slide.

    Path Parameters:
    NameTypeRequiredDescription
    slideIDStringtrueID of the announcement to be deleted
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)An input field is missing or malformed
    403 (Forbidden)You are not allowed to delete the specified announcement
    404 (Not Found)The specified announcement cannot be found

    Get Slide

    GET /slides/{slideID}

    Retrieve and return the specified slide.

    Path Parameters:
    NameTypeRequiredDescription
    slideIDStringtrueID of the slide to be returned
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned
    Retrieves:
  • Slide
  • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)If an input field is missing or malformed
    403 (Forbidden)If you are not allowed to access the specified announcement
    404 (Not Found)If the specified announcement cannot be found

    Get Slides

    GET /slides

    Return the slides for the specified carousel.

    Query Parameters:
    NameTypeRequiredDescription
    filtersObject[]falseThe filter criteria used to select content objects
    countIntegerfalseMaximum number of checkpoints to be returned (default is 25)
    startIndexIntegerfalseZero-relative offset of the first checkpoint to be returned (default is 0)
    fieldsStringfalseFields to include in each returned Slide
    Retrieves:
  • Slide[]
  • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)If an input field is missing or malformed
    409 (Conflict)if the given ID does not refer to a project
    403 (Forbidden)if you are not allowed to perform this operation
    404 (Not Found)if the specified project cannot be found

    Update Slide

    PUT /slides/{slideID}

    Update the specified slide with the specified characteristics.

    Path Parameters:
    NameTypeRequiredDescription
    slideIDStringtrueID of the slide to be updated
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to include in the returned entity
    Takes:
  • Slide representing the updated slide
  • Retrieves:
  • An Slide representing the updated announcement
  • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is missing or malformed
    403 (Forbidden)You are not allowed to access the specified announcement
    404 (Not Found)The specified announcement cannot be found