Submitter listing

GET /submitters/

Pagination:
This endpoint supports pagination and filtering via query parameters. Please see the documentation on pagination for information on the additional request and response fields headers.

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

Filtering:

The result can be filtered by any of the following fields: submitter_id, banned.

Pagination is done via the submitter_id field.

Request:

Header Value
Content-Type application/json
Header Expected Value Optional
Authorization Pointercrate access token false

Response: 200 OK

Field Type Description
- List[Submitter] A list of submitters

Example request:

GET /api/v1/submitters/
     Accept: application/json
     Authorization: Bearer <omitted>

Submitter retrieval

GET /submitters/ submitter_id /

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

Request:

Header Expected Value Optional
Authorization Pointercrate access token false
If-Match Conditional request header. If the etag value of the requested data matches any of the here provided values, the data is returned as requested. Otherwise a 412 PRECONDITION FAILED response is generated true
If-None-Match Conditional request header. If the etag value of the requested data does not match any of the here provided values, if it returned as requested. Otherwise, a 304 NOT MODIFED response is generated true

Response: 200 OK

Header Value
Content-Type application/json
ETag base64 encoded hash of the submitter object
Field Type Description
data Submitter The requested submitter object

Response: 304 NOT MODIFIED

Returned if the If-None-Match header is set, and the etag for the submitter object matches one of the set values.

Header Value
ETag base64 encoded hash of the submitter object

Errors:

Status code Error code Description
404 40401 No submitter with id submitter_id was found

Example request:

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

Banning a submitter

PATCH /submitters/ submitter_id /

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

Request:

Header Expected Value Optional
Content-Type application/merge-patch+json false
Authorization Pointercrate access token false
If-Match Conditional request header. Needs to be set to the current etag value of the submitter object false
Field Type Description Optional
banned boolean Update the submitter's banned status true

Response: 200 OK

Header Value
Content-Type application/json
ETag base64 encoded hash of the updated submitter
Field Type Description
data Submitter The updated submitter object

Response: 304 NOT MODIFIED

Returned when the PATCH operation did not make any changes.

Header Value
ETag base64 encoded hash of the submitter

Errors:

Status code Error code Description
400 40003 Invalid data type for requested field
403 40302 The requested field cannot be updated via this endpoint
404 40401 No submitter with id submitter_id was found

Example request:

PATCH /api/v1/submitters/2/
     Accept: application/json
     Authorization: Bearer <omitted>
     Content-Type: application/merge-patch+json
     If-Match: Pi0YjDmf-_EGc9fDY7xZJHQCC20=
     
     {
         "banned": true
     }