Pular para o conteúdo principal

Configura restrições do cliente

PUT /api/{userId}/establishment/{establishmentId}/clients/{clientId}/restrictions

Atualiza regras de acesso/uso do cliente, como janela de horário, dias permitidos, vagas e restrição de tabela de preço.

Parâmetros de rota

NomeTipoDescrição
userIdnumberIdentificador do usuário
establishmentIdnumberIdentificador do estabelecimento
clientIdstringIdentificador do cliente

Corpo (JSON)

CampoTipoObrigatórioDescrição
establishmentIdnumbersimEstabelecimento
startTimestringnão*Horário inicial (HH:mm:ss). Se enviar, precisa enviar endTime também
endTimestringnão*Horário final (HH:mm:ss). Se enviar, precisa enviar startTime também
vacanciesnumbernãoVagas (>= 0). String vazia vira 0
restrictionTypePricenumber / nullnãoRestrição de tabela de preço. String vazia vira null
weekDaysPermissionarraynãoDias permitidos (1–7)
userIdnumbernãoUsuário responsável
clientTypeIdnumbernãoTipo do cliente (quando o backend usa para regras específicas)

* startTime e endTime têm validação de par: se um vier, o outro é obrigatório.

Requisição

  • Método: PUT
  • Path: /api/\{userId\}/establishment/\{establishmentId\}/clients/\{clientId\}/restrictions
  • Headers: Authorization, Accept: application/json, Content-Type: application/json

Formato da resposta (JSON)

  • Sucesso (HTTP 200): { "response": "success", "data": <payload> }
  • Erro de validação (HTTP 422): retorna os erros por campo
  • Erro (HTTP 400): { "response": "error", "data": { "msg": "...", "code": "..." } }

Exemplo de resposta (JSON)

Valores ilustrativos; a forma dos campos segue o retorno real.

{
"response": "success",
"data": {
"clientId": "772420260215093421",
"establishmentId": 7724,
"startTime": "07:00:00",
"endTime": "19:00:00",
"vacancies": 2,
"restrictionTypePrice": 101,
"weekDaysPermission": [1, 2, 3, 4, 5],
"status": 1
}
}

Nuâncias por clientTypeId

  • Para clientTypeId = 2 (mensalista), a regra de weekDaysPermission pode ser tratada de forma diferente (por exemplo, permitir lista vazia como “sem permissão”).