Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

ÍNDICE

  1. Visión general
  2. Servicios disponibles
  3. Ejemplo de utilización

CONTEÚDO

  1. Visão Geral
  2. Serviços Disponíveis
  3. Exemplo de utilização
    1. GET
  4. Assuntos RelacionadosAsuntos relacionados

01. 

...

VISIÓN GENERAL

Para clientes que possuem rotinas ou aplicativos customizados e precisam consultar as informações na rotina FINA460A(Cadastro de Simulação de liquidação a receber), foram disponibilizados tienen rutinas o aplicaciones personalizadas y necesitan consultar las informaciones en la rutina FINA460A(Registro de simulación de liquidación por cobrar), se pusieron a disposición métodos Web Service REST.

02. 

...

SERVICIOS DISPONIBLES

GET
Consulta

POST
InclusãoInclusión

PUT
AlteraçãoModificación
DELETE
ExclusãoBorrado
(seleção)(erro)(erro)(erro)

03. 

...

EJEMPLO DE

...

UTILIZACIÓN

Para Para realizar testes, pode ser utilizado qualquer programa de sua preferência, que teste pruebas, puede utilizarse cualquier programa de su preferencia, que pruebe API Web Service REST.

Como exemplos ejemplos de programas, podemos citar el SoapUI o SoapUI ou Postman. Ambos são Ambas son excelentes aplicativosaplicaciones.

Os exemplo a seguir serão demonstrados utilizando programa Postman, executando o Los siguientes ejemplos se mostrarán utilizando el programa Postman, ejecutando el método GET.

Para inclusão ou alteração do inclusión o modificación del registro, pode utilizar a mesma estrutura puede utilizar la misma estructura (body), os campos podem ser adicionados dentro da los campos pueden incluirse dentro de la tag FIELDS.
Maiores detalhes referente a montagem da estrutura, verificar modelo abaixo.Para más detalles referentes al montaje de la estructura, vea el siguiente modelo.

DondeOnde:

id:

...

es la id

...

de la API

operation:

...

es el código de la operación, valor

...

estándar: 1,

pk:

...

es la clave primaria del alias del modelo de datos codificado en base64,

models:

...

son los modelos de

...

negocio de cada API,

...

es decir, modelo de

...

datos de MVC, que

...

está definido por:

id:

...

es el modelo de

...

datos definido

...

en MVC

modeltype:

...

es tipo de modelo de

...

datos, "FIELDS"

...

o "GRID"

                     fields:

...

es un vector con los campos, definido por: 

id:

...

es el nombre del campo

order:

...

orden del campo en la tabla SBE

value:

...

es el valor

...

del campo


Informações

Importante

Por padrãoestándar, para realizar una consulta, alteração ou deleção de um determinado dado do servidor através dos modificación o borrado de un determinado dato del servidor por medio de los métodos GET, PUT ou o DELETE, é necessário es necesario informar a la PK (Primary Key), valor da chave primaria do alias do modelo, encodado em base64, caso contrário não informado, serão retornado os registros conforme sua paginaçãode la clave primaria del alias del modelo, codificado en base64, en caso contrario no informado, se devolverán los registros de acuerdo con su paginación.


a. GET

Bloco de código
languagec#
themeMidnight
firstline1
titleRetorno Devolución - Modelo Estrutura estructura GET 
linenumberstrue
collapsetrue
{
    "id": "FINA460A",
    "operation": 1,
    "pk": "RCBNRyAwMSBEIE1HIDAxIDAwMDAwMDAwMDAwMDMyMTAwMDE=",
    "models": [
        {
            "id": "MASTERFO0",
            "modeltype": "FIELDS",
            "fields": [
                {
                    "id": "FO0_FILIAL",
                    "order": 1,
                    "value": "D MG 01"
                },
                {
                    "id": "FO0_PROCES",
                    "order": 2,
                    "value": "000000000000321"
                },
                {
                    "id": "FO0_VERSAO",
                    "order": 3,
                    "value": "0001"
                },
                {
                    "id": "FO0_NUMLIQ",
                    "order": 4,
                    "value": "000208"
                },
                {
                    "id": "FO0_DATA",
                    "order": 5,
                    "value": "20240306"
                },
                {
                    "id": "FO0_DTVALI",
                    "order": 6,
                    "value": "20240306"
                },
                {
                    "id": "FO0_CLIENT",
                    "order": 11,
                    "value": "000001"
                },
                {
                    "id": "FO0_LOJA",
                    "order": 12,
                    "value": "01"
                },
                {
                    "id": "FO0_NATURE",
                    "order": 13,
                    "value": "001"
                },
                {
                    "id": "FO0_STATUS",
                    "order": 14,
                    "value": "4"
                },
                {
                    "id": "FO0_MOEDA",
                    "order": 15,
                    "value": "1"
                },
                {
                    "id": "FO0_BKPSTT",
                    "order": 16,
                    "value": "1"
                },
                {
                    "id": "FO0_ORIGEM",
                    "order": 17,
                    "value": "FINA460A"
                },
                {
                    "id": "FO0_VLRNEG",
                    "order": 24,
                    "value": "1000.00"
                }
            ],
            "models": [
                {
                    "id": "TITSELFO1",
                    "modeltype": "GRID",
                    "struct": [
                        {
                            "id": "FO1_FILIAL",
                            "order": 1
                        },
                        {
                            "id": "FO1_PROCES",
                            "order": 2
                        },
                        {
                            "id": "FO1_VERSAO",
                            "order": 3
                        },
                        {
                            "id": "FO1_IDDOC",
                            "order": 4
                        },
                        {
                            "id": "FO1_SALDO",
                            "order": 5
                        },
                        {
                            "id": "FO1_TXJUR",
                            "order": 6
                        },
                        {
                            "id": "FO1_VLJUR",
                            "order": 7
                        },
                        {
                            "id": "FO1_TXMUL",
                            "order": 8
                        },
                        {
                            "id": "FO1_VLMUL",
                            "order": 9
                        },
                        {
                            "id": "FO1_DESCON",
                            "order": 10
                        },
                        {
                            "id": "FO1_ACRESC",
                            "order": 11
                        },
                        {
                            "id": "FO1_DECRES",
                            "order": 12
                        },
                        {
                            "id": "FO1_VLABT",
                            "order": 13
                        },
                        {
                            "id": "FO1_TOTAL",
                            "order": 14
                        },
                        {
                            "id": "FO1_MOEDA",
                            "order": 15
                        },
                        {
                            "id": "FO1_TXMOED",
                            "order": 16
                        },
                        {
                            "id": "FO1_FILORI",
                            "order": 17
                        },
                        {
                            "id": "FO1_VLDIA",
                            "order": 18
                        },
                        {
                            "id": "FO1_DESJUR",
                            "order": 19
                        },
                        {
                            "id": "FO1_VACESS",
                            "order": 20
                        },
                        {
                            "id": "FO1_VLADIC",
                            "order": 21
                        }
                    ],
                    "items": [
                        {
                            "id": 1,
                            "deleted": 0,
                            "fields": [
                                {
                                    "id": "FO1_FILIAL",
                                    "value": "D MG 01"
                                },
                                {
                                    "id": "FO1_PROCES",
                                    "value": "000000000000321"
                                },
                                {
                                    "id": "FO1_VERSAO",
                                    "value": "0001"
                                },
                                {
                                    "id": "FO1_IDDOC",
                                    "value": "FA75DBDD09DC4E118E3DAC5AFCAD9E8A"
                                },
                                {
                                    "id": "FO1_SALDO",
                                    "value": "1000.00"
                                },
                                {
                                    "id": "FO1_TOTAL",
                                    "value": "1000.00"
                                },
                                {
                                    "id": "FO1_MOEDA",
                                    "value": "1"
                                },
                                {
                                    "id": "FO1_TXMOED",
                                    "value": "1.0000"
                                },
                                {
                                    "id": "FO1_FILORI",
                                    "value": "D MG 01"
                                }
                            ]
                        }
                    ]
                },
                {
                    "id": "TITGERFO2",
                    "modeltype": "GRID",
                    "struct": [
                        {
                            "id": "FO2_FILIAL",
                            "order": 1
                        },
                        {
                            "id": "FO2_PROCES",
                            "order": 2
                        },
                        {
                            "id": "FO2_VERSAO",
                            "order": 3
                        },
                        {
                            "id": "FO2_IDSIM",
                            "order": 4
                        },
                        {
                            "id": "FO2_PREFIX",
                            "order": 5
                        },
                        {
                            "id": "FO2_NUM",
                            "order": 6
                        },
                        {
                            "id": "FO2_PARCEL",
                            "order": 7
                        },
                        {
                            "id": "FO2_VENCTO",
                            "order": 8
                        },
                        {
                            "id": "FO2_VALOR",
                            "order": 9
                        },
                        {
                            "id": "FO2_TXJUR",
                            "order": 10
                        },
                        {
                            "id": "FO2_VLJUR",
                            "order": 11
                        },
                        {
                            "id": "FO2_ACRESC",
                            "order": 12
                        },
                        {
                            "id": "FO2_DECRES",
                            "order": 13
                        },
                        {
                            "id": "FO2_TOTAL",
                            "order": 14
                        },
                        {
                            "id": "FO2_BANCO",
                            "order": 15
                        },
                        {
                            "id": "FO2_AGENCI",
                            "order": 16
                        },
                        {
                            "id": "FO2_CONTA",
                            "order": 17
                        },
                        {
                            "id": "FO2_NUMCH",
                            "order": 18
                        },
                        {
                            "id": "FO2_EMITEN",
                            "order": 19
                        },
                        {
                            "id": "FO2_TIPO",
                            "order": 20
                        },
                        {
                            "id": "FO2_TXCALC",
                            "order": 21
                        },
                        {
                            "id": "FO2_VLRJUR",
                            "order": 22
                        },
                        {
                            "id": "FO2_VLPARC",
                            "order": 23
                        }
                    ],
                    "items": [
                        {
                            "id": 1,
                            "deleted": 0,
                            "fields": [
                                {
                                    "id": "FO2_FILIAL",
                                    "value": "D MG 01"
                                },
                                {
                                    "id": "FO2_PROCES",
                                    "value": "000000000000321"
                                },
                                {
                                    "id": "FO2_VERSAO",
                                    "value": "0001"
                                },
                                {
                                    "id": "FO2_IDSIM",
                                    "value": "0656D1730ADC4E118E3DAC5AFCAD9E8A"
                                },
                                {
                                    "id": "FO2_PREFIX",
                                    "value": "LIQ"
                                },
                                {
                                    "id": "FO2_NUM",
                                    "value": "REST06"
                                },
                                {
                                    "id": "FO2_PARCEL",
                                    "value": "A"
                                },
                                {
                                    "id": "FO2_VENCTO",
                                    "value": "20240406"
                                },
                                {
                                    "id": "FO2_VALOR",
                                    "value": "1000.00"
                                },
                                {
                                    "id": "FO2_TOTAL",
                                    "value": "1000.00"
                                },
                                {
                                    "id": "FO2_TIPO",
                                    "value": "NF"
                                },
                                {
                                    "id": "FO2_VLPARC",
                                    "value": "1000.00"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}


04. 

...

ASUNTOS RELACIONADOS

FWRestModel - API RESTful dos de los modelos de dados do datos del Protheus

Integração do Integración del Easy Import Control via vía API REST