Chapter Point Custom Properties

As for Events and Categories, ChapterPoints can have Custom Properties too. They provide a means for storing any additional information which does not have a suitable location elsewhere in the system.

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
}

Note: id is required when updating a specific Custom Property, but optional when adding.

Note: Category & Key combinations are unique within the system and will update existing values if re-sent.

Response: 200 OK

POST /chapterpoint/customproperty/bulk/{chapterPointId}

Add or Update many Chapter Point Custom Properties by ChapterPoint Id.

Request Body:

[
  {
    "id": "d6ffb159-daa5-43d4-b310-146c6fdb9b4b",
    "category": "example-category",
    "key": "example-key",
    "value": "example-value"
  },
  {
    "category": "another-category",
    "key": "another-key",
    "value": "another0-value"
  }
]

Note: id is required when updating a specific Custom Property, but optional when adding.

Note: Category & Key combinations are unique within the system and will update existing values if re-sent.

Response: 200 OK

GET /chapterpoint/customproperty/

Get many Chapter Point Custom Properties.

Query Parameters:

Name Type Required Description
chapterPointId Guid No The Id of the ChapterPoint to filter to.
category String No The Category value to filter to.
key String No The Key value to filter to.
value String No The Value value to filter to.

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

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/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.

GET /chapterpoint/customproperty/clone/

Clone Chapter Point Custom Properties from one Chapter Point to another.

Query Parameters:

Name Type Required Description
sourceChapterId Guid Yes The ChapterPoint Id to copy from.
targetChapterId Guid Yes The ChapterPoint Id to copy to.
removeSource bool No Whether or not to remove the properties from the source ChapterPoint. Defaults to False.

Response: 200 OK

DEL /chapterpoint/customproperty/{id}

Delete a Chapter Point Custom Property by Id.

Response: 200 OK

DEL /chapterpoint/customproperty/

Delete many Chapter Point Custom Properties.

Query Parameters:

Name Type Required Description
chapterPointId Guid No The Id of the ChapterPoint to filter to.
category String No The Category value to filter to.
key String No The Key value to filter to.
value String No The Value value to filter to.

Note: at least 1 parameter must be provided otherwise you will receive a 400 Bad Request response.

Response: 200 OK