wms_custom

Expedição (expedition)

18 views 29/06/2021 10/09/2021 integrador 0

2.0info: 1.1.2 Expedição description: Eventos e Pontos de Extensão do WMS – Expedição x-senior-domain: Camada de Customização do WMS x-senior-domain-path: wms_custom x-senior-service-path: expedition 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/wms_customsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /expedition/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 /expedition/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 /expedition/actions/liberateShipmentInvoice: post: description: Liberar Nota Fiscal para Roterização THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – notasFiscais – armazem – data – usuario – status properties: notasFiscais: type: array items: type: object allOf: #/definitions/notaFiscal minimum: 1 description: Notas Fiscais armazem: type: object allOf: #/definitions/entidade description: Armazém data: type: string format: date-time description: Data usuario: type: object allOf: #/definitions/usuario description: Usuário status: type: string allOf: – #/definitions/statusLiberation description: Status responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /expedition/actions/revokeShipmentInvoiceLiberated: post: description: Voltar Nota Fiscal para Pendnete de Roterização THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – notasFiscais – armazem – data – usuario – status properties: notasFiscais: type: array items: type: object allOf: #/definitions/notaFiscal minimum: 1 description: Notas Fiscais armazem: type: object allOf: #/definitions/entidade description: Armazém data: type: string format: date-time description: Data usuario: type: object allOf: #/definitions/usuario description: Usuário status: type: string allOf: – #/definitions/statusLiberation description: Status responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /expedition/actions/linkBatches: post: description: Vincular/Desvincular Lotes na Liberação THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – notaFiscal – armazem – depositante – lotes – acao – data – usuario properties: notaFiscal: type: object allOf: #/definitions/notaFiscal description: Nota Fiscal armazem: type: object allOf: #/definitions/entidade description: Armazém depositante: type: object allOf: #/definitions/entidade description: Depositante lotes: type: array items: type: object allOf: #/definitions/loteSep minimum: 1 description: Lotes acao: type: string allOf: – #/definitions/linkedAction description: Ação data: type: string format: date-time description: Data usuario: type: object allOf: #/definitions/usuario description: Usuário responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /expedition/actions/linkBatchNumbers: post: description: Vincular/Desvincular Lotes Ind. na Liberação THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – armazem – lotes – acao – data – usuario properties: armazem: type: object allOf: #/definitions/entidade description: Armazém lotes: type: array items: type: object allOf: #/definitions/loteSepInd minimum: 1 description: Lotes acao: type: string allOf: – #/definitions/linkedAction description: Ação data: type: string format: date-time description: Data usuario: type: object allOf: #/definitions/usuario description: Usuário responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /expedition/actions/changeCuttingLimit: post: description: Alterar limite de Corte THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – notasFiscais – armazem – limite – data – usuario properties: notasFiscais: type: array items: type: object allOf: #/definitions/notaFiscal minimum: 1 description: Notas Fiscais armazem: type: object allOf: #/definitions/entidade description: Armazém limite: type: number format: double description: Limite data: type: string format: date-time description: Data usuario: type: object allOf: #/definitions/usuario description: Usuário responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /expedition/actions/definePTL: post: description: Marcar/Desmarcar PTL THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – notasFiscais – armazem – data – usuario – acao properties: notasFiscais: type: array items: type: object allOf: #/definitions/notaFiscal minimum: 1 description: Notas Fiscais armazem: type: object allOf: #/definitions/entidade description: Armazém data: type: string format: date-time description: Data usuario: type: object allOf: #/definitions/usuario description: Usuário acao: type: string allOf: – #/definitions/definedAction description: Ação responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /expedition/actions/defineAlertPoint: post: description: Definir Ponto de Alerta THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – notaFiscal – armazem – depositante – data – usuario – alerta properties: notaFiscal: type: object allOf: #/definitions/notaFiscal description: Nota Fiscal armazem: type: object allOf: #/definitions/entidade description: Armazém depositante: type: object allOf: #/definitions/entidade description: Depositante data: type: string format: date-time description: Data usuario: type: object allOf: #/definitions/usuario description: Usuário alerta: type: string description: Alerta responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /expedition/actions/authorizeShipmentWithCutting: post: description: Autorizar expedição com corte THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – notasFiscais – armazem – data – usuario properties: notasFiscais: type: array items: type: object allOf: #/definitions/notaFiscal minimum: 1 description: Notas Fiscais armazem: type: object allOf: #/definitions/entidade description: Armazém data: type: string format: date-time description: Data usuario: type: object allOf: #/definitions/usuario description: Usuário responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /expedition/actions/sendToQuarantine: post: description: Enviar para Quarentena THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – notasFiscais – armazem – data – usuario properties: notasFiscais: type: array items: type: object allOf: #/definitions/notaFiscal minimum: 1 description: Notas Fiscais armazem: type: object allOf: #/definitions/entidade description: Armazém data: type: string format: date-time description: Data usuario: type: object allOf: #/definitions/usuario description: Usuário responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /expedition/actions/requestBatchReservation: post: description: Solicitar Reserva de Lote THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – notasFiscais – armazem – data – usuario properties: notasFiscais: type: array items: type: object allOf: #/definitions/notaFiscal minimum: 1 description: Notas Fiscais armazem: type: object allOf: #/definitions/entidade description: Armazém data: type: string format: date-time description: Data usuario: type: object allOf: #/definitions/usuario description: Usuário responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /expedition/actions/cancelBatchReservation: post: description: Cancelar Reserva de Lote THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – notasFiscais – armazem – data – usuario properties: notasFiscais: type: array items: type: object allOf: #/definitions/notaFiscal minimum: 1 description: Notas Fiscais armazem: type: object allOf: #/definitions/entidade description: Armazém data: type: string format: date-time description: Data usuario: type: object allOf: #/definitions/usuario description: Usuário responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /expedition/actions/generateWave: post: description: Geração de Onda THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – titulo – armazem – configuracaoOnda – notasFiscais – docas – data – usuario properties: titulo: type: string description: Título da Onda armazem: type: object allOf: #/definitions/entidade description: Armazem configuracaoOnda: type: object allOf: #/definitions/configuracaoOnda description: Configuração da Onda notasFiscais: type: array items: type: object allOf: #/definitions/notaFiscal minimum: 1 description: Notas / Pedidos docas: type: array items: type: object allOf: #/definitions/local minimum: 1 description: Docas colmeias: type: array items: type: object allOf: #/definitions/colmeia description: Colméias data: type: string format: date-time description: Data usuario: type: object allOf: #/definitions/usuario description: Usuário responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /expedition/actions/liberateWave: post: description: Liberação da Onda THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – armazem – ondas – data – usuario properties: armazem: type: object allOf: #/definitions/entidade description: Armazem ondas: type: array items: type: object allOf: #/definitions/onda minimum: 1 description: Ondas data: type: string format: date-time description: Data usuario: type: object allOf: #/definitions/usuario description: Usuário responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /expedition/actions/removeInvoiceWave: post: description: Retirar Nota/Pedido da Onda THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idOnda – codigo – armazem – notasFiscais – data – usuario properties: idOnda: type: integer format: int64 description: Id da Onda codigo: type: string description: Código Interno armazem: type: object allOf: #/definitions/entidade description: Armazem notasFiscais: type: array items: type: object allOf: #/definitions/notaFiscal minimum: 1 description: Nota Fiscal data: type: string format: date-time description: Data usuario: type: object allOf: #/definitions/usuario description: Usuário responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /expedition/actions/cancelWave: post: description: Cancelar Onda THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – armazem – ondas – data – usuario properties: armazem: type: object allOf: #/definitions/entidade description: Armazem ondas: type: array items: type: object allOf: #/definitions/onda minimum: 1 description: Ondas data: type: string format: date-time description: Data usuario: type: object allOf: #/definitions/usuario description: Usuário responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /expedition/actions/processInvoice: post: description: Processar Nota/Pedido THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – armazem – notasFiscais – data – usuario properties: armazem: type: object allOf: #/definitions/entidade description: Armazem notasFiscais: type: array items: type: object allOf: #/definitions/notaFiscal minimum: 1 description: Nota Fiscal data: type: string format: date-time description: Data usuario: type: object allOf: #/definitions/usuario description: Usuário responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /expedition/actions/processWave: post: description: Processar Onda THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idOnda – codigo – armazem – data – usuario properties: idOnda: type: integer format: int64 description: Id da Onda codigo: type: string description: Código Interno armazem: type: object allOf: #/definitions/entidade description: Armazem data: type: string format: date-time description: Data usuario: type: object allOf: #/definitions/usuario description: Usuário responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError /expedition/actions/changeUserWaveSeparation: post: description: Trocar Usuário THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idOnda – codigo – tipoAlteracao – identificador – armazem – data – usuario – usuarioNovo properties: idOnda: type: integer format: int64 description: Id da Onda codigo: type: string description: Código Interno tipoAlteracao: type: string allOf: – #/definitions/tipoAlteracao description: Tipo de Alteração identificador: type: integer format: int64 description: Indetificado armazem: type: object allOf: #/definitions/entidade description: Armazem data: type: string format: date-time description: Data usuario: type: object allOf: #/definitions/usuario description: Usuário Alteração usuarioNovo: type: object allOf: #/definitions/usuario description: Usuário Novo responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Retorno do Serviço message: type: string description: Mensagem do Serviço default: description: Error response schema: #/definitions/genericError definitions: estadoLote: description: Estado do Lote type: string enum: – Normal – Danificado – Vencido statusLiberation: description: Ação ao vincular Nota Fiscal type: string enum: – Liberated – Pending – Unlliberated linkedAction: description: Ação ao vincular Lote na Liberação type: string enum: – Linked – Unlinked definedAction: description: Ação ao marcar PTL type: string enum: – Defined – Undefined tipoExpedicao: description: Tipo de Expedição type: string enum: – Onda – Carga tipoAlteracao: description: Tipo de Alteração de Usuário type: string enum: – Tarefa – Onda – Nota 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 entidade: description: Entidade type: object required: – cnpj properties: cnpj: type: string description: CNPJ ie: type: string description: Inscrição Estadual usuario: description: Usuário type: object required: – nomeUsuario properties: nomeUsuario: type: string description: Nome Usuário loginSeniorX: type: string description: Login SeniorX notaFiscal: description: Nota Fiscal type: object required: – numero – depositante properties: numero: type: integer format: int64 description: Número da Nota Fiscal serie: type: string description: Série da Nota Fiscal numPedido: type: string description: Número do Pedido do Fornecedor depositante: type: object allOf: #/definitions/entidade description: Depositante produto: description: Produto type: object required: – idProduto – codProduto – descricao properties: idProduto: type: integer format: int64 description: Id do Produto codProduto: type: string description: Código do Produto descricao: type: string description: Descrição embalagem: description: Embalagem type: object required: – barra – descrReduzida – fator properties: barra: type: string description: Barra descrReduzida: type: string description: Descrição Reduzida fator: type: integer format: int64 description: Fator de Conversão lote: description: Lote type: object required: – idLote – produto – embalagem – estado – qtde – depositante properties: idLote: type: integer format: int64 description: Id do Lote produto: type: object allOf: #/definitions/produto description: Produto loteIndustria: type: string description: Lote Indústria embalagem: type: object allOf: #/definitions/embalagem description: Embalagem dtFabricacao: type: string format: date-time description: Data de Fabricação dtVencimento: type: string format: date-time description: Data de Vencimento estado: type: string allOf: – #/definitions/estadoLote description: Estado do Lote qtde: type: integer format: int64 description: Quantidade depositante: type: object allOf: #/definitions/entidade description: Depositante notaFiscal: type: array items: type: object allOf: #/definitions/notaFiscal description: Nota Fiscal loteSep: description: Lotes Separação type: object required: – lote – qtde properties: lote: type: object allOf: #/definitions/lote description: Lotes qtde: type: integer format: int64 description: Quantidade loteSepInd: description: Lotes Indústria Separação type: object required: – notaFiscal – loteIndustria – produto – quantidade properties: notaFiscal: type: object allOf: #/definitions/notaFiscal description: Nota Fiscal notaFiscalCobertura: type: object allOf: #/definitions/notaFiscal description: Nota Fiscal Cobertura loteIndustria: type: string description: Lote Industria produto: type: object allOf: #/definitions/produto description: Produto quantidade: type: integer format: int64 description: Quantidade local: description: Local type: object required: – idArmazem – idLocal properties: idArmazem: type: integer format: int64 description: Id Armazém idLocal: type: string description: Id Local setor: type: object allOf: #/definitions/setor description: Setor regiao: type: object allOf: #/definitions/regiao description: Região setor: description: Setor type: object required: – idSetor – descricao properties: idSetor: type: integer format: int64 description: Id do Setor descricao: type: string description: Descrição regiao: description: Região type: object required: – idRegiao – descricao properties: idRegiao: type: integer format: int64 description: Id da Região descricao: type: string description: Descrição colmeia: description: Colmeia type: object required: – idColmeia – cor properties: idColmeia: type: integer format: int64 description: Id da Colmeia cor: type: string description: Cor configuracaoOnda: description: Configuração de Onda type: object required: – idConfiguracaoOnda – descricao – tipoExpedicao properties: idConfiguracaoOnda: type: integer format: int64 description: Id da Configuração de Onda descricao: type: string description: Descrição tipoExpedicao: type: string allOf: – #/definitions/tipoExpedicao description: Tipo Expedição onda: description: Ondas type: object required: – idOnda – codigo – configuracaoOnda properties: idOnda: type: integer format: int64 description: Id da Onda codigo: type: string description: Código Interno configuracaoOnda: type: object allOf: #/definitions/configuracaoOnda description: Configuração da Onda 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