Get case file
/api/cases/{id}One case file: reasons, the written reason, the evidence, and the profile at the time. evidence is null unless the caller holds ViewEvidence. snapshot.explanation says when the profile was captured and how old it was then; the snapshot never changes afterwards except for the one permitted recapture, which snapshot.canCaptureAgain offers when a fresher profile has arrived. evidenceDelivery repeats what the Settings evidence card says about how bytes travel, so the attach control can say the same thing.
Needs the ViewProfile permission.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Path Parameters
uuidResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/api/cases/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "userId": "string", "displayName": null, "groupId": null, "auditEntryId": null, "banFactId": null, "bannedAt": null, "bannedBy": null, "authorUserId": "ea75109d-c5c5-4407-b0ab-0da27cd41c18", "authorUsername": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "updatedByUsername": null, "reasons": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "label": "string", "isActive": true } ], "writtenReason": "string", "withdrawn": true, "withdrawnAt": null, "withdrawnByUsername": null, "withdrawnNote": null, "snapshot": { "profile": null, "membership": null, "banListEntry": null, "takenAt": "2019-08-24T14:15:22Z", "profileRefreshedAt": null, "profileAgeSecondsAtCapture": null, "recapturedAt": null, "profileRefreshedNow": null, "canCaptureAgain": true, "explanation": "string" }, "evidence": null, "evidenceDelivery": { "configured": true, "uploadsAllowed": true, "storeExplanation": "string", "directDelivery": true, "maxFileBytes": 0, "acceptedTypes": [ "string" ] }, "canEdit": true, "canAttach": true, "canViewEvidence": true, "now": "2019-08-24T14:15:22Z", "canDestroyEvidence": false, "lifted": null, "clips": null, "clipStatus": null}Check for case files GET
Whether each of these people has a case file -- the badge beside a ban. Needs the `ViewProfile` permission.
Update case file PUT
Change the reasons or the written reason. The author, or anyone who may ban. The change is a fact carrying before and after, so the edit history reads back from the log alone. The profile snapshot and the evidence are not touched by this.