Retorno

As nossas APIs foram desenvolvidas de acordo com os melhores padrões REST. Suas respostas podem ser interpretadas através do código de status HTTP. Isso permite que qualquer aplicação consuma a API de forma simples e clara, independente da linguagem utilizada.

Assim sendo, códigos do tipo 2xx indicam sucesso, códigos 4xx indicam que algum dado de entrada está incorreto (por exemplo, campo mandatório não informado ou não enviado no formato correto) e códigos 5xx indicam erro nos servidores do GIM.

Tabela de códigos de status HTTP:

Código	Definição	Ocorrência
200	Ok	Quando a requisição foi concluída. Saiba Mais
201	Created	Quando o recurso desejado é criado. Saiba Mais
400	Bad Request	Quando os dados enviados estão incompletos ou não respeitam a formatação obrigatória. Saiba Mais
401	Unauthorized	Quando o usuário não tem a permissão necessário para executar a requisição desejada. Saiba Mais
404	Not Found	O recurso solicitado não foi encontrado no servidor. Saiba Mais
500	Internal Server Error	Erro interno. Saiba Mais

Propriedade Success e relatório de operação (Operation Report)

Toda requisição efetuada ao Global Identity Manager contém uma propriedade Success, que indica se a requisição foi efetuada com sucesso ou se foi encontrado algum erro.

Campo	Tipo	Descrição	Exemplo
Success	bool	Indica se a requisição efetuada foi executada com sucesso, ou seja, sem erros. Se o valor retornado for false, verifique o OperationReport para maiores detalhes.	true

Complementado a propriedade Success, toda requisição feita ao Global Identity Manager também retorna um relatório chamado OperationReport no corpo da resposta (response body), descrevendo eventuais erros que ocorreram na requisição.

Campo	Tipo	Descrição	Exemplo
Field	string	Nome do campo que causou o erro.	firstName
Message	string	Descrição do problema encontrado.	The field cannot be null

Propriedades Execution Time

As propriedades do tipo Execution Time indicam o tempo de execução das requisições efetuadas ao Global Identity Manager.

Campo	Tipo	Descrição	Exemplo
InternalExecutionTime	int	Tempo de execução da requisição nos servidores do Global Identity Manager.	82
ExternalExecutionTime	int	Tempo de qualquer chamada externa que efetuamos na requisição. Por exemplo: chamada ao Active Directory.	18
TotalExecutionTime	int	Tempo medido entre o momento que a requisição chega no nosso servidor e o momento em que enviamos a resposta. É a soma do InternalExecutionTime e ExternalExecutionTime.	100

Propriedade RequestKey

Esta propriedade corresponde à chave única de uma requisição efetuado ao GIM. Com ela, é possível rastrear o Log da sua requisição no nosso sistema.

📘

Nas chamadas da API de gerenciamento, o Requestkey é retornado no Response Body. Já nas chamadas da API de autorização, esse parâmetro é retornado no Header da requisição.

Campo	Tipo	Descrição	Exemplo
RequestKey	string	Identificador da sua requisição no Global Identity Manager.	b7d0f4b4-2984-413f-b8ed-7a0a081b03b5