Pular para o conteúdo principal

Organizações

GET​

  • /organizations
  • /organizations/:id

Retorna as organizações cadastradas no sistema de acordo com os parâmetros da requisição.

Authorization​

  • Authorization: Bearer <session_token>

Parâmetros​

  • name - Nome da organização

Os parâmetros de filtragem são enviados na query string.

Caso id não seja passado na url, todas as organizações serão retornadas.

Resultado​

O resultado de uma requisição bem sucedida será um 200 Ok com o seguinte formato:

Array<{
  accessLevel: "tenant" | "khomp" | "normal";
  creationTimestamp: Date;
  id: number;
  name: string;
}>;

POST​

  • /organizations

Cadastra uma nova organização no sistema.

Authorization​

  • Authorization: Bearer <session_token>

Parâmetros​

  • name: Nome da organização.

Os parâmetros do body da requisição tem o seguinte formato:

{
 "name": string;
}

Resultado​

O resultado para uma requisição bem sucedida será um 201 Created com o seguinte formato:

{
 "id": number;
 "creationTimestamp": Date;
}

PATCH​

  • /resource/:id

Authorization​

  • Authorization: Bearer <session_token>

Atualiza os dados da organização cuja o id é aquele passado na url.

Parâmetros​

  • name: Nome da organização.

Os parâmetros do body da requisição tem o seguinte formato:

{
 "name": string;
}

Resultado​

O resultado para uma requisição bem sucedida será um 200 Ok com body vazio.