Plantonizei

Painel da empresa › Configurações

Empresas cadastradas e as escalas de cada uma

GET/api/v1/settings/registered-companiesPede sessão

Como funciona

As empresas que o cliente cadastrou (hospitais, clínicas, prefeituras para quem presta serviço), cada uma com os dados cadastrais e as escalas que tem. As escalas que ainda não estão em nenhuma vêm em unassignedSchedules.

Pede a permissão de ver configurações.

Respostas

200 · companies e unassignedSchedules.

  • companiesobject[] · As empresas.
  • companies[].citystring · Cidade.
  • companies[].cnpjstring · CNPJ, só dígitos.
  • companies[].companyNamestring · Razão social da empresa.
  • companies[].tradeNamestring · Nome da empresa (nome fantasia), opcional, até 200 caracteres. É o nome do seletor de empresa do painel; vazio, vale a razão social.
  • companies[].complementstring · Complemento.
  • companies[].contactEmailstring · E-mail do contato.
  • companies[].districtstring · Bairro.
  • companies[].idstring · Identificador do registro.
  • companies[].numberstring · Número.
  • companies[].ownboolean · O dado é da própria escala; falso quando é herdado da empresa.
  • companies[].phonestring · Telefone.
  • companies[].scheduleIdstring · Identificador da escala.
  • companies[].scheduleNamestring · Nome da escala.
  • companies[].schedulesobject[] · As escalas.
  • companies[].schedules[].codestring · Código.
  • companies[].schedules[].doctorsinteger · Os médicos.
  • companies[].schedules[].documentsinteger · Documentos.
  • companies[].schedules[].idstring · Identificador do registro.
  • companies[].schedules[].namestring · Nome.
  • companies[].statestring · Estado.
  • companies[].streetstring · Logradouro.
  • companies[].zipCodestring · CEP, só dígitos.
  • unassignedSchedulesobject[] · Escalas que ainda não estão em nenhuma empresa.
  • unassignedSchedules[].codestring · Código.
  • unassignedSchedules[].doctorsinteger · Os médicos.
  • unassignedSchedules[].documentsinteger · Documentos.
  • unassignedSchedules[].idstring · Identificador do registro.
  • unassignedSchedules[].namestring · Nome.

Corpo de exemplo

{
  "companies": [
    {
      "city": "texto",
      "cnpj": "texto",
      "companyName": "texto",
      "tradeName": "texto",
      "complement": "texto",
      "contactEmail": "medico@exemplo.com.br",
      "district": "texto",
      "id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "number": "texto",
      "own": true,
      "phone": "texto",
      "scheduleId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "scheduleName": "texto",
      "schedules": [
        {}
      ],
      "state": "texto",
      "street": "texto",
      "zipCode": "texto"
    }
  ],
  "unassignedSchedules": [
    {
      "code": "texto",
      "doctors": 1,
      "documents": 1,
      "id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "name": "texto"
    }
  ]
}