Painel da empresa › Configurações
Configurações da empresa
GET/api/v1/settingsPede sessãoComo funciona
As configurações da empresa, para a tela de Configurações abrir de uma vez:
minSwapRequestHours: a antecedência mínima, em horas, para o médico pedir troca.scheduleLocked: se a escala está travada para o fechamento.scheduleLocations: o local de cada escala, com endereço, coordenadas e o raio do ponto.financial,checkin,schedule,notificationsecontracts: os grupos de ajustes de cada aba, como foram gravados.onboardingDocuments: os documentos que a empresa pede no cadastro do médico, com o tipo, se é obrigatório e para qual empresa cadastrada ou escala vale.
Pede a permissão de ver configurações.
Respostas
200 · As configurações da empresa por aba.
checkinobject · Entrada.contractsobject · Contratos.financialobject · Ajustes da aba Financeiro.minSwapRequestHoursinteger · Antecedência mínima, em horas, para pedir troca (0 a 720).notificationsobject · Notificações.onboardingDocumentsobject[] · Documentos pedidos no cadastro do médico.onboardingDocuments[].companyIdstring · Identificador da empresa.onboardingDocuments[].companyNamestring · Razão social da empresa.onboardingDocuments[].createdAtstring · Quando foi criado.onboardingDocuments[].idstring · Identificador do registro.onboardingDocuments[].namestring · Nome.onboardingDocuments[].requiredboolean · É obrigatório.onboardingDocuments[].scheduleIdstring · Identificador da escala.onboardingDocuments[].scheduleNamestring · Nome da escala.onboardingDocuments[].typestring · Tipo.scheduleobject · Escala.scheduleLocationsobject[] · O local de cada escala, com endereço, coordenadas e raio do ponto.scheduleLocations[].citystring · Cidade.scheduleLocations[].latnumber · Latitude.scheduleLocations[].lngnumber · Longitude.scheduleLocations[].neighborhoodstring · Bairro.scheduleLocations[].numberstring · Número.scheduleLocations[].postIdstring · Identificador da escala (jornada) do plantão.scheduleLocations[].radiusMetersinteger · Raio, em metros, dentro do qual o ponto vale.scheduleLocations[].scheduleNamestring · Nome da escala.scheduleLocations[].statestring · Estado.scheduleLocations[].streetstring · Logradouro.scheduleLocations[].zipCodestring · CEP, só dígitos.scheduleLockedboolean · A escala está travada para o fechamento.
Corpo de exemplo
{
"checkin": {},
"contracts": {},
"financial": {},
"minSwapRequestHours": 1,
"notifications": {},
"onboardingDocuments": [
{
"companyId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"companyName": "texto",
"createdAt": "texto",
"id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"name": "texto",
"required": true,
"scheduleId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"scheduleName": "texto",
"type": "texto"
}
],
"schedule": {},
"scheduleLocations": [
{
"city": "texto",
"lat": 1,
"lng": 1,
"neighborhood": "texto",
"number": "texto",
"postId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"radiusMeters": 1,
"scheduleName": "texto",
"state": "texto",
"street": "texto",
"zipCode": "texto"
}
],
"scheduleLocked": true
}