Send Notifications

patch

https://api-sandbox.koin.com.br/v1/ato/notifications/{id}

API to send notifications about an existing case.

Supported types:

STATUS: reports strategy results and requires strategies. It schedules the strategies evaluation when the case is open and returns 412 when the case is already closed.
INFO: reports the outcome of the challenge flow and requires sub_type with one of SUCCESS, FAILED or ABANDONED. Any other sub_type, or a missing one, is rejected with 400.

INFO semantics:

SUCCESS: informative only. It is not persisted and does not change the case state.
FAILED and ABANDONED: persisted in the case notifications and, only when the case is still open, the case is closed and its business state set to CANCELLED. If the case is already closed the notification is only persisted, without state changes, and the request still returns 200.

Path Params

string

required

Evaluation ID returned by api on evaluation

Body Params

ATO case notification. STATUS notifications report strategy results and require strategies. INFO notifications report the outcome of the challenge flow through sub_type: SUCCESS is only informative and is not persisted nor changes the case, while FAILED and ABANDONED are persisted in the case notifications and, only when the case is still open, close it and cancel it.

type

string

enum

required

Notification type. STATUS requires strategies. INFO requires sub_type.

Allowed:

sub_type

string

enum

Notification subtype. Mandatory for type INFO and restricted to these values; not applicable to type STATUS. SUCCESS is not persisted and leaves the case unchanged. FAILED and ABANDONED are persisted and, if the case is open, close it and cancel it; if the case is already closed the notification is only persisted and the request still returns 200.

Allowed:

message

string

Descriptive message about notification

notification_date

string

required

Notification date as a local datetime, without a timezone suffix.

details

object

Free key/value map persisted with FAILED and ABANDONED. reason, when present, is an opaque string and is not restricted to a closed set.

strategies

object

Strategy results. Mandatory for type STATUS and not applicable to type INFO.

Responses

200

Notifications response

400Bad Request

401Unauthorized

404Not Found

500Internal Server Error