Linha Microsiga Protheus

Árvore de páginas

Índice

Objetivo

O objetivo da API é retornar todos os Funcionários ou Executantes disponíveis para realizar as operações de Calibragem e Medição de Sulco.

Header

Os parâmetros que deverão ser adicionados no header para possibilitar a utilização da api são:

VariávelDescriçãoObrigatórioExemplo
authorizationAo executar a chamada do webservice, deverá ser configurado para Basic Auth utilizando usuário e senha do Protheus.SimBasic Y0BuZ2kuY29tLmJyOjE
tenantIdCódigo da empresa + Código da FilialSimT1,D MG 01
x-erp-moduleRepresenta o módulo do ProtheusSim

GFR

filialCódigo da Filial, permite filtrar a carga de Executores por uma filial específica.Não

D MG 01

Importante

  • O valor inserido na variável tenantId não deverá possuir espaço entre a vírgula;
  • No exemplo apresentado na tabela acima, T1 corresponde a uma empresa e D MG 01 a uma filial.
  • O campo x-erp-module deve ser preenchido apenas com a abreviação de três letras do módulo, sem o prefixo "SIGA", conforme indicado no exemplo.

Endpoints 

Método: rest/mntExecutantes

Tipo: Get

Exibe as informações dos Funcionários ou Executantes disponíveis para realizar as operações de Calibragem e Medição de Sulco

Exemplo Header
curl --request GET\
--url http://localhost:8080/rest/mntExecutantes
--header 'Authorization: Basic YWRtaW46MTIzNA==' \
--header 'tenantId: T1,D MG 01' \
--header 'x-erp-module: GFR' \
--header 'filial: D MG 01' \


Regras de Negócio

  • Caso o conteúdo do X3_F3 do campo TTO_EXECUT seja 'CAD', os dados retornados serão da tabela SRA, caso contrário, serão exibidos os dados da tabela ST1.
  • Caso os dados sejam da tabela SRA, os funcionários com situação demitidos ou transferidos ( RA_SITFOLH = 'D' ou 'T' ) não serão exibidos.

Retorno da requisição

    Exemplo:

    Retorno da Requisição
    {
    "executantes": [
        {
            "codigo": "000001",
            "nome": "JOAO DA SILVA ",
            "filial": "D MG 01 "
        },
        {
            "codigo": "000002",
            "nome": "GTP001",
            "filial": "D MG 01 "
        }
    ]
}
    Campos
    NomeTipoRegra
    codigoCaractereContém o código do Funcionário (SRA) ou Executante (ST1).
    nomeCaractereNome do Funcionário
    filialCaractere

    Código da Filial do Funcionário

    Informações Adicionais

    Conteúdos Relacionados