CHAPTER POINT CUSTOM PROPERTIES

Chapter Points can have Custom Properties. These actions focus on managing those properties.


Chapter Point Custom Property Object

{
    "id": "e45fc55e-957a-4cab-9e05-94b27508e04a",
    "key": "Key-Here",
    "category": "Category-Here",
    "value": "Value-Here",
    "chapterPointId": "89cff243-9773-437c-a04e-ab3ffe75eda2"
}

Supported Actions

POST /chapterpoint/customproperty/

Add or Update a Chapter Point Custom Property.

Request Body:

{
  "Id": null,
  "ChapterPointId": "70be8065-2ab4-4d06-8234-13d512f63d11",
  "Category": "Category-goes-here",
  "Key": "Key-goes-here",
  "Value": "Value-goes-here",
  "RefreshIndex": false
}

If the Id is specified then it will perform an Update, else it will Add a new one, as long as the Category and Key does not already exist - if they do, it will be updated to the new value.

Response: 200 OK


GET /chapterpoint/customproperty/{id}

Get a Chapter Point Custom Property by Id.

Response: 200 OK and JSON containing a Chapter Point Custom Property object.


GET /chapterpoint/{chapterPointId}/customproperty/

Get all Custom Properties for the given Chapter Point Id.

Response: 200 OK and a JSON array containing multiple Chapter Point Custom Property object.


GET /chapterpoint/customproperty/event/{eventId}

Get all Custom Properties for Chapter Points on a given Event Id.

Response: 200 OK and a JSON array containing multiple Chapter Point Custom Property object.


DEL /chapterpoint/customproperty/{id}

Delete a Chapter Point Custom Property by Id.

Response: 200 OK