Saltar para o conteúdo principal

​
Organizações

Organizações são subunidades de uma instituição — faculdades, departamentos, escolas ou campi. Os cursos podem ser opcionalmente associados a uma organização para melhor classificação.

​
O objeto organização

{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "School of Engineering",
  "code": "ENG",
  "institution": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Federal University of Technology"
  },
  "created_at": "2024-01-15T10:00:00.000000Z"
}
CampoTipoDescrição
uuidstringIdentificador único
namestringNome da organização
codestringCódigo abreviado para referência interna
institutionobjectA instituição pai

​
Listar organizações

GET /organizations

curl https://api.dokstamp.eu/organizations \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "X-Tenant: {TENANT}"

​
Criar uma organização

POST /organizations
ParâmetroTipoObrigatórioDescrição
namestringSimNome da organização
institution_uuidstringSimUUID da instituição pai
codestringNãoCódigo de referência abreviado
curl -X POST https://api.dokstamp.eu/organizations \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Tenant: {TENANT}" \
  -d '{
    "name": "School of Engineering",
    "code": "ENG",
    "institution_uuid": "550e8400-e29b-41d4-a716-446655440000"
  }'

​
Obter, atualizar, eliminar

GET    /organizations/{uuid}
PATCH  /organizations/{uuid}
PUT    /organizations/{uuid}
DELETE /organizations/{uuid}
DELETE /organizations/batch/destroy
Todos seguem as mesmas convenções dos restantes recursos. Consulte Instituições para exemplos detalhados.