Record note listing

GET /api/v1/records/ record_id /notes/

Access Restrictions:
Unless the user accessing the notes for this record has a verified claim on the player associated with it, access to this endpoint requires at least LIST_HELPER permissions.

Allows retrieving a list of notes associated with the specified record.

If a user is not LIST_HELPER, only notes where is_public is true will be shown.

Request

Header Expected Value Optional
Authorization Pointercrate access token true

Response: 200 OK

Header Value
Content-Type application/json
Field Type Description
- List[Note] A list of the notes associated with this record

Errors:

Status code Error code Description
404 40401 No record with the specified ID exists

Example request

GET /api/v1/records/2/notes/
Authorization: Bearer <omitted>
Accept: application/json

Adding record notes

POST /api/v1/records/ record_id /notes/

Access Restrictions:
Access to this endpoint requires at least LIST_HELPER permissions.

Adds a note to the specified record.

Request:

Header Expected Value Optional
Content-Type application/json false
Authorization Pointercrate access token false
Field Type Description Optional
content string The content of the new note false
is_public boolean If this note should be visible to the record submitter true

Response: 201 CREATED

Header Value
Content-Type application/json
Location The location of the newly created demon
ETag unsigned 64 bit hash of the newly created note
Field Type Description
data Note The newly created record note object

Errors:

Status code Error code Description
404 40401 No record with the specified ID exists
422 42230 The content field is the empty string

Example request:

POST /api/v1/records/1/notes/
Accept: application/json
Authorization: Bearer <omitted>
Content-Type: application/json

{
    "content": "Maybe hacked, waiting on proof-stream"
}

Modifying record notes

PATCH /api/v1/records/ record_id /notes/ note_id /

Access Restrictions:
Access to this endpoint requires at least LIST_HELPER permissions if you modify your own note, or LIST_ADMINISTRATOR to modify arbitrary notes.

Modifies the specified note’s content

Request:

Header Expected Value Optional
Content-Type application/json false
Authorization Pointercrate access token false
Field Type Description Optional
content string The new content of the note true
is_public boolean If this note should be visible to the record submitter true

Response: 200 OK

Header Value
Content-Type application/json
Location The location of the newly created demon
ETag unsigned 64 bit hash of the note
Field Type Description
data Note The newly created record note object

Errors:

Status code Error code Description
404 40401 No record with the specified ID exists, or no note with the specified ID exists
422 42230 The content field is the empty string

Example request:

POST /api/v1/records/1/notes/1/
Accept: application/json
Authorization: Bearer <omitted>
Content-Type: application/json

{
    "content": "Maybe hacked, waiting on proof-stream"
}

Deleting record notes

DELETE /api/v1/records/ record_id /notes/ note_id /

Access Restrictions:
Access to this endpoint requires at least LIST_HELPER permissions if you delete your own note, or LIST_ADMINISTRATOR to delete arbitrary notes.

Deletes the specified note

Request:

Header Expected Value Optional
Authorization Pointercrate access token false

Response: 204 NO CONTENT

Nothing

Errors:

Status code Error code Description
404 40401 No record with the specified ID exists, or no note with the specified ID exists

Example request:

DELETE /api/v1/records/1/notes/1/
Accept: application/json
Authorization: Bearer <omitted>