Cargas por patriarca

Os endpoints abaixo são usados quando a autorização de sistema permite editar todo um patriarca (por exemplo, todo o Governo do ES).

Rota base da API v3:

/v3/Carga

Headers comuns a todos os endpoints:

• Authorization: Bearer {access_token}
• Content-Type: application/json (para requisições com corpo)

POST /v3/Carga/organograma/{guidPatriarcaRaiz}

Envia a estrutura completa de órgãos e unidades de um patriarca.

POST /v3/Carga/organograma/{guidPatriarcaRaiz}

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
guidPatriarcaRaiz	GUID	Sim	Identificador do patriarca onde a carga será aplicada.

Corpo (JSON)

O corpo da requisição deve seguir o modelo CargaOrganogramaEntrada,com:

• PatriarcaId
• Orgaos[] (cada um com suas Unidades[])

Resposta

• 201 Created com um Guid no corpo que identifica o pedido de carga.
• Em caso de erro de validação ou autorização, retorna erro 4xx com mensagem explicando o problema.

O Guid retornado pode ser usado para consultar o status:

• GET /v3/Carga/{guid}/status

POST /v3/Carga/lotacoes/{guidPatriarcaRaiz}

Envia a carga completa de lotações de um órgão específico dentro de um patriarca.

POST /v3/Carga/lotacoes/{guidPatriarcaRaiz}

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
guidPatriarcaRaiz	GUID	Sim	Identificador do patriarca da autorização da carga.

Corpo (JSON)

O corpo da requisição deve ser um objeto seguindo o modelo CargaLotacaoEntrada , contendo:

• PatriarcaId
• ChaveExternaOrgao
• OcupacaoServidor[], LotacoesServidor[], Gestores[]
• OcupacaoComissao[], Comissoes[], LotacoesComissao[]

A carga é sempre completa para aquele órgão.

Resposta

• 201 Created com um Guid identificando o pedido de carga.
• Erros de validação/autorização retornam 4xx.

O Guid retornado pode ser usado para consultar o status:

• GET /v3/Carga/{guid}/status

POST /v3/Carga/lotacoes/{guidPatriarcaRaiz}

Envia lotações de vários órgãos de uma vez, dentro de um mesmo patriarca.

POST /v3/Carga/lotacoes/pacote/{guidPatriarcaRaiz}

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
guidPatriarcaRaiz	GUID	Sim	Identificador do patriarca da autorização da carga.

Corpo (JSON)

O corpo é um array de objetos CargaLotacaoEntrada:

[
  {
    "PatriarcaId": "GUID-DO-PATRIARCA",
    "ChaveExternaOrgao": "ORG-SESA",
    "OcupacaoServidor": [ ... ],
    "LotacoesServidor": [ ... ],
    "Gestores": [ ... ],
    "OcupacaoComissao": [ ... ],
    "Comissoes": [ ... ],
    "LotacoesComissao": [ ... ]
  },
  {
    "PatriarcaId": "GUID-DO-PATRIARCA",
    "ChaveExternaOrgao": "ORG-SEJUS",
    "OcupacaoServidor": [ ... ],
    "LotacoesServidor": [ ... ],
    "Gestores": [ ... ],
    "OcupacaoComissao": [ ... ],
    "Comissoes": [ ... ],
    "LotacoesComissao": [ ... ]
  }
]

Regras importantes:

• Todos os itens do array devem referenciar o mesmo patriarca.
• Não pode haver órgãos repetidos (ChaveExternaOrgao) na mesma carga.
• Para cada órgão, o conteúdo é interpretado como carga completa.

Resposta

• 201 Created com um Guid identificando o pedido de carga (pacote único).
• Erros de validação/autorização retornam 4xx.

Quando há muitos órgãos dentro de um patriarca, este endpoint reduz o tempo total de atualização, evitando várias cargas sequenciais órgão a órgão.

GET /v3/Carga/{guid}/status

Consulta a situação de um pedido de carga específico.

GET /v3/Carga/{guid}/status

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
guid	GUID	Sim	Identificador do pedido de carga.

Resposta

• 200 OK com um objeto de status da carga (por exemplo, situação, data de criação, tipo de carga, mensagens de erro, etc.).
• Erros de validação/autorização retornam 4xx.

Esse endpoint é pensado para ser usado em consulta periódica (polling) até a carga ser concluída ou falhar.

GET /v3/Carga/{guidPatriarcaRaiz}/ultimasStatus

Retorna a situação dos últimos pedidos de carga para um patriarca.

GET /v3/Carga/{guidPatriarcaRaiz}/ultimasStatus

Parâmetros de rota

Nome	Tipo	Obrigatório	Descrição
guidPatriarcaRaiz	GUID	Sim	Identificador do patriarca cuja fila será consultada.

Resposta

• 200 OK com uma lista de objetos de status das cargas mais recentes daquele patriarca.
• Erros de validação/autorização retornam 4xx.

Este endpoint é útil para monitorar as últimas cargas realizadas sem precisar guardar os Guid de cada pedido.