2.0info: 0.1.1 rrs_remessa x-senior-domain: erp_man x-senior-domain-path: erp_man x-senior-service-path: rrs_remessa 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/erp_mansecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /rrs_remessa/queries/pesquisarEstagio: post: description: Retorna estágio de produção tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa properties: codigoEmpresa: type: integer format: int64 description: Código da empresa responses: 200: description: Ok schema: type: object required: – estagios properties: estagios: type: array items: type: object allOf: – #/definitions/recEstagio minimum: 1 description: Lista de estágios de produção default: description: Error response schema: #/definitions/genericError get: description: Retorna estágio de produção tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – estagios properties: estagios: type: array items: type: object allOf: – #/definitions/recEstagio minimum: 1 description: Lista de estágios de produção default: description: Error response schema: #/definitions/genericError /rrs_remessa/queries/pesquisarOperacao: post: description: Retorna operações de fabricação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa properties: codigoEmpresa: type: integer format: int64 description: Código da empresa responses: 200: description: Ok schema: type: object required: – operacoes properties: operacoes: type: array items: type: object allOf: – #/definitions/recOperacao minimum: 1 description: Lista de operações de fabricação default: description: Error response schema: #/definitions/genericError get: description: Retorna operações de fabricação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – operacoes properties: operacoes: type: array items: type: object allOf: – #/definitions/recOperacao minimum: 1 description: Lista de operações de fabricação default: description: Error response schema: #/definitions/genericError /rrs_remessa/queries/pesquisarProduto: post: description: Retorna produtos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa properties: codigoEmpresa: type: integer format: int64 description: Código da empresa responses: 200: description: Ok schema: type: object required: – produtos properties: produtos: type: array items: type: object allOf: – #/definitions/recProduto minimum: 1 description: Lista de produtos default: description: Error response schema: #/definitions/genericError get: description: Retorna produtos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – produtos properties: produtos: type: array items: type: object allOf: – #/definitions/recProduto minimum: 1 description: Lista de produtos default: description: Error response schema: #/definitions/genericError /rrs_remessa/queries/pesquisarDerivacao: post: description: Retorna lista de derivações de um ou mais produtos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoProdutos properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoProdutos: type: array items: type: string minimum: 1 description: (Opcional) Lista de codigos de produto responses: 200: description: Ok schema: type: object required: – derivacoesProdutos properties: derivacoesProdutos: type: array items: type: object allOf: – #/definitions/recDerivacao minimum: 1 description: Lista de derivações default: description: Error response schema: #/definitions/genericError get: description: Retorna lista de derivações de um ou mais produtos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa in: query required: true type: integer format: int64 – name: codigoProdutos in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – derivacoesProdutos properties: derivacoesProdutos: type: array items: type: object allOf: – #/definitions/recDerivacao minimum: 1 description: Lista de derivações default: description: Error response schema: #/definitions/genericError /rrs_remessa/queries/pesquisarRecursoFornecedor: post: description: Retorna a lista de fornecedores que servem de recurso tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – recursoFornecedores properties: recursoFornecedores: type: array items: type: object allOf: – #/definitions/recRecursoFornecedor minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de fornecedores que servem de recurso tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – recursoFornecedores properties: recursoFornecedores: type: array items: type: object allOf: – #/definitions/recRecursoFornecedor minimum: 1 description: default: description: Error response schema: #/definitions/genericError /rrs_remessa/queries/pesquisarServico: post: description: Retorna lista de serviços tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa properties: codigoEmpresa: type: integer format: int64 description: Código da empresa responses: 200: description: Ok schema: type: object properties: listaServico: type: array items: type: object allOf: – #/definitions/recServico description: default: description: Error response schema: #/definitions/genericError get: description: Retorna lista de serviços tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object properties: listaServico: type: array items: type: object allOf: – #/definitions/recServico description: default: description: Error response schema: #/definitions/genericError /rrs_remessa/queries/pesquisarProgramacaoOP: post: description: Retorna lista de Ordens de Produção a programadas ou a programar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoFilial – dataPrevisaoInicio – dataPrevisaoFim – programacaoInternaOpcaoExterna properties: codigoEmpresa: type: integer format: int64 description: codigoFilial: type: integer format: int64 description: codigoEstagio: type: array items: type: string description: codigoOperacao: type: array items: type: string description: codigoProduto: type: array items: type: string description: codigoDerivacao: type: array items: type: string description: codigoRecurso: type: array items: type: string description: dataPrevisaoInicio: type: string format: date description: dataPrevisaoFim: type: string format: date description: programacaoInternaOpcaoExterna: type: boolean description: responses: 200: description: Ok schema: type: object required: – limiteDadosAtingido properties: limiteDadosAtingido: type: boolean description: ordensProducaoProgramacao: type: array items: type: object allOf: – #/definitions/recOrdensProducaoProgramacao description: default: description: Error response schema: #/definitions/genericError get: description: Retorna lista de Ordens de Produção a programadas ou a programar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa in: query required: true type: integer format: int64 – name: codigoFilial in: query required: true type: integer format: int64 – name: codigoEstagio in: query type: array items: type: string – name: codigoOperacao in: query type: array items: type: string – name: codigoProduto in: query type: array items: type: string – name: codigoDerivacao in: query type: array items: type: string – name: codigoRecurso in: query type: array items: type: string – name: dataPrevisaoInicio in: query required: true type: string format: date – name: dataPrevisaoFim in: query required: true type: string format: date – name: programacaoInternaOpcaoExterna in: query required: true type: boolean responses: 200: description: Ok schema: type: object required: – limiteDadosAtingido properties: limiteDadosAtingido: type: boolean description: ordensProducaoProgramacao: type: array items: type: object allOf: – #/definitions/recOrdensProducaoProgramacao description: default: description: Error response schema: #/definitions/genericError /rrs_remessa/queries/pesquisarProgramacaoComponentes: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoFilial – listaOPs properties: codigoEmpresa: type: integer format: int64 description: codigoFilial: type: integer format: int64 description: listaOPs: type: array items: type: object allOf: – #/definitions/recChaveOPBuscaComponentes minimum: 1 description: responses: 200: description: Ok schema: type: object required: – limiteDadosAtingido – listaComponentesProgramadosOP properties: limiteDadosAtingido: type: boolean description: listaComponentesProgramadosOP: type: array items: type: object allOf: – #/definitions/recOrdensProducaoComponentes minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa in: query required: true type: integer format: int64 – name: codigoFilial in: query required: true type: integer format: int64 – name: listaOPs in: query required: true type: array items: type: object allOf: – #/definitions/recChaveOPBuscaComponentes minimum: 1 responses: 200: description: Ok schema: type: object required: – limiteDadosAtingido – listaComponentesProgramadosOP properties: limiteDadosAtingido: type: boolean description: listaComponentesProgramadosOP: type: array items: type: object allOf: – #/definitions/recOrdensProducaoComponentes minimum: 1 description: default: description: Error response schema: #/definitions/genericError /rrs_remessa/queries/pesquisarRemessaRetornoRealizadoProduto: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoFilial properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Código da filial responses: 200: description: Ok schema: type: object required: – limiteDadosAtingido properties: limiteDadosAtingido: type: boolean description: listaRemessaRetornoProduto: type: array items: type: object allOf: – #/definitions/recRemessaRetornoProduto description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa in: query required: true type: integer format: int64 – name: codigoFilial in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – limiteDadosAtingido properties: limiteDadosAtingido: type: boolean description: listaRemessaRetornoProduto: type: array items: type: object allOf: – #/definitions/recRemessaRetornoProduto description: default: description: Error response schema: #/definitions/genericError /rrs_remessa/queries/pesquisarRemessaRetornoRealizadoComponente: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoFilial properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoFilial: type: integer format: int64 description: Código da filial responses: 200: description: Ok schema: type: object required: – limiteDadosAtingido properties: limiteDadosAtingido: type: boolean description: listaRemessaRetornoComponente: type: array items: type: object allOf: – #/definitions/recRemessaRetornoComponente description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa in: query required: true type: integer format: int64 – name: codigoFilial in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – limiteDadosAtingido properties: limiteDadosAtingido: type: boolean description: listaRemessaRetornoComponente: type: array items: type: object allOf: – #/definitions/recRemessaRetornoComponente description: default: description: Error response schema: #/definitions/genericError /rrs_remessa/queries/pesquisarPendenteSeparacao: post: description: Retorna lista de Ordens de Produção com NF pendentes para separação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoFilial – dataPrevisaoInicio – dataPrevisaoFim – dataEmissaoNotaDe – dataEmissaoNotaAte properties: codigoEmpresa: type: integer format: int64 description: codigoFilial: type: integer format: int64 description: codigoEstagio: type: array items: type: string description: codigoProduto: type: array items: type: string description: codigoDerivacao: type: array items: type: string description: codigoRecurso: type: array items: type: string description: dataPrevisaoInicio: type: string format: date description: dataPrevisaoFim: type: string format: date description: dataEmissaoNotaDe: type: string format: date description: dataEmissaoNotaAte: type: string format: date description: responses: 200: description: Ok schema: type: object required: – limiteDadosAtingido properties: limiteDadosAtingido: type: boolean description: ordensProducaoSeparacao: type: array items: type: object allOf: – #/definitions/recOrdensProducaoSeparacao description: default: description: Error response schema: #/definitions/genericError get: description: Retorna lista de Ordens de Produção com NF pendentes para separação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa in: query required: true type: integer format: int64 – name: codigoFilial in: query required: true type: integer format: int64 – name: codigoEstagio in: query type: array items: type: string – name: codigoProduto in: query type: array items: type: string – name: codigoDerivacao in: query type: array items: type: string – name: codigoRecurso in: query type: array items: type: string – name: dataPrevisaoInicio in: query required: true type: string format: date – name: dataPrevisaoFim in: query required: true type: string format: date – name: dataEmissaoNotaDe in: query required: true type: string format: date – name: dataEmissaoNotaAte in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – limiteDadosAtingido properties: limiteDadosAtingido: type: boolean description: ordensProducaoSeparacao: type: array items: type: object allOf: – #/definitions/recOrdensProducaoSeparacao description: default: description: Error response schema: #/definitions/genericError /rrs_remessa/queries/gerarRelatorioPendenteSeparacao: post: description: Gera relatório com os dados da OP tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoFilial – dadosPesquisa properties: codigoEmpresa: type: integer format: int64 description: codigoFilial: type: integer format: int64 description: dadosPesquisa: type: array items: type: object allOf: – #/definitions/recDadosPesquisaRelatorio minimum: 1 description: responses: 200: description: Ok schema: type: object required: – pdfBase64 properties: pdfBase64: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Gera relatório com os dados da OP tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoEmpresa in: query required: true type: integer format: int64 – name: codigoFilial in: query required: true type: integer format: int64 – name: dadosPesquisa in: query required: true type: array items: type: object allOf: – #/definitions/recDadosPesquisaRelatorio minimum: 1 responses: 200: description: Ok schema: type: object required: – pdfBase64 properties: pdfBase64: type: string description: default: description: Error response schema: #/definitions/genericError /rrs_remessa/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 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 /rrs_remessa/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 /rrs_remessa/actions/processarTerceirizacaoOPs: post: description: Processo de terceirização da OP tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoFilial properties: codigoEmpresa: type: integer format: int64 description: codigoFilial: type: integer format: int64 description: listaOPs: type: array items: type: object allOf: – #/definitions/recOrdensTerceirizacao description: responses: 200: description: Ok schema: type: object required: – sucess – msgReturn properties: sucess: type: boolean description: msgReturn: type: string description: default: description: Error response schema: #/definitions/genericError definitions: enumTipoOperacao: description: Estrutura enumerador do tipo de Operação type: string enum: – Interna – Externa 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 recEstagio: description: type: object required: – codigoEstagio – abreviaturaEstagio – descricaoEstagio properties: codigoEstagio: type: integer format: int64 description: abreviaturaEstagio: type: string description: descricaoEstagio: type: string description: recOperacao: description: type: object required: – codigoOperacao – abreviaturaOperacao – descricaoOperacao properties: codigoOperacao: type: string description: abreviaturaOperacao: type: string description: descricaoOperacao: type: string description: recProduto: description: type: object required: – codigoProduto – descricaoProduto properties: codigoProduto: type: string description: descricaoProduto: type: string description: recDerivacao: description: type: object required: – codigoProduto – codigoDerivacao – descricaoDerivacao properties: codigoProduto: type: string description: codigoDerivacao: type: string description: descricaoDerivacao: type: string description: recRecursoFornecedor: description: type: object required: – codigoFornecedor – nomeFornecedor properties: codigoFornecedor: type: integer format: int64 description: nomeFornecedor: type: string description: recServico: description: type: object required: – codigoServico – descricaoServico properties: codigoServico: type: string description: descricaoServico: type: string description: recChaveOP: description: Estrutura com chave da OP discriminator: _discriminator type: object required: – origemOP – numeroOP – _discriminator properties: origemOP: type: string description: numeroOP: type: integer format: int64 description: _discriminator: type: string description: recOrdens: description: Estrutura comum das ordens de produção allOf: – #/definitions/recChaveOP – type: object required: – codigoEstagio – abreviaturaEstagio – codigoOperacao – abreviaturaOperacao – codigoDerivacao – descricaoDerivacao – codigoRecursoFornecedor – descricaoRecursoFornecedor – codigoServico – descricaoServico – previsaoDataInicioEst – qtdePrevistaOrdem – qtdeRemeter – unidadeMedida – prioridade – tipoOperacao properties: codigoEstagio: type: integer format: int64 description: abreviaturaEstagio: type: string description: codigoOperacao: type: string description: abreviaturaOperacao: type: string description: codigoDerivacao: type: string description: descricaoDerivacao: type: string description: codigoRecursoFornecedor: type: integer format: int64 description: descricaoRecursoFornecedor: type: string description: codigoServico: type: string description: descricaoServico: type: string description: previsaoDataInicioEst: type: string format: date description: qtdePrevistaOrdem: type: number format: double description: qtdeRemeter: type: number format: double description: unidadeMedida: type: string description: prioridade: type: integer format: int64 description: tipoOperacao: type: string allOf: – #/definitions/enumTipoOperacao description: recChaveOPBuscaComponentes: description: allOf: – #/definitions/recChaveOP – type: object required: – codigoEstagio – qtdPrv properties: codigoEstagio: type: integer format: int64 description: qtdPrv: type: number format: double description: recOrdensProducao: description: Estrutura de dados das ordens de produção allOf: – #/definitions/recOrdens – type: object required: – codigoProduto – descricaoProduto properties: codigoProduto: type: string description: descricaoProduto: type: string description: recOrdensProducaoProgramacao: description: Estrutura das ordens de produção para programação allOf: – #/definitions/recOrdensProducao – type: object required: – opOpcaoInterna – qtdeRemetida properties: opOpcaoInterna: type: boolean description: qtdeRemetida: type: number format: double description: recOrdensProducaoComponentes: description: Estrutura de dados das ordens de produção – componentes allOf: – #/definitions/recOrdens – type: object required: – codigoComponente – descricaoComponente – qtdeRemetida – sequenciaComponente properties: codigoComponente: type: string description: descricaoComponente: type: string description: qtdeRemetida: type: number format: double description: sequenciaComponente: type: integer format: int64 description: recOrdensProducaoSeparacao: description: Estrutura das ordens de produção pendentes para separação allOf: – #/definitions/recOrdensProducao – type: object required: – notaFiscal – serieNota properties: notaFiscal: type: string description: serieNota: type: string description: recRemessaRetornoRealizado: description: Estrutura de remessa e retorno realizado discriminator: _discriminator type: object required: – codigoRecursoFornecedor – descricaoRecursoFornecedor – codigoProduto – descricaoProduto – codigoDerivacao – descricaoDerivacao – qtdePoderTerceiro – unidadeMedida – _discriminator properties: codigoRecursoFornecedor: type: integer format: int64 description: descricaoRecursoFornecedor: type: string description: codigoProduto: type: string description: descricaoProduto: type: string description: codigoDerivacao: type: string description: descricaoDerivacao: type: string description: qtdePoderTerceiro: type: number format: double description: Quantidade em poder de terceiro unidadeMedida: type: string description: _discriminator: type: string description: recComponenteProgramacao: description: Estrutra utilizada na hora da terceirização allOf: – #/definitions/recChaveOP – type: object required: – codigoEmpresa – codigoComponente – derivacaoComponente – quantidadeRemeter – sequenciaComponente properties: codigoEmpresa: type: integer format: int64 description: codigoComponente: type: string description: derivacaoComponente: type: string description: quantidadeRemeter: type: number format: double description: sequenciaComponente: type: integer format: int64 description: recOrdensTerceirizacao: description: allOf: – #/definitions/recChaveOP – type: object required: – codigoEstagio – quantidadeRemeter – codRecursoFornecedor – codigoServico – numeroPrioridade – movExternoInterno properties: codigoEstagio: type: integer format: int64 description: quantidadeRemeter: type: number format: double description: codRecursoFornecedor: type: integer format: int64 description: codigoServico: type: string description: numeroPrioridade: type: integer format: int64 description: Número da prioridade movExternoInterno: type: boolean description: Alimentado com verdadeiro quando a OP sofre alteração de externo para interno listaComponentes: type: array items: type: object allOf: – #/definitions/recComponenteProgramacao description: Lista dos compoentens que vão sofrer a programação recRemessaRetornoProduto: description: Estrutura de remessa e retorno dos produtos das OPs selecionadas allOf: – #/definitions/recRemessaRetornoRealizado – type: object required: – qtdeRemetida – qtdeRetornada properties: qtdeRemetida: type: number format: double description: qtdeRetornada: type: number format: double description: recRemessaRetornoComponente: description: Estrutura de remessa e retorno dos componentes das OPs selecionadas allOf: – #/definitions/recRemessaRetornoRealizado – type: object recDadosPesquisaRelatorio: description: allOf: – #/definitions/recChaveOP – type: object required: – codigoEstagio – numeroNota – serieNota properties: codigoEstagio: type: integer format: int64 description: numeroNota: type: integer format: int64 description: serieNota: type: string description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: 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 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