Linha Microsiga Protheus

Árvore de páginas


CONTEÚDO

  1. Visão Geral
  2. Definições de Serviços
    1. GET - WSPfsApi/dataByCODLD/{tabela}/{campo}/{codLD}
      1. Filtros

      2. Mensagens de erro

01. VISÃO GERAL

O serviço especificado neste documento tem por objetivo permitir ao usuário consultar um registro no Protheus através do código Legaldesk desse registro, e assim obter a chave em base 64, ou valores de todos os campos ou campos específicos, conforme as definições abaixo.

02. DEFINIÇÕES DE SERVIÇOS

 a. GET - WSPfsApi/dataByCODLD/{tabela}/{campo}/{codLD}

Exibe a chave única do registro no Protheus em base 64:

Parâmetros:

tabela - Tabela do registro (Ex: NUH)

campo - Campo de código Legaldesk da tabela (Ex: NUH_CODLD)

codLd - Código Legaldesk para busca do registro

Exemplo URL de requisição: http://localhost:9000/WSPfsApi/dataByCODLD/NUH/NUH_CODLD/72276fbb-9df7-578f-8073-42e3e21796a5

Request Header 
TENANTID: T1,M SP 01
Content-Type: application/json
Response.json 
ICAgICAgICBERUwwMDEwMQ==


a.1. Filtros

É possível obter resultados diferentes através de filtros opcionais realizados (o uso sem filtros retornará sempre a chave única do registro no Protheus em base 64), conforme os exemplos abaixo:

a.1.1 Campo(s) específico(s)

É possível adicionar o parâmetro fields, indicando o(s) campos que deseja obter o resultado. 

Formato de uso: fields=campo

Exemplo URL de requisição: http://localhost:9000/WSPfsApi/dataByCODLD/NUH/NUH_CODLD/72276fbb-9df7-578f-8073-42e3e21796a5?fields=NUH_COD

Response.json 
[
    {
        "field": "NUH_COD",
        "value": "DEL001"
    }
]


Para obter mais de um campo, separe por vírgulas.

Formato de uso: fields=campo1,campo2.

Exemplo URL de requisição: http://localhost:9000/WSPfsApi/dataByCODLD/NUH/NUH_CODLD/72276fbb-9df7-578f-8073-42e3e21796a5?fields=NUH_COD,NUH_LOJA

Response.json 
[
    {
        "field": "NUH_COD",
        "value": "DEL001"
    },
    {
        "field": "NUH_LOJA",
        "value": "01"
    }
]


a.1.2 Campos da chave única da tabela

É possível adicionar o parâmetro fields, indicando o(s) que deseja obter a estrutura com todos os campos que formam a chave única da tabela e seus valores.

Formato de uso: fields=unique

Exemplo URL de requisição: http://localhost:9000/WSPfsApi/dataByCODLD/NUH/NUH_CODLD/72276fbb-9df7-578f-8073-42e3e21796a5?fields=UNIQUE

Response.json 
[
    {
        "field": "NUH_FILIAL",
        "value": ""
    },
    {
        "field": "NUH_COD",
        "value": "DEL001"
    },
    {
        "field": "NUH_LOJA",
        "value": "01"
    }
]

a.1.3 Todos os campos (somente campos reais)

É possível adicionar o parâmetro fields, indicando o(s) que deseja obter a estrutura com todos os campos reais e seus valores.

Formato de uso: fields=all

Exemplo URL de requisição: http://localhost:9000/WSPfsApi/dataByCODLD/NUH/NUH_CODLD/72276fbb-9df7-578f-8073-42e3e21796a5?fields=ALL

Response.json 
[
    {
        "field": "NUH_FILIAL",
        "value": ""
    },
    {
        "field": "NUH_COD",
        "value": "DEL001"
    },
    {
        "field": "NUH_LOJA",
        "value": "01"
    },
    {
        "field": "NUH_PERFIL",
        "value": "1"
    },
    {
        "field": "NUH_CPART",
        "value": "000008"
    },
    {
        "field": "NUH_AJNV",
        "value": "1"
    },
    {
        "field": "NUH_DSPDIS",
        "value": "2"
    },
    {
        "field": "NUH_EMFAT",
        "value": "2"
    },
    {
        "field": "NUH_AGRUPA",
        "value": "2"
    },
    {
        "field": "NUH_CESCR",
        "value": "SP001"
    },
    {
        "field": "NUH_CESCR2",
        "value": "SP001"
    },
    {
        "field": "NUH_CMOE",
        "value": "01"
    },
    {
        "field": "NUH_FPAGTO",
        "value": "1"
    },
    {
        "field": "NUH_CBANCO",
        "value": "000"
    },
    {
        "field": "NUH_CAGENC",
        "value": "0000"
    },
    {
        "field": "NUH_CCONTA",
        "value": "000000"
    },
    {
        "field": "NUH_CIDIO",
        "value": "01"
    },
    {
        "field": "NUH_CIDIO2",
        "value": "01"
    },
    {
        "field": "NUH_UNIREL",
        "value": "1"
    },
    {
        "field": "NUH_VINCOM",
        "value": ""
    },
    {
        "field": "NUH_CRELAT",
        "value": "0001"
    },
    {
        "field": "NUH_CCARTA",
        "value": "0001"
    },
    {
        "field": "NUH_CTABH",
        "value": "0001"
    },
    {
        "field": "NUH_SITCAD",
        "value": "2"
    },
    {
        "field": "NUH_SITCLI",
        "value": "2"
    },
    {
        "field": "NUH_DTEFT",
        "value": ""
    },
    {
        "field": "NUH_ATIVO",
        "value": "1"
    },
    {
        "field": "NUH_DTENC",
        "value": ""
    },
    {
        "field": "NUH_UTEBIL",
        "value": "2"
    },
    {
        "field": "NUH_CEMP",
        "value": ""
    },
    {
        "field": "NUH_CLIEBI",
        "value": ""
    },
    {
        "field": "NUH_FORMEB",
        "value": ""
    },
    {
        "field": "NUH_CMOEBI",
        "value": ""
    },
    {
        "field": "NUH_DIAVEN",
        "value": ""
    },
    {
        "field": "NUH_DIAEMI",
        "value": ""
    },
    {
        "field": "NUH_CASAUT",
        "value": "2"
    },
    {
        "field": "NUH_ENCCAS",
        "value": "2"
    },
    {
        "field": "NUH_CGRPEM",
        "value": ""
    },
    {
        "field": "NUH_OBSCAD",
        "value": ""
    },
    {
        "field": "NUH_OBSFAT",
        "value": ""
    },
    {
        "field": "NUH_NIRE",
        "value": ""
    },
    {
        "field": "NUH_EMITNF",
        "value": "2"
    },
    {
        "field": "NUH_NIF",
        "value": ""
    },
    {
        "field": "NUH_GROSHN",
        "value": "1"
    },
    {
        "field": "NUH_PERCGH",
        "value": ""
    },
    {
        "field": "NUH_MOTNIF",
        "value": ""
    },
    {
        "field": "NUH_TPNIF",
        "value": ""
    },
    {
        "field": "NUH_TXADM",
        "value": ""
    },
    {
        "field": "NUH_GLOSUP",
        "value": ""
    },
    {
        "field": "NUH_GROSUP",
        "value": ""
    },
    {
        "field": "NUH_JUSTAP",
        "value": ""
    },
    {
        "field": "NUH_CODLD",
        "value": "72276fbb-9df7-578f-8073-42e3e21796a5"
    },
    {
        "field": "NUH_TXPERM",
        "value": ""
    },
    {
        "field": "NUH_PJUROS",
        "value": ""
    },
    {
        "field": "NUH_DESFIN",
        "value": ""
    },
    {
        "field": "NUH_DIADES",
        "value": ""
    },
    {
        "field": "NUH_TPDESC",
        "value": "1"
    },
    {
        "field": "NUH_CORFAT",
        "value": "2"
    },
    {
        "field": "NUH_TPFECH",
        "value": ""
    },
    {
        "field": "NUH_SRCCOD",
        "value": ""
    },
    {
        "field": "NUH_CTPEBI",
        "value": ""
    }
]


a.2. Mensagens de erro

Caso os parâmetros de busca estejam incorretos ou o registro não seja encontrado serão retornadas mensagens com status 404-Not Found, conforme exemplos abaixo:


a.2.1 Caso os parâmetros de tabela ou campo de código Legaldesk não sejam enviados

Exemplo URL de requisição sem tabela: http://localhost:9000/WSPfsApi/dataByCODLD//NUH_CODLD/72276fbb-9df7-578f-8073-42e3e21796a5

Exemplo URL de requisição sem campo de código Legaldesk: http://localhost:9000/WSPfsApi/dataByCODLD/NUH//72276fbb-9df7-578f-8073-42e3e21796a5

Response.json 
{
    "errorCode": 404,
    "errorMessage": "Não foram enviados os parâmetros necessários para a consulta. Verifique a tabela, campo e CODLD enviados na requisição."
}


a.2.2 Caso a tabela enviada não exista

Exemplo URL de requisição (tabela ZZZ): http://localhost:9000/WSPfsApi/dataByCODLD/ZZZ/ZZZ_CODLD/72276fbb-9df7-578f-8073-42e3e21796a5

Response.json 
{
    "errorCode": 404,
    "errorMessage": "Tabela 'ZZZ' não encontrada."
}


a.2.3 Caso o campo de código Legaldesk enviado não exista

Exemplo URL de requisição (tabela RD0): http://localhost:9000/WSPfsApi/dataByCODLD/RD0/RD0_CODLD/72276fbb-9df7-578f-8073-42e3e21796a5a

Response.json 
{
    "errorCode": 404,
    "errorMessage": "Campo RD0_CODLD não encontrado na tabela RD0 - Pessoas/Participantes"
}


a.2.4 Caso a tabela e campo sejam válidos, porém o código Legaldesk enviado não foi encontrado em nenhum registro

Exemplo URL de requisição: http://localhost:9000/WSPfsApi/dataByCODLD/NUH/NUH_CODLD/72276fbb-9df7-578f-8073-42e3e21796a5zz

Response.json 
{
    "errorCode": 404,
    "errorMessage": "Registro não encontrado na tabela NUH - Clientes"
}