Gestão de Pessoas (hcm)

onboardingintegration

119 views 15/07/2019 27/11/2020 integrador 0

2.0info: 1.27.0 onboardingintegration description: Serviço do onboarding para integração com outros sistemas. x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: onboardingintegration contact: name: Senior X Platform url: http://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: /onboardingintegration/queries/searchPendingAdmission: post: description: Busca todas as pré-admissões com status Admissão pendente e que estão entre as datas pesquisadas.\n Atualmente esta ação é utilizada para integração com o módulo Administração de Pessoal.\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: startDate: type: string format: date description: Data inicial para a pesquisa pela data de admissão. endDate: type: string format: date description: Data final para a pesquisa pela data de admissão. responses: 200: description: Ok schema: type: object properties: result: type: object allOf: – #/definitions/pendingAdmissionListData description: Resultado com as informações da pré-admissão necessárias para apresentar no módulo Administração de Pessoal. default: description: Error response schema: #/definitions/genericError get: description: Busca todas as pré-admissões com status Admissão pendente e que estão entre as datas pesquisadas.\n Atualmente esta ação é utilizada para integração com o módulo Administração de Pessoal.\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial para a pesquisa pela data de admissão. in: query type: string format: date – name: endDate description: Data final para a pesquisa pela data de admissão. in: query type: string format: date responses: 200: description: Ok schema: type: object properties: result: type: object allOf: – #/definitions/pendingAdmissionListData description: Resultado com as informações da pré-admissão necessárias para apresentar no módulo Administração de Pessoal. default: description: Error response schema: #/definitions/genericError /onboardingintegration/queries/preAdmissionQuery: post: description: Busca todas as informações de uma pré-admissão de acordo com o identificador único. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Identificador único da pré-admissão. responses: 200: description: Ok schema: type: object properties: result: type: object allOf: – #/definitions/preAdmissionData description: Resultado com todas as informações da pré-admissão. default: description: Error response schema: #/definitions/genericError get: description: Busca todas as informações de uma pré-admissão de acordo com o identificador único. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: preAdmissionId description: Identificador único da pré-admissão. in: query required: true type: string responses: 200: description: Ok schema: type: object properties: result: type: object allOf: – #/definitions/preAdmissionData description: Resultado com todas as informações da pré-admissão. default: description: Error response schema: #/definitions/genericError /onboardingintegration/queries/preAdmissionFinishedListQuery: post: description: Busca todas as pré-admissões finalizadas de um determinado período e para cada uma, lista todas as informações.\n A lista de pré-admissões possui paginação, ou seja, somente alguns registros são exibidos em cada página.\n Algumas regras são aplicadas na busca das pré-admissões:\n * A quantidade de registros por página não pode ser superior a 30 registros (A quantidade padrão é igual a 10).\n * O período de admissão não pode ser superior a 31 dias.\n * A ordenação das pré-admissões será efetuada por data de admissão e, caso houver mais de uma pré-admissão com a mesma data de\n admissão, será pelo nome do novo colaborador.\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial para a pesquisa pela data de admissão. endDate: type: string format: date description: Data final para a pesquisa pela data de admissão. size: type: integer format: int64 description: Quantidade de registros que deve ser apresentada em cada página. default: 10 page: type: integer format: int64 description: Número da página atual. A primeira página inicia em zero. default: 0 responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/preAdmissionList description: Lista das pré-admissões encontradas com base nas informações fornecidas. default: description: Error response schema: #/definitions/genericError get: description: Busca todas as pré-admissões finalizadas de um determinado período e para cada uma, lista todas as informações.\n A lista de pré-admissões possui paginação, ou seja, somente alguns registros são exibidos em cada página.\n Algumas regras são aplicadas na busca das pré-admissões:\n * A quantidade de registros por página não pode ser superior a 30 registros (A quantidade padrão é igual a 10).\n * O período de admissão não pode ser superior a 31 dias.\n * A ordenação das pré-admissões será efetuada por data de admissão e, caso houver mais de uma pré-admissão com a mesma data de\n admissão, será pelo nome do novo colaborador.\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: startDate description: Data inicial para a pesquisa pela data de admissão. in: query required: true type: string format: date – name: endDate description: Data final para a pesquisa pela data de admissão. in: query required: true type: string format: date – name: size description: Quantidade de registros que deve ser apresentada em cada página. in: query type: integer format: int64 – name: page description: Número da página atual. A primeira página inicia em zero. in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/preAdmissionList description: Lista das pré-admissões encontradas com base nas informações fornecidas. default: description: Error response schema: #/definitions/genericError /onboardingintegration/queries/preAdmissionListQuery: post: description: Busca todas as pré-admissões de um status de um determinado período e para cada uma, lista todas as informações.\n A lista de pré-admissões possui paginação, ou seja, somente alguns registros são exibidos em cada página.\n Algumas regras são aplicadas na busca das pré-admissões:\n * A quantidade de registros por página não pode ser superior a 30 registros (A quantidade padrão é igual a 10).\n * O período de admissão não pode ser superior a 31 dias.\n * A ordenação das pré-admissões será efetuada por data de admissão e, caso houver mais de uma pré-admissão com a mesma data de\n admissão, será pelo nome do novo colaborador.\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – status properties: startDate: type: string format: date description: Data inicial para a pesquisa pela data de admissão. endDate: type: string format: date description: Data final para a pesquisa pela data de admissão. status: type: string allOf: – #/definitions/enumInvitationStatus description: Status atual da pré-admissão. size: type: integer format: int64 description: Quantidade de registros que deve ser apresentada em cada página. default: 10 page: type: integer format: int64 description: Número da página atual. A primeira página inicia em zero. default: 0 responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/preAdmissionList description: Lista das pré-admissões encontradas com base nas informações fornecidas. default: description: Error response schema: #/definitions/genericError /onboardingintegration/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: 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: default: description: Error response schema: #/definitions/genericError /onboardingintegration/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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 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: PUBLIC 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 default: description: Error response schema: #/definitions/genericError /onboardingintegration/actions/preAdmissionStatusUpdate: post: description: Esta ação possibilita atualizar o status de uma pré-admissão de acordo com a operação que o usuário está executando.\n Atualmente esta ação é utilizada para integração com o módulo Administração de Pessoal.\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId – hiringProcessAction properties: preAdmissionId: type: string description: Identificador único da pré-admissão. hiringProcessAction: type: string allOf: – #/definitions/enumHiringProcessActions description: Ação que está sendo executada pelo usuário. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado da ação. default: description: Error response schema: #/definitions/genericError /onboardingintegration/actions/preAdmissionSend: post: description: Efetua o envio de um convite para iniciar o processo de admissão de um novo colaborador.\n Durante o processo de envio as informações serão validadas e você receberá um retorno positivo ou negativo, caso o convite tenha sido enviado com sucesso, ou não.\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – employeeName – admissionDate – modelId properties: employeeName: type: string maxLength: 100 description: Nome completo do novo colaborador. employeeEmail: type: string maxLength: 255 description: E-mail do novo colaborador. employeeMobilePhone: type: string maxLength: 20 description: Número de telefone celular do novo colaborador. key: type: string maxLength: 255 description: Chave da pré-admissão, para convites brasileiros, a chave de identificação é o CPF do novo colaborador. admissionDate: type: string format: date description: Data de admissão do novo colaborador. modelId: type: string description: Identificador único do modelo de convite associado a pré-admissão. additionalInfo: type: string description: Informação adicional que pode ser enviada no modelo de convite. jobPosition: type: string description: Identificador único do cargo. branchOffice: type: string description: Identificador único da filial. company: type: string description: Identificador único da empresa. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado do envio do convite. default: description: Error response schema: #/definitions/genericError definitions: enumHiringProcessActions: description: Ações que podem ser executadas no módulo Administração de pessoal. type: string enum: – IMPORT – HIRE enumInvitationStatus: description: Status que uma pré-admissão pode assumir. type: string enum: – UNREAD – READ – EXPIRED – IN_VALIDATION – FINISHED – PENDING_ADMISSION – STARTED_ADMISSION – FINISHED_ADMISSION 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 resultBaseData: description: Contém as informações relacionadas ao retorno das primitivas. type: object required: – ok properties: ok: type: boolean description: Indicativo se o resultado foi efetuado com sucesso ou não. message: type: string description: Mensagem de retorno da primitiva. default: idPreAdmission: type: string description: ID da PreAdmission default: pendingAdmissionListData: description: Contém a lista dos registros pendentes de admissão. type: object properties: employees: type: array items: type: object allOf: – #/definitions/pendingAdmissionData description: Lista com os registros pendentes de admissão. pendingAdmissionData: description: Contém as informações básicas de uma pré-admissão. type: object properties: preAdmissionId: type: string description: Identificador único da pré-admissão. employeeName: type: string description: Nome do novo colaborador. employeeCpf: type: string description: CPF do novo colaborador. admissionDate: type: string format: date description: Data que o colaborador será admitido. preAdmissionList: description: Contém todas as informações das pré-admissões de um determinado período, utilizando paginação. type: object properties: totalElements: type: integer format: int64 description: Total de pré-admissões encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/preAdmissionData description: Relação das pré-admissões relacionadas a página. preAdmissionData: description: Contém todas as informações de uma determinada pré-admissão. type: object properties: preAdmissionId: type: string description: Identificador único da pré-admissão. admissionDate: type: string format: date description: Data que o novo colaborador será admitido. contract: type: object allOf: – #/definitions/contractData description: Informações de contrato com a empresa. personalData: type: object allOf: – #/definitions/preAdmissionPersonalBRAData description: Informações pessoais do novo colaborador. document: type: object allOf: – #/definitions/preAdmissionDocumentBRAData description: Documentos do novo colaborador. dependents: type: array items: type: object allOf: – #/definitions/dependentData description: Relação de dependentes do novo colaborador. contractData: description: Contém as informações relacionadas ao contrato com a empresa. type: object properties: employeeType: type: string description: Tipo do colaborador. employeeContract: type: string description: Tipo de contrato. eSocialCategory: type: string description: Categoria do eSocial. sefipCategory: type: string description: Categoria da SEFIP. unemploymentInsurance: type: string description: Tipo do seguro desemprego. raisType: type: string description: Vínculo RAIS. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. preAdmissionPersonalBRAData: description: Contém todas as informações pessoais do novo colaborador. type: object properties: basic: type: object allOf: – #/definitions/personalBasicData description: Informações pessoais básicas. complementary: type: object allOf: – #/definitions/personalComplementaryData description: Informações complementares. birthPlace: type: object allOf: – #/definitions/personalBirthPlaceData description: Informações do local de nascimento. address: type: object allOf: – #/definitions/personalAddressBRAData description: Informações de endereço. email: type: object allOf: – #/definitions/personalEmailData description: Informações de e-mail. phone: type: object allOf: – #/definitions/personalTelephoneData description: Informações de telefone. preAdmissionDocumentBRAData: description: Contém todos os documentos do novo colaborador. type: object properties: cpf: type: object allOf: – #/definitions/cpfData description: Cadastro de pessoas físicas (CPF). pis: type: object allOf: – #/definitions/pisData description: Programa de integração social (PIS). ctps: type: object allOf: – #/definitions/ctpsData description: Carteira de trabalho e previdência social (CTPS). rg: type: object allOf: – #/definitions/rgData description: Registro geral (RG). passport: type: object allOf: – #/definitions/passportData description: Passaporte. ric: type: object allOf: – #/definitions/ricData description: Registro de identidade civil (RIC). voter: type: object allOf: – #/definitions/voterData description: Título de eleitor. cnh: type: object allOf: – #/definitions/cnhData description: Carteira nacional de habilitação (CNH). reservist: type: object allOf: – #/definitions/reservistData description: Certificado de reservista. civilCertificate: type: object allOf: – #/definitions/civilCertificateData description: Certidão civil. cns: type: object allOf: – #/definitions/cnsData description: Cartão nacional de saúde (CNS). dnv: type: object allOf: – #/definitions/dnvData description: Declaração de nascido vivo (DNV). bankAccount: type: object allOf: – #/definitions/bankAccountData description: Dados bancários. receiveSalaryAdvance: type: string description: Indicativo se o novo colaborador gostaria de receber adiantamento salarial. personalBasicData: description: Contém as informações pessoais básicas da pré-admissão. type: object properties: employeeFullName: type: string description: Nome completo do novo colaborador. gender: type: string description: Gênero do novo colaborador. birthDate: type: string format: date description: Data e nascimento do novo colaborador. preferredName: type: string description: Nome pelo qual o novo colaborador prefere ser chamado. mothersName: type: string description: Nome da mãe do novo colaborador. fathersName: type: string description: Nome do pai do novo colaborador. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. personalComplementaryData: description: Contém as informações complementares da pré-admissão. type: object properties: maritalStatus: type: string description: Estado civil. degreeOfEducation: type: integer format: int64 description: Grau de instrução. nationality: type: string description: Nacionalidade. religion: type: string description: Religião. race: type: string description: Raça/Cor. socialName: type: string description: Nome social. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. personalBirthPlaceData: description: Contém as informações do local de nascimento da pré-admissão. type: object properties: country: type: string description: País de nascimento. state: type: string description: Estado de nascimento. city: type: string description: Cidade de nascimento. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. personalEmailData: description: Contém as informações de e-mails para contato com o novo colaborador da pré-admissão. type: object properties: emailPersonal: type: string description: Email pessoal do novo colaborador. Esta informação só estará disponível em integrações internas. emailBusiness: type: string description: Email comercial do novo colaborador. Esta informação só estará disponível em integrações internas. firstType: type: string description: Tipo do email principal. firstEmail: type: string description: Email principal do novo colaborador. secondType: type: string description: Tipo do email secundário. secondEmail: type: string description: Email secundário do novo colaborador. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. personalTelephoneData: description: Contém as informações de telefones para contato com o novo colaborador da pré-admissão. type: object properties: firstType: type: string description: Tipo do contato do telefone principal. firstPhone: type: string description: Número do telefone principal. secondType: type: string description: Tipo do contato do telefone principal. secondPhone: type: string description: Número do telefone secundário. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. personalAddressBRAData: description: Contém as informações dos dados do endereço da pré-admissão. type: object properties: country: type: string description: País de nascimento. state: type: string description: Estado de nascimento. city: type: string description: Cidade de nascimento. cep: type: string description: CEP do endereço. neighborhood: type: string maxLength: 255 description: Bairro. addressType: type: string description: Logradouro. address: type: string description: Endereço. number: type: string description: Número do endereço. additional: type: string description: Informação adicional referente ao endereço. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. cpfData: description: Contém as informações do cadastro de pessoas físicas (CPF). type: object properties: number: type: string description: Número. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. pisData: description: Contém as informações do programa de integração social (PIS). type: object properties: number: type: string description: Número. issueDate: type: string format: date description: Data de emissão. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. ctpsData: description: Contém as informações da carteira de trabalho e previdência social (CTPS). type: object properties: number: type: string description: Número. serie: type: string description: Série. digit: type: string maxLength: 2 description: Dígito. issuerState: type: string description: Estado de emissão. issueDate: type: string format: date description: Data de emissão. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. rgData: description: Contém as informações do registro geral (RG). type: object properties: number: type: string description: Número. issuer: type: string description: Órgão emissor. issuerState: type: string description: Estado de emissão. issueDate: type: string format: date description: Data de emissão. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. passportData: description: Contém as informações do passaporte. type: object properties: number: type: string description: Número. issuer: type: string description: Emissor. issueDate: type: string format: date description: Data de emissão. expiryDate: type: string format: date description: Data de validade. issuerCountry: type: string description: País da emissão. issuerState: type: string description: Estado da emissão do passaporte. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. ricData: description: Contém as informações do Registro de Identidade Civil (RIC). type: object properties: number: type: string description: Número. issuer: type: string description: Órgão emissor. issuerCity: type: string description: Cidade da emissão. issuerState: type: string description: Estado da emissão. issueDate: type: string format: date description: Data de emissão. expiryDate: type: string format: date description: Data de validade. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. voterData: description: Contém as informações do título de eleitor. type: object properties: number: type: string description: Número. votingDistrict: type: string description: Zona. votingSection: type: string description: Seção. issueDate: type: string format: date description: Data de emissão. issuerCity: type: string description: Cidade de emissão. issuerState: type: string description: Estado de emissão. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. cnhData: description: Contém as informações da carteira nacional de habilitação (CNH). type: object properties: number: type: string description: Número. category: type: string maxLength: 4 description: Categoria. issuer: type: string description: Órgão emissor. issuerState: type: string maxLength: 2 description: Estado de emissão. issueDate: type: string format: date description: Data de emissão. expiryDate: type: string format: date description: Data de validade do CNH. firstDriverLicenseDate: type: string format: date description: Data da primeira habilitação. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. reservistData: description: Contém as informações do certificado de reservista. type: object properties: number: type: string description: Número. serie: type: string description: Série. ra: type: string description: RA. exemptionDate: type: string format: date description: Data de dispensa. hasCertificate: type: boolean description: Indica se a pessoa possui certificado de reservista. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. civilCertificateData: description: Contém as informações do certificado civil. type: object properties: type: type: string description: Tipo. issueDate: type: string format: date description: Data de emissão. registry: type: string description: Matrícula. term: type: string description: Termo. book: type: string description: Livro. sheet: type: string description: Folha. notaryOffice: type: string description: Cartório. issuerCity: type: string description: Cidade de emissão. issuerState: type: string description: Estado de emissão. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. dnvData: description: Contém as informações da declaração de nascido vivo (DNV). type: object properties: number: type: string description: Número. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. cnsData: description: Contém as informações do cartão nacional de saúde (CNS). type: object properties: number: type: string description: Número. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. bankAccountData: description: Contém as informações bancárias. type: object properties: bank: type: string description: Identificador do banco. branch: type: integer format: int64 description: Número da agência. accountType: type: string description: Tipo da conta. bankAccount: type: string description: Conta bancária. digit: type: string description: Digito da conta. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. dependentData: description: Contém os dados do dependente do novo colaborador. type: object properties: fullName: type: string description: Nome completo. degreeOfKinship: type: string description: Grau de parentesco. gender: type: string description: Gênero. birthDate: type: string format: date description: Data de nascimento. mothersName: type: string description: Nome da mãe. maritalStatus: type: string description: Estado civil. declareIncomeTax: type: string description: Indica que o dependente declara imposto de renda. cpf: type: object allOf: – #/definitions/cpfData description: Cadastro de pessoas físicas (CPF). rg: type: object allOf: – #/definitions/rgData description: Registro geral (RG). ric: type: object allOf: – #/definitions/ricData description: Registro de identidade civil (RIC). sus: type: object allOf: – #/definitions/susData description: Cartão do sistema único de saúde (SUS). vaccinationBooklet: type: object allOf: – #/definitions/vaccinationBookletData description: Caderneta de vacinação. proofOfEnrollment: type: object allOf: – #/definitions/proofOfEnrollmentData description: Comprovante de matrícula. deathCertificate: type: object allOf: – #/definitions/civilCertificateData description: Certidão de óbito. birthCertificate: type: object allOf: – #/definitions/civilCertificateData description: Certidão de nascimento. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. susData: description: Contém as informações do cartão do sistema único de saúde (SUS). type: object properties: number: type: string description: Número. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. vaccinationBookletData: description: Contém as informações da caderneta de vacinação. type: object properties: customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. proofOfEnrollmentData: description: Contém as informações de comprovante de matrícula. type: object properties: customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. customData: description: Contém com os valores relacionados aos campos customizados. type: object required: – field properties: field: type: string description: Nome do campo. value: type: string description: Valor do campo. valueList: type: array items: type: string description: Valor do campo tipo lista. 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

Este artigo foi útil para você?

Leave A Comment