2.0info: 2.1.0 prescription_integration_hub description: Receitário Agronômico x-senior-domain: agro x-senior-domain-path: agro x-senior-service-path: prescription_integration_hub 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/agrosecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /prescription_integration_hub/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/upDown description: Status geral do serviços 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/upDown description: Status geral do serviços 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 /prescription_integration_hub/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 /prescription_integration_hub/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/queries/exportE070fil: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/queries/exportIntegrationConfig: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/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 /prescription_integration_hub/actions/cidascDataLoad: post: description: Inicializa a carga de dados do Cidasc tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cidascDataLoadId – controlCode – companyId – branchId properties: cidascDataLoadId: type: string description: Id da carga de dados controlCode: type: integer format: int64 description: Código de controle do evento companyId: type: string description: Id da empresa branchId: type: string description: Id da filial responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/actions/importE070fil: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/actions/importIntegrationConfig: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/signals/sendPrescriptionToSisDev: post: description: Endpoint para envio de receituário agronômico para o SisDev tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – prescriptionIssuanceId – input properties: eventControlItemId: type: string description: Id do evento prescriptionIssuanceId: type: string description: Id da emissão da receita input: type: object allOf: – #/definitions/sisDevPrescriptionIssuance description: Json com os dados do receituário agronômico responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/signals/sendPrescriptionToCidasc: post: description: Endpoint para envio de receituário agronômico para o Cidasc tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – prescriptionIssuanceId – input properties: eventControlItemId: type: string description: Id do evento prescriptionIssuanceId: type: string description: Id da emissão da receita input: type: object allOf: – #/definitions/cidascPrescriptionIssuance description: Json com os dados do receituário agronômico responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/signals/cancelCidascPrescription: post: description: Endpoint para cancelar o envio do receituário para o Cidasc tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – prescriptionIssuanceId – input properties: eventControlItemId: type: string description: Id do evento prescriptionIssuanceId: type: string description: Id da emissão da receita input: type: object allOf: – #/definitions/cidascCancelIssuance description: Json com os dados do cancelamento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/signals/sendDataLoadPrescription: post: description: Carrega dados de receita agronômica tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: filterDate: type: string format: date description: Data da ultima atualização responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/signals/sendPrescriptionToOcr: post: description: Integração com OCR para receituário agronômico tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – logIntegrationOcrId – ocrData properties: logIntegrationOcrId: type: string description: id do log de integração ocrData: type: object allOf: – #/definitions/ocrData description: Dados do receituário agronômico responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/events/importE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/events/exportE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/events/importE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/events/exportE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/events/importIntegrationConfigEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/events/exportIntegrationConfigEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/entities/e070emp: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/entities/e070emp/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/entities/e070fil: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/entities/e070fil/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/entities/integrationConfig: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/integrationConfig responses: 200: description: The created resource schema: #/definitions/integrationConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/integrationConfig responses: 200: description: The created resource schema: #/definitions/integrationConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/integrationConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/entities/integrationConfig/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editIntegrationConfig responses: 200: description: Ok schema: #/definitions/editIntegrationConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/integrationConfig responses: 200: description: Ok schema: #/definitions/integrationConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/integrationConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /prescription_integration_hub/entities/integrationConfig/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/integrationConfig responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: dataLoadPrescriptionType: type: string enum: – FORMULATION – ACTIVE_PRINCIPLE – PRODUCT_TYPE – BULLETIN – FINALIZE description: Tipo de carga de dados de receita agronômica: * `FORMULATION` – Formulação * `ACTIVE_PRINCIPLE` – Princípio Ativo * `PRODUCT_TYPE` – Tipo de Produto * `BULLETIN` – Bula * `FINALIZE` – Finalizar integração dataLoadCidascType: type: string enum: – CULTURE – PEST – PRODUCT – MEASURE_UNIT – COMPOSED_MEASURE_UNIT description: Tipo de carga de dados do CIDASC: * `CULTURE` – Cultura * `PEST` – Praga * `PRODUCT` – Defensivo * `MEASURE_UNIT` – Unidade de medida * `COMPOSED_MEASURE_UNIT` – Unidade de medida composta eventOperation: type: string enum: – SIS_DEV_INTEGRATION – PRESCRIPTION_DATA_LOAD – CIDASC_DATA_LOAD_CULTURE – CIDASC_DATA_LOAD_PEST – CIDASC_DATA_LOAD_PRODUCT – CIDASC_DATA_LOAD_MEASURE_UNIT – CIDASC_DATA_LOAD_COMPOSED_MEASURE_UNIT description: Tipo da operação do evento: * `SIS_DEV_INTEGRATION` – Integração com o SisDev * `PRESCRIPTION_DATA_LOAD` – Carga de dados de receita agronômica * `CIDASC_DATA_LOAD_CULTURE` – Carga de dados do Cidasc – Cultura * `CIDASC_DATA_LOAD_PEST` – Carga de dados do Cidasc – Praga * `CIDASC_DATA_LOAD_PRODUCT` – Carga de dados do Cidasc – Produto * `CIDASC_DATA_LOAD_MEASURE_UNIT` – Carga de dados do Cidasc – Unidade de medida * `CIDASC_DATA_LOAD_COMPOSED_MEASURE_UNIT` – Carga de dados do Cidasc – Unidade de medida composta eventOrigin: type: string enum: – PRESCRIPTION_INTEGRATION_HUB – AGRONOMIC_PRESCRIPTION description: Evento de origem: * `PRESCRIPTION_INTEGRATION_HUB` – Integrador do Receituário Agronômico * `AGRONOMIC_PRESCRIPTION` – Receituário Agronômico eventStatus: type: string enum: – PENDING – PROCESSING – SUCCESS – FAILED – CANCELED description: Status do evento: * `PENDING` – Pendente * `PROCESSING` – Processado * `SUCCESS` – Sucesso * `FAILED` – Falha * `CANCELED` – Cancelado upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down authType: type: string enum: – BEARER – BASIC – API_KEY – OAUTH2 description: Tipo de autenticação para serviços externos: * `BEARER` – Bearer * `BASIC` – Basic * `API_KEY` – API Key * `OAUTH2` – OAuth2 integrationServiceName: type: string enum: – SIS_DEV_PRESCRIPTION – CIDASC_PRESCRIPTION – NEW_PRESCRIPTION – AGRONOMIC_PRESCRIPTION_OCR description: Nome do serviço de integração: * `SIS_DEV_PRESCRIPTION` – Envio de receituário agronômico ao SisDev * `CIDASC_PRESCRIPTION` – Envio de receituário agronômico ao Cidasc * `NEW_PRESCRIPTION` – Integração com o NovoReceituário * `AGRONOMIC_PRESCRIPTION_OCR` – Receita agronômica a partir de OCR integrationResult: type: string enum: – SUCCESS – ERROR – CANCELED description: Resultado da integração com o órgão responsável: * `SUCCESS` – Sucesso no envio * `ERROR` – Falha no envio * `CANCELED` – Cancelado com sucesso userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error createEvents: description: DTO do Endpoint genérico de criação de eventos type: object required: – eventControl – eventControlItems properties: eventControl: type: object allOf: – #/definitions/eventControlReceived description: Entidade Cabeçalho dos Eventos eventControlItems: type: array items: type: object allOf: – #/definitions/eventControlItemReceived minimum: 1 description: Lista de itens de controle de eventos eventControlReceived: description: DTO para envio/criação de evento type: object required: – e070emp – e070fil – eventOrigin – externalId – status properties: e070emp: type: string description: Empresa e070fil: type: string description: Filial eventOrigin: type: string allOf: – #/definitions/eventOrigin description: Origem do evento externalId: type: string description: Id externo status: type: string allOf: – #/definitions/eventStatus description: Status do evento controlCode: type: string description: Codigo de controle da origem do evento eventControlItemReceived: description: DTO para o envio/criação de item do evento type: object required: – eventGroup – sequence – eventOperation properties: eventGroup: type: string description: Grupo do evento sequence: type: integer format: int64 description: Sequência do evento eventOperation: type: string allOf: – #/definitions/eventOperation description: Tipo da operação do evento input: type: string description: Input do evento enviado no payload da primitiva output: type: string description: Output do evento recebido no payload da primitiva message: type: string description: Mensagem de evento checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck setSuccessStatus: description: DTO de payload indicando que o evento foi processado com sucesso type: object required: – eventControlItemId properties: eventControlItemId: type: string description: Id do item de controle de eventos message: type: string description: Mensagem informativa para registro setFailedStatus: description: DTO de payload indicando que o evento falhou type: object required: – eventControlItemId – message properties: eventControlItemId: type: string description: Id do item de controle de eventos message: type: string description: Mensagem informativa para registro sisDevPrescriptionIssuance: description: DTO para a emissão de receita agronômica ao SisDev – não traduzirou mudar os nomes dos atributos type: object required: – nrArt – nrReceita – cpfAgronomo properties: nrArt: type: string description: Número da ART nrReceita: type: integer format: int64 description: Número da receita cpfAgronomo: type: string description: CPF do agrônomo responsável itens: type: array items: type: object allOf: – #/definitions/sisDevItem description: Lista de itens da receita sisDevItem: description: DTO para o item da receita agronômica ao SisDev – – não traduzirou mudar os nomes dos atributos type: object required: – codRegMapaAgrotoxico – codUnidadeMedida – codTipoAplicacao – codCultura – codPraga – quantidade – areaTratada properties: documentNumber: type: string maxLength: 50 description: Número da nota fiscal codRegMapaAgrotoxico: type: string maxLength: 100 description: Código do registro do MAPA do agrotóxico codUnidadeMedida: type: string maxLength: 50 description: Código da unidade de medida codTipoAplicacao: type: string maxLength: 50 description: Código do tipo de aplicação codCultura: type: string maxLength: 50 description: Código da cultura codPraga: type: string maxLength: 50 description: Código da praga quantidade: type: number format: double description: Quantidade do produto areaTratada: type: number format: double description: Área tratada cidascPrescriptionIssuance: description: DTO para a emissão de receita agronômica ao Cidasc conforme novo modelo type: object required: – nrReceituario – dtEmissao – cdMunicipioIbge – nrDocumentoProdutor – nmProdutor – cdNomeComumEspecieVegetal – endereco – listaDiagnosticos properties: nrRegistro: type: integer format: int64 description: Número do registro da empresa (Informe apenas números). No mínimo 2 e máximo 6 caracteres nrConselho: type: string description: Número do Conselho do engenheiro responsável (Informe apenas números). No mínimo 5 e máximo 8 caracteres. Para CFTA: Número do CFTA do técnico responsável. nrArtTrt: type: string description: Número da ART/TRT do Receituário é obrigatório, formato: 99999999-9. Para CFTA: formato [BR20200400001] nrArt: type: string description: Número da ART do Receituário é obrigatório, formato: 99999999-9. Para CFTA: formato [BR20200400001] nrReceituario: type: string description: Número do Receituário (1 a 20 caracteres). Para CFTA: formato [BR202002RA000001] dtEmissao: type: string description: Data que o receituário foi emitido (dd/mm/aaaa) cdMunicipioIbge: type: integer format: int64 description: Código IBGE do município onde foi emitido o receituário (máximo 7 caracteres) nrDocumentoProdutor: type: string description: Número de Documento do usuário do agrotóxico (máximo 20 caracteres) nmProdutor: type: string description: Nome do usuário do agrotóxico (mínimo 5, máximo 200 caracteres) nmPropriedade: type: string description: Nome da propriedade em que o agrotóxico será aplicado (mínimo 3, máximo 200 caracteres) cdNomeComumEspecieVegetal: type: integer format: int64 description: Nome comum da espécie vegetal (apenas números, máximo 4 caracteres) georreferenciamento: type: object allOf: – #/definitions/cidascGeoreference description: GeoReferenciamento endereco: type: object allOf: – #/definitions/cidascAddress description: Endereço listaDiagnosticos: type: array items: type: object allOf: – #/definitions/cidascItem minimum: 1 description: Lista de Diagnóstico (Informe ao menos um diagnóstico) cidascItem: description: DTO para o item da receita agronômica ao Cidasc conforme novo modelo type: object required: – cdAgrotoxico – cdUnidadeMedidaAdquirida – cdUnidadeMedidaArea – cdUnidadeMedidaDosagem – qtAdquirida – qtArea – qtDosagem – nrIntervalo – dsDiagnostico – dsModalidadeEpoca – dsPrecaucao properties: cdAgrotoxico: type: integer format: int64 description: Código do Agrotóxico utilizado (apenas números, máximo 4 caracteres) cdPraga: type: integer format: int64 description: Código da praga tratada (apenas números, máximo 4 caracteres) cdUnidadeMedidaAdquirida: type: integer format: int64 description: Código da unidade de medida do agrotóxico (apenas números, máximo 4 caracteres) cdUnidadeMedidaArea: type: integer format: int64 description: Código da unidade de medida em área (apenas números, máximo 4 caracteres) cdUnidadeMedidaDosagem: type: integer format: int64 description: Código da unidade de medida da dosagem aplicada (apenas números, máximo 4 caracteres) qtAdquirida: type: number format: double description: Quantidade adquirida do Agrotóxico (apenas números) qtArea: type: number format: double description: Área total onde o agrotóxico será aplicado (se decimal, separar por vírgula) qtDosagem: type: number format: double description: Dosagem aplicada (apenas números) nrIntervalo: type: string description: Número de intervalo das aplicações (máximo 4 números) dsDiagnostico: type: string description: Descrição do diagnóstico dsModalidadeEpoca: type: string description: Descrição da época em que o agrotóxico pode ser aplicado dsPrecaucao: type: string description: Descrição da precaução ao utilizar o agrotóxico dsOrientacao: type: string description: Descrição da orientação ao utilizar o agrotóxico dsEPI: type: string description: Descrição dos produtos de EPI dsOutros: type: string description: Descrição adicional do agrotóxico cidascAddress: description: type: object required: – cdLocalidade properties: cdLocalidade: type: integer format: int64 description: Localidade onde será aplicado o Agrotóxico informe apenas números. cdTipoLogradouro: type: integer format: int64 description: Código do Tipo logradouro em que o agrotóxico será aplicado informe apenas números. dsLogradouro: type: string description: Descrição do logradouro no mínimo 5 no máximo 200 caracteres dsNumeroLogradouro: type: string description: Número do logradouro em que o agrotóxico será aplicado no máximo 20 caracteres dsComplementoLogradouro: type: string description: Complemento do logradouro em que o agrotóxico será aplicado no máximo 30 caracteres nrCepLogradouro: type: string description: Cep de local onde o Agrotóxico será aplicado informe apenas números cidascGeoreference: description: type: object properties: nrAltitude: type: string description: Número da Altitude em relação ao GPS informe apenas números nrLatitude: type: string description: Número da Latitude em relação ao GPS, exemplo: -27,597542 (utilizar vírgula) nrLongitude: type: string description: Número da Longitude em relação ao GPS exemplo: -48,543151 (utilizar vírgula) cidascCancelIssuance: description: DTO para o cancelamento de emissão de receituário agronômico ao Cidasc type: object required: – nrReceituario properties: nrRegistro: type: integer format: int64 description: Número do registro da empresa (Informe apenas números). No mínimo 2 e máximo 6 caracteres nrConselho: type: string description: Para no Conselho: Número do Conselho do engenheiro responsável (Informe apenas números). No mínimo 5 e máximo 8 caracteres Para CFTA: Número do CFTA do técnico responsável.Deverá ter 11 digitos(tamanho do CPF) nrArtTrt: type: string description: Para no ARTTRT: Número da ART/TRT do Receituário é obrigatório, e deve respeitar o formato: 9999999 – 9.Para CFTA: Número do TRT do Receituário é obrigatório, e deve respeitar o formato proposto pelo conselho: [BR20200400001]. nrReceituario: type: string description: Número do Receituário (Tem que conter de 1 a 20 caracteres). Para CFTA: Número do Receituário no formato proposto pelo conselho: [BR202002RA000001]. integrationListener: description: DTO utilizado para informar se a emissão da receita que foi integrado com sucesso ou erro ao SisDev type: object required: – prescriptionIssuanceId – result properties: prescriptionIssuanceId: type: string description: Id da emissão da receita message: type: string description: Mensagem de retorno result: type: string allOf: – #/definitions/integrationResult description: Resultado da integração com o SisDev cidascIntegrationListener: description: DTO utilizado para informar o resultado da integração com o Cidasc type: object required: – result properties: message: type: string description: Mensagem de retorno result: type: string allOf: – #/definitions/integrationResult description: Resultado da integração com o SisDev dataLoadInput: description: Carga de dados de receituário agronômico type: object required: – data – type properties: data: type: string description: Dados do novo receituário type: type: string allOf: – #/definitions/dataLoadPrescriptionType description: Tipo de carga de dados companyId: type: string description: Id da empresa branchId: type: string description: Id da filial cidascDataLoadPayload: description: Carga de dados do Cidasc type: object required: – cidascDataLoadId – data – type properties: cidascDataLoadId: type: string description: Id da carga de dados data: type: string description: Dados em JSON type: type: string allOf: – #/definitions/dataLoadCidascType description: Tipo de dado a ser processado updatePrescriptionIntegrationStatusInput: description: record para atualizar o status de integração do receituário agronômico type: object properties: begin: type: boolean description: Inicia o processo de integração failed: type: boolean description: Indica se houve erro no processo de integração message: type: string description: Mensagem do resultado da integração companyId: type: string description: Id da empresa branchId: type: string description: Id da filial ocrIntegrationResponse: description: DTO para o retorno do OCR type: object required: – logIntegrationOcrId – success properties: logIntegrationOcrId: type: string description: Id do log de integração message: type: string description: Mensagem de retorno do OCR success: type: boolean description: Sucesso ou falha da integração com o OCR ocrData: description: DTO para envio de dados para o OCR type: object required: – tipo_documento – app – tenant – image_path properties: tipo_documento: type: string description: tipoDocumento app: type: string description: app tenant: type: string description: tenant image_path: type: string description: imagePath e070emp: description: Empresa type: object required: – codEmp – nomEmp – sigEmp properties: id: type: string format: uuid description: Id codEmp: type: integer format: int64 description: Código da empresa nomEmp: type: string maxLength: 100 description: Nome da empresa sigEmp: type: string maxLength: 100 description: Nome fantasia / Sigla da empresa extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e070fil: description: Filial type: object required: – e070emp – codFil – nomFil – sigFil properties: id: type: string format: uuid description: Id e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa codFil: type: integer format: int64 description: Código da filial nomFil: type: string maxLength: 100 description: Nome da filial sigFil: type: string maxLength: 100 description: Nome fantasia da filial numCgc: type: string maxLength: 18 description: CNPJ cidFil: type: string maxLength: 60 description: Cidade numFon: type: string maxLength: 20 description: Numero Telefone extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: integrationConfig: description: Configurações para integrações com serviços externos type: object required: – serviceName – authType properties: id: type: string format: uuid description: Id company: type: object allOf: – #/definitions/e070emp description: Empresa branch: type: object allOf: – #/definitions/e070fil description: Filial serviceName: type: string allOf: – #/definitions/integrationServiceName description: Nome do serviço serviceUrl: type: string maxLength: 255 description: URL do serviço authType: type: string allOf: – #/definitions/authType description: Tipo de autenticação authToken: type: string maxLength: 255 description: Token de autenticação authUser: type: string maxLength: 200 description: Usuario de autenticação authPassword: type: string maxLength: 200 description: Senha de autenticação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editIntegrationConfig: type: object required: – id allOf: – #/definitions/integrationConfig 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. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: 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 enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage