Matricular pacote

Descrição

Endpoint para matricular um ou mais alunos em um ou mais pacotes.

📋 Detalhes da Requisição

URL

POST https://seudominio.com/api/packages

Headers Obrigatórios

Corpo da Requisição (JSON)

{
  "students": [123, 456],
  "packages": [789, 101112]
}

📤 Respostas da API

✅ Sucesso (201 Created)

{
  "success": true,
  "message": "Matrículas realizadas com sucesso: 4 matrícula(s)",
  "data": {
    "success_count": 4,
    "error_count": 0,
    "total_processed": 4,
    "message": "Matrículas realizadas com sucesso: 4 matrícula(s)"
  },
  "timestamp": "2025-01-28 10:30:00",
  "status_code": 201
}

✅ Sucesso Parcial (201 Created)

{
  "success": true,
  "message": "Matrículas realizadas parcialmente: 2 sucesso(s), 2 erro(s)",
  "data": {
    "success_count": 2,
    "error_count": 2,
    "total_processed": 4,
    "errors": [
      "Erro ao matricular aluno João Silva no pacote Pacote Completo: Aluno ja matriculado nesse pacote",
      "Erro ao matricular aluno Maria Santos no pacote Pacote Marketing: Pacote nao possui cursos"
    ],
    "message": "Matrículas realizadas parcialmente: 2 sucesso(s), 2 erro(s)"
  },
  "timestamp": "2025-01-28 10:30:00",
  "status_code": 201
}

❌ Erro - Dados Inválidos (400 Bad Request)

{
  "success": false,
  "message": "Os campos students e packages são obrigatórios e não podem estar vazios",
  "errors": [],
  "timestamp": "2025-01-28 10:30:00",
  "status_code": 400
}

❌ Erro - Aluno/Pacote Não Encontrado (404 Not Found)

{
  "success": false,
  "message": "Aluno com o id 999 não encontrado",
  "errors": [],
  "timestamp": "2025-01-28 10:30:00",
  "status_code": 404
}

❌ Erro - Nenhuma Matrícula Realizada (400 Bad Request)

{
  "success": false,
  "message": "Nenhuma matrícula foi realizada com sucesso",
  "errors": [
    "Erro ao matricular aluno João Silva no pacote Pacote Completo: Aluno ja matriculado nesse pacote"
  ],
  "timestamp": "2025-01-28 10:30:00",
  "status_code": 400
}

🔍 Campos da Requisição

Campo	Tipo	Obrigatório	Descrição	Exemplo
`students`	array	✅ Sim	Array de IDs dos alunos	`[123, 456]`
`packages`	array	✅ Sim	Array de IDs dos pacotes	`[789, 101112]`

Comportamento em Erros

Se uma matrícula falhar, as outras ainda serão processadas

O resultado retornado indicará quantas matrículas foram bem-sucedidas e quantas falharam

Detalhes dos erros estarão disponíveis no campo errors da resposta

⚠️ Códigos de Status HTTP

Código	Descrição	Quando Ocorre
`201`	Created	Pelo menos uma matrícula foi realizada com sucesso
`400`	Bad Request	Dados inválidos ou nenhuma matrícula realizada
`401`	Unauthorized	Token inválido ou não fornecido
`404`	Not Found	Aluno ou pacote não encontrado
`500`	Internal Server Error	Erro interno do servidor

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

application/json

Body

Exemplo

{
    "success": true,
    "message": "string",
    "data": {
        "success_count": 0,
        "error_count": 0,
        "total_processed": 0,
        "message": "string"
    },
    "timestamp": "string",
    "status_code": 0
}

Descrição#

📋 Detalhes da Requisição#

URL#

Headers Obrigatórios#

Corpo da Requisição (JSON)#

📤 Respostas da API#

✅ Sucesso (201 Created)#

✅ Sucesso Parcial (201 Created)#

❌ Erro - Dados Inválidos (400 Bad Request)#

❌ Erro - Aluno/Pacote Não Encontrado (404 Not Found)#

❌ Erro - Nenhuma Matrícula Realizada (400 Bad Request)#

🔍 Campos da Requisição#

Comportamento em Erros#

⚠️ Códigos de Status HTTP#

Requisição

Exemplos de Requisição

Respostas