Descrição: Todas as requisições HTTP POST, PUT e DELETE listadas acima são processadas de forma assíncrona na LEX.
Utilize o request_id retornado em cada uma das requisições para consultar o status do processamento do seu pedido.
Endpoint:
/integration/partner/v2/callback?request_id={request_id}Cabeçalho:
Content-Type: application/jsonAuthorization: Bearer {access_token}Parâmetros
| Parâmetro | Tipo | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|
request_id |
UUID |
Sim | 36 | ID da requisição . |
Exemplo de Response
200 Ok
//Exemplo do response body no contexto de usuários:
{
"request_id": "80ea6f87-92f3-4ea7-bd2b-17d07582264c",
"status": "DONE",
"payload": {
"user_id": "76f4ac7a-bb23-487a-89e3-0e3d35a128fa"
}
}
//Exemplo do response body no contexto de turmas:
{
"request_id": "e68b2948-535e-430b-8ca9-77bda582bfe7",
"status": "DONE",
"payload": {
"class_id": "449ffb2c-9348-40f2-a619-347e459105e6"
}
}
//Exemplo do response body no contexto de enturmação:
{
"request_id": "5e99a0d0-8c24-41e9-b8f7-f6ae49ed9946",
"status": "DONE",
"payload": {
"bond_id": "303388d8-c3a4-4b6f-8f7f-66bf273c50b6"
}
}
Em alguns casos as requisições terão problemas ou serão realizadas parcialmente, então o padrão de erro para esses casos é da seguinte forma:
{
"request_id": "8acd80e2-3e36-4fd4-a03c-475896b19f88",
"status": "ERROR",
"error": {
"code": "BO001",
"message": "The email 'eliam2355@uorak.com' is already associated with a different document."
}
}
{
"request_id": "7459e510-9ab8-44cb-be46-1b38886424d6",
"status": "DONE_WITH_PENDENCIES",
"payload": {
"is_success": false,
"user_id": "b0f71e73-ea62-4c68-a287-c170f92dc740",
"account_pendencies": [
"Já existe uma conta verificada com o mesmo e-mail mas com outro CPF."
]
}
}
{
"request_id": "7459e510-9ab8-44cb-be46-1b38886424d6",
"status": "DONE_WITH_PENDENCIES",
"payload": {
"is_success": false,
"user_id": "00000000-0000-0000-0000-000000000000",
"error_messages": [
"Usuário com o perfil Responsável ou Colaborador deve ser maior de idade.",
"O responsável 'Xpto' é menor de idade."
]
}
}
Parâmetros da resposta
| Parâmetro | Tipo | Contexto | Obrigatório | Tamanho | Descrição |
|---|---|---|---|---|---|
request_id |
UUID |
Todos | Sim | 36 | ID único da solicitação, utilizado para rastrear a operação realizada. |
status |
string |
Todos | Sim | 50 | Status da operação. Ex.: "DONE" para operações concluídas. |
payload |
object |
Todos | Sim | - | Objeto contendo o resultado da operação conforme o contexto (usuários, turmas, enturmação). |
payload.user_id |
UUID |
Usuários | Sim | 36 | ID único do usuário criado ou atualizado. |
payload.class_id |
UUID |
Turmas | Sim | 36 | ID único da turma criada ou atualizada. |
payload.bond_id |
UUID |
Enturmação | Sim | 36 | ID único do vínculo de enturmação criado ou atualizado. |
Status disponíveis
| Valor | Descrição |
|---|---|
PENDING |
Não processado. |
PROCESSING |
Processando. |
DONE |
Concluída. |
ERROR |
Ocorreu um erro. |
DONE_WITH_PENDENCIES |
Concluída com alguma pendência. |
401 Unauthorized (Sem autorização, ausência de token ou token incorreto)
400 BadRequest (Requisição incorreta)
{
"Error":
{
"Code": "CLA001",
"Message": ""
}
}
409 Conflict (Paramêtros incorretos)
{
"Error": {
"Code": "FLU001",
"Message": "Error validating properties",
"ErrorProperties": [
{
"PropertyName": "tenant_id",
"ErrorMessage": "tenant_id is required."
}
]
}
}
500 Internal Server Error (Erro não mapeado no servidor)
{
"Error":
{
"Code": "INT500",
"Message": "Internal server error."
}
}