Painel da empresa › Escalas
Grade da escala
GET/api/v1/schedulePede sessãoComo funciona
A grade da escala no período: cada escala com a regra (setor, especialidade, horário, dias da semana, vigência, valores, local) e os plantões do período, com o médico escalado ou a vaga aberta.
O período padrão é o mês corrente. Mude com period (today, week) ou com from e to em AAAA-MM-DD. Para ver uma escala só, mande scheduleId.
Pede a permissão de ver escalas.
Parâmetros
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.fromQuery · stringInício do período (`AAAA-MM-DD`).toQuery · stringFim do período (`AAAA-MM-DD`).scheduleIdQuery · stringMostra só uma escala.
Respostas
200 · posts: as escalas com os plantões do período.
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) oumanual(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) oumanual(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[].checkinInformedboolean · A entrada foi informada depois (lançada à mão), não batida no local. Recusado o ponto, só o horário informado deixa de valer.posts[].shifts[].checkoutInformedboolean · A saída foi informada depois (lançada à mão), não batida no local.posts[].shifts[].justificationstring · A justificativa do lançamento manual.posts[].shifts[].evidenceKeystring · A chave do comprovante do lançamento manual; abre porGET /api/v1/schedule/evidencias?key=.posts[].shifts[].postedBystring · Quem lançou o horário à mão.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.
Corpo de exemplo
{
"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"
}
]
}