HCM – Careers Manager Candidate (careersmanagercandidate)

2.0info: 8.3.1 HCM – Careers Manager Candidate description: HCM – Careers Manager Candidate x-senior-domain: HCM x-senior-domain-path: hcm x-senior-service-path: careersmanagercandidate contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /careersmanagercandidate/queries/healthcheck: post: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/myProfile: post: description: Aggregates the necessary info and returns the users profile tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – profile properties: profile: type: object allOf: – #/definitions/myProfileDTO description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Aggregates the necessary info and returns the users profile tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – profile properties: profile: type: object allOf: – #/definitions/myProfileDTO description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/getMyPicture: post: description: Obtém os metadados da foto de perfil do candidato tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – data properties: data: type: object allOf: – #/definitions/fileDataDTO description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os metadados da foto de perfil do candidato tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – data properties: data: type: object allOf: – #/definitions/fileDataDTO description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/getTranslationBundle: post: description: Obtém os metadados de tradução do translation hub tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/translationFileDTO minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: Obtém os metadados de tradução do translation hub tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/translationFileDTO minimum: 1 description: default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/listResumeGroups: post: description: Busca os grupos relacionados ao curriculo principal do user e pais do mesmo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – groups properties: groups: type: array items: type: object allOf: – #/definitions/resumeGroupDTO minimum: 1 description: O grupos relacionados ao curriculo hasData: type: boolean description: Indicador que representará se o candidato possui informações persistidas no seu resume default: false 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os grupos relacionados ao curriculo principal do user e pais do mesmo tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – groups properties: groups: type: array items: type: object allOf: – #/definitions/resumeGroupDTO minimum: 1 description: O grupos relacionados ao curriculo hasData: type: boolean description: Indicador que representará se o candidato possui informações persistidas no seu resume default: false 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/checkDocument: post: description: Verificar se o documento já existe cadastrado para outro usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentType – documentNumber properties: documentType: type: string description: Nome do documento único documentNumber: type: string description: Número do documento único responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verificar se o documento já existe cadastrado para outro usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: documentType description: Nome do documento único in: query required: true type: string – name: documentNumber description: Número do documento único in: query required: true type: string responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/getListFieldsByGroupResume: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – groupInformationFormId properties: groupInformationFormId: type: string description: Identificador do agrupador de dados responses: 200: description: Ok schema: type: object required: – groupData properties: groupData: type: object allOf: – #/definitions/dataGroupingDTO description: Grupo de campos do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: groupInformationFormId description: Identificador do agrupador de dados in: query required: true type: string responses: 200: description: Ok schema: type: object required: – groupData properties: groupData: type: object allOf: – #/definitions/dataGroupingDTO description: Grupo de campos do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/listFieldsEnabledByCompany: post: description: Retorna a lista de campos habilitados pela companhia para preenchimento na candidatura tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – groupId – vacancyId properties: groupId: type: string description: Identificador do agrupador de dados vacancyId: type: string description: Identificador da vaga responses: 200: description: Ok schema: type: object required: – groupData properties: groupData: type: object allOf: – #/definitions/dataGroupingDTO description: Grupo de campos do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de campos habilitados pela companhia para preenchimento na candidatura tags: – Queries x-senior-visibility: PRIVATE parameters: – name: groupId description: Identificador do agrupador de dados in: query required: true type: string – name: vacancyId description: Identificador da vaga in: query required: true type: string responses: 200: description: Ok schema: type: object required: – groupData properties: groupData: type: object allOf: – #/definitions/dataGroupingDTO description: Grupo de campos do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/getContactConfirmedByDocument: post: description: Retorna os meios de contato(E-mail e Telefone) confirmados através do país, tipo e número de documento cadastrado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentType – documentNumber properties: countryAbbreviation: type: string description: País de origem default: BR documentType: type: string description: Tipo de documento documentNumber: type: string description: Numero do documento responses: 200: description: Ok schema: type: object required: – data properties: data: type: object allOf: – #/definitions/confirmedContactByUserDTO description: default: description: Error response schema: #/definitions/genericError get: description: Retorna os meios de contato(E-mail e Telefone) confirmados através do país, tipo e número de documento cadastrado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: countryAbbreviation description: País de origem in: query type: string – name: documentType description: Tipo de documento in: query required: true type: string – name: documentNumber description: Numero do documento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – data properties: data: type: object allOf: – #/definitions/confirmedContactByUserDTO description: default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/enableCountries: post: description: Listar todos os países homologados tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – countries properties: countries: type: array items: type: object allOf: – #/definitions/countryDTO minimum: 1 description: Lista de países homologados com as suas informações cadastradas default: description: Error response schema: #/definitions/genericError get: description: Listar todos os países homologados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – countries properties: countries: type: array items: type: object allOf: – #/definitions/countryDTO minimum: 1 description: Lista de países homologados com as suas informações cadastradas default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/passwordPolicy: post: description: Exibe a política de senha requerida pela plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – policy properties: policy: type: object allOf: – #/definitions/passwordPolicyDTO description: default: description: Error response schema: #/definitions/genericError get: description: Exibe a política de senha requerida pela plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – policy properties: policy: type: object allOf: – #/definitions/passwordPolicyDTO description: default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/termOfUseAndPrivacy: post: description: Busca o termo de uso e privacidade cadastrado na base tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object allOf: – #/definitions/termOfUseAndPrivacyDTO default: description: Error response schema: #/definitions/genericError get: description: Busca o termo de uso e privacidade cadastrado na base tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object allOf: – #/definitions/termOfUseAndPrivacyDTO default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/getHomePageStructure: post: description: Primitiva para obter a estrutura principal da home com dados para os carousels tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – vacancies – companies properties: vacancies: type: array items: type: object allOf: – #/definitions/homeHighlightedVacancyDTO minimum: 1 description: companies: type: array items: type: object allOf: – #/definitions/partnerCompanyDTO minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: Primitiva para obter a estrutura principal da home com dados para os carousels tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – vacancies – companies properties: vacancies: type: array items: type: object allOf: – #/definitions/homeHighlightedVacancyDTO minimum: 1 description: companies: type: array items: type: object allOf: – #/definitions/partnerCompanyDTO minimum: 1 description: default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/getTermsOfUseAndPrivacy: post: description: Realiza a obtenção dos termos de uso e privacidade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – code properties: code: type: string description: Identificador da vaga responses: 200: description: Ok schema: type: object allOf: – #/definitions/termOfUseAndPrivacyDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Realiza a obtenção dos termos de uso e privacidade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: code description: Identificador da vaga in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/termOfUseAndPrivacyDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/getMyCandidature: post: description: Realiza a obtenção dos dados da candidatura do candidato a partir do código da vaga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – code properties: code: type: string description: Identificador da vaga responses: 200: description: Ok schema: type: object required: – candidature properties: candidature: type: object allOf: – #/definitions/decodedCandidatureDTO description: Dados da candidatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Realiza a obtenção dos dados da candidatura do candidato a partir do código da vaga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: code description: Identificador da vaga in: query required: true type: string responses: 200: description: Ok schema: type: object required: – candidature properties: candidature: type: object allOf: – #/definitions/decodedCandidatureDTO description: Dados da candidatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/getQuestionnaire: post: description: Busca o questionário associado a vaga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – code properties: code: type: string description: Identificador da vaga responses: 200: description: Ok schema: type: object required: – questionnaire properties: questionnaire: type: object allOf: – #/definitions/questionnaireDTO description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca o questionário associado a vaga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: code description: Identificador da vaga in: query required: true type: string responses: 200: description: Ok schema: type: object required: – questionnaire properties: questionnaire: type: object allOf: – #/definitions/questionnaireDTO description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/searchVacancies: post: description: Retorna informações das vagas e empresa anunciante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – match properties: page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Quantidade de registros por página. default: 10 filter: type: string description: Termo de pesquisa match: type: object allOf: – #/definitions/searchVacancyMatchDTO description: responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas. totalElements: type: integer format: int64 description: Total de elementos encontrados. contents: type: array items: type: object allOf: – #/definitions/searchSummaryDTO minimum: 1 description: Lista de vagas. default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/fetchCities: post: description: Retorna informações das vagas e empresa anunciante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – match properties: page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Quantidade de registros por página. maximum: 100 default: 10 filter: type: string description: Termo de pesquisa match: type: object allOf: – #/definitions/searchVacancyMatchDTO description: responses: 200: description: Ok schema: type: object required: – cities properties: cities: type: array items: type: string minimum: 1 description: Lista de cidades. default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/findVacancyById: post: description: Retorna a vaga pelo identificador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador da vaga responses: 200: description: Ok schema: type: object required: – vacancy – company properties: vacancy: type: object allOf: – #/definitions/vacancyDTO description: Dados da vaga company: type: object allOf: – #/definitions/searchSummaryCompanyDTO description: Dados da empresa default: description: Error response schema: #/definitions/genericError get: description: Retorna a vaga pelo identificador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador da vaga in: query required: true type: string responses: 200: description: Ok schema: type: object required: – vacancy – company properties: vacancy: type: object allOf: – #/definitions/vacancyDTO description: Dados da vaga company: type: object allOf: – #/definitions/searchSummaryCompanyDTO description: Dados da empresa default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/listGroupsEnabledByCompany: post: description: Retorna os grupos requeridos pela empresa na candidatura tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacancyId properties: vacancyId: type: string description: Identificador da vaga responses: 200: description: Ok schema: type: object required: – groups properties: groups: type: array items: type: object allOf: – #/definitions/resumeGroupDTO minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os grupos requeridos pela empresa na candidatura tags: – Queries x-senior-visibility: PRIVATE parameters: – name: vacancyId description: Identificador da vaga in: query required: true type: string responses: 200: description: Ok schema: type: object required: – groups properties: groups: type: array items: type: object allOf: – #/definitions/resumeGroupDTO minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/getCompanyProfile: post: description: Retorna o cadastro de um Perfil pelo Tipo e Número do Doumento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: id do perfil responses: 200: description: Ok schema: type: object allOf: – #/definitions/companyProfileDTO default: description: Error response schema: #/definitions/genericError get: description: Retorna o cadastro de um Perfil pelo Tipo e Número do Doumento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: id do perfil in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/companyProfileDTO default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/getMyCandidatures: post: description: Busca lista de candidaturas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Número da página minimum: 0 default: 0 size: type: integer format: int64 description: Tamanho da página minimum: 1 maximum: 200 default: 10 responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Quantidade de páginas totalElements: type: integer format: int64 description: Quantidade de elementos contents: type: array items: type: object allOf: – #/definitions/candidatureListItemDTO minimum: 1 description: Dados da candidatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca lista de candidaturas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: page description: Número da página in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Quantidade de páginas totalElements: type: integer format: int64 description: Quantidade de elementos contents: type: array items: type: object allOf: – #/definitions/candidatureListItemDTO minimum: 1 description: Dados da candidatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/isEnableFeatureToggled: post: description: Query para conferir se uma feature toggled está ou não ativa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – featureName properties: featureName: type: string description: responses: 200: description: Ok schema: type: object required: – isEnable properties: isEnable: type: boolean description: default: description: Error response schema: #/definitions/genericError get: description: Query para conferir se uma feature toggled está ou não ativa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: featureName description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – isEnable properties: isEnable: type: boolean description: default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/canApplyToVacancy: post: description: Valida se um candidato pode ou não aplicar a uma vaga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacancyId properties: vacancyId: type: string description: Id da vaga a se candidatar responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Valida se um candidato pode ou não aplicar a uma vaga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: vacancyId description: Id da vaga a se candidatar in: query required: true type: string responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/searchCompanies: post: description: Primitiva para buscar empresas cadastradas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Quantidade de registros por página. maximum: 100 default: 10 filter: type: string description: Termo de pesquisa localizations: type: array items: type: object allOf: – #/definitions/searchLocalizationDTO description: Termos para o filtro de localização responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos encontrados contents: type: array items: type: object allOf: – #/definitions/basicCompanyInfoDTO minimum: 1 description: Lista de Empresas default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/getAccountExclusionJustificationOptions: post: description: Busca as opções de justificativa de exclusão de conta tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – options properties: options: type: array items: type: object allOf: – #/definitions/justificationExclusionDTO minimum: 1 description: Lista de opções de justificativas de exclusão de conta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as opções de justificativa de exclusão de conta tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – options properties: options: type: array items: type: object allOf: – #/definitions/justificationExclusionDTO minimum: 1 description: Lista de opções de justificativas de exclusão de conta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/verifyUser: post: description: Verifica se o telefone ou e-mail já possui cadastro na plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – login properties: login: type: string description: Identificador do cadastro responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Verifica se o telefone ou e-mail já possui cadastro na plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: – name: login description: Identificador do cadastro in: query required: true type: string responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/companiesThatUseMyData: post: description: Retorna uma lista contendo todas as empresas que consumiram os dados do candidato tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – companies properties: companies: type: array items: type: object allOf: – #/definitions/companyUseDataDTO minimum: 1 description: Lista de empresas que consumiram os dados do candidato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista contendo todas as empresas que consumiram os dados do candidato tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – companies properties: companies: type: array items: type: object allOf: – #/definitions/companyUseDataDTO minimum: 1 description: Lista de empresas que consumiram os dados do candidato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/getMyFavoriteVacancies: post: description: Busca lista de vagas favoritadas por um candidato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Número da página minimum: 0 default: 0 size: type: integer format: int64 description: Tamanho da página minimum: 1 maximum: 200 default: 10 responses: 200: description: Ok schema: type: object required: – contents – totalPages – totalElements properties: contents: type: array items: type: object allOf: – #/definitions/favoritedVacancyDTO minimum: 1 description: Dados das vagas favoritadas totalPages: type: integer format: int64 description: Quantidade de páginas totalElements: type: integer format: int64 description: Quantidade de elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca lista de vagas favoritadas por um candidato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: page description: Número da página in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – contents – totalPages – totalElements properties: contents: type: array items: type: object allOf: – #/definitions/favoritedVacancyDTO minimum: 1 description: Dados das vagas favoritadas totalPages: type: integer format: int64 description: Quantidade de páginas totalElements: type: integer format: int64 description: Quantidade de elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/parseResume: post: description: Primitiva para retornar os dados do currículo do candidato a partir de um PDF no formato do LinkedIn tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – provider – resume properties: provider: type: string description: Plataforma de onde virão os metadados do currículo resume: type: string description: Arquivo PDF em formato Base64 responses: 200: description: Ok schema: type: object required: – groupData properties: groupData: type: array items: type: object allOf: – #/definitions/configurationGroupByProviderDTO minimum: 1 description: Grupo de campos do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/updateProfile: post: description: Realiza a atualização dos dados de usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – profile properties: profile: type: object allOf: – #/definitions/updateProfileCandidateDTO description: responses: 200: description: Ok schema: type: object required: – profile properties: profile: type: object allOf: – #/definitions/updateProfileCandidateDTO description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/changePassword: post: description: Realizar a atualização de senha do usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: data: type: object allOf: – #/definitions/changePasswordDTO description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/updateMyPicture: post: description: Realizar upload da foto do perfil tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – photo properties: photo: type: string description: Foto do usuário, em Base64. (opcional) responses: 200: description: Ok schema: type: object required: – data properties: data: type: object allOf: – #/definitions/fileDataDTO description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/sign: post: description: Permite registrar um novo usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – user properties: user: type: object allOf: – #/definitions/registerUserDTO description: Informações para a criação de um novo usuário responses: 200: description: Ok schema: type: object required: – user properties: user: type: object allOf: – #/definitions/userCreatedDTO description: Informações referente ao novo usuário criado default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/login: post: description: Efetuar login tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – username – password properties: username: type: string description: Username: e-mail ou telefone do usuário password: type: string description: responses: 200: description: Ok schema: type: object required: – data properties: data: type: object allOf: – #/definitions/authTokenDTO description: default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/sendConfirmationEmailContact: post: description: Realiza envio de solicitação para confirmação do email de contato do candidato autenticado tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/sendConfirmationPhoneContact: post: description: Realiza envio de solicitação para confirmação do email de contato do candidato autenticado tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/sendConfirmationEmail: post: description: Realiza envio de solicitação para confirmação do email de contato do candidato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – identifier properties: identifier: type: string description: Identificador do usuário responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/sendConfirmationPhoneNumber: post: description: Realiza envio de solicitação para confirmação do email de contato do candidato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – identifier properties: identifier: type: string description: Identificador do usuário responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/confirmPhoneNumber: post: description: Confirmar numero de telefone do usuario tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – phoneNumber – pinCode properties: phoneNumber: type: string description: numero de telefone do usuario pinCode: type: integer format: int64 description: pincode para confirmação do telefone responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/confirmEmail: post: description: Confirmar email do usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – email – pinCode properties: email: type: string description: email pinCode: type: integer format: int64 description: pincode responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/confirmPassword: post: description: Confirmação de password de usuário autenticado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – username – password properties: username: type: string description: Username: e-mail ou telefone do usuário password: type: string description: responses: 200: description: Ok schema: type: object required: – data properties: data: type: object allOf: – #/definitions/authTokenDTO description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/uploadAttachment: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileName – attachment properties: fileName: type: string description: Nome do arquivo attachment: type: string description: Arquivo para anexar, em Base64. responses: 200: description: Ok schema: type: object required: – data properties: data: type: object allOf: – #/definitions/fileDataDTO description: DTO com os metadados do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/saveResume: post: description: Salva os dados de JSON do currículo do usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – information properties: id: type: string description: Caso deseje atualizar o currículo, inclua seu id name: type: string description: Nome do currículo information: type: string format: byte description: Dados do currículo(JSON) responses: 200: description: Ok schema: type: object allOf: – #/definitions/resumeDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/sendRecoveryPasswordByEmail: post: description: Realiza envio de solicitação para recuperação de conta por email do candidato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – identifier properties: identifier: type: string description: Identificador do usuário responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/sendRecoveryPasswordByPhoneNumber: post: description: Realiza envio de solicitação para recuperação de conta por telefone celular do candidato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – identifier properties: identifier: type: string description: Identificador do usuário responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/deleteAttachment: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: data: type: object allOf: – #/definitions/fileDataDTO description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/confirmRecoveryPassword: post: description: Realiza a validação do processo de recuperação de senha tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – identifier – pinCode properties: identifier: type: string description: Identificador do usuário pinCode: type: integer format: int64 description: Codigo de verificação responses: 200: description: Ok schema: type: object required: – token properties: token: type: string description: Token para realização do processo de recuperação de senha default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/resetPassword: post: description: Redefine a senha do usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – identifier – password – token properties: identifier: type: string description: Identificador do usuário password: type: string description: Nova senha do usuário token: type: string description: Token gerado pelo processo de confirmação da alteração de senha responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/createCandidature: post: description: Criação da candidatura tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/createCandidatureDTO responses: 200: description: Ok schema: type: object required: – candidature properties: candidature: type: object allOf: – #/definitions/createCandidatureResponse description: Dados da candidatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/acceptCookies: post: description: Salvar os termos de aceitação de cookies tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/registerCookieDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/acceptedCookieDTO default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/getProfileIdBySubdomain: post: description: Realiza o Id do Perfil da Companhia a partir do Nome do Domínio tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – subdomain properties: subdomain: type: string description: Nome do SubDomínio responses: 200: description: Ok schema: type: object required: – profileId properties: profileId: type: string description: Id do Perfil da Companhia default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/favoriteVacancy: post: description: Salva um registro de vaga-candidato favoritado no careers preferences backend tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacancyId properties: vacancyId: type: string description: Identificador da vaga responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/actions/unfavoriteVacancy: post: description: Exclui um registro de vaga-candidato favoritado no careers preferences backend tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacancyId properties: vacancyId: type: string description: Identificador da vaga responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/signals/clearCompanyCache: post: description: Realiza a limpeza de Cache das empresas parceiras tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /careersmanagercandidate/signals/clearVacancyCache: post: description: Realiza a limpeza de Cache das vagas destaque tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericErrordefinitions: healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN typeNameDTO: description: Tipo de nome utilizado pelo candidato type: string enum: – SOCIAL_NAME – CIVIL_NAME confirmContactModeEnum: description: Enum para formas de confirmação de contato do usuário type: string enum: – EMAIL – SMS typeField: description: Tipo de campo type: string enum: – TEXT – DATE – NUMBER – ATTACHMENT – LOCALE – LINK – LIST – BOOLEAN sendRecoveryPasswordModeEnum: description: Enum para formas de configuração de envio de recuperação de senha type: string enum: – TOKEN – PIN_CODE – NONE – ALL recordType: description: Tipo de registro type: string enum: – FLEX – MONO – MULTI searchType: description: Tipo de pesquisa type: string enum: – VACANCY – COMPANY questionnaireQuestionType: description: type: string enum: – CHECKBOX – RADIO – TEXT consentCategoryCookiesEnum: description: Categoria de cookies a serem aceites type: string enum: – REQUIRED – FUNCTIONAL – MARKETING userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT documentUniqueByCountryDTO: description: Armazena as definições de documentos únicos type: object required: – name – mask – justificationTranslations – validatorAlgorithms properties: name: type: string description: Nome do campo do documento mask: type: string description: Máscara do campo do documento justificationTranslations: type: array items: type: object allOf: – #/definitions/translationDTO minimum: 1 description: Lista que conterá as translations da justificativa do documento validatorAlgorithms: type: array items: type: object allOf: – #/definitions/validatorAlgorithmDTO minimum: 1 description: Lista que conterá os algoritmos responsáveis por fazer a validação do documento validatorAlgorithmDTO: description: Armazena as definições dos algoritmos de tradução do documento type: object required: – algorithm – errorMessageTranslations properties: algorithm: type: string description: Algoritmo utilizado para a validação do documento errorMessageTranslations: type: array items: type: object allOf: – #/definitions/translationDTO minimum: 1 description: Lista que conterá as translations das mensagens de erro passwordPolicyDTO: description: Armazena a definição da política de senha da plataforma. type: object required: – minSize – maxSize – numbers – lowerCases – upperCases – symbols – regex properties: minSize: type: integer format: int64 description: Tamanho mínimo para a senha maxSize: type: integer format: int64 description: Tamanho máximo para a senha numbers: type: boolean description: Deve conter números lowerCases: type: boolean description: Deve conter letras minusculas upperCases: type: boolean description: Deve conter letras maíusculas symbols: type: string description: Deve conter símbolos regex: type: string description: Expressão regular de validação checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status documentByCountryDTO: description: Armazena a identificação do(s) documento(s) habilitados para cadastro type: object required: – name – mask – justificationTranslations properties: name: type: string description: Nome mask: type: string description: Mascara de formatação do documento justificationTranslations: type: array items: type: object allOf: – #/definitions/translationDTO minimum: 1 description: Lista que conterá as traduções da justificativa de coleta do documento countryDTO: description: Retorna as informações sobre os países homologados type: object required: – id – name – abbreviation – ddi – currencyCode – phoneNumberMask – documents – preferredLanguage – translations properties: id: type: string description: Identificador do cadastro name: type: string description: Nome abbreviation: type: string description: Abreviação para identificação do país ddi: type: integer format: int64 description: Código de telefonia internacional currencyCode: type: string description: Moeda phoneNumberMask: type: string description: Máscara para o número telefônico documents: type: array items: type: object allOf: – #/definitions/documentUniqueByCountryDTO minimum: 1 description: Documentos únicos preferredLanguage: type: string description: Idioma principal translations: type: array items: type: object allOf: – #/definitions/translationDTO minimum: 1 description: Lista com todas as traduções para os idiomas confirmedContactByUserDTO: description: Meios de contato confirmado por usuário type: object required: – userId – email – phoneNumber properties: userId: type: string description: Identificador do usuário email: type: string description: E-mail confirmado phoneNumber: type: string description: Número de telefone confirmado dataGroupingDTO: description: type: object required: – name – fieldGroups properties: name: type: string description: Nome do grupo macro da tabela groupInformationForm fieldGroups: type: array items: type: object allOf: – #/definitions/groupedFieldsFormDTO minimum: 1 description: Grupo de campos groupedFieldsFormDTO: description: type: object required: – fieldGroupingName – tag – fieldsValidatorPolicies – fieldFormEnabler – note – fields properties: id: type: string description: identificador único do subgrupo fieldGroupingName: type: string description: Nome do agrupamento de campos no idioma pré-definido tag: type: string description: Identificador do registro fieldsValidatorPolicies: type: array items: type: object allOf: – #/definitions/fieldsValidatorPoliciesDTO minimum: 1 description: Políticas de validação de campos options: type: string format: byte description: JSON Options fieldFormEnabler: type: array items: type: object allOf: – #/definitions/criteriaFieldFormEnablerDTO minimum: 1 description: Habilitador do campo content: type: string format: byte description: Conteúdo dos campos extraídos do currículo note: type: string description: Anotação do agrupamento no idioma de contexto learnMore: type: string description: Anotação sobre descrição saiba mais informações do grupo fields: type: array items: type: object allOf: – #/definitions/fieldFormDetailsDTO minimum: 1 description: Campos do formulário com suas respectivas informações fieldFormDetailsDTO: description: type: object required: – id – sequence – name – typeField – length – sensibleData – mask – placeholder – possibleValuesList – enable – canRequiredByCompany – justification – hint – notes – fieldsToDisable – validatorAlgorithms properties: id: type: string description: Identificador único do campo sequence: type: integer format: int64 description: Sequência name: type: string description: Nome do Campo typeField: type: string allOf: – #/definitions/typeField description: Tipo de Campo length: type: integer format: int64 description: Tamanho máximo do campo sensibleData: type: boolean description: Define se a informação se enquadra na LGPD como dado sensível mask: type: string description: Máscara a ser utilizada para o tipo de informação placeholder: type: string description: Texto a ser apresentado na tela como dica de preenchimento para o candidato possibleValuesList: type: array items: type: object allOf: – #/definitions/itemValueGroupInformationByCountryDTO minimum: 1 description: Valores possíveis para campos do tipo Lista enable: type: boolean description: Habilitado por padrão required: type: boolean description: Campo de preenchimento exigido pela empresa canRequiredByCompany: type: boolean description: Pode ser solicitado pela empresa justification: type: object allOf: – #/definitions/justificationDTO description: Justificativa coleta de dados options: type: string format: byte description: JSON Options hint: type: string description: Hint do campo do formulário traduzido com o idioma de contexto notes: type: string description: Anotação adicionada ao campo de acordo ao idioma de contexto fieldsToDisable: type: array items: type: object allOf: – #/definitions/fieldsToDisableDTO minimum: 1 description: Desabilitador do campo validatorAlgorithms: type: array items: type: object allOf: – #/definitions/validatorAlgorithmTranslatedDTO minimum: 1 description: Lista que conterá os algoritmos responsáveis por fazer a validação do documento translationDTO: description: type: object required: – locale – value properties: locale: type: string description: Pré-definição de variante do idioma value: type: string description: Valor traduzido da propriedade de acordo à pré-definição da variante do idioma justificationDTO: description: type: object required: – enable – value properties: enable: type: boolean description: Indica se a justificativa da coleta dos dados está habilitada value: type: string description: Indica a descrição da justificação a partir do idioma de contexto validatorAlgorithmTranslatedDTO: description: type: object required: – algorithm – errorMessage properties: algorithm: type: string description: Algoritmo utilizado para a validação do documento errorMessage: type: string description: Mensagem de erro criteriaFieldFormEnablerDTO: description: type: object required: – itemGroupInformationEnablerId – fieldFormEnablerId – valueEnabler properties: itemGroupInformationEnablerId: type: string description: Gupo que controla a habilitação deste campo fieldFormEnablerId: type: string description: Campo que controla a habilitação deste campo valueEnabler: type: string description: Valor informado no campo controlador que habilita este campo fieldsToDisableDTO: description: type: object required: – value – fields properties: value: type: string description: Campo que controla a desabilitação deste campo fields: type: array items: type: string minimum: 1 description: Valor informado no campo controlador que desabilita este campo userDTO: description: Informações básicas para criar um novo usuário discriminator: _discriminator type: object required: – firstName – lastName – documentType – documentNumber – birthDate – _discriminator properties: firstName: type: string description: Nome do usuário lastName: type: string description: Sobrenome do usuário documentType: type: string description: Tipo de documento do usuário documentNumber: type: string description: Número de documento do usuário email: type: string description: E-mail phoneNumber: type: string description: Telefone Celular birthDate: type: string format: date description: Data de nascimento countryAbbreviation: type: string description: País de origem no padrão: ISO 3166-1 alpha-2 default: BR language: type: string description: Idioma de preferência default: pt-BR _discriminator: type: string description: registerUserDTO: description: Informações necessárias para registrar um novo usuário allOf: – #/definitions/userDTO – type: object required: – password properties: password: type: string description: Senha definida pelo usuário isReceiveCommunications: type: boolean description: Deseja receber comunicados? default: false userCreatedDTO: description: Informações sobre um novo usuário criado allOf: – #/definitions/userDTO – type: object required: – enable – isComplete properties: id: type: string description: Identificador do novo cadastro enable: type: boolean description: Usuário ativo isComplete: type: boolean description: Usuário possuí o cadastro completo profileCandidateDTO: description: type: object required: – firstName – lastName – documentType – documentNumber – birthDate – userId – typeName properties: id: type: string description: Identificador do registro firstName: type: string description: Nome do candidato lastName: type: string description: Sobrenome do candidato documentType: type: string description: Tipo de documento do candidato documentNumber: type: string description: Número de documento do candidato email: type: string description: E-mail phoneNumber: type: string description: Telefone Celular birthDate: type: string format: date description: Data de nascimento userId: type: string description: Identificador do usuário typeName: type: string allOf: – #/definitions/typeNameDTO description: Tipo de nome utilizado updateProfileCandidateDTO: description: type: object required: – firstName – lastName – documentType – documentNumber – birthDate – typeName properties: firstName: type: string description: Nome do candidato lastName: type: string description: Sobrenome do candidato documentType: type: string description: Tipo de documento do candidato documentNumber: type: string description: Número de documento do candidato birthDate: type: string format: date description: Data de nascimento typeName: type: string allOf: – #/definitions/typeNameDTO description: Tipo do nome do candidato myProfileDTO: description: type: object required: – firstName – lastName – documentType – documentNumber – birthDate – userId – language – highlighted properties: id: type: string description: Identificador do registro firstName: type: string description: Nome do candidato lastName: type: string description: Sobrenome do candidato profilePicture: type: string description: Foto de perfil do candidato documentType: type: string description: Tipo de documento do candidato documentNumber: type: string description: Número de documento do candidato email: type: string description: E-mail phoneNumber: type: string description: Telefone Celular birthDate: type: string format: date description: Data de nascimento userId: type: string description: Identificador do usuário position: type: string description: Position hasDisabilities: type: boolean description: People With Disabilities country: type: string description: The user location, ex: Unites States city: type: string description: The user city score: type: string description: The user profile score, the higher the information amount, higher the score isConfirmedEmail: type: boolean description: If the email was already confirmed by the user isConfirmedPhoneNumber: type: boolean description: If the phone was already confirmed by the user language: type: string description: The country in use by the user typeName: type: string allOf: – #/definitions/typeNameDTO description: Tipo de nome utilizado highlighted: type: array items: type: object allOf: – #/definitions/highlightedDTO minimum: 1 description: Informações a destacar no perfil changePasswordDTO: description: type: object required: – currentPassword – newPassword properties: currentPassword: type: string description: Password atual do usuário newPassword: type: string description: Novo password itemValueGroupInformationByCountryDTO: description: type: object required: – itemValue – defaultValue – sequence – itemHint – itemDescription properties: itemValue: type: string description: Item da lista de valores possíveis para o campo defaultValue: type: boolean description: Indica se o item é a opção padrão da lista sequence: type: integer format: int64 description: Sequência de apresentação em tela options: type: string format: byte description: JSON Options itemHint: type: string description: Nome do item no idioma de contexto itemDescription: type: string description: Descrição do item no idioma de contexto fileDataDTO: description: type: object required: – targetObjectId – contentType – extension – size – url properties: targetObjectId: type: string description: Identificador do arquivo contentType: type: string description: Content-type do arquivo extension: type: string description: Extensão do arquivo size: type: integer format: int64 description: Tamanho do arquivo url: type: string description: Url de acesso público do arquivo fileName: type: string description: Nome do arquivo translationFileDTO: description: type: object required: – locale – url properties: locale: type: string description: Locale – idioma url: type: string description: Url de acesso público do arquivo authTokenDTO: description: type: object required: – access_token – refresh_token – token_type – expires_in – username properties: access_token: type: string description: Access Token refresh_token: type: string description: Refresh Token token_type: type: string description: Token Type expires_in: type: integer format: int64 description: Expires In username: type: string description: Username resumeGroupDTO: description: discriminator: _discriminator type: object required: – id – tag – description – recordType – maxInformationKeys – visualizationSequence – candidateHasResumeData – note – _discriminator properties: id: type: string description: Id identificador do grupo tag: type: string description: Nome do grupo description: type: string description: Descrição do grupo recordType: type: string allOf: – #/definitions/recordType description: Se as informações do grupo são multiplas, únicas ou uma combinação das duas coisas maxInformationKeys: type: integer format: int64 description: Maximo de chaves encontradas dentro de informações visualizationSequence: type: integer format: int64 description: Sequência em que a informação deve ser disposta no front candidateHasResumeData: type: boolean description: Se o candidate possui dados para esse grupo note: type: object allOf: – #/definitions/groupNoteDTO description: Anotações do grupo options: type: string format: byte description: Configurações específicas do grupo _discriminator: type: string description: groupNoteDTO: description: type: object required: – type – title – description properties: type: type: string description: Tipo da anotação type: string description: Título da anotação description: type: string description: Anotação resumeDTO: description: type: object properties: id: type: string description: Identificador do registro de currículo de perfil name: type: string description: Nome do currículo information: type: string format: byte description: Informações do curriculo candidateId: type: string description: Id do candidato resumeStructureDTO: description: type: object required: – groups properties: groups: type: array items: type: object allOf: – #/definitions/groupDTO minimum: 1 description: groupDTO: description: type: object required: – id – name – maxRecordLimit – enable – sequence – subGroups properties: id: type: string description: Id identificador do grupo do formulário name: type: string description: Nome do grupo do formulário maxRecordLimit: type: integer format: int64 description: Limite máximo de registros enable: type: boolean description: Habilitado por padrão? sequence: type: integer format: int64 description: Sequência subGroups: type: array items: type: object allOf: – #/definitions/subGroupDTO minimum: 1 description: Sub grupos subGroupDTO: description: type: object required: – name – tag – fields properties: name: type: string description: Nome do sub grupo tag: type: string description: Tag do sub grupo fields: type: array items: type: object allOf: – #/definitions/fieldDTO minimum: 1 description: Campos do currículo fieldDTO: description: type: object required: – sequence – name – typeField – length – sensibleData – mask – placeholder – enableByDefault – canRequiredByCompany properties: sequence: type: integer format: int64 description: Sequência name: type: string description: Nome do Campo typeField: type: string allOf: – #/definitions/typeField description: Tipo de Campo length: type: integer format: int64 description: Tamanho máximo do campo sensibleData: type: boolean description: Define se a informação se enquadra na LGPD como dado sensível mask: type: string description: Máscara a ser utilizada para o tipo de informação placeholder: type: string description: Texto a ser apresentado na tela como dica de preenchimento para o candidato enableByDefault: type: boolean description: Habilitado por padrão canRequiredByCompany: type: boolean description: Pode ser solicitado pela empresa termOfUseAndPrivacyDTO: description: Termo de uso e privacidade type: object required: – situation – publishedDate – title – content properties: situation: type: string description: Situação do termo (rascunho ou publicado) publishedDate: type: string format: date-time description: Data de publicação type: string description: Título em um idioma específico content: type: string description: Conteúdo em um idioma específico partnerCompanyDTO: description: Armazena as informações da empresa para busca de empresas parceiras type: object required: – id – name – profilePicture properties: id: type: string description: Identificador do registro name: type: string description: Nome profilePicture: type: object allOf: – #/definitions/attachmentDTO description: Imagem de perfil highlightedDTO: description: Informações de destaque type: object required: – category – values properties: category: type: string description: Categoria values: type: array items: type: string minimum: 1 description: Dados do candidato candidatureDTO: description: Informações simplificadas da candidatura type: object required: – id – idVacancy – jobCode – idQuestionnaireAnswer – candidatureDate – resume properties: id: type: string description: Id da candidatura idVacancy: type: string description: Id da vaga no GRS jobCode: type: integer format: int64 description: Código da vaga no GRS idQuestionnaireAnswer: type: string description: Id da resposta do questionário da vaga candidatureDate: type: string format: date description: Data da candidatura resume: type: string description: Currículo findVacancyDTO: description: DTO do retorno da primitiva findVacancyById type: object required: – vacancy – company properties: vacancy: type: object allOf: – #/definitions/vacancyDTO description: Dados da vaga company: type: object allOf: – #/definitions/searchSummaryCompanyDTO description: Dados da empresa vacancyDTO: description: Armazena as informações da vaga type: object properties: id: type: string description: Identificador do registro code: type: integer format: int64 description: Código type: string description: Título hiringRegime: type: object allOf: – #/definitions/translatedEnumDTO description: Regime de Contratação em formato type e value jobModel: type: array items: type: object allOf: – #/definitions/translatedEnumDTO description: Modalidade de Trabalho em formato type e value experience: type: array items: type: object allOf: – #/definitions/translatedEnumDTO description: Nível de Experiência em formato type e value pcd: type: boolean description: PCD salary: type: object allOf: – #/definitions/salaryDTO description: Salário positions: type: integer format: int64 description: Quantidade about: type: object allOf: – #/definitions/informationDTO description: About requirements: type: object allOf: – #/definitions/informationDTO description: Requisitos duties: type: object allOf: – #/definitions/informationDTO description: Obrigações questionnaire: type: string description: Identificador do questionário localization: type: object allOf: – #/definitions/addressDTO description: Localização publication: type: object allOf: – #/definitions/publicationDTO description: Publicação isFavorite: type: boolean description: É uma vaga favoritada pelo candidato? addressDTO: description: Armazena as informações do endereço type: object properties: id: type: string description: Identificador do registro city: type: string description: Cidade province: type: string description: Província country: type: string description: País attachmentDTO: description: Armazena as informações dos anexos type: object properties: name: type: string description: Nome contentType: type: string description: Tipo extension: type: string description: Extensão size: type: integer format: int64 description: Tamanho type: string description: Versão url: type: string description: URL de acesso ao arquivo salaryDTO: description: Armazena as informações do salário type: object properties: id: type: string description: Identificador do registro startRange: type: number format: double description: Faixa Inicial endRange: type: number format: double description: Faixa Final informationDTO: description: Armazena as informações diversas type: object properties: id: type: string description: Identificador do registro description: type: string description: Descrição publicationDTO: description: Armazena as informações de publicação type: object properties: id: type: string description: Identificador do registro startDate: type: string description: Data inicio endDate: type: string description: Data término searchVacancyMatchDTO: description: Armazena as informações dos filtros de pesquisa type: object required: – type properties: type: type: string allOf: – #/definitions/searchType description: Tipo de pesquisa localizations: type: array items: type: object allOf: – #/definitions/searchLocalizationDTO description: Filtro Localização companies: type: array items: type: object allOf: – #/definitions/searchVacancyCompanyDTO description: Filtro empresas searchLocalizationDTO: description: Armazena as informações da localização da empresa retornada type: object required: – city properties: id: type: string description: Identificador do registro city: type: string description: Cidade province: type: string description: Estado/Província country: type: string description: País searchVacancyCompanyDTO: description: Armazena as informações da empresa para pesquisa de vagas type: object required: – id properties: id: type: string description: Identificador do registro searchSummaryDTO: description: Retorno da pesquisa de vagas type: object properties: vacancy: type: object allOf: – #/definitions/searchSummaryVacancyDTO description: Vaga company: type: object allOf: – #/definitions/searchSummaryCompanyDTO description: Data inicio searchSummaryVacancyDTO: description: Armazena as informações das vagas retornadas type: object properties: id: type: string description: Identificador do registro type: string description: Title jobModel: type: array items: type: object allOf: – #/definitions/translatedEnumDTO description: Modalidade de Trabalho em formato type e value localization: type: object allOf: – #/definitions/searchLocalizationDTO description: Localization publication: type: object allOf: – #/definitions/publicationDTO description: Publicação searchSummaryCompanyDTO: description: Armazena as informações das empresas retornadas type: object properties: id: type: string description: Identificador do registro picture: type: object allOf: – #/definitions/attachmentDTO description: Imagem de perfil name: type: string description: Nome sector: type: string description: Setor de atuação da empresa address: type: object allOf: – #/definitions/searchLocalizationDTO description: Dados de localização publicationDate: type: string description: Data de publicação tenant: type: string description: Tenant homeHighlightedVacancyDTO: description: DTO para representar os dados de uma vaga de destaque na home type: object required: – id – code – jobFunction – pcd – publishDate – headquarters – company properties: id: type: string description: Id de identificação da vaga code: type: string description: Código da vaga jobFunction: type: string description: Função ou título da vaga jobModel: type: array items: type: object allOf: – #/definitions/translatedEnumDTO description: Modalidade de Trabalho em formato type e value pcd: type: boolean description: Indicar se a vaga é para pessoas com deficiência publishDate: type: string description: Data de publicação da vaga headquarters: type: string description: Dados de localização da vaga company: type: object allOf: – #/definitions/homeHighlightedVacancyBasicCompanyInfoDTO description: Dados básicos da empresa ofertadora da vaga homeHighlightedVacancyBasicCompanyInfoDTO: description: DTO para representar as informações básicas da empresa type: object required: – id – name properties: id: type: string description: Id de identificação da vaga name: type: string description: Nome da empresa logo: type: string description: Url público do logo da empresa profileDTO: description: DTO do perfil da empresa type: object properties: id: type: string description: Id code: type: string description: Código do perfil da empresa no elastic company: type: string description: Company location: type: string description: Localização picture: type: string description: Hash dos dados da imagem de perfil tenant: type: string description: Tenant companyProfileDTO: description: DTO para visualização do perfil da empresa type: object required: – company properties: id: type: string description: Identificador do registro tenant: type: string description: Tenant about: type: string description: About profilePicture: type: object allOf: – #/definitions/attachmentDTO description: Foto do perfil coverPicture: type: object allOf: – #/definitions/attachmentDTO description: Foto de Capa sector: type: string description: Setor website: type: string description: Website size: type: string description: Tamanho socialNetworks: type: array items: type: string format: byte description: Redes Sociais company: type: object allOf: – #/definitions/companyDTO description: Informações da Empresa decodedProfileDTO: description: DTO do perfil da empresa type: object properties: id: type: string description: Id code: type: string description: Código do perfil da empresa no elastic company: type: string description: Company location: type: string description: Localização picture: type: object allOf: – #/definitions/fileDataDTO description: Dados da imagem de perfil tenant: type: string description: Tenant decodedVacancyDTO: description: Informações da vaga e perfil da empresa anunciante type: object properties: id: type: string description: Identificador da vaga profile: type: object allOf: – #/definitions/decodedProfileDTO description: Dados do perfil da empresa code: type: string description: Código da vaga no GRS jobCode: type: integer format: int64 description: Código da vaga (numérico) no GRS type: string description: Título da vaga status: type: string description: Status da vaga getVacancyDTO: description: Informações da vaga e perfil da empresa anunciante type: object properties: id: type: string description: Identificador da vaga profile: type: object allOf: – #/definitions/profileDTO description: Dados do perfil da empresa code: type: string description: Código da vaga no GRS jobCode: type: integer format: int64 description: Código da vaga (numérico) no GRS type: string description: Título da vaga status: type: string description: Status da vaga candidatureVacancyDTO: description: DTO da vaga type: object properties: id: type: string description: Identificador da vaga idProfile: type: string description: Identificador do perfil da empresa code: type: string description: Código da vaga no GRS jobCode: type: integer format: int64 description: Código da vaga (numérico) no GRS type: string description: Título da vaga status: type: string description: Status da vaga createCandidatureDTO: description: DTO da primitiva createCandidature type: object required: – code properties: code: type: string description: Id da vaga resume: type: object allOf: – #/definitions/resumeFileDTO description: Currículo questionnaire: type: object allOf: – #/definitions/createCandidatureQuestionnaireDTO description: Questionário additionalData: type: string format: byte description: Informações adicionais não persistidas no currículo amendResume: type: boolean description: Indicativo se as informações prestadas na candidatura devem ser salvas no curriculo do candidato default: true answerQuestionnaireResponseDTO: description: DTO de retorno na chamada para responder questionário type: object required: – idAnswer properties: idAnswer: type: string description: createCandidatureQuestionnaireDTO: description: DTO do questionário da primitiva createCandidature type: object required: – id properties: id: type: string description: Id do questionário answers: type: array items: type: object allOf: – #/definitions/createCandidatureQuestionnaireAnswerDto description: Respostas do questionário createCandidatureQuestionnaireAnswerDto: description: DTO do resposta do questionário da primitiva createCandidature type: object required: – id – type properties: id: type: string description: Id da questão answer: type: string format: byte description: Resposta da questão type: type: string allOf: – #/definitions/questionnaireQuestionType description: Tipo de resposta da questão resumeFileDTO: description: DTO dos dados do currículo type: object required: – name – content properties: name: type: string description: Nome do arquivo content: type: string description: Arquivo em Base64 decodedCandidatureDTO: description: DTO contendo informações da candidatura, vaga e perfil relacionados a candidatura type: object required: – stages properties: id: type: string description: Identificador da candidatura idCandidate: type: string description: Identificador do candidato idQuestionnaire: type: string description: Identificador do questionário dateCandidature: type: string format: date description: Data da candidatura resume: type: object allOf: – #/definitions/fileDataDTO description: Currículo vacancy: type: object allOf: – #/definitions/decodedVacancyDTO description: Dados da vaga stages: type: array items: type: object allOf: – #/definitions/candidatureStageDTO minimum: 1 description: Etapas da candidatura getCandidatureDTO: description: DTO contendo informações da candidatura, vaga e perfil relacionados a candidatura type: object properties: id: type: string description: Identificador da candidatura idCandidate: type: string description: Identificador do candidato idQuestionnaire: type: string description: Identificador do questionário dateCandidature: type: string format: date description: Data da candidatura resume: type: string description: Currículo vacancy: type: object allOf: – #/definitions/getVacancyDTO description: Dados da vaga simplifiedCandidatureDTO: description: DTO de retorno da primitiva createCandidature no careers-candidature type: object required: – id – idCandidate – idVacancy – idQuestionnaire – dateCandidature – resume properties: id: type: string description: Identificador da candidatura idCandidate: type: string description: Identificador do candidato idVacancy: type: string description: Identificador da Vaga idQuestionnaire: type: string description: Identificador do questionário dateCandidature: type: string format: date description: Data da candidatura resume: type: string description: Currículo createCandidatureResponse: description: DTO de resposta da primitiva createCandidature type: object required: – id – idCandidate – idVacancy – idProfile – dateCandidature – status properties: id: type: string description: Identificador da candidatura idCandidate: type: string description: Identificador do candidato idVacancy: type: string description: Identificador da Vaga idProfile: type: string description: Identificador do perfil da empresa dateCandidature: type: string format: date description: Data da candidatura status: type: string description: Status da candidatura candidatureListItemDTO: description: DTO para armazenar dados da candidatura type: object required: – id – idCandidate – dateCandidature – idQuestionnaire – vacancy properties: id: type: string description: Identificador da candidatura idCandidate: type: string description: Identificador do candidato dateCandidature: type: string format: date description: Data de realização da candidatura idQuestionnaire: type: string description: Identificador do questionário resume: type: object allOf: – #/definitions/fileDataDTO description: Hash do Currículo vacancy: type: object allOf: – #/definitions/vacancyListItemDTO description: Informações da vaga vacancyListItemDTO: description: DTO para armazenar dados da vaga type: object required: – id – code – jobCode – title – status – profile properties: id: type: string description: Identificador da vaga code: type: string description: Identificador da vaga no GRS jobCode: type: integer format: int64 description: Código da vaga no GRS type: string description: Título da vaga status: type: string description: Status da vaga profile: type: object allOf: – #/definitions/profileListItemDTO description: Infomações de perfil profileListItemDTO: description: DTO para armazenar dados do perfil da empresa type: object required: – id – company – location – picture properties: id: type: string description: Identificador do perfil company: type: string description: Noma da empresa location: type: string description: Localização picture: type: object allOf: – #/definitions/fileDataDTO description: Hash da imagem questionnaireDTO: description: DTO do questionário type: object properties: id: type: string description: Identificador único da entidade. questions: type: array items: type: object allOf: – #/definitions/questionDTO description: Questões desse questionário. questionDTO: description: DTO das questões do questionário. type: object properties: id: type: string description: Identificador único da entidade. description: type: string description: Descrição da questão. type: type: string description: Tipo da questão. required: type: boolean description: Indica se a questão é obrigatória. sequence: type: integer format: int64 description: Sequência em que essa questão deve ser apresentada. alternatives: type: array items: type: object allOf: – #/definitions/alternativeDTO description: Alternativas dessa questão. alternativeDTO: description: DTO das alternativas das questões. type: object properties: id: type: string description: Identificador único da entidade. description: type: string description: Descrição da alternativa. questionId: type: string description: Identificador da questão a qual essa alternativa está associada. sequence: type: integer format: int64 description: Sequência em que essa alternativa deve ser apresentada. companyDTO: description: Armazena as informações da empresa type: object required: – name properties: id: type: string description: Identificador do registro identificationType: type: string description: Tipo de identificação identificationNumber: type: string description: Número de identificação name: type: string description: Nome address: type: object allOf: – #/definitions/addressDTO description: Endereço companyUseDataDTO: description: Informações da empresa que consumiram os dados do candidato type: object required: – name properties: name: type: string description: Nome registerCookieDTO: description: DTO com dados necessários para salvar consentimento de cookies type: object properties: categories: type: array items: type: string allOf: – #/definitions/consentCategoryCookiesEnum description: Lista de categorias acceptedCookieDTO: description: DTO de resposta após consentimento de cookies type: object required: – cookie – expiresAt properties: cookie: type: string description: Id do cookie expiresAt: type: string format: date-time description: Data de expiração do cookie translatedEnumDTO: description: Estrutura que armazenará a declaração do enum e o seu valor traduzido type: object required: – type – value properties: type: type: string description: Nome de declaração do enum value: type: string description: Valor traduzido do enum de acordo ao idioma homologado translatedGroupDTO: description: Estrutura que armazenará as informações de tradução type: object required: – locale – value properties: locale: type: string description: Pré-definição de variante do idioma value: type: string description: hint basicCompanyInfoDTO: description: Estrutura para representar os dados mínimos/necessários da empresa type: object required: – id – name – localization properties: id: type: string description: Id do perfil da empresa name: type: string description: Nome da empresa profilePicture: type: object allOf: – #/definitions/attachmentDTO description: Foto de Perfil localization: type: string description: Endereço tenant: type: string description: Tenant da Empresa identificationNumber: type: string description: Identificação da Empresa fieldsValidatorPoliciesDTO: description: Políticas de validação de campos type: object required: – id – firstFieldId – validationRule – lastFieldId properties: id: type: string description: Identificador único do objeto firstFieldId: type: string description: Id do primeiro campo para validação validationRule: type: string description: regra de validação lastFieldId: type: string description: Id do segundo campo para validação justificationExclusionDTO: description: Justificativa de exclusão de conta type: object required: – id – content – additional properties: id: type: string description: Identificador único da justificativa content: type: string description: Lista de conteúdos em seus respectivos idiomas additional: type: array items: type: string minimum: 1 description: Condições adicionais ao campo configurationGroupByProviderDTO: description: Metadados do currículo allOf: – #/definitions/resumeGroupDTO – type: object required: – subgroups properties: subgroups: type: array items: type: object allOf: – #/definitions/groupedFieldsFormDTO minimum: 1 description: candidatureStageDTO: description: Etapa de candidatura type: object required: – id – name – sequence – currentStage properties: id: type: string description: Identificador da etapa name: type: string description: Nome da etapa sequence: type: integer format: int64 description: Ordem da etapa currentStage: type: boolean description: Indica se é a etapa atual do candidato no processo seletivo profileDTOAtCareersPreferences: description: Perfil da empresa type: object required: – id – externalProfileId – company – location properties: id: type: string description: Identificador do perfil, no formato UUID externalProfileId: type: string description: Identificador do perfil no Elasticsearch, no formato UUID company: type: string description: Nome da empresa location: type: string description: Localização da empresa picture: type: string description: Url da imagem do perfil vacancyInfoDTOAtCareersPreferences: description: Informações da vaga para exibição na busca de vagas favoritadas type: object required: – id – externalVacancyId – jobCode – title – status – profile properties: id: type: string description: Identificador da vaga, no formato UUID externalVacancyId: type: string description: Identificador da vaga no Elasticsearch, no formato UUID jobCode: type: integer format: int64 description: Código da vaga type: string description: Título da vaga status: type: string description: Status da vaga publishedDate: type: string format: date description: Data de publicação da vaga jobModels: type: array items: type: string description: Modelo de trabalho location: type: string description: Localização da vaga profile: type: object allOf: – #/definitions/profileDTOAtCareersPreferences description: Dados da empresa favoritedVacancyDTO: description: Informações de uma vaga favoritada type: object required: – id – candidateId – createdDate – vacancy properties: id: type: string description: Identificador do item na tabela favorite_vacancy candidateId: type: string description: identificador do candidato createdDate: type: string format: date description: Data em que a vaga foi favoritada vacancy: type: object allOf: – #/definitions/vacancyInfoDTOAtCareersPreferences description: Informações da vaga notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. 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 _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service 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