Mais pesquisados:Customização, Tutorial, Documentação

tiposocorrencia

305 views 0 07/11/2018 Atualizado em 20/08/2024 integrador

2.0info: 4.2.1 tiposocorrencia x-senior-domain: tmsentregas x-senior-domain-path: tmsentregas x-senior-service-path: tiposocorrencia contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/tmsentregassecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /tiposocorrencia/queries/buscaTiposOcorrencia: post: description: Pesquisa de Tipos de Ocorrência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdTipoOcorrenciaIni properties: cdTipoOcorrenciaIni: type: integer format: int64 description: Código identificador do tipo de ocorrência. Caso informado valor menor ou igual a zero, retorna todos. cdTipoOcorrenciaFim: type: integer format: int64 description: inAtividade: type: integer format: int64 description: inEntregue: type: integer format: int64 description: dsTipoOcorrencia: type: string description: inAtivo: type: integer format: int64 description: 0-Inativo; 1-Ativo inLibAtvNovaRoteirizacao: type: integer format: int64 description: 0-Não; 1-Sim inLibAtvFase: type: integer format: int64 description: Caso libere apontamento, em qual momento: 0-No Apontamento da ocorrência; 1-Na finalização da rota inValidaDocumento: type: boolean description: Validar documento (CPF/RG) default: false responses: 200: description: Ok schema: type: object required: – tiposOcorrencia properties: tiposOcorrencia: type: array items: type: object allOf: – #/definitions/tipoOcorrenciaRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Tipos de Ocorrência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdTipoOcorrenciaIni description: Código identificador do tipo de ocorrência. Caso informado valor menor ou igual a zero, retorna todos. in: query required: true type: integer format: int64 – name: cdTipoOcorrenciaFim description: in: query type: integer format: int64 – name: inAtividade description: in: query type: integer format: int64 – name: inEntregue description: in: query type: integer format: int64 – name: dsTipoOcorrencia description: in: query type: string – name: inAtivo description: 0-Inativo; 1-Ativo in: query type: integer format: int64 – name: inLibAtvNovaRoteirizacao description: 0-Não; 1-Sim in: query type: integer format: int64 – name: inLibAtvFase description: Caso libere apontamento, em qual momento: 0-No Apontamento da ocorrência; 1-Na finalização da rota in: query type: integer format: int64 – name: inValidaDocumento description: Validar documento (CPF/RG) in: query type: boolean responses: 200: description: Ok schema: type: object required: – tiposOcorrencia properties: tiposOcorrencia: type: array items: type: object allOf: – #/definitions/tipoOcorrenciaRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tiposocorrencia/queries/buscaSituacoesTipoOcorrencia: post: description: Pesquisa de Situações do Tipo de Ocorrência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdSituacao – inAtividade properties: cdSituacao: type: integer format: int64 description: Código identificador da Situação do Tipo de Ocorrência. Caso informado valor menor que zero, retorna todos. inAtividade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/situacaoOcorrenciaRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Situações do Tipo de Ocorrência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdSituacao description: Código identificador da Situação do Tipo de Ocorrência. Caso informado valor menor que zero, retorna todos. in: query required: true type: integer format: int64 – name: inAtividade description: in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/situacaoOcorrenciaRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tiposocorrencia/queries/buscaLibAtvNovaRoteirizacao: post: description: Combo para verificar se a atividade pode participar de novas roteirizações. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdSituacao properties: inLibAtvNovaRoteirizacao: type: integer format: int64 description: Código condicional – 0: Não – 1: Sim cdSituacao: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/libAtvNovaRoteirizacaoRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Combo para verificar se a atividade pode participar de novas roteirizações. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: inLibAtvNovaRoteirizacao description: Código condicional – 0: Não – 1: Sim in: query type: integer format: int64 – name: cdSituacao description: in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/libAtvNovaRoteirizacaoRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tiposocorrencia/queries/buscaLibAtvFase: post: description: Combo para verificar em que momento a atividade é liberada. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – inLibAtvFase properties: inLibAtvFase: type: integer format: int64 description: 0: Apontamento da ocorrência – 1: Finalização da rota inLibAtvNovaRoteirizacao: type: integer format: int64 description: Código condicional – 0: Não – 1: Sim responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/libAtvFaseRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Combo para verificar em que momento a atividade é liberada. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: inLibAtvFase description: 0: Apontamento da ocorrência – 1: Finalização da rota in: query required: true type: integer format: int64 – name: inLibAtvNovaRoteirizacao description: Código condicional – 0: Não – 1: Sim in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/libAtvFaseRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tiposocorrencia/queries/buscaCamposObrigTipoOcorrencia: post: description: Pesquisa de Campos Obrigatórios do Tipo de Ocorrência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – inExibeContatoFone properties: inExibeContatoFone: type: integer format: int64 description: Código identificador. Caso informado valor menor que zero, retorna todos. responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/inExibeContatoFoneRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Campos Obrigatórios do Tipo de Ocorrência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: inExibeContatoFone description: Código identificador. Caso informado valor menor que zero, retorna todos. in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/inExibeContatoFoneRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tiposocorrencia/queries/buscaOpcoesOcorrencia: post: description: Pesquisa de Opções de Ocorrência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – inOpcaoOcorr properties: inOpcaoOcorr: type: integer format: int64 description: Código identificador da Opção da Ocorrência inAtividade: type: integer format: int64 description: Tipo da atividade responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/opcaoOcorrRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Opções de Ocorrência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: inOpcaoOcorr description: Código identificador da Opção da Ocorrência in: query required: true type: integer format: int64 – name: inAtividade description: Tipo da atividade in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/opcaoOcorrRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tiposocorrencia/queries/buscaInAtivoOcorrencia: post: description: Inativo/Ativo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: inAtivo: type: integer format: int64 description: 0: Inativo, 1: Ativo consulta: type: boolean description: responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/inAtivoRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Inativo/Ativo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: inAtivo description: 0: Inativo, 1: Ativo in: query type: integer format: int64 – name: consulta description: in: query type: boolean responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/inAtivoRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tiposocorrencia/queries/integracoesAtividadesEmAndamento: post: description: Retorna a quantidade de integrações de atividades em andamento, sem data de fim. Para cada integração pendente é feito o disparo do sinal integracaoAtividadeEmAndamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – quantidade properties: quantidade: type: integer format: int64 description: Quantidade de integrações de atividades em andamento minimum: 0 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de integrações de atividades em andamento, sem data de fim. Para cada integração pendente é feito o disparo do sinal integracaoAtividadeEmAndamento tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – quantidade properties: quantidade: type: integer format: int64 description: Quantidade de integrações de atividades em andamento minimum: 0 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tiposocorrencia/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/serviceHealthStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/serviceHealthStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tiposocorrencia/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tiposocorrencia/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tiposocorrencia/actions/insereTiposOcorrencia: post: description: Cadastro de Tipos de Ocorrência (Histórico de Entrega) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – descricao – dsApelidoWAP – cdSituacao – cdTpAtividade – inAnexComprEntrDigit – inSolicAssinaturaMOB – inExigeObs – inAtivo properties: descricao: type: string description: Descrição do Tipo de Ocorrência dsApelidoWAP: type: string description: Apelido para a descrição do tipo de ocorrência cdSituacao: type: integer format: int64 description: Situação da Mercadoria inExibeContatoFone: type: integer format: int64 description: 0-Não exigir; 1-Exigir nome e telefone; 2-Exigir somente nome; 3-Exigir nome e Documento (CPF/RG); cdTpAtividade: type: integer format: int64 description: Tipo de Atividade: 1-Coleta; 2-Entrega; 3-Serviço inAnexComprEntrDigit: type: integer format: int64 description: Comprovante de entrega: 0-Não utiliza; 1-Opcional; 2-Obrigatório inSolicAssinaturaMOB: type: integer format: int64 description: Assinatura: 0-Não utiliza; 1-Opcional; 2-Obrigatório inExigeObs: type: integer format: int64 description: Observação: 0-Não utiliza; 1-Opcional; 2-Obrigatório inAtivo: type: integer format: int64 description: 0-Inativo; 1-Ativo inLibAtvNovaRoteirizacao: type: integer format: int64 description: 0-Não; 1-Sim inLibAtvFase: type: integer format: int64 description: Caso libere apontamento, em qual momento: 0-No Apontamento da ocorrência; 1-Na finalização da rota inExigeDadosComplementares: type: string allOf: – #/definitions/enumeradorExigeDadosComplementares description: 0-Não utiliza; 1-Opcional; 2-Obrigatório inExigeDetalhesEntrega: type: string allOf: – #/definitions/enumeradorExigeDetalhesEntrega description: 0-Não utiliza; 1-Opcional; 2-Obrigatório inGerarEtiqueta: type: integer format: int64 description: Indica se gera impressão de etiqueta de coleta inValidaDocumento: type: boolean description: Validar documento (CPF/RG) default: false validarComprovante: type: boolean description: Validar foto do comprovante de entrega default: false utilizaApp: type: boolean description: Indica se o tipo de ocorrência será utilizado no App default: true responses: 200: description: Ok schema: type: object required: – ok – dsErro – cdTipoOcorrencia properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: Descrição do erro cdTipoOcorrencia: type: integer format: int64 description: Código identificador do Tipo de Ocorrência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tiposocorrencia/actions/alteraTiposOcorrencia: post: description: Edição de Tipo de Ocorrência tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigo – dsApelidoWAP – cdSituacao – cdTpAtividade – inAnexComprEntrDigit – inSolicAssinaturaMOB – inExigeObs – inAtivo properties: codigo: type: integer format: int64 description: Código identificador do Tipo de Ocorrência descricao: type: string description: Descrição do Tipo de Ocorrência dsApelidoWAP: type: string description: Apelido para a descrição do tipo de ocorrência cdSituacao: type: integer format: int64 description: Situação da Marcadoria inExibeContatoFone: type: integer format: int64 description: 0-Não exigir;1-Exigir nome e telefone;2-Exigir somente nome;3-Exigir nome e RG; cdTpAtividade: type: integer format: int64 description: Tipo de Atividade: 1-Coleta; 2-Entrega; inAnexComprEntrDigit: type: integer format: int64 description: Comprovante de entrega: 0-opcional; 1-obrigatório; 2-não utiliza; inSolicAssinaturaMOB: type: integer format: int64 description: Assinatura: 0-opcional, 1-obrigatório, 2-não utiliza inExigeObs: type: integer format: int64 description: Observação: 0-opcional, 1-obrigatório, 2-não utiliza inAtivo: type: integer format: int64 description: 0-Inativo; 1-Ativo inLibAtvNovaRoteirizacao: type: integer format: int64 description: 0-Não; 1-Sim inLibAtvFase: type: integer format: int64 description: Caso libere apontamento, em qual momento: 0-No Apontamento da ocorrência; 1-Na finalização da rota inExigeDadosComplementares: type: string allOf: – #/definitions/enumeradorExigeDadosComplementares description: 0-Não utiliza; 1-Opcional; 2-Obrigatório inExigeDetalhesEntrega: type: string allOf: – #/definitions/enumeradorExigeDetalhesEntrega description: 0-Não utiliza; 1-Opcional; 2-Obrigatório inGerarEtiqueta: type: integer format: int64 description: Indica se gera impressão de etiqueta de coleta inValidaDocumento: type: boolean description: Validar documento (CPF/RG) default: false validarComprovante: type: boolean description: Validar foto do comprovante de entrega default: false utilizaApp: type: boolean description: Indica se tipo de ocorrência será utilizado no App default: true responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: Descrição do erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tiposocorrencia/actions/deletaTiposOcorrencia: post: description: Exclusão de Tipo de Ocorrência tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdTipoOcorrencia – cdTpAtividade properties: cdTipoOcorrencia: type: integer format: int64 description: Código identificador do Tipo de Ocorrência cdTpAtividade: type: integer format: int64 description: inValidaDocumento: type: boolean description: Validar documento (CPF/RG) default: false responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: Descrição do erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tiposocorrencia/actions/inicializaBaseDados: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tiposocorrencia/signals/integracaoAtividadeEmAndamento: post: description: Cada disparo de sinal corresponde a uma integração de atividade em andamento. Ocorre após a chamada da primitiva integracoesAtividadesEmAndamento tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericErrordefinitions: enumeradorExigeDadosComplementares: description: type: string enum: – NAO_UTILIZA – OPCIONAL – OBRIGATORIO enumeradorExigeDetalhesEntrega: description: type: string enum: – NAO_UTILIZA – OPCIONAL – OBRIGATORIO serviceHealthStatus: description: Define o Status do serviço type: string enum: – UP – DOWN 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 tipoOcorrenciaRec: description: type: object required: – codigo – descricao – dsApelidoWAP – cdSituacao – dsSituacao – cdTpAtividade – dsTpAtividade – inAtivo properties: codigo: type: integer format: int64 description: descricao: type: string description: dsApelidoWAP: type: string description: cdSituacao: type: integer format: int64 description: dsSituacao: type: string description: inExibeContatoFone: type: integer format: int64 description: dsInExibeContatoFone: type: string description: cdTpAtividade: type: integer format: int64 description: dsTpAtividade: type: string description: inAnexComprEntrDigit: type: integer format: int64 description: inSolicAssinaturaMOB: type: integer format: int64 description: inExigeObs: type: integer format: int64 description: inAtivo: type: integer format: int64 description: 0: Inativo, 1: Ativo inLibAtvNovaRoteirizacao: type: integer format: int64 description: 0: Não, 1: Sim inLibAtvFase: type: integer format: int64 description: 0: Apontamento da ocorrência – 1: Finalização da rota inExigeDadosComplementares: type: string allOf: – #/definitions/enumeradorExigeDadosComplementares description: inExigeDetalhesEntrega: type: string allOf: – #/definitions/enumeradorExigeDetalhesEntrega description: inGerarEtiqueta: type: integer format: int64 description: Indica se gera impressão de etiqueta de coleta inValidaDocumento: type: boolean description: Validar documento (CPF/RG) default: false validarComprovante: type: boolean description: default: false utilizaApp: type: boolean description: default: true createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data última modificação situacaoOcorrenciaRec: description: type: object required: – cdSituacao – dsSituacao properties: cdSituacao: type: integer format: int64 description: dsSituacao: type: string description: inExibeContatoFoneRec: description: type: object required: – inExibeContatoFone – dsInExibeContatoFone properties: inExibeContatoFone: type: integer format: int64 description: dsInExibeContatoFone: type: string description: tipoAtividadeRec: description: type: object required: – cdTpAtividade – dsTpAtividade properties: cdTpAtividade: type: integer format: int64 description: dsTpAtividade: type: string description: opcaoOcorrRec: description: type: object required: – inOpcaoOcorr – dsOpcaoOcorr properties: inOpcaoOcorr: type: integer format: int64 description: dsOpcaoOcorr: type: string description: inAtivoRec: description: type: object required: – inAtivo – dsAtivo properties: inAtivo: type: integer format: int64 description: dsAtivo: type: string description: libAtvNovaRoteirizacaoRec: description: type: object required: – inLibAtvNovaRoteirizacao – dsLibAtvNovaRoteirizacao properties: inLibAtvNovaRoteirizacao: type: integer format: int64 description: dsLibAtvNovaRoteirizacao: type: string description: libAtvFaseRec: description: type: object required: – inLibAtvFase – dsLibAtvFase properties: inLibAtvFase: type: integer format: int64 description: 0: Apontamento da ocorrência – 1: Finalização da rota dsLibAtvFase: type: string description: checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/serviceHealthStatus description: Status do healthcheck 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
Mais pesquisados:Customização, Tutorial, Documentação