Plantonizei

Painel da empresa › Escalas

Tudo que a tela de Escalas precisa para abrir

GET/api/v1/schedule/aggregatePede sessão

Como funciona

Tudo que a tela de Escalas precisa para abrir, numa chamada: a grade do período, a lista de escalas, as opções dos formulários (setores, especialidades, tipos de plantão), os grupos de escala e os modelos de contrato de onde sai o valor do plantão.

Aceita o mesmo período de GET /schedule (period, from, to). A resposta fica guardada por alguns segundos por empresa e período; qualquer alteração na escala limpa essa memória na hora, então quem salva vê o que salvou.

Se os modelos de contrato falharem, a tela abre do mesmo jeito, com o seletor de contrato vazio.

Parâmetros

  • fromQuery · stringInício do período (`AAAA-MM-DD`). Sem ele, vale o mês corrente.
  • toQuery · stringFim do período (`AAAA-MM-DD`).
  • periodQuery · stringAtalho de período: `today` (hoje), `week` (últimos 7 dias) ou `period` (datas de `from` e `to`). Sem ele, vale o mês corrente.

Respostas

200 · posts, schedules, options, groups e contractTemplates.

  • contractTemplatesobject[] · Modelos de contrato.
  • contractTemplates[].arquivoBytesinteger · Tamanho do arquivo do modelo, em bytes.
  • contractTemplates[].arquivoChavestring · Chave do PDF do modelo, devolvida pelo link de envio.
  • contractTemplates[].arquivoNomestring · Nome do arquivo do modelo.
  • contractTemplates[].cnpjstring · CNPJ, só dígitos.
  • contractTemplates[].contratosGeradosinteger · Contratos já enviados com este modelo.
  • contractTemplates[].descriptionstring · Descrição.
  • contractTemplates[].fieldsstring[] · Valores dos marcadores do texto que não vêm do cadastro, como valor e prazo.
  • contractTemplates[].hourlyRateCentsinteger · Valor da hora, em centavos.
  • contractTemplates[].idstring · Identificador do registro.
  • contractTemplates[].kindstring · Tipo.
  • contractTemplates[].namestring · Nome.
  • contractTemplates[].paymentTermstring · Prazo de pagamento: à vista ou a prazo.
  • contractTemplates[].razaoSocialstring · Razão social.
  • contractTemplates[].schedulesUsinginteger · Escalas que usam este modelo.
  • contractTemplates[].scopestring · Alcance.
  • contractTemplates[].signerEmailstring · E-mail de quem assina pela contratante; vazio, a empresa não assina.
  • contractTemplates[].textstring · Texto.
  • contractTemplates[].updatedAtstring · Última atualização.
  • groupsobject[] · Grupos de escala.
  • groups[].citystring · Cidade.
  • groups[].createdAtstring · Quando foi criado.
  • groups[].descriptionstring · Descrição.
  • groups[].idstring · Identificador do registro.
  • groups[].namestring · Nome.
  • groups[].scheduleIdsstring[] · Identificadores das escalas.
  • groups[].statestring · Estado.
  • groups[].statusstring · Situação.
  • groups[].updatedAtstring · Última atualização.
  • optionsobject · Opções dos formulários de escala.
  • options.doctorsobject[] · Os médicos.
  • options.doctors[].crmstring · Número do CRM.
  • options.doctors[].idstring · Identificador do registro.
  • options.doctors[].namestring · Nome.
  • options.sectorsobject[] · Setores.
  • options.sectors[].idstring · Identificador do registro.
  • options.sectors[].namestring · Nome.
  • options.shiftTypesobject[] · Tipos de plantão.
  • options.shiftTypes[].idstring · Identificador do registro.
  • options.shiftTypes[].namestring · Nome.
  • options.specialtiesobject[] · Especialidades.
  • options.specialties[].idstring · Identificador do registro.
  • options.specialties[].namestring · Nome.
  • postsobject[] · As escalas, com a regra e os plantões do período.
  • posts[].attendanceTypestring · Tipo de atendimento.
  • posts[].cepstring · CEP, só dígitos.
  • posts[].citystring · Cidade.
  • posts[].complementstring · Complemento.
  • posts[].contractTemplateIdstring · Identificador do modelo de contrato que define o valor do plantão.
  • posts[].contractTemplateNamestring · Nome do modelo de contrato.
  • posts[].coordinatorstring · Coordenador responsável pela jornada.
  • posts[].diasSemanainteger[] · Dias da semana da escala fixa: 0 é domingo e 6 é sábado. Vem sempre, vazio quando a escala não é fixa.
  • posts[].distribuicaostring: auto | vazio | manual · Como os médicos entram nos plantões que a escala gera: auto (o sistema distribui o time pela folga), vazio (plantões sem médico) ou manual (o gestor escolhe por dia).
  • posts[].districtstring · Bairro.
  • posts[].doctorsobject[] · Os médicos.
  • posts[].doctors[].crmstring · Número do CRM.
  • posts[].doctors[].idstring · Identificador do registro.
  • posts[].doctors[].namestring · Nome.
  • posts[].escalistastring · Escalista responsável pela jornada.
  • posts[].geofenceRadiusMetersinteger · Raio, em metros, dentro do qual o ponto vale.
  • posts[].hourlyRateCentsinteger · Valor da hora, em centavos.
  • posts[].idstring · Identificador do registro.
  • posts[].latitudenumber · Latitude do local da escala.
  • posts[].longitudenumber · Longitude.
  • posts[].medicosPropriosboolean · A jornada tem time próprio, em vez de usar o da escala.
  • posts[].numberstring · Número.
  • posts[].scaleNamestring · Nome da escala.
  • posts[].scheduleIdstring · Identificador da escala.
  • posts[].scheduleNamestring · Nome da escala.
  • posts[].sectorstring · Setor.
  • posts[].sectorIdstring · Identificador do setor.
  • posts[].shiftstring · Turno.
  • posts[].shiftTypeIdstring · Identificador do tipo de plantão.
  • posts[].shiftsobject[] · Os plantões.
  • posts[].shifts[].checkInstring · Horário da entrada.
  • posts[].shifts[].checkInIdstring · Identificador do registro de ponto; ausente quando não há ponto.
  • posts[].shifts[].checkOutstring · Horário da saída.
  • posts[].shifts[].coordinatorstring · Coordenador responsável pela jornada.
  • posts[].shifts[].datestring · Data.
  • posts[].shifts[].doctorNamestring · Nome do médico.
  • posts[].shifts[].durationHoursnumber · Duração, em horas.
  • posts[].shifts[].endsAtstring · Fim.
  • posts[].shifts[].idstring · Identificador do registro.
  • posts[].shifts[].lateMinutesinteger · Minutos de atraso na entrada.
  • posts[].shifts[].origemstring · Origem do plantão: rule (da escala fixa) ou manual (avulso).
  • posts[].shifts[].pendingReleaseboolean · Há pedido de liberação da vaga aguardando a coordenação.
  • posts[].shifts[].releasedBystring · Quem da coordenação liberou a batida fora da regra, quando houve pedido aprovado.
  • posts[].shifts[].companyConfirmedAtstring · Quando a empresa escalou o médico atual do plantão.
  • posts[].shifts[].doctorConfirmedAtstring · Quando o médico confirmou o plantão pelo aplicativo; ausente enquanto não confirmou.
  • posts[].shifts[].paidAtstring · Quando o plantão foi pago na hora (dinheiro no local).
  • posts[].shifts[].paidAmountCentsinteger · Valor pago na hora, em centavos.
  • posts[].shifts[].addressstring · Endereço do posto (só na agenda do médico).
  • posts[].shifts[].latnumber · Latitude do posto (só na agenda do médico).
  • posts[].shifts[].lngnumber · Longitude do posto (só na agenda do médico).
  • posts[].shifts[].paidBystring · Quem registrou o pagamento na hora.
  • posts[].shifts[].punchLatnumber · Latitude de onde o médico bateu o ponto.
  • posts[].shifts[].punchLngnumber · Longitude de onde o médico bateu o ponto.
  • posts[].shifts[].punchOriginstring · Como o ponto entrou: batido pelo médico ou lançado pela coordenação.
  • posts[].shifts[].scaleNamestring · Nome da escala.
  • posts[].shifts[].sectorstring · Setor.
  • posts[].shifts[].shiftstring · Turno.
  • posts[].shifts[].specialtystring · Especialidade.
  • posts[].shifts[].startsAtstring · Início.
  • posts[].shifts[].statusstring · Situação.
  • posts[].shifts[].validatedAtstring · Quando foi validado.
  • posts[].shifts[].validatedBystring · Quem validou; ausente enquanto ninguém validou.
  • posts[].shifts[].valueCentsinteger · Valor, em centavos.
  • posts[].shifts[].windowstring · Janela do plantão (início e fim), em texto.
  • posts[].specialtystring · Especialidade.
  • posts[].specialtyIdstring · Identificador da especialidade.
  • posts[].statestring · Estado.
  • posts[].statusstring · Situação.
  • posts[].streetstring · Logradouro.
  • posts[].swapPolicystring · Política de troca da escala.
  • posts[].totalCentsinteger · Valor total, em centavos.
  • posts[].validoAtestring · Fim da vigência (AAAA-MM-DD). A escala vale no máximo 1 ano.
  • posts[].validoDestring · Início da vigência (AAAA-MM-DD). Obrigatório na escala fixa.
  • posts[].windowstring · Janela do plantão (início e fim), em texto.
  • schedulesobject[] · As escalas.
  • schedules[].idstring · Identificador do registro.
  • schedules[].namestring · Nome.
  • schedules[].postsobject[] · As escalas, com a regra e os plantões do período.
  • schedules[].posts[].idstring · Identificador do registro.
  • schedules[].posts[].labelstring · Nome exibido.
  • schedules[].posts[].shiftTypestring · Tipo de plantão.
  • schedules[].posts[].shiftTypeIdstring · Identificador do tipo de plantão.

Corpo de exemplo

{
  "contractTemplates": [
    {
      "arquivoBytes": 1,
      "arquivoChave": "texto",
      "arquivoNome": "texto",
      "cnpj": "texto",
      "contratosGerados": 1,
      "description": "texto",
      "fields": [
        null
      ],
      "hourlyRateCents": 150000,
      "id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "kind": "texto",
      "name": "texto",
      "paymentTerm": "texto",
      "razaoSocial": "texto",
      "schedulesUsing": 1,
      "scope": "texto",
      "signerEmail": "medico@exemplo.com.br",
      "text": "texto",
      "updatedAt": "texto"
    }
  ],
  "groups": [
    {
      "city": "texto",
      "createdAt": "texto",
      "description": "texto",
      "id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "name": "texto",
      "scheduleIds": [
        null
      ],
      "state": "texto",
      "status": "texto",
      "updatedAt": "texto"
    }
  ],
  "options": {
    "doctors": [
      {
        "crm": null,
        "id": null,
        "name": null
      }
    ],
    "sectors": [
      {
        "id": null,
        "name": null
      }
    ],
    "shiftTypes": [
      {
        "id": null,
        "name": null
      }
    ],
    "specialties": [
      {
        "id": null,
        "name": null
      }
    ]
  },
  "posts": [
    {
      "attendanceType": "texto",
      "cep": "texto",
      "city": "texto",
      "complement": "texto",
      "contractTemplateId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "contractTemplateName": "texto",
      "coordinator": "texto",
      "diasSemana": [
        null
      ],
      "distribuicao": "auto",
      "district": "texto",
      "doctors": [
        {}
      ],
      "escalista": "texto",
      "geofenceRadiusMeters": 1,
      "hourlyRateCents": 150000,
      "id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "latitude": 1,
      "longitude": 1,
      "medicosProprios": true,
      "number": "texto",
      "scaleName": "texto",
      "scheduleId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "scheduleName": "texto",
      "sector": "texto",
      "sectorId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "shift": "texto",
      "shiftTypeId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "shifts": [
        {}
      ],
      "specialty": "texto",
      "specialtyId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "state": "texto",
      "status": "texto",
      "street": "texto",
      "swapPolicy": "texto",
      "totalCents": 150000,
      "validoAte": "texto",
      "validoDe": "texto",
      "window": "texto"
    }
  ],
  "schedules": [
    {
      "id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "name": "texto",
      "posts": [
        {}
      ]
    }
  ]
}