Linha RM

Atalhos

Páginas filhas
  • API de Coligada

Versões comparadas

Versão antiga 30

changes.mady.by.user Adriano Diniz Agrizzi

Gravado em

comparado com

Nova versão 31

changes.mady.by.user Adriano Diniz Agrizzi

Gravado em

Chave

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

...

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/campanies?{campo}={valor}

Informações
iconfalse
title1.1.3 Filter
Expandir
Informações
iconfalse
titleConfiguração
Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: state

Valor: MG

Url Utilizada: http://localhost:8051/api/framework/v1/companies?state=MG

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": false,
    "items": [
        {
            "id": "1",
            "code": 1,
            "nickname": "TOTVS SA",
            "federalId": "21.867.387/0001-58",
            "name": "TOTVS SA",
            "phoneNumber": "31-21229000",
            "faxNumber": "31-21229155",
            "email": "[email protected]",
            "street": "AVENIDA RAJA GABAGLIA",
            "number": "2664",
            "complement": "2º ANDAR",
            "neighborhood": "SANTA LÚCIA",
            "city": "Belo Horizonte",
            "state": "MG",
            "country": "Brasil",
            "zipCode": "30350-540",
            "isFluigIntegrated": 0
        },
        {
            "id": "6",
            "code": 6,
            "nickname": "INSTITUTO TOTVS DE ENSINO SA",
            "federalId": "25.578.337/0001-01",
            "name": "INSTITUTO TOTVS DE ENSINO SA",
            "stateId": "0626103430010",
            "phoneNumber": "31-21229000",
            "faxNumber": "31-21229155",
            "email": "[email protected]",
            "street": "AVENIDA RAJA GABAGLIA",
            "number": "2664",
            "complement": "2º ANDAR",
            "neighborhood": "SANTA LÚCIA",
            "city": "BELO HORIZONTE",
            "state": "MG",
            "country": "BRASIL",
            "zipCode": "30350-540",
            "isFluigIntegrated": 0
        },
        {
            "id": "7",
            "code": 7,
            "nickname": "INSTITUTO TOTVS DE ENSINO SUPERIOR SA",
            "federalId": "05.295.401/0001-30",
            "name": "INSTITUTO TOTVS DE ENSINO SUPERIOR SA",
            "phoneNumber": "31-21229000",
            "faxNumber": "31-21229155",
            "email": "[email protected]",
            "street": "AVENIDA RAJA GABAGLIA",
            "number": "2664",
            "complement": "2º ANDAR",
            "neighborhood": "SANTA LÚCIA",
            "city": "BELO HORIZONTE",
            "state": "MG",
            "country": "BRASIL",
            "zipCode": "30350-540",
            "isFluigIntegrated": 0
        }
    ]
}

1.1.4 - Paginação

...

Informações
titleParâmetros

Page: Página que será apresentada.

PageSize: Quantidade máxima de registros por página que serão apresentados.

Exemplo: ?page=valor1&pageSize=1

Valores padrão: Caso não sejam preenchidos os parâmetros evidenciados acima serão preenchidos com valores padrão.

Page: 1

PageSize: 20

...