PlaceTopics

PlaceTopics Service

Web service endpoints for interacting with place topics. See PlaceTopic for an example of the JSON representation.

Since: 3.8

Create Place Topic

POST /placeTopics

Create a new place topic entry based on the characteristics in the incoming place topic object.

Query Parameters:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned (default value is @all)
Takes:
  • PlaceTopic containing the required data to construct a new place topic entry
  • Retrieves:
  • PlaceTopic representing the newly created place topic
  • PlaceTopic representing the newly created place topic entry
  • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    400 (Bad Request)An input field is missing or malformed
    403 (Forbidden)You are not allowed to create this place topic entry
    Since: 3.8

    Destroy Place Topic

    DELETE /placeTopics/{placeTopicID}

    Delete the specified place topic.

    Path Parameters:
    NameTypeRequiredDescription
    placeTopicIDStringtrueID of the place topic to be deleted
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to access this place topic
    404 (Not Found)The specified place topic does not exist
    Since: 3.8

    Get Place Topic

    GET /placeTopics/{placeTopicID}

    Return a PlaceTopic whose name matches the specified name.

    Availability:

    Available to Jive admins only

    Path Parameters:
    NameTypeRequiredDescription
    placeTopicIDStringtrueID of the place topic to be returned
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned for each place topic (default value is @all)
    Retrieves:
  • PlaceTopic
  • Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)Any input field is missing or malformed
    404 (Not Found)The name does not match a valid place topic
    403 (Forbidden)The requesting user is not authorized to retrieve place topics
    Since: 3.8

    Get Place Topics

    GET /placeTopics

    Return a PlaceTopic whose name matches the specified name.

    Availability:

    Available to Jive admins only

    Query Parameters:
    NameTypeRequiredDescription
    startIndexIntegerfalseThe zero-relative index of the first matching content to be returned (default value is 0)
    filterObject[]falseFilter expression(s) used to select matching results
    countIntegerfalseThe maximum number of contents to be returned (default value is 25)
    fieldsStringfalseFields to be returned for each place topic (default value is @all)
    Retrieves:
  • PlaceTopic
  • Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)Any input field is missing or malformed
    404 (Not Found)The name does not match a valid place topic
    403 (Forbidden)The requesting user is not authorized to retrieve place topics
    Since: 3.8

    Update Place Topic

    PUT /placeTopics/{placeTopicID}

    Update the place topic with the specified characteristics.

    Path Parameters:
    NameTypeRequiredDescription
    placeTopicIDStringtrueID of the place topic to be updated
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to include in the returned entity (default value is @all)
    Takes:
  • PlaceTopic representing the updated place topic
  • Retrieves:
  • An PlaceTopic representing the updated place topic
  • 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 place topic
    404 (Not Found)The specified place topic cannot be found
    Since: 3.8