DELETE institution by ID - ocariot/api-gateway GitHub Wiki

Description

Deletes an institution by its ID.

Permissions:

• Only Admin user can do this.

Scope

institutions:delete

URL

DELETE https://localhost/v1/institutions/{institution_id}

Parameters

institution_id: string (A 24-byte hex ID)

Curl example

curl -X DELETE "https://localhost/v1/institutions/5a62be07de34500146d9c544" -H "accept: /" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response body

• 204 Operation performed successfully. There is no data to be returned.

• 400 Validation errors

  • Invalid institution_id

  • Institution is associated with one or more registered users in the platform.

    {
      "code": 400,
      "message": "The institution is associated with one or more users."
    }
    

• 401 Unauthorized Error

• 403 Permission Error

• 429 Too Many Requests Error

• 500 Internal Server Error