Session ratings

Session ratings: available fields, filters, associations, and API operations.

Operations

Event-level resource. Every operation requires an enabled Core API scope for this resource and access to the URL context.

GETList records

/api/core/organizations/123/events/456/session-ratings

Permission: Read access. Readable fields, query filters and related objects must be selected in the scope.

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request GET \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/session-ratings' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}"

Response: 200 OK. A JSON:API data array and pagination metadata. Default page size 30; maximum 100.

View response structure

{
  "data": [
    {
      "id": "1201",
      "type": "session-rating"
    }
  ],
  "meta": {
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

Illustrative, with no additional response fields selected.

Errors: 400 for invalid parameter shapes; 403 for a missing/expired token or disallowed operation; 404 when the URL context, record or a referenced record is inaccessible; 429 for rate limits. Troubleshooting and retry guidance.

GETGet a record

/api/core/organizations/123/events/456/session-ratings/1201

Permission: Read access. Readable fields, query filters and related objects must be selected in the scope.

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request GET \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/session-ratings/1201' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}"

Response: 200 OK. A JSON:API data object; fields depend on the token scope.

View response structure

{
  "data": {
    "id": "1201",
    "type": "session-rating"
  }
}

Illustrative, with no additional response fields selected.

POSTCreate a record

/api/core/organizations/123/events/456/session-ratings

Permission: Write access with the create action. Every request key must map to an allowed writable field; unconfigured inputs are ignored.

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request POST \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/session-ratings' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "simple_rateable_id": 5501,
  "registrant_id": 1201,
  "score": 4
}'

Response: 201 Created. Save data.id for later requests. Attributes come from Write-response fields.

View response structure

{
  "data": {
    "id": "1201",
    "type": "session-rating"
  }
}

Illustrative, with no additional response fields selected.

Errors: 400 for invalid parameter shapes; 403 for a missing/expired token or disallowed operation; 404 when the URL context, record or a referenced record is inaccessible; 422 for validation or business rules; 429 for rate limits. Troubleshooting and retry guidance.

PATCHUpdate a record

/api/core/organizations/123/events/456/session-ratings/9301

Permission: Write access with the update action. Every request key must map to an allowed writable field; unconfigured inputs are ignored.

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request PATCH \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/session-ratings/9301' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "score": 5,
  "comment": "Excellent after the final discussion"
}'

Response: 200 OK. Attributes come from Write-response fields; these can differ from readable fields.

View response structure

{
  "data": {
    "id": "1201",
    "type": "session-rating"
  }
}

Illustrative, with no additional response fields selected.

Errors: 400 for invalid parameter shapes; 403 for a missing/expired token or disallowed operation; 404 when the URL context, record or a referenced record is inaccessible; 422 for validation or business rules; 429 for rate limits. Troubleshooting and retry guidance.

PATCH changes supplied fields. Collection inputs can replace existing values; read the input notes before sending arrays.

Path: events/{event_id}/session-ratings
Methods: GET collection/record, POST, PATCH. There is no DELETE operation.

Fields, filters and associations

Browse 8 response fields

The scope chooses these response fields. id is always returned. Configuration names and response names can differ.

event-id: Scope field: event_id
session-id: Scope field: simple_rateable_id
registrant-id: Scope field: registrant_id
score: Scope field: score
comment: Scope field: comment
skipped: Scope field: skipped
created-at: Scope field: created_at
updated-at: Scope field: updated_at

Filters: simple_rateable_id (the session ID), registrant_id, score, created_from, created_to.
Associations: none.

GET .../session-ratings?simple_rateable_id=5501

POST inputs: simple_rateable_id, registrant_id, score, comment.

{
  "simple_rateable_id": 5501,
  "registrant_id": 1201,
  "score": 4,
  "comment": "Good session"
}

The session and registrant must belong to the event, and the registrant must have an associated Brella user. POST is an upsert for the session and registrant pair. A score of 0 means skipped. PATCH accepts score and comment; the session and registrant cannot be changed.