(PRIVATE) – onboarding (onboarding)

2.0info: 1.52.5 (PRIVATE) – onboarding description: Serviço do onboarding x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: onboarding contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /private/hcm/onboardingsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /preAdmissionPending: post: description: Ação para trocar status de uma pré-admissão para PENDING_ADMISSION. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador único da pré-admissão. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado de tornar pendente. message: type: string description: Mensagem detalhando o resultado de tornar pendente default: description: Error response schema: #/definitions/genericError /anonymous/employeeDocumentSave: post: description: Ação para salvar os documentos de uma pré-admissão na jornada do colaborador. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – id – documentData – saveAsDraft – token properties: id: type: string description: Identificador único da pré-admissão. documentData: #/definitions/preAdmissionDocumentBRAData saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. token: type: string description: Token de Acesso responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/employeePreAdmissionSaveData default: description: Error response schema: #/definitions/genericError /paramsForTracksaleQuery: post: description: Retorna as informações necessárias para o tracksale. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/paramsForTracksaleData default: description: Error response schema: #/definitions/genericError /invitationLayoutConfigurationQuery: post: description: Retorna as informações da configuração do layout de um modelo de convite x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: preAdmissionId: type: string description: Id da pré-admissão, no caso de reenvio de convite inviteModelId: type: string description: Id do modelo de convite responses: 200: description: Ok schema: type: object properties: result: #/definitions/invitationLayoutConfigurationData default: description: Error response schema: #/definitions/genericError /anonymous/startDigitalTrialRD: post: description: Ação responsável por iniciar um período de trial do Onboarding a partir do RD x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – leads properties: leads: type: array items: #/definitions/rRDData description: Dados vindo da integração com o RD responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /anonymous/employeeDeleteObjectsFromCustomFields: post: description: Deleta uma lista de arquivos (blob) dos campos customizados. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – domain – service – objects – entityName – token properties: domain: type: string description: Domínio do serviço service: type: string description: Nome do serviço objects: type: array items: #/definitions/deleteObjectDef description: Lista de objetos para deletar entityName: type: string description: Nome da entidade token: type: string description: Token de acesso responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /preAdmissionCountByStatus: post: description: Retorna a quantidade de registros relacionado aos estados de uma pré-admissão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – statusAll – statusInProgress – statusInValidation – statusComplete – statusInHiringProcess – statusInSignature – statusSigned properties: statusAll: type: string description: Filtros que indicam a quantidade total de pré-admissões. statusInProgress: type: string description: Filtros que indicam a quantidade de pré-admissões em andamento. statusInValidation: type: string description: Filtros que indicam a quantidade de pré-admissões em validação. statusComplete: type: string description: Filtros que indicam a quantidade de pré-admissões completadas. statusInHiringProcess: type: string description: Filtros que indicam a quantidade de pré-admissões em processo de admissão (Utilizado apenas quando integrado ao módulo Administração de Pessoal). statusInSignature: type: string description: Filtros que indicam a quantidade de pré-admissões em assinatura. statusSigned: type: string description: Filtros que indicam a quantidade de pré-admissões assinadas. contractFilter: #/definitions/contractFilterData responses: 200: description: Ok schema: type: object required: – statusAll – statusInProgress – statusInValidation – statusComplete – statusInHiringProcess – statusInSignature – statusSigned properties: statusAll: type: integer description: Quantidade total de pré-admissões. statusInProgress: type: integer description: Quantidade de pré-admissões em andamento. statusInValidation: type: integer description: Quantidade de pré-admissões em validação. statusComplete: type: integer description: Quantidade de pré-admissões completadas. statusInHiringProcess: type: integer description: Quantidade de pré-admissões em processo de admissão (Utilizado apenas quando integrado ao módulo Administração de Pessoal). statusInSignature: type: integer description: Filtros que indicam a quantidade de pré-admissões em assinatura. statusSigned: type: integer description: Filtros que indicam a quantidade de pré-admissões assinadas. default: description: Error response schema: #/definitions/genericError /anonymous/externalModulesSave: post: description: Ação para salvar/alterar um novo registro na entidade ExternalModules x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – enumExternalModule properties: id: type: string description: Identificador único enumExternalModule: #/definitions/enumExternalModules responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /anonymous/employeeIsAValidPreAdmissionQuery: post: description: Retorna se o Id do link é uma pré-admissão válida. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – linkId properties: linkId: type: string description: Identificador único do convite responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Identifica se o Id é uma pré-admissão válida. default: description: Error response schema: #/definitions/genericError /anonymous/employeeSaveAndSubmit: post: description: Ação que salva as informações pessoais e documentos de uma pré-admissão e envia para validação na jornada do colaborador x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – id – personalData – documentData – saveAsDraft – hasDependent – token properties: id: type: string description: Identificador único da pré-admissão. personalData: #/definitions/preAdmissionPersonalBRAData documentData: #/definitions/preAdmissionDocumentBRAData saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. hasDependent: type: boolean description: Identifica se possui dependente token: type: string description: Token de Acesso responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/employeePreAdmissionSaveData default: description: Error response schema: #/definitions/genericError /preAdmissionAnalyticsSituationQuery: post: description: Retorna os dados para se montar o analytics de situação das pré-admissões x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/preAdmissionAnalyticsSituationData default: description: Error response schema: #/definitions/genericError /preAdmissionSave: post: description: Ação para salvar as informações de uma pré-admissão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id – document – personalData – saveAsDraft properties: id: type: string description: Identificador único da pré-admissão. document: #/definitions/preAdmissionDocumentBRAData personalData: #/definitions/preAdmissionPersonalBRAData contract: #/definitions/preAdmissionContractBraData hasDependent: type: boolean description: Identifica se existem dependentes. saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da gravação. default: description: Error response schema: #/definitions/genericError /preAdmissionMessageQuery: post: description: Retorna os perfis da conversa e as mensagens desta. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – preAdmissionId – reader properties: preAdmissionId: type: string description: Código da pré admissão na qual a mensagem está referenciada. reader: #/definitions/messageSender responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/preAdmissionMessageData default: description: Error response schema: #/definitions/genericError /employeeContractModelQuery: post: description: Retorna os contratos vinculados ao modelo de convite x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – inviteModelId properties: inviteModelId: type: string description: Código do modelo de convite. responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/contractModelData default: description: Error response schema: #/definitions/genericError /anonymous/employeeDegreeOfEducationListQuery: post: description: Retorna as informações básicas do cadastro de grau de instrução. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/degreeOfEducation default: description: Error response schema: #/definitions/genericError /saveMultipleBanks: post: description: Inserir banco em lote x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – bank properties: bank: type: array items: #/definitions/bank description: lista de bank responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /resendRequestSignMail: post: description: Reenvia o email de solicitação de assinatura. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope signers: type: array items: type: string description: Lista com os emails dos assinantes, ou vazio para reenviar para todos que ainda não assinaram responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /changeJobPositionStatus: post: description: Ativa ou inativa o cargo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do cargo responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/situation default: description: Error response schema: #/definitions/genericError /anonymous/employeeCompanyListQuery: post: description: Retorna as informações básicas do cadastro de empresas do Payroll. Este endpoint foi concebido para ser utilizado apenas quando o Onboarding está integrado com o Payroll. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/company default: description: Error response schema: #/definitions/genericError /anonymous/verifyPreAdmissionToken: post: description: Verifica a autenticidade do token x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – linkId – token properties: linkId: type: string description: linkID da preAdmissão token: type: string description: Token da pre-admissão responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /anonymous/employeeBlobServiceRequestAccess: post: description: Solicitação para acessar um arquivo. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – fileId – token properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). ttl: type: integer description: Tempo em minutos que o arquivo deve ficar disponível para download no link que será retornado (padrão 30 minutos). thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto e que deve ser retornado seu Thumbnail(128X128px). token: type: string description: Token de acesso responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/blobServiceRequestAccessData default: description: Error response schema: #/definitions/genericError /anonymous/employeeCaptchaForSocialQualificationQuery: post: description: Retorna o captcha para o usuário preencher x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/captchaData default: description: Error response schema: #/definitions/genericError /preAdmissionSaveHeader: post: description: Salva uma lista de novos colaboradores e faz o envio dos convites. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – preAdmissionSaveData properties: preAdmissionSaveData: type: array items: #/definitions/preAdmissionSaveData description: Lista de colaboradores que serão enviado os convites responses: 200: description: Ok schema: type: object required: – result – listWithError – employeesWithSuccess – messageFromSmartphoneData properties: result: type: boolean description: Resultado da action listWithError: #/definitions/preAdmissionSaveData employeesWithSuccess: type: integer description: Quantidade de colaboradores bem-sucedidos messageFromSmartphoneData: #/definitions/messageFromSmartphoneData preAdmissionData: type: string description: Dados da preAdmissao default: description: Error response schema: #/definitions/genericError /anonymous/employeeStateListQuery: post: description: Retorna as informações básicas do cadastro de estado/unidades federativa. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/state default: description: Error response schema: #/definitions/genericError /anonymous/employeeSearchAddress: post: description: Ação para buscar o cep informado na base do onboarding e cadastrar caso não o tenha x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – cep properties: cep: type: string description: Cep do logradouro responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/personalAddressBRAData default: description: Error response schema: #/definitions/genericError /getAllURLFilesFromPreAdmissionId: post: description: Busca todas as URLs de imagens de uma pré admissão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Identificador único da pré-admissão responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/rKeyValueData default: description: Error response schema: #/definitions/genericError /anonymous/purchaseHistoryIsTrialEndOrCancel: post: description: Retorna se PurchaseActions é TRIAL_END ou CANCEL x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Indica se EnumPurchaseActions é TRIAL_END ou CANCEL default: description: Error response schema: #/definitions/genericError /changeInviteModelStatus: post: description: Ação para modificar o status do modelo de convite. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – inviteModelId properties: inviteModelId: type: string description: Código do modelo de convite status: #/definitions/situation responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /anonymous/purchaseHistorySave: post: description: Ação para ajustar o histórico de teste/compra do produto. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – purchaseAction – clientCode – clientName – billingDate – preAdmissionAmount properties: id: type: string description: Identificador único do registro. purchaseAction: #/definitions/enumPurchaseActions purchaseDate: type: string description: Data do teste/compra. reason: type: string description: Motivo da alteração do teste/compra. clientCode: type: integer description: Código do cliente do ERP. clientName: type: string description: Nome do cliente no ERP billingDate: type: string description: Data de início do faturamento preAdmissionAmount: type: integer description: Quantidade de admissões responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /saveMultipleCompanies: post: description: Inserir empresas em lote x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – company properties: company: type: array items: #/definitions/company description: Id da preadmission responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /professionalAdviceDelete: post: description: Exclui o conselho profissional caso não esteja vinculado a nenhum registro profissional. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do conselho profissional responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /bankListQuery: post: description: Retorna as informações básicas do cadastro de banco. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/bank default: description: Error response schema: #/definitions/genericError /changeBranchOfficeStatus: post: description: Ativa ou inativa a filial x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – branchOfficeId properties: branchOfficeId: type: string description: Id da filial responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/situation default: description: Error response schema: #/definitions/genericError /anonymous/employeeEntityQuery: post: description: Retorna uma entidade baseado no domínio, serviço e no id. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – entityId properties: entityId: #/definitions/entityIdDef translated: type: boolean description: Se <b>true</b>, retorna o label e o tooltip da customização traduzidos. responses: 200: description: Ok schema: type: object properties: entity_: #/definitions/entityDef default: description: Error response schema: #/definitions/genericError /saveMultipleNationalities: post: description: Inserir nacionalidades em lote x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – nationality properties: nationality: type: array items: #/definitions/nationality description: lista de nationality responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /saveMultipleReligions: post: description: Inserir religiões em lote x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – religion properties: religion: type: array items: #/definitions/religion description: lista de religion responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /anonymous/employeeDocumentQuery: post: description: Retorna todos os documentos de uma pré-admissão na jornada do colaborador. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – preAdmissionId – token properties: preAdmissionId: type: string description: Identificador único da pré-admissão. token: type: string description: Token de Acesso responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/preAdmissionData default: description: Error response schema: #/definitions/genericError /cityListQuery: post: description: Retorna as informações básicas do cadastro de cidade. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/city default: description: Error response schema: #/definitions/genericError /anonymous/employeeEnumInformation: post: description: Retorna uma lista com as enumerações traduzidas. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – names properties: names: type: array items: type: string description: Nome das enumerações responses: 200: description: Ok schema: type: object required: – results properties: results: #/definitions/enumInformationData default: description: Error response schema: #/definitions/genericError /preAdmissionFinish: post: description: Ação para trocar status de uma pré-admissão para FINISHED_ADMISSION. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador único da pré-admissão. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da finalização. message: type: string description: Mensagem detalhando o resultado da finalização default: description: Error response schema: #/definitions/genericError /anonymous/preAdmissionEmployeeTokenResend: post: description: Gera / Reseta token do colaborador x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object properties: preAdmissionId: type: string description: Id da pré-admissão do colaborador sendTokenOption: #/definitions/enumSendToken responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /religionListQuery: post: description: Retorna as informações básicas do cadastro de religião. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/religion default: description: Error response schema: #/definitions/genericError /anonymous/employeeBankListQuery: post: description: Retorna as informações básicas do cadastro de banco. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/bank default: description: Error response schema: #/definitions/genericError /countryListQuery: post: description: Retorna as informações básicas do cadastro de país. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/country default: description: Error response schema: #/definitions/genericError /preAdmissionMessageSend: post: description: Ação para adicionar mensagens na conversa. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – preAdmissionId – message – sender properties: preAdmissionId: type: string description: Código da pré admissão message: type: string description: Mensagem a ser enviada sender: #/definitions/messageSender responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /preAdmissionBackToValidation: post: description: Ação para trocar status de uma pré-admissão para IN_VALIDATION. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador único da pré-admissão. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da alteração para em validação. message: type: string description: Mensagem detalhando a alteração para em validação default: description: Error response schema: #/definitions/genericError /branchOfficeDelete: post: description: Exclui a filial caso esta não esteja vinculada a nenhuma pre-admissão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da filial responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /purchaseInfoQuery: post: description: Retorna as informações de teste/compra do produto. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/purchaseInfoData default: description: Error response schema: #/definitions/genericError /anonymous/employeeCommitObjectFromCustomFields: post: description: Commita uma lista de arquivos (blob) dos campos customizados. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – objects – token properties: objects: type: array items: #/definitions/commitObjectDef description: Lista de objetos para fazer o commit token: type: string description: Token de acesso responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /anonymous/employeeVerifySocialQualificationQuery: post: description: Retorna status de verificação do colaborador x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – preAdmissionId – name – birthDate – cpf – pis – challengeField – captcha – token properties: preAdmissionId: type: string description: Código da pré admissão. name: type: string description: Nome do colaborador birthDate: type: string description: Data de nascimento do colaborador cpf: type: string description: CPF do colaborador pis: type: string description: PIS do colaborador challengeField: type: string description: Chave do desafio captcha: type: string description: Captcha do desafio ignoreGovernmentQualification: type: boolean description: Quando o site do governo estiver indisponível, essa flag deverá ser true, assim irá ignorar a qualificação cadastral e permitirá a finalização do processo. token: type: string description: Token de Acesso responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/socialQualificationData default: description: Error response schema: #/definitions/genericError /companyListQuery: post: description: Retorna as informações do cadastro de empresas. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/company default: description: Error response schema: #/definitions/genericError /blobServiceDelete: post: description: Solicitação para apagar um arquivo. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto e que deve ser apagado seu Thumbnail(128X128px). responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /preAdmissionExpire: post: description: Ação para expirar uma pré-admissão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador único da pré-admissão. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da expiração. message: type: string description: Mensagem detalhando o resultado da expiração default: description: Error response schema: #/definitions/genericError /anonymous/employeePreAdmissionEntitiesQuery: post: description: Retorna a lista de entidades utilizada na pré-admissão de forma anônima na jornada do colaborador. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Id da pré-admissão translated: type: boolean description: Se <b>true</b>, retorna o label e o tooltip da customização traduzidos. responses: 200: description: Ok schema: type: object required: – entities properties: entities: #/definitions/entityDefList default: description: Error response schema: #/definitions/genericError /changeProfessionalAdviceStatus: post: description: Ativa ou inativa o conselho profissional x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – professionalAdviceId properties: professionalAdviceId: type: string description: Id do conselho profissional responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/situation default: description: Error response schema: #/definitions/genericError /saveMultipleDegreeOfEducation: post: description: Inserir graus de instrução em lote x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – degreeOfEducation properties: degreeOfEducation: type: array items: #/definitions/degreeOfEducation description: lista de degreeOfEducation responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /getMetadata: post: description: Default 'getMetadata' query. Every service must handle this command and return metadata in the format requested. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /contractInviteModelFieldQuery: post: description: Retorna os campos para montar layout x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – inviteModelId properties: inviteModelId: type: string description: Identificador único da pré-admissão responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/inviteModelFieldData default: description: Error response schema: #/definitions/genericError /anonymous/employeeCityListQuery: post: description: Retorna as informações básicas do cadastro de cidade. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/city default: description: Error response schema: #/definitions/genericError /alterDocumentModelEnabledStatus: post: description: Altera o status do modelo de documento x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – enabled – contractModelId properties: enabled: type: boolean description: Novo status do modelo de contrato contractModelId: type: string description: Id do modelo de documento a ser alterado o status responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action. default: description: Error response schema: #/definitions/genericError /anonymous/employeeSave: post: description: Ação para salvar as informações pessoais e documentos de uma pré-admissão na jornada do colaborador. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – id – personalData – documentData – hasDependent – saveAsDraft – token properties: id: type: string description: Identificador único da pré-admissão. personalData: #/definitions/preAdmissionPersonalBRAData documentData: #/definitions/preAdmissionDocumentBRAData hasDependent: type: boolean description: Identifica se existem dependentes. saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. token: type: string description: Token de Acesso responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/employeePreAdmissionSaveData default: description: Error response schema: #/definitions/genericError /anonymous/employeePreAdmissionDependentSave: post: description: Ação para salvar as informações de um dependente. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – preAdmissionId – basic – document – saveAsDraft – token properties: dependentId: type: string description: Identificador único do dependente. preAdmissionId: type: string description: Identificador único da pré-admissão. basic: #/definitions/dependentBasicData document: #/definitions/dependentDocumentData saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. token: type: string description: Token de Acesso responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/employeePreAdmissionSaveData default: description: Error response schema: #/definitions/genericError /anonymous/employeeDependentListQuery: post: description: Retorna uma lista com os dependentes de uma pré-admissão para a jornada do colaborador. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – token properties: size: type: integer description: Tamanho das páginas. page: type: integer description: Indicativo da página atual. filterQuery: type: string description: Filtro a ser aplicado na pesquisa. token: type: string description: Token de Acesso responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/preAdmissionDependentListData default: description: Error response schema: #/definitions/genericError /preAdmissionSendSms: post: description: Envio do SMS para uma lista de colaborador. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – employeeId properties: employeeId: type: array items: type: string description: Id do futuro colaborador responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /preAdmissionSaveAndFinish: post: description: Ação para salvar e finalizar uma pré-admissão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id – document – personalData – contract – saveAsDraft properties: id: type: string description: Identificador único da pré-admissão. document: #/definitions/preAdmissionDocumentBRAData personalData: #/definitions/preAdmissionPersonalBRAData contract: #/definitions/preAdmissionContractBraData hasDependent: type: boolean description: Identifica se existem dependentes. saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da gravação. default: description: Error response schema: #/definitions/genericError /documentsSend: post: description: Envia documentos para assinatura. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – contracts – signer – instructionsToSigner – preAdmissionId properties: contracts: type: array items: #/definitions/contractData description: Lista de documentos selecionados. signer: type: array items: #/definitions/signer description: dados do assinante do contrato. instructionsToSigner: type: string description: Um texto com instruções para o assinante preAdmissionId: type: string description: ID da Pre Admissão demandGeolocation: type: boolean description: Obrigar geolocalização responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /anonymous/employeeGlobalSettingsQuery: post: description: Retorna as configurações globais do módulo. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object properties: linkId: type: string description: Id da admissão responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/globalSettingsData default: description: Error response schema: #/definitions/genericError /extendTrial: post: description: Ação para efetuar a prorrogação do período de trial do produto. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – reason properties: reason: type: string description: Motivo da prorrogação do período de trial. responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /inviteModelLayoutQuery: post: description: Retorna as informações de leiaute de um modelo de convite. Caso o modelo não for informado, retorna um DTO vazio. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: inviteModelId: type: string description: Código do modelo de convite, caso convite já existente. responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/inviteModelLayoutData default: description: Error response schema: #/definitions/genericError /anonymous/employeeSocialQualificationSave: post: description: Ação para salvar a qualificação cadastral quando o site do governo estiver indisponível. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – preAdmissionId – token properties: preAdmissionId: type: string description: Código da pré admissão. token: type: string description: Token de Acesso responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /saveMultipleJobPositions: post: description: Inserir cargos em lote x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – jobPosition properties: jobPosition: type: array items: #/definitions/jobPosition description: lista de jobPosition responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /preAdmissionCountByMonth: post: description: Retorna os dados para se montar o analytics das pré-admissões por mês x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: monthPeriod: type: integer description: Quantidade de meses para buscar responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/preAdmissionMonthData default: description: Error response schema: #/definitions/genericError /healthcheck: post: description: HealthCheck Plataforma x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – status – checks properties: status: #/definitions/heathcheckDTO checks: #/definitions/checkDTO default: description: Error response schema: #/definitions/genericError /anonymous/employeeProfessionalAdviceListQuery: post: description: Retorna as informações do cadastro de conselho profissional. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/professionalAdvice default: description: Error response schema: #/definitions/genericError /anonymous/employeeRequestUploadFromCustomFields: post: description: Solicita a importação de um arquivo dos campos customizados x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – domain – service – entityName – field – fileName properties: domain: type: string description: Domínio do serviço service: type: string description: Nome do serviço entityName: type: string description: Nome da entidade field: type: string description: Nome do campo fileName: type: string description: Nome do arquivo responses: 200: description: Ok schema: type: object required: – location – version – objectId properties: location: type: string description: URL para upload do arquivo type: string description: Versão objectId: type: string description: Id de identificação do objeto default: description: Error response schema: #/definitions/genericError /anonymous/employeeNationalityListQuery: post: description: Retorna as informações básicas do cadastro de nacionalidade. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/nationality default: description: Error response schema: #/definitions/genericError /professionalAdviceListQuery: post: description: Retorna as informações do cadastro de conselho profissional. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/professionalAdvice default: description: Error response schema: #/definitions/genericError /inviteModelInvitationLayoutQuery: post: description: Retorna as informações do leiaute da tela de envio de convite x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: inviteModelId: type: string description: Id do modelo de convite. responses: 200: description: Ok schema: type: object properties: result: #/definitions/inviteModelInvitationLayoutData default: description: Error response schema: #/definitions/genericError /anonymous/employeePreAdmissionMessagesQuery: post: description: Retorna os perfis da conversa e as mensagens desta – visão do novo colaborador x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Código da pré admissão na qual a mensagem está referenciada. responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/preAdmissionMessageData default: description: Error response schema: #/definitions/genericError /anonymous/employeeDependentSave: post: description: Ação para salvar se uma pré-admissão tem dependentes vinculados. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – preAdmissionId – hasDependent – token properties: preAdmissionId: type: string description: Identificador único da pré-admissão. hasDependent: type: boolean description: Identifica se existem dependentes. token: type: string description: Token de Acesso responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/employeePreAdmissionSaveData default: description: Error response schema: #/definitions/genericError /anonymous/purchaseInfoQueryEmployee: post: description: Retorna as informações de teste compra do produto para a etapa do employee x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/purchaseInfoData default: description: Error response schema: #/definitions/genericError /anonymous/employeeReligionListQuery: post: description: Retorna as informações básicas do cadastro de religião. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/religion default: description: Error response schema: #/definitions/genericError /anonymous/employeeCountryListQuery: post: description: Retorna as informações básicas do cadastro de país. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/country default: description: Error response schema: #/definitions/genericError /autocompleteFilterBranchOffice: post: description: Retorna as filiais utilizadas pelo campo de lookup x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: #/definitions/autocompleteFilter default: description: Error response schema: #/definitions/genericError /changeCompanyStatus: post: description: Ativa ou inativa a empresa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – companyId properties: companyId: type: string description: Id da empresa responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/situation default: description: Error response schema: #/definitions/genericError /preAdmissionResend: post: description: Reenvia o convite para um colaborador x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – employee properties: employee: #/definitions/preAdmissionSaveData responses: 200: description: Ok schema: type: object required: – result – messageFromSmartphoneData properties: result: type: boolean description: Resultado da action message: type: string description: Mensagem de retorno messageFromSmartphoneData: #/definitions/messageFromSmartphoneData default: description: Error response schema: #/definitions/genericError /anonymous/employeeSocialQualificationInfoQuery: post: description: Retorna informações da qualificação social x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – preAdmissionId – token properties: preAdmissionId: type: string description: Identificador único da pré-admissão. token: type: string description: Token de Acesso responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/socialQualification default: description: Error response schema: #/definitions/genericError /blobServiceRequestAccess: post: description: Solicitação para acessar um arquivo. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). ttl: type: integer description: Tempo em minutos que o arquivo deve ficar disponível para download no link que será retornado (padrão 30 minutos). thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto e que deve ser retornado seu Thumbnail(128X128px). responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/blobServiceRequestAccessData default: description: Error response schema: #/definitions/genericError /employeeContractQuery: post: description: Retorna os contratos enviados da pré admissão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Código do modelo de convite. responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/envelopeTree default: description: Error response schema: #/definitions/genericError /globalSettingsQuery: post: description: Retorna as configurações globais do módulo. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: linkId: type: string description: Id da admissão responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/globalSettingsData default: description: Error response schema: #/definitions/genericError /dependentSave: post: description: Ação para salvar as informações de um dependente. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – preAdmissionId – basic – document – saveAsDraft properties: dependentId: type: string description: Identificador único do dependente. preAdmissionId: type: string description: Identificador único da pré-admissão. basic: #/definitions/dependentBasicData document: #/definitions/dependentDocumentData validation: #/definitions/validationData saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da gravação. default: description: Error response schema: #/definitions/genericError /preAdmissionSendEmail: post: description: Ação para enviar o e-mail ao colaborador. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Código da pré admissão responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /anonymous/employeeInviteModelFieldQuery: post: description: Retorna os campos para montar layout x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Identificador único da pré-admissão responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/inviteModelFieldData default: description: Error response schema: #/definitions/genericError /preAdmissionListQuery: post: description: Retorna as informações básicas da pré-admissão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. page: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filterQuery: type: string description: Filtro a ser aplicado na pesquisa. contractFilter: #/definitions/contractFilterData responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/preAdmissionListData default: description: Error response schema: #/definitions/genericError /inviteModelContractQuery: post: description: Retorna as informações do contrato de um modelo de convite. Caso o modelo não for informado, retorna um DTO vazio. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: inviteModelId: type: string description: Código do modelo de convite, caso o convite já existente responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/inviteModelContractQueryData default: description: Error response schema: #/definitions/genericError /saveMultipleProfessionalAdvices: post: description: Inserir conselhos profissionais em lote x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – professionalAdvice properties: professionalAdvice: type: array items: #/definitions/professionalAdvice description: lista de professionalAdvice responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /anonymous/employeePersonalSave: post: description: Ação para salvar as informações pessoais de uma pré-admissão na jornada do colaborador. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – id – personalData – saveAsDraft – token properties: id: type: string description: Identificador único da pré-admissão. personalData: #/definitions/preAdmissionPersonalBRAData saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. token: type: string description: Token de Acesso responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/employeePreAdmissionSaveData default: description: Error response schema: #/definitions/genericError /anonymous/startDigitalTrial: post: description: Ação responsável por iniciar um período de trial do Onboarding a partir do digital x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – request properties: request: #/definitions/digitalTrialData responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /preAdmissionQuery: post: description: Retorna as informações de uma pré-admissão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Identificador único da pré-admissão. responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/preAdmissionData default: description: Error response schema: #/definitions/genericError /odata: post: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /anonymous/setUpPurchaseHistory: post: description: Realiza as configurações do purchase de um tenant existente. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – tenant – username – clientCode – clientName – billingDate – preAdmissionAmount properties: tenant: type: string description: Tenant que será configurado. username: type: string description: Usuário existente que terá o papel do Onboarding vinculado. clientCode: type: integer description: Código do cliente do ERP. clientName: type: string description: Nome do cliente no ERP billingDate: type: string description: Data de início do faturamento preAdmissionAmount: type: integer description: Quantidade de admissões responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /dependentDelete: post: description: Ação para excluir um dependente. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: dependentId: type: string description: Identificador único do dependente. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da exclusão. default: description: Error response schema: #/definitions/genericError /anonymous/preAdmissionEmployeeToken: post: description: Gera / Reseta token do colaborador x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object properties: preAdmissionId: type: string description: Id da pré-admissão do colaborador sendTokenOption: #/definitions/enumSendToken responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /preAdmissionCancel: post: description: Cancelar uma preadmissao x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Id da preadmission responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /companyDelete: post: description: Exclui a empresa caso esta não esteja vinculada a nenhuma pre-admissão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da empresa responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /anonymous/setUpOnboarding: post: description: Realiza as configurações de um tenant existente. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – tenant – username – clientCode – clientName – billingDate – preAdmissionAmount properties: tenant: type: string description: Tenant que será configurado. username: type: string description: Usuário existente que terá o papel do Onboarding vinculado. companyName: type: string description: Nome da empresa que será criada caso não exista nenhuma cadastrada. enumExternalModule: #/definitions/enumExternalModules isPurchase: type: boolean description: Indica se o produto foi adquirido. clientCode: type: integer description: Código do cliente do ERP. clientName: type: string description: Nome do cliente no ERP billingDate: type: string description: Data de início do faturamento preAdmissionAmount: type: integer description: Quantidade de admissões responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /inviteModelFieldListQuery: post: description: Retorna a lista de campos do modelo de convite de acordo com o tipo e subtipo. Esta lista é retornada ordenada pela categoria do campo e a ordem de exibição na tela. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – country – fieldType – fieldSubType properties: inviteModelId: type: string description: Código do modelo de convite, caso convite já existente. country: #/definitions/inviteModelCountry fieldType: #/definitions/inviteFieldType fieldSubType: #/definitions/inviteFieldSubType responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/inviteModelFieldListQueryData default: description: Error response schema: #/definitions/genericError /anonymous/employeeDependentQuery: post: description: Retorna as informações de dependentes de uma pré-admissão para a jornada do colaborador. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – dependentId – token properties: dependentId: type: string description: Identificador único do dependente. token: type: string description: Token de Acesso responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/dependentData default: description: Error response schema: #/definitions/genericError /searchAddress: post: description: Ação para obter informações do cep e caso não exista, inserir na base x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cep properties: cep: type: string description: Cep do logradouro responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/personalAddressBRAData default: description: Error response schema: #/definitions/genericError /jobPositionListQuery: post: description: Retorna as informações do cadastro de cargo. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/jobPosition default: description: Error response schema: #/definitions/genericError /getPreAdmissionEntities: post: description: Retorna a lista de entidades utilizada na pré-admissão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Id da pré-admissão translated: type: boolean description: Se <b>true</b>, retorna o label e o tooltip da customização traduzidos. responses: 200: description: Ok schema: type: object required: – entities properties: entities: #/definitions/entityDefList default: description: Error response schema: #/definitions/genericError /autocompleteFilterCompany: post: description: Retorna as empresas utilizadas pelo campo de lookup x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: #/definitions/autocompleteFilter default: description: Error response schema: #/definitions/genericError /preAdmissionDependentQuery: post: description: Retorna as informações de dependentes de uma pré-admissão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – dependentId properties: dependentId: type: string description: Identificador único do dependente. responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/dependentData default: description: Error response schema: #/definitions/genericError /anonymous/externalModulesDelete: post: description: Ação para remover um registro na entidade ExternalModules x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – enumExternalModule properties: enumExternalModule: #/definitions/enumExternalModules responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /enumInformation: post: description: Retorna uma lista com as enumerações traduzidas. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – names properties: names: type: array items: type: string description: Nome das enumerações responses: 200: description: Ok schema: type: object required: – results properties: results: #/definitions/enumInformationData default: description: Error response schema: #/definitions/genericError /anonymous/getExternalModulesAndPurchaseHistoryQuery: post: description: Query para buscar as informações da tabela external_modules e purchaseHistory x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – tenant – username – key properties: tenant: type: string description: Tenant que será será feita a busca. username: type: string description: Usuário existente para acesso ao tenant key: type: string description: Senha de acesso a API responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultPurchaseExternal default: description: Error response schema: #/definitions/genericError /anonymous/employeeRequestAccessFromCustomFields: post: description: Solicitação para acessar um arquivo dos campos customizados. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – objectId properties: objectId: type: string description: Identificador para retornar a url do arquivo seguindo o padrão – objectId/fileName responses: 200: description: Ok schema: type: object required: – fileName – uri properties: fileName: type: string description: Nome do arquivo uri: type: string description: Url do arquivo default: description: Error response schema: #/definitions/genericError /jobPositionDelete: post: description: Exclui o cargo caso não esteja vinculado a nenhuma pre-admissão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do cargo responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /degreeOfEducationListQuery: post: description: Retorna as informações básicas do cadastro de grau de instrução. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/degreeOfEducation default: description: Error response schema: #/definitions/genericError /anonymous/employeeBlobServiceRequestUpload: post: description: Solicitação para realizar o upload de um arquivo. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome do arquivo que será carregado. thumbnail: type: boolean description: Condicional se será salvo um thumbnail. responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/blobServiceRequestUploadData default: description: Error response schema: #/definitions/genericError /blobServiceRequestUpload: post: description: Solicitação para realizar o upload de um arquivo. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome do arquivo que será carregado. thumbnail: type: boolean description: Condicional se será salvo um thumbnail. responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/blobServiceRequestUploadData default: description: Error response schema: #/definitions/genericError /inviteModelDelete: post: description: Exclui o modelo de convite caso este não esteja vinculado a nenhuma pre-admissão x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – inviteModelId properties: inviteModelId: type: string description: Id do modelo de convite responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /preAdmissionDependentListQuery: post: description: Retorna uma lista com os dependentes de uma pré-admissão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. page: type: integer description: Indicativo da página atual. filterQuery: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/preAdmissionDependentListData default: description: Error response schema: #/definitions/genericError /documentConvert: post: description: Converte o documento de string HTML para PDF para envio ao GED x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – document properties: document: type: string description: HTML do documento a ser convertido responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: Resultado da operação. default: description: Error response schema: #/definitions/genericError /branchOfficeListQuery: post: description: Retorna as informações do cadastro de filiais. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/branchOffice default: description: Error response schema: #/definitions/genericError /documentCancel: post: description: Cancela documento enviado para assinatura. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: ID de referencia do envelope na base responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /stateListQuery: post: description: Retorna as informações básicas do cadastro de estado/unidades federativa. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/state default: description: Error response schema: #/definitions/genericError /requestUpload: post: description: Solicita o upload de um documento x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome que irá corresponder ao arquivo. responses: 200: description: Ok schema: type: object required: – fileUrl – uploadUrl properties: fileUrl: type: string description: Url do arquivo do arquivo. uploadUrl: type: string description: Url onde deverá ocorrer o download do arquivo. default: description: Error response schema: #/definitions/genericError /preAdmissionContractBraQuery: post: description: Retorna as informações do contrato de uma pré admissão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Identificador da pré-admissão. responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/preAdmissionContractBraData default: description: Error response schema: #/definitions/genericError /anonymous/employeeInviteInfoQuery: post: description: Retorna as informações do layout da tela do colaborador. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Identificador único da pré-admissão. responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/inviteInfoData default: description: Error response schema: #/definitions/genericError /nationalityListQuery: post: description: Retorna as informações básicas do cadastro de nacionalidade. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: size: type: integer description: Tamanho das páginas. offset: type: integer description: Indicativo da página atual. orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: #/definitions/nationality default: description: Error response schema: #/definitions/genericError /blobServiceCommit: post: description: Realiza o commit de um arquivo que foi carregado anteriormente. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – fileId – version properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). type: string description: Versão do arquivo. thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto, e que deve ser criada a foto e seu Thumbnail(128X128px). responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/resultBaseData default: description: Error response schema: #/definitions/genericError /anonymous/employeePersonalQuery: post: description: Retorna todas as informações pessoais de uma pré-admissão na jornada do colaborador. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – preAdmissionId – token properties: preAdmissionId: type: string description: Identificador único da pré-admissão. token: type: string description: Token de Acesso responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/preAdmissionData default: description: Error response schema: #/definitions/genericError /anonymous/employeeDependentDelete: post: description: Ação para excluir um dependente. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – preAdmissionId – token properties: dependentId: type: string description: Identificador único do dependente. preAdmissionId: type: string description: Identificador único da pre-admissão token: type: string description: Token de Acesso responses: 200: description: Ok schema: type: object required: – result properties: result: #/definitions/employeePreAdmissionSaveData default: description: Error response schema: #/definitions/genericError /saveMultipleBranchOffice: post: description: Inserir filiais em lote x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – branchOffice properties: branchOffice: type: array items: #/definitions/branchOffice description: Id da branchOffice responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /anonymous/employeePreAdmissionSendMessage: post: description: Ação para enviar a mensagem ao analista de RH na jornada do colaborador. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – preAdmissionId – message properties: preAdmissionId: type: string description: Código da pré admissão message: type: string description: Mensagem a ser enviada responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /inviteModelSave: post: description: Salva o modelo de convite completo. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – inviteModel properties: inviteModel: #/definitions/inviteModelData responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action. default: description: Error response schema: #/definitions/genericError /lgpdSyncField: post: description: Sincroniza os campos para atender a LGPD x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /verifyExpiredPreAdmissions: post: description: Expira os convites que a data de validade é menor que hoje e o status é diferente de finalizado, expirado e em validação x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /anonymous/verifyTrialEndSituation: post: description: Verifica a situação do trial para o tenant x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – #/parameters/clientId – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /payrollPreAdmissionSaved: post: description: Notifica que um salvamento de Pré-admissão integrada com o Payroll foi bem sucedida e envia no payload o ID do rascunho da pré-admissão x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – preAdmissionId – payrollDraftId properties: warning: type: boolean description: Indica sucesso com alerta message: type: string description: Mensagem de retorno preAdmissionId: type: string description: ID da Pré-admissão do Colabbe payrollDraftId: type: string description: ID do admissionDraft do Payroll responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /serviceStarted: post: description: Default 'serviceStarted' event. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – domain – service properties: domain: type: string description: service: type: string description: responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /notifyUserEvent: post: description: Default 'notifyUser' event. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/notifyUserEventPayload responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/company: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/company responses: 200: description: The created resource schema: #/definitions/company default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/company responses: 200: description: The created resource schema: #/definitions/company default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/company default: description: Error response schema: #/definitions/genericError /entities/company/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/company default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/company/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/company responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/contractModel: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/contractModel responses: 200: description: The created resource schema: #/definitions/contractModel default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/contractModel responses: 200: description: The created resource schema: #/definitions/contractModel default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/contractModel default: description: Error response schema: #/definitions/genericError /entities/contractModel/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contractModel responses: 200: description: Ok schema: #/definitions/contractModel default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contractModel responses: 200: description: Ok schema: #/definitions/contractModel default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contractModel default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/contractModel/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/contractModel responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/personalBirthPlace: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/personalBirthPlace responses: 200: description: The created resource schema: #/definitions/personalBirthPlace default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/personalBirthPlace responses: 200: description: The created resource schema: #/definitions/personalBirthPlace default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/personalBirthPlace default: description: Error response schema: #/definitions/genericError /entities/personalBirthPlace/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalBirthPlace responses: 200: description: Ok schema: #/definitions/personalBirthPlace default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalBirthPlace responses: 200: description: Ok schema: #/definitions/personalBirthPlace default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personalBirthPlace default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/personalBirthPlace/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/personalBirthPlace responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/branchOffice: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/branchOffice responses: 200: description: The created resource schema: #/definitions/branchOffice default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/branchOffice responses: 200: description: The created resource schema: #/definitions/branchOffice default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/branchOffice default: description: Error response schema: #/definitions/genericError /entities/branchOffice/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/branchOffice responses: 200: description: Ok schema: #/definitions/branchOffice default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/branchOffice responses: 200: description: Ok schema: #/definitions/branchOffice default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/branchOffice default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/branchOffice/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/branchOffice responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/reservist: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/reservist responses: 200: description: The created resource schema: #/definitions/reservist default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/reservist responses: 200: description: The created resource schema: #/definitions/reservist default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/reservist default: description: Error response schema: #/definitions/genericError /entities/reservist/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/reservist responses: 200: description: Ok schema: #/definitions/reservist default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/reservist responses: 200: description: Ok schema: #/definitions/reservist default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/reservist default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/reservist/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/reservist responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/inviteModelLayout: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/inviteModelLayout responses: 200: description: The created resource schema: #/definitions/inviteModelLayout default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/inviteModelLayout responses: 200: description: The created resource schema: #/definitions/inviteModelLayout default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/inviteModelLayout default: description: Error response schema: #/definitions/genericError /entities/inviteModelLayout/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModelLayout responses: 200: description: Ok schema: #/definitions/inviteModelLayout default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModelLayout responses: 200: description: Ok schema: #/definitions/inviteModelLayout default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/inviteModelLayout default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/inviteModelLayout/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/inviteModelLayout responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/personalBasic: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/personalBasic responses: 200: description: The created resource schema: #/definitions/personalBasic default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/personalBasic responses: 200: description: The created resource schema: #/definitions/personalBasic default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/personalBasic default: description: Error response schema: #/definitions/genericError /entities/personalBasic/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalBasic responses: 200: description: Ok schema: #/definitions/personalBasic default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalBasic responses: 200: description: Ok schema: #/definitions/personalBasic default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personalBasic default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/personalBasic/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/personalBasic responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/dnv: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/dnv responses: 200: description: The created resource schema: #/definitions/dnv default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/dnv responses: 200: description: The created resource schema: #/definitions/dnv default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/dnv default: description: Error response schema: #/definitions/genericError /entities/dnv/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dnv responses: 200: description: Ok schema: #/definitions/dnv default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dnv responses: 200: description: Ok schema: #/definitions/dnv default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dnv default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/dnv/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/dnv responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/countryField: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/countryField responses: 200: description: The created resource schema: #/definitions/countryField default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/countryField responses: 200: description: The created resource schema: #/definitions/countryField default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/countryField default: description: Error response schema: #/definitions/genericError /entities/countryField/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/countryField responses: 200: description: Ok schema: #/definitions/countryField default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/countryField responses: 200: description: Ok schema: #/definitions/countryField default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/countryField default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/countryField/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/countryField responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/preAdmissionDependentBra: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/preAdmissionDependentBra responses: 200: description: The created resource schema: #/definitions/preAdmissionDependentBra default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/preAdmissionDependentBra responses: 200: description: The created resource schema: #/definitions/preAdmissionDependentBra default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/preAdmissionDependentBra default: description: Error response schema: #/definitions/genericError /entities/preAdmissionDependentBra/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionDependentBra responses: 200: description: Ok schema: #/definitions/preAdmissionDependentBra default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionDependentBra responses: 200: description: Ok schema: #/definitions/preAdmissionDependentBra default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/preAdmissionDependentBra default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/preAdmissionDependentBra/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionDependentBra responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/preAdmissionContractBra: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/preAdmissionContractBra responses: 200: description: The created resource schema: #/definitions/preAdmissionContractBra default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/preAdmissionContractBra responses: 200: description: The created resource schema: #/definitions/preAdmissionContractBra default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/preAdmissionContractBra default: description: Error response schema: #/definitions/genericError /entities/preAdmissionContractBra/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionContractBra responses: 200: description: Ok schema: #/definitions/preAdmissionContractBra default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionContractBra responses: 200: description: Ok schema: #/definitions/preAdmissionContractBra default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/preAdmissionContractBra default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/preAdmissionContractBra/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionContractBra responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/civilCertificate: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/civilCertificate responses: 200: description: The created resource schema: #/definitions/civilCertificate default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/civilCertificate responses: 200: description: The created resource schema: #/definitions/civilCertificate default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/civilCertificate default: description: Error response schema: #/definitions/genericError /entities/civilCertificate/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/civilCertificate responses: 200: description: Ok schema: #/definitions/civilCertificate default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/civilCertificate responses: 200: description: Ok schema: #/definitions/civilCertificate default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/civilCertificate default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/civilCertificate/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/civilCertificate responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/preAdmissionPersonalBRA: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/preAdmissionPersonalBRA responses: 200: description: The created resource schema: #/definitions/preAdmissionPersonalBRA default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/preAdmissionPersonalBRA responses: 200: description: The created resource schema: #/definitions/preAdmissionPersonalBRA default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/preAdmissionPersonalBRA default: description: Error response schema: #/definitions/genericError /entities/preAdmissionPersonalBRA/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionPersonalBRA responses: 200: description: Ok schema: #/definitions/preAdmissionPersonalBRA default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionPersonalBRA responses: 200: description: Ok schema: #/definitions/preAdmissionPersonalBRA default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/preAdmissionPersonalBRA default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/preAdmissionPersonalBRA/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionPersonalBRA responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/city: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/city responses: 200: description: The created resource schema: #/definitions/city default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/city responses: 200: description: The created resource schema: #/definitions/city default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/city default: description: Error response schema: #/definitions/genericError /entities/city/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/city responses: 200: description: Ok schema: #/definitions/city default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/city responses: 200: description: Ok schema: #/definitions/city default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/city default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/city/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/city responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/professionalAdvice: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/professionalAdvice responses: 200: description: The created resource schema: #/definitions/professionalAdvice default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/professionalAdvice responses: 200: description: The created resource schema: #/definitions/professionalAdvice default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/professionalAdvice default: description: Error response schema: #/definitions/genericError /entities/professionalAdvice/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/professionalAdvice responses: 200: description: Ok schema: #/definitions/professionalAdvice default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/professionalAdvice responses: 200: description: Ok schema: #/definitions/professionalAdvice default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/professionalAdvice default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/professionalAdvice/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/professionalAdvice responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/inviteModelField: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/inviteModelField responses: 200: description: The created resource schema: #/definitions/inviteModelField default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/inviteModelField responses: 200: description: The created resource schema: #/definitions/inviteModelField default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/inviteModelField default: description: Error response schema: #/definitions/genericError /entities/inviteModelField/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModelField responses: 200: description: Ok schema: #/definitions/inviteModelField default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModelField responses: 200: description: Ok schema: #/definitions/inviteModelField default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/inviteModelField default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/inviteModelField/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/inviteModelField responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/preAdmission: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/preAdmission responses: 200: description: The created resource schema: #/definitions/preAdmission default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/preAdmission responses: 200: description: The created resource schema: #/definitions/preAdmission default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/preAdmission default: description: Error response schema: #/definitions/genericError /entities/preAdmission/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmission responses: 200: description: Ok schema: #/definitions/preAdmission default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmission responses: 200: description: Ok schema: #/definitions/preAdmission default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/preAdmission default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/preAdmission/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/preAdmission responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/sus: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/sus responses: 200: description: The created resource schema: #/definitions/sus default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/sus responses: 200: description: The created resource schema: #/definitions/sus default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/sus default: description: Error response schema: #/definitions/genericError /entities/sus/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/sus responses: 200: description: Ok schema: #/definitions/sus default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/sus responses: 200: description: Ok schema: #/definitions/sus default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/sus default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/sus/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/sus responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/hiringMedicalExam: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/hiringMedicalExam responses: 200: description: The created resource schema: #/definitions/hiringMedicalExam default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/hiringMedicalExam responses: 200: description: The created resource schema: #/definitions/hiringMedicalExam default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/hiringMedicalExam default: description: Error response schema: #/definitions/genericError /entities/hiringMedicalExam/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/hiringMedicalExam responses: 200: description: Ok schema: #/definitions/hiringMedicalExam default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/hiringMedicalExam responses: 200: description: Ok schema: #/definitions/hiringMedicalExam default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/hiringMedicalExam default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/hiringMedicalExam/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/hiringMedicalExam responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/state: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/state responses: 200: description: The created resource schema: #/definitions/state default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/state responses: 200: description: The created resource schema: #/definitions/state default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/state default: description: Error response schema: #/definitions/genericError /entities/state/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/state responses: 200: description: Ok schema: #/definitions/state default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/state responses: 200: description: Ok schema: #/definitions/state default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/state default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/state/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/state responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/country: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/country responses: 200: description: The created resource schema: #/definitions/country default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/country responses: 200: description: The created resource schema: #/definitions/country default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/country default: description: Error response schema: #/definitions/genericError /entities/country/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/country responses: 200: description: Ok schema: #/definitions/country default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/country responses: 200: description: Ok schema: #/definitions/country default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/country default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/country/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/country responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/cnh: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/cnh responses: 200: description: The created resource schema: #/definitions/cnh default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/cnh responses: 200: description: The created resource schema: #/definitions/cnh default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/cnh default: description: Error response schema: #/definitions/genericError /entities/cnh/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cnh responses: 200: description: Ok schema: #/definitions/cnh default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cnh responses: 200: description: Ok schema: #/definitions/cnh default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/cnh default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/cnh/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/cnh responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/contract: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/contract responses: 200: description: The created resource schema: #/definitions/contract default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/contract responses: 200: description: The created resource schema: #/definitions/contract default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/contract default: description: Error response schema: #/definitions/genericError /entities/contract/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contract responses: 200: description: Ok schema: #/definitions/contract default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contract responses: 200: description: Ok schema: #/definitions/contract default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contract default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/contract/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/contract responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/preAdmissionMessage: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/preAdmissionMessage responses: 200: description: The created resource schema: #/definitions/preAdmissionMessage default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/preAdmissionMessage responses: 200: description: The created resource schema: #/definitions/preAdmissionMessage default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/preAdmissionMessage default: description: Error response schema: #/definitions/genericError /entities/preAdmissionMessage/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionMessage responses: 200: description: Ok schema: #/definitions/preAdmissionMessage default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionMessage responses: 200: description: Ok schema: #/definitions/preAdmissionMessage default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/preAdmissionMessage default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/preAdmissionMessage/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionMessage responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/bank: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/bank responses: 200: description: The created resource schema: #/definitions/bank default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/bank responses: 200: description: The created resource schema: #/definitions/bank default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/bank default: description: Error response schema: #/definitions/genericError /entities/bank/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bank responses: 200: description: Ok schema: #/definitions/bank default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bank responses: 200: description: Ok schema: #/definitions/bank default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/bank default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/bank/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/bank responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/dependentDocument: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/dependentDocument responses: 200: description: The created resource schema: #/definitions/dependentDocument default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/dependentDocument responses: 200: description: The created resource schema: #/definitions/dependentDocument default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/dependentDocument default: description: Error response schema: #/definitions/genericError /entities/dependentDocument/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentDocument responses: 200: description: Ok schema: #/definitions/dependentDocument default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentDocument responses: 200: description: Ok schema: #/definitions/dependentDocument default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dependentDocument default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/dependentDocument/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/dependentDocument responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/professionalRecord: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/professionalRecord responses: 200: description: The created resource schema: #/definitions/professionalRecord default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/professionalRecord responses: 200: description: The created resource schema: #/definitions/professionalRecord default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/professionalRecord default: description: Error response schema: #/definitions/genericError /entities/professionalRecord/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/professionalRecord responses: 200: description: Ok schema: #/definitions/professionalRecord default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/professionalRecord responses: 200: description: Ok schema: #/definitions/professionalRecord default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/professionalRecord default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/professionalRecord/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/professionalRecord responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/proofOfEnrollment: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/proofOfEnrollment responses: 200: description: The created resource schema: #/definitions/proofOfEnrollment default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/proofOfEnrollment responses: 200: description: The created resource schema: #/definitions/proofOfEnrollment default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/proofOfEnrollment default: description: Error response schema: #/definitions/genericError /entities/proofOfEnrollment/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/proofOfEnrollment responses: 200: description: Ok schema: #/definitions/proofOfEnrollment default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/proofOfEnrollment responses: 200: description: Ok schema: #/definitions/proofOfEnrollment default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/proofOfEnrollment default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/proofOfEnrollment/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/proofOfEnrollment responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/personalComplementary: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/personalComplementary responses: 200: description: The created resource schema: #/definitions/personalComplementary default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/personalComplementary responses: 200: description: The created resource schema: #/definitions/personalComplementary default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/personalComplementary default: description: Error response schema: #/definitions/genericError /entities/personalComplementary/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalComplementary responses: 200: description: Ok schema: #/definitions/personalComplementary default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalComplementary responses: 200: description: Ok schema: #/definitions/personalComplementary default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personalComplementary default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/personalComplementary/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/personalComplementary responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/cns: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/cns responses: 200: description: The created resource schema: #/definitions/cns default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/cns responses: 200: description: The created resource schema: #/definitions/cns default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/cns default: description: Error response schema: #/definitions/genericError /entities/cns/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cns responses: 200: description: Ok schema: #/definitions/cns default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cns responses: 200: description: Ok schema: #/definitions/cns default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/cns default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/cns/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/cns responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/inviteModel: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/inviteModel responses: 200: description: The created resource schema: #/definitions/inviteModel default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/inviteModel responses: 200: description: The created resource schema: #/definitions/inviteModel default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/inviteModel default: description: Error response schema: #/definitions/genericError /entities/inviteModel/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModel responses: 200: description: Ok schema: #/definitions/inviteModel default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModel responses: 200: description: Ok schema: #/definitions/inviteModel default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/inviteModel default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/inviteModel/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/inviteModel responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/envelope: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/envelope responses: 200: description: The created resource schema: #/definitions/envelope default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/envelope responses: 200: description: The created resource schema: #/definitions/envelope default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/envelope default: description: Error response schema: #/definitions/genericError /entities/envelope/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelope responses: 200: description: Ok schema: #/definitions/envelope default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelope responses: 200: description: Ok schema: #/definitions/envelope default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelope default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/envelope/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/envelope responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/inviteModelContract: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/inviteModelContract responses: 200: description: The created resource schema: #/definitions/inviteModelContract default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/inviteModelContract responses: 200: description: The created resource schema: #/definitions/inviteModelContract default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/inviteModelContract default: description: Error response schema: #/definitions/genericError /entities/inviteModelContract/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModelContract responses: 200: description: Ok schema: #/definitions/inviteModelContract default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModelContract responses: 200: description: Ok schema: #/definitions/inviteModelContract default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/inviteModelContract default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/inviteModelContract/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/inviteModelContract responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/personalEmail: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/personalEmail responses: 200: description: The created resource schema: #/definitions/personalEmail default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/personalEmail responses: 200: description: The created resource schema: #/definitions/personalEmail default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/personalEmail default: description: Error response schema: #/definitions/genericError /entities/personalEmail/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalEmail responses: 200: description: Ok schema: #/definitions/personalEmail default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalEmail responses: 200: description: Ok schema: #/definitions/personalEmail default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personalEmail default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/personalEmail/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/personalEmail responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/employeeToken: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/employeeToken responses: 200: description: The created resource schema: #/definitions/employeeToken default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/employeeToken responses: 200: description: The created resource schema: #/definitions/employeeToken default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/employeeToken default: description: Error response schema: #/definitions/genericError /entities/employeeToken/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeeToken responses: 200: description: Ok schema: #/definitions/employeeToken default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/employeeToken responses: 200: description: Ok schema: #/definitions/employeeToken default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/employeeToken default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/employeeToken/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/employeeToken responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/signer: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/signer responses: 200: description: The created resource schema: #/definitions/signer default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/signer responses: 200: description: The created resource schema: #/definitions/signer default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/signer default: description: Error response schema: #/definitions/genericError /entities/signer/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/signer responses: 200: description: Ok schema: #/definitions/signer default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/signer responses: 200: description: Ok schema: #/definitions/signer default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/signer default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/signer/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/signer responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/dependentBasic: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/dependentBasic responses: 200: description: The created resource schema: #/definitions/dependentBasic default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/dependentBasic responses: 200: description: The created resource schema: #/definitions/dependentBasic default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/dependentBasic default: description: Error response schema: #/definitions/genericError /entities/dependentBasic/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentBasic responses: 200: description: Ok schema: #/definitions/dependentBasic default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentBasic responses: 200: description: Ok schema: #/definitions/dependentBasic default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dependentBasic default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/dependentBasic/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/dependentBasic responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/passport: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/passport responses: 200: description: The created resource schema: #/definitions/passport default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/passport responses: 200: description: The created resource schema: #/definitions/passport default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/passport default: description: Error response schema: #/definitions/genericError /entities/passport/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/passport responses: 200: description: Ok schema: #/definitions/passport default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/passport responses: 200: description: Ok schema: #/definitions/passport default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/passport default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/passport/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/passport responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/rg: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/rg responses: 200: description: The created resource schema: #/definitions/rg default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/rg responses: 200: description: The created resource schema: #/definitions/rg default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/rg default: description: Error response schema: #/definitions/genericError /entities/rg/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/rg responses: 200: description: Ok schema: #/definitions/rg default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/rg responses: 200: description: Ok schema: #/definitions/rg default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/rg default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/rg/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/rg responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/socialQualification: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/socialQualification responses: 200: description: The created resource schema: #/definitions/socialQualification default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/socialQualification responses: 200: description: The created resource schema: #/definitions/socialQualification default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/socialQualification default: description: Error response schema: #/definitions/genericError /entities/socialQualification/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/socialQualification responses: 200: description: Ok schema: #/definitions/socialQualification default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/socialQualification responses: 200: description: Ok schema: #/definitions/socialQualification default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/socialQualification default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/socialQualification/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/socialQualification responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/externalModules: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/externalModules responses: 200: description: The created resource schema: #/definitions/externalModules default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/externalModules responses: 200: description: The created resource schema: #/definitions/externalModules default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/externalModules default: description: Error response schema: #/definitions/genericError /entities/externalModules/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/externalModules responses: 200: description: Ok schema: #/definitions/externalModules default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/externalModules responses: 200: description: Ok schema: #/definitions/externalModules default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/externalModules default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/externalModules/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/externalModules responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/voter: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/voter responses: 200: description: The created resource schema: #/definitions/voter default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/voter responses: 200: description: The created resource schema: #/definitions/voter default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/voter default: description: Error response schema: #/definitions/genericError /entities/voter/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/voter responses: 200: description: Ok schema: #/definitions/voter default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/voter responses: 200: description: Ok schema: #/definitions/voter default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/voter default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/voter/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/voter responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/vaccinationBooklet: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/vaccinationBooklet responses: 200: description: The created resource schema: #/definitions/vaccinationBooklet default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/vaccinationBooklet responses: 200: description: The created resource schema: #/definitions/vaccinationBooklet default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/vaccinationBooklet default: description: Error response schema: #/definitions/genericError /entities/vaccinationBooklet/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vaccinationBooklet responses: 200: description: Ok schema: #/definitions/vaccinationBooklet default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vaccinationBooklet responses: 200: description: Ok schema: #/definitions/vaccinationBooklet default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/vaccinationBooklet default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/vaccinationBooklet/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/vaccinationBooklet responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/addressBra: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/addressBra responses: 200: description: The created resource schema: #/definitions/addressBra default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/addressBra responses: 200: description: The created resource schema: #/definitions/addressBra default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/addressBra default: description: Error response schema: #/definitions/genericError /entities/addressBra/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/addressBra responses: 200: description: Ok schema: #/definitions/addressBra default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/addressBra responses: 200: description: Ok schema: #/definitions/addressBra default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/addressBra default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/addressBra/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/addressBra responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/personalAddressBRA: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/personalAddressBRA responses: 200: description: The created resource schema: #/definitions/personalAddressBRA default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/personalAddressBRA responses: 200: description: The created resource schema: #/definitions/personalAddressBRA default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/personalAddressBRA default: description: Error response schema: #/definitions/genericError /entities/personalAddressBRA/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalAddressBRA responses: 200: description: Ok schema: #/definitions/personalAddressBRA default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalAddressBRA responses: 200: description: Ok schema: #/definitions/personalAddressBRA default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personalAddressBRA default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/personalAddressBRA/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/personalAddressBRA responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/personalTelephone: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/personalTelephone responses: 200: description: The created resource schema: #/definitions/personalTelephone default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/personalTelephone responses: 200: description: The created resource schema: #/definitions/personalTelephone default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/personalTelephone default: description: Error response schema: #/definitions/genericError /entities/personalTelephone/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalTelephone responses: 200: description: Ok schema: #/definitions/personalTelephone default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalTelephone responses: 200: description: Ok schema: #/definitions/personalTelephone default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personalTelephone default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/personalTelephone/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/personalTelephone responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/religion: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/religion responses: 200: description: The created resource schema: #/definitions/religion default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/religion responses: 200: description: The created resource schema: #/definitions/religion default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/religion default: description: Error response schema: #/definitions/genericError /entities/religion/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/religion responses: 200: description: Ok schema: #/definitions/religion default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/religion responses: 200: description: Ok schema: #/definitions/religion default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/religion default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/religion/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/religion responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/bankAccount: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/bankAccount responses: 200: description: The created resource schema: #/definitions/bankAccount default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/bankAccount responses: 200: description: The created resource schema: #/definitions/bankAccount default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/bankAccount default: description: Error response schema: #/definitions/genericError /entities/bankAccount/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bankAccount responses: 200: description: Ok schema: #/definitions/bankAccount default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bankAccount responses: 200: description: Ok schema: #/definitions/bankAccount default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/bankAccount default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/bankAccount/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/bankAccount responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/ric: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/ric responses: 200: description: The created resource schema: #/definitions/ric default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/ric responses: 200: description: The created resource schema: #/definitions/ric default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/ric default: description: Error response schema: #/definitions/genericError /entities/ric/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/ric responses: 200: description: Ok schema: #/definitions/ric default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/ric responses: 200: description: Ok schema: #/definitions/ric default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/ric default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/ric/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/ric responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/nationality: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/nationality responses: 200: description: The created resource schema: #/definitions/nationality default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/nationality responses: 200: description: The created resource schema: #/definitions/nationality default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/nationality default: description: Error response schema: #/definitions/genericError /entities/nationality/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/nationality responses: 200: description: Ok schema: #/definitions/nationality default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/nationality responses: 200: description: Ok schema: #/definitions/nationality default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/nationality default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/nationality/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/nationality responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/purchaseHistory: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/purchaseHistory responses: 200: description: The created resource schema: #/definitions/purchaseHistory default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/purchaseHistory responses: 200: description: The created resource schema: #/definitions/purchaseHistory default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/purchaseHistory default: description: Error response schema: #/definitions/genericError /entities/purchaseHistory/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/purchaseHistory responses: 200: description: Ok schema: #/definitions/purchaseHistory default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/purchaseHistory responses: 200: description: Ok schema: #/definitions/purchaseHistory default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/purchaseHistory default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/purchaseHistory/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/purchaseHistory responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/validationData: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/validationData responses: 200: description: The created resource schema: #/definitions/validationData default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/validationData responses: 200: description: The created resource schema: #/definitions/validationData default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/validationData default: description: Error response schema: #/definitions/genericError /entities/validationData/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/validationData responses: 200: description: Ok schema: #/definitions/validationData default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/validationData responses: 200: description: Ok schema: #/definitions/validationData default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/validationData default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/validationData/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/validationData responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/ctps: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/ctps responses: 200: description: The created resource schema: #/definitions/ctps default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/ctps responses: 200: description: The created resource schema: #/definitions/ctps default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/ctps default: description: Error response schema: #/definitions/genericError /entities/ctps/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/ctps responses: 200: description: Ok schema: #/definitions/ctps default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/ctps responses: 200: description: Ok schema: #/definitions/ctps default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/ctps default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/ctps/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/ctps responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/preAdmissionDocumentBRA: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/preAdmissionDocumentBRA responses: 200: description: The created resource schema: #/definitions/preAdmissionDocumentBRA default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/preAdmissionDocumentBRA responses: 200: description: The created resource schema: #/definitions/preAdmissionDocumentBRA default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/preAdmissionDocumentBRA default: description: Error response schema: #/definitions/genericError /entities/preAdmissionDocumentBRA/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionDocumentBRA responses: 200: description: Ok schema: #/definitions/preAdmissionDocumentBRA default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionDocumentBRA responses: 200: description: Ok schema: #/definitions/preAdmissionDocumentBRA default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/preAdmissionDocumentBRA default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/preAdmissionDocumentBRA/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionDocumentBRA responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/jobPosition: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/jobPosition responses: 200: description: The created resource schema: #/definitions/jobPosition default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/jobPosition responses: 200: description: The created resource schema: #/definitions/jobPosition default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/jobPosition default: description: Error response schema: #/definitions/genericError /entities/jobPosition/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/jobPosition responses: 200: description: Ok schema: #/definitions/jobPosition default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/jobPosition responses: 200: description: Ok schema: #/definitions/jobPosition default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/jobPosition default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/jobPosition/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/jobPosition responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/degreeOfEducation: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/degreeOfEducation responses: 200: description: The created resource schema: #/definitions/degreeOfEducation default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/degreeOfEducation responses: 200: description: The created resource schema: #/definitions/degreeOfEducation default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/degreeOfEducation default: description: Error response schema: #/definitions/genericError /entities/degreeOfEducation/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/degreeOfEducation responses: 200: description: Ok schema: #/definitions/degreeOfEducation default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/degreeOfEducation responses: 200: description: Ok schema: #/definitions/degreeOfEducation default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/degreeOfEducation default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/degreeOfEducation/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/degreeOfEducation responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/cpf: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/cpf responses: 200: description: The created resource schema: #/definitions/cpf default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/cpf responses: 200: description: The created resource schema: #/definitions/cpf default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/cpf default: description: Error response schema: #/definitions/genericError /entities/cpf/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cpf responses: 200: description: Ok schema: #/definitions/cpf default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cpf responses: 200: description: Ok schema: #/definitions/cpf default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/cpf default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/cpf/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/cpf responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/pis: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/pis responses: 200: description: The created resource schema: #/definitions/pis default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/pis responses: 200: description: The created resource schema: #/definitions/pis default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/pis default: description: Error response schema: #/definitions/genericError /entities/pis/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pis responses: 200: description: Ok schema: #/definitions/pis default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pis responses: 200: description: Ok schema: #/definitions/pis default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pis default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/pis/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/pis responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/inviteModelInvitationLayout: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/inviteModelInvitationLayout responses: 200: description: The created resource schema: #/definitions/inviteModelInvitationLayout default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/inviteModelInvitationLayout responses: 200: description: The created resource schema: #/definitions/inviteModelInvitationLayout default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/inviteModelInvitationLayout default: description: Error response schema: #/definitions/genericError /entities/inviteModelInvitationLayout/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModelInvitationLayout responses: 200: description: Ok schema: #/definitions/inviteModelInvitationLayout default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModelInvitationLayout responses: 200: description: Ok schema: #/definitions/inviteModelInvitationLayout default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/inviteModelInvitationLayout default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/inviteModelInvitationLayout/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/inviteModelInvitationLayout responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericErrordefinitions: inviteModelCountry: type: string enum: – BRAZIL heathcheckDTO: type: string enum: – UP – DOWN inviteFieldType: type: string enum: – EMPLOYEE inviteFieldSubType: type: string enum: – PERSONAL_DATA – DOCUMENT – DEPENDENT – COMPLEMENTARY – SOCIAL_QUALIFICATION – PATTERN situation: type: string enum: – ACTIVE – INACTIVE messageSender: type: string enum: – EMPLOYEE – COMPANY enumPurchaseActions: type: string enum: – TRIAL_START – TRIAL_END – TRIAL_EXTEND – PURCHASE – CANCEL – PILOT enumExternalModules: type: string enum: – ADM_DE_PESSOAL – PAYROLL – API enumSendToken: type: string enum: – SMS – EMAIL – ALL enumDocumentStatus: type: string enum: – PROCESSING – IN_SIGNATURE – CANCELED – SIGNED – FAILURE_PROCESSING_FILE employeeContractType: type: string enum: – EMPLOYEE – MANAGER – FARM_WORKER – RETIRED – TRAINEE – APPRENTICE – FIXED_DUE_DATE – RETIRED_MANAGER – PUBLIC_AGENT – TEACHER – COOPERATIVE_WORKER – DOMESTIC_WORKER – TEACHER_FIXED_DUE_DATE eSocialCategory: type: string enum: – CATEGORY_101 – CATEGORY_102 – CATEGORY_103 – CATEGORY_104 – CATEGORY_105 – CATEGORY_106 – CATEGORY_111 – CATEGORY_201 – CATEGORY_202 – CATEGORY_301 – CATEGORY_302 – CATEGORY_303 – CATEGORY_305 – CATEGORY_306 – CATEGORY_307 – CATEGORY_308 – CATEGORY_309 – CATEGORY_401 – CATEGORY_410 – CATEGORY_701 – CATEGORY_711 – CATEGORY_712 – CATEGORY_721 – CATEGORY_722 – CATEGORY_723 – CATEGORY_731 – CATEGORY_734 – CATEGORY_738 – CATEGORY_741 – CATEGORY_751 – CATEGORY_761 – CATEGORY_771 – CATEGORY_781 – CATEGORY_901 – CATEGORY_902 – CATEGORY_903 – CATEGORY_904 – CATEGORY_905 – CATEGORY_997 – CATEGORY_998 – CATEGORY_999 unemploymentInsuranceType: type: string enum: – NOT_CONSULTED – NOT_RECEIVING – IS_RECEIVING sefipCategoryType: type: string enum: – TYPE_01 – TYPE_02 – TYPE_03 – TYPE_04 – TYPE_05 – TYPE_06 – TYPE_07 – TYPE_11 – TYPE_12 – TYPE_13 – TYPE_14 – TYPE_15 – TYPE_16 – TYPE_17 – TYPE_18 – TYPE_19 – TYPE_20 – TYPE_21 – TYPE_22 – TYPE_23 – TYPE_24 – TYPE_25 – TYPE_26 – TYPE_99 employeeType: type: string enum: – EMPLOYEE – THIRD – PARTNER raisType: type: string enum: – TYPE_10 – TYPE_15 – TYPE_20 – TYPE_25 – TYPE_30 – TYPE_31 – TYPE_35 – TYPE_40 – TYPE_49 – TYPE_50 – TYPE_55 – TYPE_60 – TYPE_65 – TYPE_70 – TYPE_75 – TYPE_80 – TYPE_90 – TYPE_95 – TYPE_96 – TYPE_97 categoryField: type: string enum: – BASIC – COMPLEMENTARY – PLACE_OF_BIRTH – ADDRESS – PHONES – EMAILS – DOCUMENT – INVITATION_LAYOUT – SOCIAL_QUALIFICATION – PATTERN – BANKINFO – CTPS – CPF – PIS – RG – VOTER_CARD – CNH – RESERVIST – DNV – CNS – CIVIL_CERTIFICATE – PASSPORT – CIVILIAN_IDENTITY_REGISTRY – HIRING_MEDICAL_EXAM – PROFESSIONAL_RECORD – DEPENDENT_CPF – DEPENDENT_RG – DEPENDENT_RIC – DEPENDENT_SUS_CARD – DEPENDENT_VACCINATION_BOOKLET – DEPENDENT_PROOF_OF_ENROLLMENT – DEPENDENT_DEATH_CERTIFICATE – DEPENDENT_BIRTH_CERTIFICATE – RECEIVE_SALARY_ADVANCE valueType: type: string enum: – FULL_NAME – PREFERRED_NAME – BADGE_PHOTO – GENDER – BIRTH_DATE – MOTHER_NAME – FATHER_NAME – MARITAL_STATUS – DEGREE_OF_EDUCATION – NATIONALITY – RELIGION – RACE – SOCIAL_NAME – COUNTRY – STATE – CITY – FIRST_PHONE – SECOND_PHONE – FIRST_EMAIL – SECOND_EMAIL – ADDRESS – BANKINFO – RECEIVE_SALARY_ADVANCE – CTPS – CPF – PIS – RG – VOTER_CARD – CNH – RESERVIST – DNV – CNS – CIVIL_CERTIFICATE – PASSPORT – CIVILIAN_IDENTITY_REGISTRY – HIRING_MEDICAL_EXAM – PROFESSIONAL_RECORD – DEPENDENT_FULL_NAME – DEPENDENT_DEGREE_OF_KINSHIP – DEPENDENT_GENDER – DEPENDENT_BIRTH_DATE – DEPENDENT_DECLARE_INCOME_TAX – DEPENDENT_MOTHER_NAME – DEPENDENT_MARITAL_STATUS – DEPENDENT_CPF – DEPENDENT_RG – DEPENDENT_RIC – DEPENDENT_SUS_CARD – DEPENDENT_VACCINATION_BOOKLET – DEPENDENT_PROOF_OF_ENROLLMENT – DEPENDENT_DEATH_CERTIFICATE – DEPENDENT_BIRTH_CERTIFICATE – SOCIAL_QUALIFICATION – PATTERN_UPPERCASE – PATTERN_SPECIAL_CHARACTER – PATTERN_CAPITALIZE – PATTERN_PASCAL_CASE – CUSTOM_FIELD – PROFESSIONAL_ADVICE – EXEMPTION_DATE – MTE_NUMBER – REGITRY – TERM – DOCUMENT_FIRST_FILE – DOCUMENT_SECOND_FILE – DOCUMENT_THIRD_FILE – RA – DOCUMENT_ISSUE_DATE – DOCUMENT_CITY – IS_TEMPORARY – BOOK – DOCUMENT_NUMBER – SHEET – CATEGORY – DOCUMENT_STATE – DOCUMENT_SERIE – DOCUMENT_COUNTRY_ISSUING – FIRST_DATE_LICENCE – DOCUMENT_ISSUING_AGENT – DOCUMENT_DIGIT – BRANCH – BANK – ACCOUNT_TYPE – ACCOUNT_DIGIT – DISTRICT – SECTION – DOCUMENT_EXPIRATION_DATE – NOTARY_OFFICE – BANK_ACCOUNT – DOCUMENT_DOESNT_HAVE – CERTIFICATE_TYPE – ADDRESS_FILE – POSTAL_CODE – ADDRESS_TYPE – COMPLEMENT – NUMBER – NEIGHBORHOOD enumInvitationFieldsType: type: string enum: – KEY – COMPANY – BRANCH – CONTRACT_TYPE – JOB_POSITION – SPECIAL_CHARACTERS – UPPERCASE invitationStatus: type: string enum: – UNREAD – READ – EXPIRED – IN_VALIDATION – FINISHED – PENDING_ADMISSION – STARTED_ADMISSION – FINISHED_ADMISSION – IN_SIGNATURE – SIGNED eSocialStatus: type: string enum: – VERIFIED – NOT_VERIFIED enumGender: type: string enum: – MALE – FEMALE enumAccountType: type: string enum: – CURRENT_ACCOUNT – SAVINGS_ACCOUNT – SALARY_ACCOUNT – OTHER enumCivilCertificate: type: string enum: – BIRTH_CERTIFICATE – MARRIAGE_CERTIFICATE – INDIGENOUS_PERSONS_BIRTH_CERTIFICATE – DEATH_CERTIFICATE enumDegreeOfKinship: type: string enum: – ADOPTED – CHILD – CONCUBINE – EX_SPOUSE – EX_PARTNER – GRANDPARENT – GRANDCHILD – GREAT_GRANDPARENT – GREAT_GRANDCHILD – GUARDIANSHIP – NEPHEW_NIECE – OTHER – PARENT – FATHER_IN_LAW – PARTNER – PENSIONERS – PUPIL – SIBLING – SON_DAUGHTER_IN_LAW – SPOUSE – STEPFATHER – STEPMOTHER – STEPCHILD – TRUSTED – UNCLE_AUNT – TUTOR enumYesNo: type: string enum: – YES – NO enumMaritalStatus: type: string enum: – SINGLE – MARRIED – DIVORCED – WIDOWER – CONCUBINAGE – SEPARATED – STABLEUNION – OTHERS enumDriverLicenceCategory: type: string enum: – A – B – C – D – E – AB – AC – AD – AE enumTelephone: type: string enum: – PERSONAL_TELEPHONE – COMMERCIAL_TELEPHONE – CELLPHONE – PERSONAL_FAX – COMMERCIAL_FAX – OTHER_TELEPHONE_TYPE enumAddressType: type: string enum: – OTHERS – AIRPORT – LANE – AREA – AVENUE – BALNEARY – BLOCK – FIELD – FARMSTEAD – COLOGNE – CONDOMINIUM – SET – DISTRICT – TERRACE – SEASON – ROAD – SHANTYTOWN – FARM – MARKET – GALLERY – GRANJA – GARDEN – SLOPE – LAKE – LAGOON – LONG – ALLOTMENT – HILL – CORE – PARK – FOOTBRIDGE – COURTYARD – SQUARE – BEACH – COURT – NOOK – RESIDENTIAL – HIGHWAY – STREET – SECTOR – SITE – BYSTREET – EXCERPT – CLOVER – VALLEY – PATH – VIA – VIADUCT – ALLEY – VILLAGE – ACCESS – CAMP – LOCAL_ACCESS – CHURCHYARD – SPECIAL_AREA – RIGHT_MARGINAL_AVENUE – LEFT_MARGINAL_AVENUE – RING_ROAD – LATER_ROAD_BETWEEN – ARTERY – HIGH – SHORTCUT – GREEN_AREA – CONTOUR_AVENUE – MARGINAL_AVENUE – OLD_AVENUE – ALLEYWAY – HOLE – BELVEDERE – BALLOON – BLOCKS – BULEVAR – FOREST – BOULEVARD – LOW – PIER – SIDEWALK – WAY – CHANNEL – CHAPADAO – BICYCLE_PATH – CIRCULAR_ROAD – HOUSING_COMPLEX – ROAD_COMPLEX – COMMUNITY – HALL – STREAM – CONTOUR – DESCENT – DETOUR – BETWEEN_BLOCK – INTERMUNICIPAL_ROAD – COVE – PRIVATE_ENTRANCE – BETWEEN_QUARTER – LADDER – STAIRCASE – STATE_HIGHWAY – VICINAL_ROAD – ROAD_CONNECTION – MUNICIPAL_ROAD – ROAD_TO_SERFDOM – OLD_ROAD – LATER_ROAD – STADIUM – OFFICE – PRIVATE_ROAD – PARKING – EVANGELICAL – LOFTY – INDUSTRIAL_AXIS – RAILROAD – SOURCE – STRONG – HOUSING_NUCLEUS – ISLAND – UNDETERMINED – ISLET – WINDOW – LOT – MARKETPLACE – MARINA – MODULE – PROJECTION – MOUNT – RURAL_NUCLEUS – KNOLL – PARALLEL – TOUR – SPORTS_SQUARE – STOP – REST_AREA – TIP – PROLONGING – CITY_PARK – RESIDENTIAL_PARK – PASSAGE – PEDESTRIAN_WALKWAY – UNDERGROUND_PASSAGE – BRIDGE – PORT – FIFTH – FARMS – INTEGRATION_STREET – LINK_STREET – PRIVATE_STREET – OLD_STREET – BRANCH – PLAYGROUND – RETREAT – STRAIGHT – SIDE_STREET – RAMP – RODO_RING – KNEECAP – PEDESTRIAN_STREET – MARGIN – RETURN – ROUNDABOUT – SECOND_AVENUE – BONDAGE – UPLOADING – TRENCH – TERMINAL – TUNNEL – PRIVATE_BYSTREET – OLD_BYSTREET – UNITY – COLLECTOR_ROAD – LOCAL_WAY – ACCESS_WAY – DITCH – COASTAL_WAY – EXPRESSWAY – HIGHROAD – COASTAL_ROAD – WALKWAY – VARIANT – ZIGZAG enumEmail: type: string enum: – PERSONAL_EMAIL – PROFESSIONAL_EMAIL enumRacialType: type: string enum: – WHITE – BLACK – BROWN – YELLOW – INDIGENOUS – NOT_INFORMED enumMobilePhoneOption: type: string enum: – SMS – WHATSAPP – ALL enumDegreeOfEducation: type: string enum: – ILLITERATE – ELEMENTARY_SCHOOL_INCOMPLETE – ELEMENTARY_SCHOOL_COMPLETE – MIDDLE_SCHOOL_INCOMPLETE – MIDDLE_SCHOOL_COMPLETED – HIGH_SCHOOL_INCOMPLETE – HIGH_SCHOOL_COMPLETED – HIGHER_INCOMPLETE – HIGHER_COMPLETED – POST_GRADUATED – MASTER – DOCTORAL enumNationalityType: type: string enum: – BRAZILIAN – OTHER enumEmployeeQuantity: type: string enum: – UP_100 – BETWEEN_100_250 – BETWEEN_250_500 – BETWEEN_500_1000 – BETWEEN_1000_2500 – BETWEEN_2500_5000 – MORE_5000 enumBusinessSegment: type: string enum: – AGENCY – CONSULTING – E_COMMERCE – EDUCATION – HARDWARE – REAL_STATE – MANUFACTURE_INDUSTRY – LEGAL – HR_AND_RECRUITMENT – HEALTH – CORPORATE_SERVICES – FINANCIAL_SERVICES – CONSUMER_SERVICES – SOFTWARE_AND_CLOUD – TELECOMMUNICATIONS – TOURISM_AND_LEISURE – COMMUNICATION_VEHICLE enumAverageAdmissions: type: string enum: – UP_10 – BETWEEN_10_25 – BETWEEN_25_50 – BETWEEN_50_100 – MORE_100 fieldTypeDef: type: string enum: – String – Boolean – Integer – Double – Date – DateTime – Time – Money – Uuid – Blob – Binary – Any – Enumeration – Record userNotificationKind: type: string enum: – Operational – Management – News userNotificationPriority: type: string enum: – Error – Alert – None rRDData: type: object required: – email – name – company – personal_phone properties: email: type: string description: Email name: type: string description: Nome company: type: string description: Empresa personal_phone: type: string description: telefone envelopeTree: type: object required: – id – envelopeName – instructions – demandGeolocation – gedEnvelopeId – status – createdDate – contracts properties: id: type: string description: Identificador do envelope. envelopeName: type: string description: Nome do envelope instructions: type: string description: Instruções para o assinante. demandGeolocation: type: boolean description: Indicativo se o modelo de contrato está ativo ou não. gedEnvelopeId: type: string description: ID de referencia do envelope no GED signed: type: boolean description: Valida a resposta do colaborador status: #/definitions/enumDocumentStatus createdDate: type: string description: Data de criação format: date-time contracts: type: array items: #/definitions/contract description: contratos do envelope contract: type: object required: – contractName – contract – preAdmission – signed – gedDocumentId – gedDocumentVersionId – gedTicketId – status properties: id: type: string description: format: uuid contractName: type: string description: Nome do arquivo do contrato no GED contract: type: string description: Texto base do contrato. preAdmission: #/definitions/preAdmission signed: type: boolean description: Valida a resposta do colaborador gedDocumentId: type: string description: format: uuid gedDocumentVersionId: type: string description: format: uuid gedTicketId: type: string description: ID de referencia do ticket de processamento no GED status: #/definitions/enumDocumentStatus envelope: #/definitions/envelope createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time preAdmission: type: object required: – employeeName – sendDate – admissionDate – status – deadlineDate – inviteESocialStatus properties: id: type: string description: format: uuid linkId: type: string description: format: uuid modelId: #/definitions/inviteModel key: type: string description: Chave de identificação única da pré-admissão. employeeName: type: string description: Nome do novo colaborador employeeEmail: type: string description: Email do novo colaborador employeeMobilePhone: type: string description: Número de telefone celular do novo colaborador sendDate: type: string description: Data de envio do convite format: date conclusionPercentage: type: integer description: Percentual de conclusão do preenchimento do convite conclusionDocumentPercentage: type: integer description: Percentual de conclusão do preenchimento dos campos de documentos conclusionPersonalDataPercentage: type: integer description: Percentual de conclusão do preenchimento dos campos de dados pessoais conclusionDependentDataPercentage: type: integer description: Percentual de conclusão dos dependentes da pré-admissão. conclusionSocialQualificationPercentage: type: integer description: Percentual de conclusão do preenchimento do eSocial admissionDate: type: string description: Data prevista de admissão do novo colaborador format: date status: #/definitions/invitationStatus deadlineDate: type: string description: Data de expiração do convite format: date inviteESocialStatus: #/definitions/eSocialStatus unreadMessages: type: integer description: Quantidade de mensagens não lidas hasDependent: type: boolean description: Identifica se existem dependentes. socialQualification: type: array items: #/definitions/socialQualification description: Relacionamento da socialQualification preAdmissionPersonalBRA: type: array items: #/definitions/preAdmissionPersonalBRA description: Relacionamento da preAdmissionPersonalBRA preAdmissionMessage: type: array items: #/definitions/preAdmissionMessage description: Relacionamento da preAdmissionMessage preAdmissionDocumentBRA: type: array items: #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA preAdmissionDependentBra: type: array items: #/definitions/preAdmissionDependentBra description: Relacionamento da preAdmissionDependentBra preAdmissionContractBra: type: array items: #/definitions/preAdmissionContractBra description: Relacionamento da preAdmissionContractBra employeeMobilePhoneOption: #/definitions/enumMobilePhoneOption canceled: type: boolean description: Flag para sinalizacao de uma preAdmission cancelada firstFinishedDate: type: string description: Data da primeira finalização. format: date-time lastFinishedDate: type: string description: Data da última finalização. format: date-time finishedTimes: type: integer description: Contador de finalizações createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time inviteModel: type: object required: – name – enabled – country – deadline properties: id: type: string description: format: uuid name: type: string description: Descrição do modelo. enabled: #/definitions/situation country: #/definitions/inviteModelCountry deadline: type: integer description: Prazo do convite. preAdmission: type: array items: #/definitions/preAdmission description: Relacionamento da preAdmission inviteModelContract: type: array items: #/definitions/inviteModelContract description: Relacionamento da inviteModelContract inviteModelLayout: type: array items: #/definitions/inviteModelLayout description: Relacionamento da inviteModelLayout inviteModelField: type: array items: #/definitions/inviteModelField description: Relacionamento da inviteModelField inviteModelInvitationLayout: type: array items: #/definitions/inviteModelInvitationLayout description: Relacionamento da inviteModelField createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time inviteModelContract: type: object required: – modelId properties: id: type: string description: format: uuid modelId: #/definitions/inviteModel employeeContract: #/definitions/employeeContractType eSocialCategory: #/definitions/eSocialCategory unemploymentInsurance: #/definitions/unemploymentInsuranceType sefipCategory: #/definitions/sefipCategoryType employeeType: #/definitions/employeeType raisType: #/definitions/raisType company: type: string description: format: uuid branchOffice: type: string description: format: uuid jobPosition: type: string description: format: uuid createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time inviteModelLayout: type: object required: – modelId – sender – subject – baseColor – companyLogoId – circularCompanyLogoId – emailMessage – smsMessage properties: id: type: string description: format: uuid modelId: #/definitions/inviteModel sender: type: string description: Remetente do convite. subject: type: string description: Assunto do convite. baseColor: type: string description: Cor base da jornada do colaborador em hexadecimal. companyLogoId: type: string description: Endereço da logomarca da empresa. circularCompanyLogoId: type: string description: Logomarca da empresa em formato circular. emailHeaderImageId: type: string description: Imagem do cabeçalho do e-mail. emailMessage: type: string description: Conteúdo da mensagem enviada por e-mail. emailFooterImageId: type: string description: Imagem do rodapé do e-mail. smsMessage: type: string description: Conteúdo da mensagem enviada por SMS. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time inviteModelField: type: object required: – modelId – type – subType – category – description – valueOrder – valueType properties: id: type: string description: format: uuid modelId: #/definitions/inviteModel type: #/definitions/inviteFieldType subType: #/definitions/inviteFieldSubType category: #/definitions/categoryField description: type: string description: Descrição do campo. visible: type: boolean description: Indicativo de campo visível ou não. mandatory: type: boolean description: Indicativo de campo obrigatório ou não. attachFile: type: boolean description: Indicativo de obrigatoriedade para inclusão de um campo para anexos. valueOrder: type: integer description: Ordem de visualização. valueType: #/definitions/valueType canReceiveAttachment: type: boolean description: Indicativo se o campo aceita anexos ou não. acceptsGuidance: type: boolean description: Indicativo se o campo aceita orientação. guidance: type: string description: Texto de orientação. dependsOn: #/definitions/valueType customFieldKey: type: string description: Chave do Campo Customizado createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time inviteModelInvitationLayout: type: object required: – inviteModel – description – mandatory properties: id: type: string description: format: uuid inviteModel: #/definitions/inviteModel description: type: string description: Descrição do campo. field: #/definitions/enumInvitationFieldsType mandatory: type: boolean description: Indica se o campo será obrigatório. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time socialQualification: type: object required: – preAdmission properties: id: type: string description: format: uuid preAdmission: #/definitions/preAdmission name: type: string description: Nome do colaborador birthDate: type: string description: Data de nascimento do colaborador format: date cpf: type: string description: CPF do colaborador pis: type: string description: PIS do colaborador message: type: string description: Mensagem de retorno Esocial orientation: type: string description: Mensagem de orientação Esocial isGovernmentMessage: type: boolean description: Se o retorno é do governo ou não createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time preAdmissionPersonalBRA: type: object required: – preAdmission properties: id: type: string description: format: uuid preAdmission: #/definitions/preAdmission basic: #/definitions/personalBasic complementary: #/definitions/personalComplementary birthPlace: #/definitions/personalBirthPlace address: #/definitions/personalAddressBRA telephone: #/definitions/personalTelephone email: #/definitions/personalEmail createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time personalBasic: type: object properties: id: type: string description: format: uuid employeeName: type: string description: Nome completo do novo colaborador. preferredName: type: string description: Nome pelo qual o novo colaborador prefere ser chamado. badgeFileId: type: string description: Endereço onde a imagem do crachá está salva. gender: #/definitions/enumGender birthDate: type: string description: Data e nascimento do novo colaborador. format: date mothersName: type: string description: Nome da mãe do novo colaborador. fathersName: type: string description: Nome do pai do novo colaborador. validation: #/definitions/validationData preAdmissionPersonalBRA: type: array items: #/definitions/preAdmissionPersonalBRA description: Relacionamento da preAdmissionPersonalBRA createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time validationData: type: object properties: id: type: string description: format: uuid validated: type: boolean description: Indica se o documento foi validado. validationUser: type: string description: Indica o usuário que efetuou a validação. validationDate: type: string description: Indica a data e hora de validação do documento. format: date-time bankAccount: type: array items: #/definitions/bankAccount description: Relacionamento da bankAccount civilCertificate: type: array items: #/definitions/civilCertificate description: Relacionamento da civilCertificate cnh: type: array items: #/definitions/cnh description: Relacionamento da cnh cns: type: array items: #/definitions/cns description: Relacionamento da cns cpf: type: array items: #/definitions/cpf description: Relacionamento da cpf personalTelephone: type: array items: #/definitions/personalTelephone description: Relacionamento da personalTelephone ctps: type: array items: #/definitions/ctps description: Relacionamento da ctps voter: type: array items: #/definitions/voter description: Relacionamento da voter hiringMedicalExam: type: array items: #/definitions/hiringMedicalExam description: Relacionamento da hiringMedicalExam dnv: type: array items: #/definitions/dnv description: Relacionamento da dnv personalAddressBRA: type: array items: #/definitions/personalAddressBRA description: Relacionamento da personalAddressBRA personalBasic: type: array items: #/definitions/personalBasic description: Relacionamento da personalBasic personalEmail: type: array items: #/definitions/personalEmail description: Relacionamento da personalEmail passport: type: array items: #/definitions/passport description: Relacionamento da passport personalBirthPlace: type: array items: #/definitions/personalBirthPlace description: Relacionamento da personalBirthPlace personalComplementary: type: array items: #/definitions/personalComplementary description: Relacionamento da personalComplementary preAdmissionDependentBra: type: array items: #/definitions/preAdmissionDependentBra description: Relacionamento da preAdmissionDependentBra reservist: type: array items: #/definitions/reservist description: Relacionamento da reservist ric: type: array items: #/definitions/ric description: Relacionamento da ric rg: type: array items: #/definitions/rg description: Relacionamento da rg pis: type: array items: #/definitions/pis description: Relacionamento da pis professionalRecord: type: array items: #/definitions/professionalRecord description: Relacionamento da professionalRecord createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time bankAccount: type: object required: – branch properties: id: type: string description: format: uuid bank: type: string description: format: uuid branch: type: integer description: Número da agência. accountType: #/definitions/enumAccountType bankAccount: type: string description: Conta bancária. digit: type: string description: Digito da conta. firstFile: type: string description: Primeira imagem. secondFile: type: string description: Segunda imagem. validation: #/definitions/validationData preAdmissionDocumentBRA: type: array items: #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time preAdmissionDocumentBRA: type: object required: – preAdmission properties: id: type: string description: format: uuid preAdmission: #/definitions/preAdmission ctps: #/definitions/ctps cpf: #/definitions/cpf pis: #/definitions/pis rg: #/definitions/rg voter: #/definitions/voter cnh: #/definitions/cnh reservist: #/definitions/reservist dnv: #/definitions/dnv cns: #/definitions/cns civilCertificate: #/definitions/civilCertificate passport: #/definitions/passport ric: #/definitions/ric hiringMedicalExam: #/definitions/hiringMedicalExam bankAccount: #/definitions/bankAccount receiveSalaryAdvance: #/definitions/enumYesNo professionalRecord: #/definitions/professionalRecord createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time ctps: type: object properties: id: type: string description: format: uuid number: type: string description: Número. serie: type: string description: Série. digit: type: string description: Dígito. issuerState: type: string description: format: uuid issueDate: type: string description: Data de emissão. format: date firstFile: type: string description: Primeira imagem. secondFile: type: string description: Segunda imagem. validation: #/definitions/validationData preAdmissionDocumentBRA: type: array items: #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time cpf: type: object properties: id: type: string description: format: uuid number: type: string description: Número. firstFile: type: string description: Primeira imagem. validation: #/definitions/validationData preAdmissionDocumentBRA: type: array items: #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA dependentDocument: type: array items: #/definitions/dependentDocument description: Relacionamento da dependentDocument createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time dependentDocument: type: object properties: id: type: string description: format: uuid cpf: #/definitions/cpf rg: #/definitions/rg ric: #/definitions/ric sus: #/definitions/sus vaccinationBooklet: #/definitions/vaccinationBooklet proofOfEnrollment: #/definitions/proofOfEnrollment deathCertificate: #/definitions/civilCertificate birthCertificate: #/definitions/civilCertificate preAdmissionDependentBra: type: array items: #/definitions/preAdmissionDependentBra description: Relacionamento da preAdmissionDependentBra createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time rg: type: object properties: id: type: string description: format: uuid number: type: string description: Número. issuer: type: string description: Órgão emissor. issuerState: type: string description: format: uuid issueDate: type: string description: Data de emissão. format: date firstFile: type: string description: Primeira imagem. secondFile: type: string description: Segunda imagem. validation: #/definitions/validationData preAdmissionDocumentBRA: type: array items: #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA dependentDocument: type: array items: #/definitions/dependentDocument description: Relacionamento da dependentDocument createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time ric: type: object properties: id: type: string description: format: uuid number: type: string description: Número. issuer: type: string description: Órgão emissor. issuerCity: type: string description: format: uuid issuerState: type: string description: format: uuid issueDate: type: string description: Data de emissão. format: date expiryDate: type: string description: Data de validade. format: date firstFile: type: string description: Primeira imagem. secondFile: type: string description: Segunda imagem. validation: #/definitions/validationData preAdmissionDocumentBRA: type: array items: #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA dependentDocument: type: array items: #/definitions/dependentDocument description: Relacionamento da dependentDocument createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time sus: type: object properties: id: type: string description: format: uuid number: type: string description: Número firstFile: type: string description: Primeira imagem. dependentDocument: type: array items: #/definitions/dependentDocument description: Relacionamento da dependentDocument createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time vaccinationBooklet: type: object properties: id: type: string description: format: uuid firstFile: type: string description: Primeiro arquivo. secondFile: type: string description: Segundo arquivo thirdFile: type: string description: Terceiro arquivo dependentDocument: type: array items: #/definitions/dependentDocument description: Relacionamento da dependentDocument createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time proofOfEnrollment: type: object properties: id: type: string description: format: uuid firstFile: type: string description: Primeiro arquivo. dependentDocument: type: array items: #/definitions/dependentDocument description: Relacionamento da dependentDocument createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time civilCertificate: type: object properties: id: type: string description: format: uuid type: #/definitions/enumCivilCertificate issueDate: type: string description: Data de emissão. format: date registry: type: string description: Matrícula. term: type: string description: Termo. book: type: string description: Livro. sheet: type: string description: Folha. notaryOffice: type: string description: Cartório. issuerCity: type: string description: format: uuid issuerState: type: string description: format: uuid firstFile: type: string description: Primeira imagem. secondFile: type: string description: Segunda imagem. validation: #/definitions/validationData preAdmissionDocumentBRA: type: array items: #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA dependentDocument: type: array items: #/definitions/dependentDocument description: Relacionamento da dependentDocument dependentDocument2: type: array items: #/definitions/dependentDocument description: Relacionamento da dependentDocument createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time preAdmissionDependentBra: type: object required: – preAdmission properties: id: type: string description: format: uuid preAdmission: #/definitions/preAdmission dependentBasic: #/definitions/dependentBasic dependentDocument: #/definitions/dependentDocument conclusionPercentage: type: integer description: Percentual de conclusão. validation: #/definitions/validationData createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time dependentBasic: type: object properties: id: type: string description: format: uuid fullName: type: string description: Nome completo degreeOfKinship: #/definitions/enumDegreeOfKinship gender: #/definitions/enumGender birthDate: type: string description: Nascimento do dependente format: date declareIncomeTax: #/definitions/enumYesNo mothersName: type: string description: Nome da mãe maritalStatus: #/definitions/enumMaritalStatus preAdmissionDependentBra: type: array items: #/definitions/preAdmissionDependentBra description: Relacionamento da preAdmissionDependentBra createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time pis: type: object properties: id: type: string description: format: uuid number: type: string description: Número. issueDate: type: string description: Data de emissão. format: date firstFile: type: string description: Primeira imagem. validation: #/definitions/validationData preAdmissionDocumentBRA: type: array items: #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time voter: type: object properties: id: type: string description: format: uuid number: type: string description: Número. votingDistrict: type: string description: Zona. votingSection: type: string description: Seção. issuerCity: type: string description: format: uuid issuerState: type: string description: format: uuid issueDate: type: string description: Data de emissão. format: date firstFile: type: string description: Primeira imagem. secondFile: type: string description: Segunda imagem. validation: #/definitions/validationData preAdmissionDocumentBRA: type: array items: #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time cnh: type: object properties: id: type: string description: format: uuid number: type: string description: Número. category: #/definitions/enumDriverLicenceCategory issuer: type: string description: Órgão emissor. issuerState: type: string description: format: uuid issueDate: type: string description: Data de emissão. format: date expiryDate: type: string description: Data de validade do CNH. format: date firstDriverLicenceDate: type: string description: Data da primeira habilitação. format: date firstFile: type: string description: Primeira imagem. validation: #/definitions/validationData preAdmissionDocumentBRA: type: array items: #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time reservist: type: object properties: id: type: string description: format: uuid number: type: string description: Número. serie: type: string description: Série. ra: type: string description: RA. exemptionDate: type: string description: Data de dispensa. format: date firstFile: type: string description: Primeira imagem. secondFile: type: string description: Segunda imagem. doesntHave: type: boolean description: Se a pessoa não possui certificado de reservista validation: #/definitions/validationData preAdmissionDocumentBRA: type: array items: #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time dnv: type: object properties: id: type: string description: format: uuid number: type: string description: Número. firstFile: type: string description: Primeira imagem. validation: #/definitions/validationData preAdmissionDocumentBRA: type: array items: #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time cns: type: object properties: id: type: string description: format: uuid number: type: string description: Número. firstFile: type: string description: Primeira imagem. validation: #/definitions/validationData preAdmissionDocumentBRA: type: array items: #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time passport: type: object properties: id: type: string description: format: uuid number: type: string description: Número. issuer: type: string description: Emissor. issueDate: type: string description: Data de emissão. format: date expiryDate: type: string description: Data de validade. format: date issuerCountry: type: string description: format: uuid issuerState: type: string description: format: uuid firstFile: type: string description: Primeira imagem. validation: #/definitions/validationData preAdmissionDocumentBRA: type: array items: #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time hiringMedicalExam: type: object properties: id: type: string description: format: uuid file: type: string description: Arquivo do exame. validation: #/definitions/validationData preAdmissionDocumentBRA: type: array items: #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA examDate: type: string description: Data do exame. format: date createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time professionalRecord: type: object properties: id: type: string description: format: uuid professionalAdvice: type: string description: format: uuid number: type: string description: Número de registro no conselho profissional isTemporary: #/definitions/enumYesNo mteNumber: type: string description: Número do registro profissional no ministério do trabalho (MTE) shippingDate: type: string description: Data de expedição do registro format: date dueDate: type: string description: Data de vencimento do registro format: date doesntHave: type: boolean description: Se a pessoa não possui registro profissional firstFile: type: string description: Primeira imagem. secondFile: type: string description: Segunda imagem. validation: #/definitions/validationData preAdmissionDocumentBRA: type: array items: #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time personalTelephone: type: object properties: id: type: string description: format: uuid firstPhone: type: string description: Número do telefone principal. firstType: #/definitions/enumTelephone secondPhone: type: string description: Número do telefone secundário. secondType: #/definitions/enumTelephone validation: #/definitions/validationData preAdmissionPersonalBRA: type: array items: #/definitions/preAdmissionPersonalBRA description: Relacionamento da preAdmissionPersonalBRA createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time personalAddressBRA: type: object properties: id: type: string description: format: uuid country: type: string description: format: uuid state: type: string description: format: uuid city: type: string description: format: uuid cep: type: string description: CEP do endereço. neighborhood: type: string description: Bairro. addressType: #/definitions/enumAddressType address: type: string description: Endereço. firstFile: type: string description: Primeira imagem. number: type: string description: Número do endereço. additional: type: string description: Informação adicional referente ao endereço. validation: #/definitions/validationData preAdmissionPersonalBRA: type: array items: #/definitions/preAdmissionPersonalBRA description: Relacionamento da preAdmissionPersonalBRA createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time personalEmail: type: object properties: id: type: string description: format: uuid firstEmail: type: string description: Email principal do novo colaborador. firstType: #/definitions/enumEmail secondEmail: type: string description: Email secundário do novo colaborador. secondType: #/definitions/enumEmail validation: #/definitions/validationData preAdmissionPersonalBRA: type: array items: #/definitions/preAdmissionPersonalBRA description: Relacionamento da preAdmissionPersonalBRA createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time personalBirthPlace: type: object properties: id: type: string description: format: uuid country: type: string description: format: uuid state: type: string description: format: uuid city: type: string description: format: uuid validation: #/definitions/validationData preAdmissionPersonalBRA: type: array items: #/definitions/preAdmissionPersonalBRA description: Relacionamento da preAdmissionPersonalBRA createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time personalComplementary: type: object properties: id: type: string description: format: uuid maritalStatus: #/definitions/enumMaritalStatus degreeOfEducation: type: string description: format: uuid degreeOfEducationFileId: type: string description: Comprovante do grau de instrução. nationality: type: string description: format: uuid religion: type: string description: format: uuid race: #/definitions/enumRacialType socialName: type: string description: Nome social. validation: #/definitions/validationData preAdmissionPersonalBRA: type: array items: #/definitions/preAdmissionPersonalBRA description: Relacionamento da preAdmissionPersonalBRA createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time preAdmissionMessage: type: object required: – preAdmission – sender – sendDate – message properties: id: type: string description: format: uuid preAdmission: #/definitions/preAdmission sender: #/definitions/messageSender sendDate: type: string description: Data na qual a mensagem foi enviada. format: date-time readDate: type: string description: Data na qual a mensagem foi lida. format: date-time message: type: string description: Mensagem enviada. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time preAdmissionContractBra: type: object required: – preAdmission properties: id: type: string description: format: uuid preAdmission: #/definitions/preAdmission employeeContractType: #/definitions/employeeContractType eSocialCategory: #/definitions/eSocialCategory unemploymentInsuranceType: #/definitions/unemploymentInsuranceType sefipCategoryType: #/definitions/sefipCategoryType employeeType: #/definitions/employeeType raisType: #/definitions/raisType company: type: string description: format: uuid branchOffice: type: string description: format: uuid jobPosition: type: string description: format: uuid createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time envelope: type: object required: – envelopeName – instructions – demandGeolocation – status properties: id: type: string description: format: uuid envelopeName: type: string description: Nome do envelope instructions: type: string description: Instruções para o assinante. demandGeolocation: type: boolean description: Indicativo se o modelo de contrato está ativo ou não. preAdmission: #/definitions/preAdmission gedTicketId: type: string description: ID de referencia do ticket de processamento no GED gedEnvelopeId: type: string description: ID de referencia do envelope no GED signed: type: boolean description: Valida a resposta do colaborador status: #/definitions/enumDocumentStatus createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time checkDTO: type: object required: – name – status properties: name: type: string description: Nome do status status: #/definitions/heathcheckDTO enumInformationData: type: object required: – enumName – items properties: enumName: type: string description: Nome da enumeração. items: type: array items: #/definitions/enumInformationItemData description: Lista com os items das enumerações. enumInformationItemData: type: object required: – key – value properties: key: type: string description: Chave do item da enumeração. value: type: string description: Valor traduzido do item da enumeração. inviteModelFieldListQueryData: type: object required: – categories properties: categories: type: array items: #/definitions/inviteModelFieldCategory description: Lista de categorias do modelo de convite. inviteModelFieldCategory: type: object required: – category – fields properties: category: #/definitions/categoryField entityName: type: string description: Nome da entidade fields: type: array items: #/definitions/inviteModelFieldData description: Campos. inviteModelFieldData: type: object required: – type – subType – category – description – valueOrder – valueType – canReceiveAttachment properties: id: type: string description: Identificação do campo, quando não for um novo registro. type: #/definitions/inviteFieldType subType: #/definitions/inviteFieldSubType category: #/definitions/categoryField description: type: string description: Chave de tradução correspondente a descrição do campo. valueOrder: type: integer description: Ordem de apresentação do campo na tela. valueType: #/definitions/valueType canReceiveAttachment: type: boolean description: Indicativo se o seletor de foto será exibido ou não. visible: type: boolean description: Indicativo se o campo está visível ou não. mandatory: type: boolean description: Indicativo se o campo é obrigatório ou não. attachFile: type: boolean description: Indicativo se o usuário pode anexar foto ou não. acceptsGuidance: type: boolean description: Indicativo se o campo aceita orientação. guidance: type: string description: Texto de orientação. dependsOn: #/definitions/valueType entityName: type: string description: Nome da Entidade do Campo customFieldKey: type: string description: Chave do campo customizado inviteModelData: type: object required: – name – enabled – country – deadline – fields – layout – contract properties: id: type: string description: Identificador do modelo. name: type: string description: Descrição do modelo. enabled: #/definitions/situation country: #/definitions/inviteModelCountry deadline: type: integer description: Prazo do convite fields: type: array items: #/definitions/inviteModelFieldData description: Campos relacionados ao dados do colaborador layout: #/definitions/inviteModelLayoutData contract: #/definitions/inviteModelContractData invitationLayout: type: array items: #/definitions/inviteModelInvitationLayoutData description: Layout da tela de envio de convites. contractModelList: type: array items: #/definitions/contractModel description: Lista de modelos de contratos a serem assinados pelo colaborador inviteModelLayoutData: type: object required: – sender – subject – baseColor – companyLogoId – circularCompanyLogoId – emailMessage – smsMessage properties: id: type: string description: Identificador da configuração. sender: type: string description: Remetente do convite. subject: type: string description: Assunto do convite. baseColor: type: string description: Cor base da jornada do colaborador em hexadecimal. companyLogoId: type: string description: Endereço da logomarca da empresa. companyLogoVersionId: type: string description: Versão do arquivo temporário da logomarca da empresa. companyLogoPermanentUrl: type: string description: Caminho permanente do arquivo da logomarca da empresa. circularCompanyLogoId: type: string description: Logomarca da empresa em formato circular. circularCompanyLogoVersionId: type: string description: Versão do arquivo temporário da logomarca da empresa em formato circular. circularCompanyLogoPermanentUrl: type: string description: Caminho permanente do arquivo da logomarca da empresa em formato circular. emailHeaderImageId: type: string description: Imagem do cabeçalho do e-mail. emailHeaderImageVersionId: type: string description: Versão do arquivo temporário da imagem do cabeçalho do e-mail. emailHeaderImagePermanentUrl: type: string description: Caminho permanente do arquivo da imagem do cabeçalho do e-mail. emailMessage: type: string description: Conteúdo da mensagem enviada por e-mail. emailFooterImageId: type: string description: Imagem do rodapé do e-mail. emailFooterImageVersionId: type: string description: Versão do arquivo temporário da imagem do rodapé do e-mail. emailFooterImagePermanentUrl: type: string description: Caminho permanente do arquivo da imagem do rodapé do e-mail. smsMessage: type: string description: Conteúdo da mensagem enviada por SMS. inviteModelContractData: type: object properties: id: type: string description: Identificação do campo, quando não for um novo registro. employeeContractType: #/definitions/employeeContractType eSocialCategory: #/definitions/eSocialCategory unemploymentInsuranceType: #/definitions/unemploymentInsuranceType sefipCategoryType: #/definitions/sefipCategoryType employeeType: #/definitions/employeeType raisType: #/definitions/raisType company: #/definitions/company branchOffice: #/definitions/branchOffice jobPosition: #/definitions/jobPosition customFieldsInviteModelContract: type: array items: #/definitions/customData description: Campos customizados. customFields: type: array items: #/definitions/customData description: Campos customizados. company: type: object required: – companyName – enabled properties: id: type: string description: format: uuid companyName: type: string description: Nome da empresa. code: type: string description: Código externo da empresa. enabled: #/definitions/situation branchOffice: type: array items: #/definitions/branchOffice description: Filiais. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time branchOffice: type: object properties: id: type: string description: format: uuid company: #/definitions/company branchOfficeName: type: string description: Razão social. tradingName: type: string description: Nome fantasia. enabled: #/definitions/situation code: type: string description: Código do sistema externo. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time jobPosition: type: object required: – name properties: id: type: string description: format: uuid name: type: string description: Nome. enabled: #/definitions/situation code: type: string description: Código externo. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time customData: type: object required: – field properties: field: type: string description: Nome do campo. value: type: string description: Valor do campo. valueList: type: array items: type: string description: Valor do campo tipo lista. inviteModelInvitationLayoutData: type: object required: – description – mandatory properties: id: type: string description: Identificador único do registro. description: type: string description: Descrição do campo. field: #/definitions/enumInvitationFieldsType mandatory: type: boolean description: Indica se o campo será obrigatório. contractModel: type: object required: – contractModelName – contract – enabled properties: id: type: string description: format: uuid contractModelName: type: string description: Nome do modelo de contrato. contract: type: string description: Texto base do contrato. enabled: #/definitions/situation inviteModelId: #/definitions/inviteModel createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time inviteModelContractQueryData: type: object properties: id: type: string description: Identificador único do registro. employeeContractType: #/definitions/enumInformationItemData eSocialCategory: #/definitions/enumInformationItemData unemploymentInsuranceType: #/definitions/enumInformationItemData sefipCategoryType: #/definitions/enumInformationItemData employeeType: #/definitions/enumInformationItemData raisType: #/definitions/enumInformationItemData company: #/definitions/company branchOffice: #/definitions/branchOffice jobPosition: #/definitions/jobPosition customFields: type: array items: #/definitions/customData description: Campos customizados. customFieldsInviteModelContract: type: array items: #/definitions/customData description: Campos customizados. invitationLayoutConfigurationData: type: object properties: contract: #/definitions/contractQueryData fields: type: array items: #/definitions/inviteModelInvitationLayoutData description: Configuração dos campos contractQueryData: type: object properties: id: type: string description: Identificador único do registro. employeeContractType: #/definitions/enumInformationItemData eSocialCategory: #/definitions/enumInformationItemData unemploymentInsuranceType: #/definitions/enumInformationItemData sefipCategoryType: #/definitions/enumInformationItemData employeeType: #/definitions/enumInformationItemData raisType: #/definitions/enumInformationItemData company: #/definitions/company branchOffice: #/definitions/branchOffice jobPosition: #/definitions/jobPosition customFields: type: array items: #/definitions/customData description: Campos customizados. customFieldsInviteModelContract: type: array items: #/definitions/customData description: Campos customizados. resultBaseData: type: object required: – ok properties: ok: type: boolean description: Flag para indicar sucesso. message: type: string description: Mensagem de retorno. blobServiceRequestUploadData: type: object required: – ok – fileId – version – locationURI properties: ok: type: boolean description: Flag para indicar sucesso. message: type: string description: Mensagem de retorno. fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). type: string description: Versão do arquivo. locationURI: type: string description: URI onde o upload deve ser realizado. blobServiceRequestAccessData: type: object required: – ok – locationURI properties: ok: type: boolean description: Flag para indicar sucesso. message: type: string description: Mensagem de retorno. locationURI: type: string description: URI onde o arquivo está disponível para download. preAdmissionSaveData: type: object required: – inviteModel – employeeName – admissionDate properties: id: type: string description: Identificador único da pré-admissão inviteModel: #/definitions/inviteModel key: type: string description: Chave de identificação única da pré-admissão. employeeName: type: string description: Nome do novo colaborador employeeEmail: type: string description: Email do novo colaborador employeeMobilePhone: type: string description: Número de telefone celular do novo colaborador admissionDate: type: string description: Data prevista de admissão do novo colaborador format: date additionalInfo: type: string description: Informação adicional para ser enviada no modelo de convite employeeContractType: #/definitions/employeeContractType company: type: string description: Empresa branchOffice: type: string description: Filial jobPosition: type: string description: Cargo employeeMobilePhoneOption: #/definitions/enumMobilePhoneOption fromIntegration: type: boolean description: flag se a chamada veio de integracao preAdmissionData: type: object required: – status properties: id: type: string description: Identificação da pré-admissão. employeeName: type: string description: Nome do colaborador. status: #/definitions/enumInformationItemData inviteModelId: type: string description: Identificador do modelo de convite inviteModelName: type: string description: Nome do modelo de convite hasDependent: type: boolean description: Identifica se existem dependentes. inviteFields: type: array items: #/definitions/inviteModelFieldData description: Campos personalData: #/definitions/preAdmissionPersonalBRAData document: #/definitions/preAdmissionDocumentBRAData contract: #/definitions/preAdmissionContractBraData preAdmissionPersonalBRAData: type: object properties: basic: #/definitions/personalBasicData complementary: #/definitions/personalComplementaryData birthPlace: #/definitions/personalBirthPlaceData address: #/definitions/personalAddressBRAData telephone: #/definitions/personalTelephoneData email: #/definitions/personalEmailData personalBasicData: type: object properties: id: type: string description: Identificador único do registro. employeeFullName: type: string description: Nome completo do novo colaborador. preferredName: type: string description: Nome pelo qual o novo colaborador prefere ser chamado. badgeFileId: type: string description: Endereço onde a imagem do crachá está salva. badgeFileVersion: type: string description: Versão para realizar o commit do arquivo badgeFileIdPermanentUrl: type: string description: Caminho permanente do arquivo da imagem do crachá. gender: #/definitions/enumInformationItemData birthDate: type: string description: Data e nascimento do novo colaborador. format: date mothersName: type: string description: Nome da mãe do novo colaborador. fathersName: type: string description: Nome do pai do novo colaborador. validation: #/definitions/validationData customFieldsPersonalBasic: type: array items: #/definitions/customData description: Campos customizados. personalComplementaryData: type: object properties: id: type: string description: Identificador da tabela maritalStatus: #/definitions/enumInformationItemData degreeOfEducation: #/definitions/degreeOfEducation degreeOfEducationFileId: type: string description: Comprovante do grau de instrução degreeOfEducationFileVersion: type: string description: Versão para realizar o commit do anexo de grau de instrução degreeOfEducationFileIdPermanentUrl: type: string description: Caminho permanente do arquivo do arquivo que comprova o grau de instrução. nationality: #/definitions/nationality religion: #/definitions/religion race: #/definitions/enumInformationItemData socialName: type: string description: Nome social. validation: #/definitions/validationData customFieldsPersonalComplementary: type: array items: #/definitions/customData description: Campos customizados. degreeOfEducation: type: object properties: id: type: string description: format: uuid code: type: integer description: Código do grau de instrução. name: type: string description: Nome do grau de instrução. type: #/definitions/enumDegreeOfEducation createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time nationality: type: object properties: id: type: string description: format: uuid code: type: integer description: Código da nacionalidade name: type: string description: Nome da nacionalidade type: #/definitions/enumNationalityType createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time religion: type: object required: – code – name properties: id: type: string description: format: uuid code: type: integer description: Código da religião. name: type: string description: Descrição da religião. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time personalBirthPlaceData: type: object properties: id: type: string description: Identificador único do registro. country: #/definitions/country state: #/definitions/state city: #/definitions/city validation: #/definitions/validationData customFieldsPersonalBirthPlace: type: array items: #/definitions/customData description: Campos customizados. country: type: object properties: id: type: string description: format: uuid name: type: string description: Nome do país. abbreviation: type: string description: Abreviação do nome do país. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time state: type: object properties: id: type: string description: format: uuid name: type: string description: Nome do estado. abbreviation: type: string description: Abreviação do nome do estado. country: type: string description: format: uuid createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time city: type: object required: – name properties: id: type: string description: format: uuid name: type: string description: Nome da cidade. state: type: string description: format: uuid createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time personalAddressBRAData: type: object properties: id: type: string description: Identificador único do registro. country: #/definitions/country state: #/definitions/state city: #/definitions/city cep: type: string description: CEP do endereço. neighborhood: type: string description: Bairro. addressType: #/definitions/enumInformationItemData address: type: string description: Endereço. number: type: string description: Número do endereço. firstFileId: type: string description: Primeira imagem. firstFileVersion: type: string description: Versão para realizar o commit do primeiro arquivo firstFilePermanentUrl: type: string description: Url de acesso a primeira imagem additional: type: string description: Informação adicional referente ao endereço. validation: #/definitions/validationData customFieldsPersonalAddressBRA: type: array items: #/definitions/customData description: Campos customizados. personalTelephoneData: type: object properties: id: type: string description: Identificador único do registro. firstPhone: type: string description: Número do telefone principal. firstType: #/definitions/enumInformationItemData secondPhone: type: string description: Número do telefone secundário. secondType: #/definitions/enumInformationItemData validation: #/definitions/validationData customFieldsPersonalTelephone: type: array items: #/definitions/customData description: Campos customizados. personalEmailData: type: object properties: id: type: string description: Identificador único do registro. firstEmail: type: string description: Email principal do novo colaborador. firstType: #/definitions/enumInformationItemData secondEmail: type: string description: Email secundário do novo colaborador. secondType: #/definitions/enumInformationItemData validation: #/definitions/validationData customFieldsPersonalEmail: type: array items: #/definitions/customData description: Campos customizados. preAdmissionDocumentBRAData: type: object properties: ctps: #/definitions/ctpsData cpf: #/definitions/cpfData pis: #/definitions/pisData rg: #/definitions/rgData voter: #/definitions/voterData cnh: #/definitions/cnhData reservist: #/definitions/reservistData dnv: #/definitions/dnvData cns: #/definitions/cnsData civilCertificate: #/definitions/civilCertificateData passport: #/definitions/passportData ric: #/definitions/ricData hiringMedicalExam: #/definitions/hiringMedicalExamData bankAccount: #/definitions/bankAccountData receiveSalaryAdvance: #/definitions/enumInformationItemData professionalRecord: #/definitions/professionalRecordData ctpsData: type: object properties: id: type: string description: Identificador único da CTPS. number: type: string description: Número. serie: type: string description: Série. digit: type: string description: Dígito. issuerState: #/definitions/state issueDate: type: string description: Data de emissão. format: date firstFileId: type: string description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileId: type: string description: Segunda imagem. secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: #/definitions/validationData customFieldsCtps: type: array items: #/definitions/customData description: Campos customizados. cpfData: type: object properties: id: type: string description: Identificador único do CPF. number: type: string description: Número. firstFileId: type: string description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: #/definitions/validationData customFieldsCpf: type: array items: #/definitions/customData description: Campos customizados. pisData: type: object properties: id: type: string description: Identificador único do PIS. number: type: string description: Número. issueDate: type: string description: Data de emissão. format: date firstFileId: type: string description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: #/definitions/validationData customFieldsPis: type: array items: #/definitions/customData description: Campos customizados. rgData: type: object properties: id: type: string description: Identificador único do RG. number: type: string description: Número. issuer: type: string description: Órgão emissor. issuerState: #/definitions/state issueDate: type: string description: Data de emissão. format: date firstFileId: type: string description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileId: type: string description: Segunda imagem. secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: #/definitions/validationData customFieldsRg: type: array items: #/definitions/customData description: Campos customizados. voterData: type: object properties: id: type: string description: Identificador único do Título de eleitor. number: type: string description: Número. votingDistrict: type: string description: Zona. votingSection: type: string description: Seção. issuerCity: #/definitions/city issuerState: #/definitions/state issueDate: type: string description: Data de emissão. format: date firstFileId: type: string description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileId: type: string description: Segunda imagem. secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: #/definitions/validationData customFieldsVoter: type: array items: #/definitions/customData description: Campos customizados. cnhData: type: object properties: id: type: string description: Identificador único da CNH. number: type: string description: Número. category: #/definitions/enumInformationItemData issuer: type: string description: Órgão emissor. issuerState: #/definitions/state issueDate: type: string description: Data de emissão. format: date expiryDate: type: string description: Data de validade do CNH. format: date firstDriverLicenceDate: type: string description: Data da primeira habilitação. format: date firstFileId: type: string description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: #/definitions/validationData customFieldsCnh: type: array items: #/definitions/customData description: Campos customizados. reservistData: type: object properties: id: type: string description: Identificador único do certificado de reservista. number: type: string description: Número. serie: type: string description: Série. ra: type: string description: RA. exemptionDate: type: string description: Data de dispensa. format: date doesntHave: type: boolean description: Se a pessoa não possui certificado de reservista firstFileId: type: string description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileId: type: string description: Segunda imagem. secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: #/definitions/validationData customFieldsReservist: type: array items: #/definitions/customData description: Campos customizados. dnvData: type: object properties: id: type: string description: Identificador único do registro. number: type: string description: Número. firstFileId: type: string description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: #/definitions/validationData customFieldsDnv: type: array items: #/definitions/customData description: Campos customizados. cnsData: type: object properties: id: type: string description: Identificador único da CNS. number: type: string description: Número. firstFileId: type: string description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: #/definitions/validationData customFieldsCns: type: array items: #/definitions/customData description: Campos customizados. civilCertificateData: type: object properties: id: type: string description: Identificador único do certificado civil. type: #/definitions/enumInformationItemData issueDate: type: string description: Data de emissão. format: date registry: type: string description: Matrícula. term: type: string description: Termo. book: type: string description: Livro. sheet: type: string description: Folha. notaryOffice: type: string description: Cartório. issuerCity: #/definitions/city issuerState: #/definitions/state firstFileId: type: string description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileId: type: string description: Segunda imagem. secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: #/definitions/validationData customFieldsCivilCertificate: type: array items: #/definitions/customData description: Campos customizados. passportData: type: object properties: id: type: string description: Identificador único do passaporte. number: type: string description: Número. issuer: type: string description: Emissor. issueDate: type: string description: Data de emissão. format: date expiryDate: type: string description: Data de validade. format: date issuerCountry: #/definitions/country issuerState: #/definitions/state firstFileId: type: string description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: #/definitions/validationData customFieldsPassport: type: array items: #/definitions/customData description: Campos customizados. ricData: type: object properties: id: type: string description: Identificador único do RIC. number: type: string description: Número. issuer: type: string description: Órgão emissor. issuerCity: #/definitions/city issuerState: #/definitions/state issueDate: type: string description: Data de emissão. format: date expiryDate: type: string description: Data de validade. format: date firstFileId: type: string description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileId: type: string description: Segunda imagem. secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: #/definitions/validationData customFieldsRic: type: array items: #/definitions/customData description: Campos customizados. hiringMedicalExamData: type: object properties: id: type: string description: Identificador único do exame admissional. fileId: type: string description: Arquivo do exame. fileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. filePermanentUrl: type: string description: URL de acesso ao arquivo. validation: #/definitions/validationData customFieldsHiringMedicalExam: type: array items: #/definitions/customData description: Campos customizados. examDate: type: string description: Data do exame. format: date bankAccountData: type: object properties: id: type: string description: Identificador da conta bancária. bank: #/definitions/bank branch: type: integer description: Número da agência. accountType: #/definitions/enumInformationItemData firstFileId: type: string description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileId: type: string description: Segunda imagem. secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao segundo arquivo. bankAccount: type: string description: Conta bancária. digit: type: string description: Digito da conta. validation: #/definitions/validationData customFieldsBankAccount: type: array items: #/definitions/customData description: Campos customizados. bank: type: object required: – code – name properties: id: type: string description: format: uuid code: type: integer description: Número do banco. name: type: string description: Descrição. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time professionalRecordData: type: object properties: id: type: string description: Identificador único do registro profissional. professionalAdvice: #/definitions/professionalAdvice number: type: string description: Número de registro no conselho profissional isTemporary: #/definitions/enumInformationItemData mteNumber: type: string description: Órgão emissor. shippingDate: type: string description: Data de expedição do registro format: date dueDate: type: string description: Data de vencimento do registro. format: date doesntHave: type: boolean description: Se a pessoa não possui registro profissional firstFileId: type: string description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileId: type: string description: Segunda imagem. secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: #/definitions/validationData customFieldsProfessionalRecord: type: array items: #/definitions/customData description: Campos customizados. professionalAdvice: type: object required: – name properties: id: type: string description: format: uuid name: type: string description: Nome do conselho profissional abbreviation: type: string description: Sigla do conselho profissional enabled: #/definitions/situation code: type: string description: Código externo. createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time preAdmissionContractBraData: type: object properties: id: type: string description: Identificador único do registro. employeeContractType: #/definitions/enumInformationItemData eSocialCategory: #/definitions/enumInformationItemData unemploymentInsuranceType: #/definitions/enumInformationItemData sefipCategoryType: #/definitions/enumInformationItemData employeeType: #/definitions/enumInformationItemData raisType: #/definitions/enumInformationItemData company: #/definitions/company branchOffice: #/definitions/branchOffice jobPosition: #/definitions/jobPosition customFields: type: array items: #/definitions/customData description: Campos customizados. customFieldsInviteModelContract: type: array items: #/definitions/customData description: Campos customizados. preAdmission: #/definitions/preAdmission inviteInfoData: type: object required: – preAdmission – inviteInfoLayout properties: preAdmission: #/definitions/preAdmission inviteInfoLayout: #/definitions/inviteInfoLayoutData inviteInfoLayoutData: type: object properties: companyLogoUrl: type: string description: Logo Marca circularCompanyLogoUrl: type: string description: Logo circular baseColor: type: string description: Cor base do convite employeePreAdmissionSaveData: type: object required: – conclusionPercentage – status – requestStatus properties: conclusionPercentage: type: integer description: Percentual de conclusão da pré-admissão. conclusionDocumentPercentage: type: integer description: Percentual de conclusão dos documentos da pré-admissão. conclusionPersonalDataPercentage: type: integer description: Percentual de conclusão dos dados pessoais da pré-admissão. conclusionDependentDataPercentage: type: integer description: Percentual de conclusão dos dependentes da pré-admissão. conclusionSocialQualificationPercentage: type: integer description: Percentual de conclusão do e-social da pré-admissão. status: #/definitions/enumInformationItemData requestStatus: type: boolean description: Status da ação de salvar. preAdmissionListData: type: object required: – key – employeeName – sendDate – admissionDate – status – deadlineDate – inviteESocialStatus – hasDependent – canceled properties: id: type: string description: Identificador do campo. modelId: #/definitions/inviteModel key: type: string description: Chave de identificação única da pré-admissão. employeeName: type: string description: Nome do novo colaborador employeeEmail: type: string description: Email do novo colaborador employeeMobilePhone: type: string description: Número de telefone celular do novo colaborador sendDate: type: string description: Data de envio do convite format: date conclusionPercentage: type: integer description: Percentual de conclusão do preenchimento do convite conclusionDocumentPercentage: type: integer description: Percentual de conclusão do preenchimento dos campos de documentos conclusionPersonalDataPercentage: type: integer description: Percentual de conclusão do preenchimento dos campos de dados pessoais conclusionDependentDataPercentage: type: integer description: Percentual de conclusão dos dependentes da pré-admissão. conclusionSocialQualificationPercentage: type: integer description: Percentual de conclusão do preenchimento do eSocial admissionDate: type: string description: Data prevista de admissão do novo colaborador format: date status: #/definitions/invitationStatus deadlineDate: type: string description: Data de expiração do convite format: date inviteESocialStatus: #/definitions/eSocialStatus unreadMessages: type: integer description: Quantidade de mensagens não lidas preAdmissionImagePermanentUrl: type: string description: URL para a imagem do crachá da pré-admissão hasDependent: type: boolean description: Identifica se existem dependentes. canceled: type: boolean description: dependentData: type: object required: – id – preAdmissionId properties: id: type: string description: Identificador único do dependente. preAdmissionId: type: string description: Identificador único da pré-admissão. inviteFields: type: array items: #/definitions/inviteModelFieldData description: Campos do modelo de convite. basic: #/definitions/dependentBasicData document: #/definitions/dependentDocumentData validation: #/definitions/validationData dependentBasicData: type: object properties: id: type: string description: Identificador único dos dados básicos. fullName: type: string description: Nome completo. degreeOfKinship: #/definitions/enumInformationItemData gender: #/definitions/enumInformationItemData birthDate: type: string description: Nascimento do dependente format: date declareIncomeTax: #/definitions/enumInformationItemData mothersName: type: string description: Nome da mãe maritalStatus: #/definitions/enumInformationItemData customFieldsDependentBasic: type: array items: #/definitions/customData description: Campos customizados. dependentDocumentData: type: object properties: id: type: string description: Identificador único do documento. cpf: #/definitions/cpfData rg: #/definitions/rgData ric: #/definitions/ricData sus: #/definitions/susData vaccinationBooklet: #/definitions/vaccinationBookletData proofOfEnrollment: #/definitions/proofOfEnrollmentData deathCertificate: #/definitions/civilCertificateData birthCertificate: #/definitions/civilCertificateData susData: type: object properties: id: type: string description: Identificador único do cartão do SUS. number: type: string description: Número. firstFileId: type: string description: Primeiro arquivo. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. customFieldsSus: type: array items: #/definitions/customData description: Campos customizados. vaccinationBookletData: type: object properties: id: type: string description: Identificador único do registro firstFileId: type: string description: Primeiro arquivo. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileId: type: string description: Segundo arquivo secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao segundo arquivo. thirdFileId: type: string description: Terceiro arquivo thirdFileVersion: type: string description: Identificador para efetuar o commit do terceiro arquivo. thirdFilePermanentUrl: type: string description: URL de acesso ao terceiro arquivo. customFieldsVaccinationBooklet: type: array items: #/definitions/customData description: Campos customizados. proofOfEnrollmentData: type: object properties: id: type: string description: Identificador único do comprovante de matrícula. firstFileId: type: string description: Primeiro arquivo. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. customFieldsProofOfEnrollment: type: array items: #/definitions/customData description: Campos customizados. preAdmissionDependentListData: type: object properties: totalElements: type: integer description: Total de registros encontrados. totalPages: type: integer description: Total de páginas encontradas. contents: type: array items: #/definitions/preAdmissionDependentData description: Lista dos dependentes da pré-admissão preAdmissionDependentData: type: object properties: id: type: string description: Id do dependente fullName: type: string description: Nome completo do dependente degreeOfKinship: #/definitions/enumInformationItemData conclusionPercentage: type: integer description: Percentual de conclusão. validation: type: boolean description: Validação do dependente globalSettingsData: type: object required: – isIntegratedWithPayroll – companyName – isIntegratedWithAP properties: isIntegratedWithPayroll: type: boolean description: Indica se o módulo está integrado com o módulo de folha. companyName: type: string description: Nome da empresa isIntegratedWithAP: type: boolean description: Indica se módulo está integrado com o módulo Administração de pessoal (G5). purchaseInfoData: type: object required: – isBlocked – isTrial properties: isBlocked: type: boolean description: Indica se algumas funções devem ser bloqueadas. isTrial: type: boolean description: Indica se está em período de trial. trialEndDayDiff: type: integer description: Dias de distância do fim do período de trial. canExtend: type: boolean description: Indica se o período de trial poderá ser prorrogado. preAdmissionMessageData: type: object required: – employee – company – messages properties: employee: #/definitions/messageProfile company: #/definitions/messageProfile messages: type: array items: #/definitions/sentMessage description: Mensagens enviadas messageProfile: type: object required: – name – messageSender properties: name: type: string description: Nome de quem enviou a mensagem photoUrl: type: string description: foto do perfil do usuario messageSender: #/definitions/messageSender sentMessage: type: object required: – dateSent – message – isNew – messageSender properties: dateSent: type: string description: Data de envio da mensagem format: date-time message: type: string description: Mensagem enviada isNew: type: boolean description: Se a mensagem é nova messageSender: #/definitions/messageSender digitalTrialData: type: object required: – firstName – lastName – businessEmail – companyName – companyPhone – employeeQuantity – businessSegment – averageAdmissions properties: firstName: type: string description: Primeiro nome da pessoa de contato. lastName: type: string description: Sobrenome da pessoa de contato. businessEmail: type: string description: Endereço de e-mail profissional. password: type: string description: Senha de acesso. companyName: type: string description: Nome da empresa solicitando o trial. companyPhone: type: string description: Número de telefone da empresa para contato. cnpj: type: string description: CNPJ da empresa solicitando o trial. employeeQuantity: #/definitions/enumEmployeeQuantity businessSegment: #/definitions/enumBusinessSegment averageAdmissions: #/definitions/enumAverageAdmissions preAdmissionMonthData: type: object required: – name – y – date properties: name: type: string description: Label para exibição y: type: integer description: Quantidade para usar no highCharts date: type: string description: Data final do mês em vigor format: date preAdmissionAnalyticsSituationData: type: object required: – name – y – type properties: name: type: string description: Label para exibição y: type: integer description: Quantidade para usar no highCharts type: #/definitions/invitationStatus captchaData: type: object required: – urlCaptcha – challengeField properties: urlCaptcha: type: string description: Url da imagem do captcha challengeField: type: string description: Hash do desafio socialQualificationData: type: object required: – status – message – orientation – isGovernmentMessage properties: status: type: boolean description: Se a qualificação social é valida message: type: string description: Mensagem de retorno do governo orientation: type: string description: Orientação para corrigir a requisição isGovernmentMessage: type: boolean description: Se o retorno é do governo ou não contractFilterData: type: object properties: company: type: string description: ID Empresa. branchOffice: type: string description: ID Filial. jobPosition: type: string description: ID Cargo rKeyValueData: type: object required: – key – value properties: key: type: string description: Chave value: type: string description: Valor messageFromSmartphoneData: type: object required: – mobilePhone – text – employeeName properties: mobilePhone: type: string description: Número de celular text: type: string description: Texto sem tag HTML employeeName: type: string description: Nome do colaborador paramsForTracksaleData: type: object required: – fullName – email – id – tenantName – clientCode – isTrial properties: fullName: type: string description: Nome completo email: type: string description: E-mail id: type: string description: ID tenantName: type: string description: Nome do tenant clientCode: type: string description: Código do cliente isTrial: type: boolean description: Indica se o tenant está em período de trial entityIdDef: type: object required: – domain_ – service_ – id properties: domain_: type: string description: Domínio da entidade. service_: type: string description: Serviço da entidade. id: type: string description: identificador da entidade. entityDef: type: object required: – id – fields – active properties: id: type: string description: Id. fields: type: array items: #/definitions/fieldDef description: Campos. active: type: boolean description: Indica se está ativo ou não. fieldDef: type: object required: – id – type properties: id: type: string description: Id. type: #/definitions/fieldTypeDef key: type: boolean description: Indica se o campo é chave. customizable: type: boolean description: Indica se o campo é customizável. customization: #/definitions/fieldCustomizationDef fieldCustomizationDef: type: object required: – label – order – active – mandatory properties: change: #/definitions/changeInfoDef label: type: string description: Rótulo do campo. order: type: integer description: Ordem do campo. active: type: boolean description: Campo ativo. validationRegex: type: string description: Expressão regular de validação. tooltip: type: string description: Dica. mask: type: string description: Máscara. labelTranslationKey: type: string description: Chave de tradução do label.<br/><b>Read only.</b>. tooltipTranslationKey: type: string description: Chave de transição do tooltip.<br/><b>Read only.</b>. resourceURI: type: string description: Resource de permissão.<br/><b>Read only.</b>. customEnumeration: #/definitions/customEnumerationDef mandatory: type: boolean description: Verificador de campo obrigatório changeInfoDef: type: object required: – user – time_ properties: user: type: string description: Usuário que criou ou efetuou a última alteração no objeto. time_: type: string description: Hora que o objeto foi criado ou alterado pela última vez. format: date-time customEnumerationDef: type: object required: – values properties: multiple: type: boolean description: Campo é multi valores values: type: array items: #/definitions/customEnumerationValue description: Possíveis valores para o enumeration customEnumerationValue: type: object required: – key – value properties: key: type: string description: Chave value: type: string description: Valor entityDefList: type: object required: – id – entity_ properties: id: type: string description: Id da entidade entity_: #/definitions/entityDef autocompleteFilter: type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Valor armazenado no filtro commitObjectDef: type: object required: – objectId – fileName – version properties: objectId: type: string description: Id de identificação do objeto fileName: type: string description: Nome do arquivo type: string description: Versão deleteObjectDef: type: object required: – field – objectId properties: field: type: string description: Nome do campo objectId: type: string description: Id de identificação do objeto seguindo o padrão – objectId/fileName contractModelData: type: object required: – id – contractModelName – contract – checked properties: id: type: string description: Identificador do modelo de contrato. contractModelName: type: string description: Nome do modelo de contrato. contract: type: string description: Texto base do contrato. enabled: #/definitions/situation checked: type: boolean description: Contrato padrão contractData: type: object required: – contractModelName – contractFileName – contract properties: contractModelName: type: string description: Nome do modelo de contrato. contractFileName: type: string description: Nome do documento do contrato contract: type: string description: Texto base do contrato. gedDocumentId: type: string description: ID de referencia do documento no GED gedDocumentURI: type: string description: URI do documento no GED gedDocumentVersionId: type: string description: ID de referencia da versão do documento no GED status: #/definitions/enumDocumentStatus resultPurchaseExternal: type: object required: – resultMessage – purchaseHistory – externalModules properties: resultMessage: type: string description: Mensagem de resulado purchaseHistory: type: array items: #/definitions/purchaseHistory description: Entidade purchaseHistory externalModules: type: array items: #/definitions/externalModules description: Entidade externalModules purchaseHistory: type: object required: – purchaseAction – purchaseDate – clientCode – clientName – billingDate – preAdmissionAmount properties: id: type: string description: format: uuid purchaseAction: #/definitions/enumPurchaseActions purchaseDate: type: string description: Data do teste/compra. format: date-time reason: type: string description: Motivo da alteração do teste/compra. clientCode: type: integer description: Código do cliente do ERP. clientName: type: string description: Nome do cliente no ERP billingDate: type: string description: Data de início do faturamento format: date-time preAdmissionAmount: type: integer description: Quantidade de admissões createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time externalModules: type: object required: – enumExternalModules properties: id: type: string description: format: uuid enumExternalModules: #/definitions/enumExternalModules createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time countryField: type: object required: – country – type – subType – category – description – valueOrder – valueType properties: id: type: string description: format: uuid country: #/definitions/inviteModelCountry type: #/definitions/inviteFieldType subType: #/definitions/inviteFieldSubType category: #/definitions/categoryField description: type: string description: Descrição do campo. valueOrder: type: integer description: Ordem de apresentação do campo na tela. valueType: #/definitions/valueType canReceiveAttachment: type: boolean description: Indicativo se o campo aceita anexos ou não. acceptsGuidance: type: boolean description: Indicativo se o campo aceita orientação. dependsOn: #/definitions/valueType createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time signer: type: object required: – signerName – signerEmail – signerPhone – signerInstructions properties: id: type: string description: format: uuid signerName: type: string description: Nome do assinante. signerEmail: type: string description: Texto base do contrato. signerPhone: type: string description: Telefone do assinante signerInstructions: type: string description: Instruções para o assinante contract: #/definitions/contract preAdmission: #/definitions/preAdmission envelope: #/definitions/envelope createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time addressBra: type: object properties: id: type: string description: format: uuid city: type: string description: format: uuid cep: type: string description: Cep do logradouro neighborhood: type: string description: Bairro do logradouro name: type: string description: Descrição do logradouro additional: type: string description: Complemento do logradouro createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time employeeToken: type: object required: – token – tokenCreatedDate – attempts properties: id: type: string description: format: uuid token: type: string description: Token tokenCreatedDate: type: string description: Data Criação Token format: date-time attempts: type: integer description: Validade do Token expired: type: boolean description: Verificador se está expirado preAdmission: type: string description: format: uuid createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time notifyUserEventPayload: type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: #/definitions/userNotificationKind notificationPriority: #/definitions/userNotificationPriority notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE