Linha RM

Atalhos

Páginas filhas
  • API de Coligada

Versões comparadas

Versão antiga 34

changes.mady.by.user Adriano Diniz Agrizzi

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Adriano Diniz Agrizzi

Gravado em

Chave

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

...

Informações
iconfalse
titleGetAll

Máscara fMáscara de Url: http://{domínio}:{porta}/api/framework/v1/companies/

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/framework/v1/companies

Aviso
titleImportante

A partir da versão 12.1.2310, o resultado não é filtrado pelo perfil de segurança do usuário, mantendo o mesmo padrão da MDI, trazendo todas as coligadas.

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
        },
        {
            "id": "8",
            "code": 8,
            "nickname": "Teste",
            "name": "Teste",
            "phoneNumber": "dsds",
            "country": "chile",
            "isFluigIntegrated": 0
        },
        {
            "id": "9",
            "code": 9,
            "nickname": "Teste PUT",
            "federalId": "82.122.163/0001-01",
            "name": "Teste PUT",
            "street": "AVENIDA RAJA GABAGLIA",
            "number": "2664",
            "isFluigIntegrated": 0
        },
        {
            "id": "10",
            "code": 10,
            "nickname": "Colligada",
            "federalId": "38.737.259/0001-92",
            "name": "Coligada",
            "country": "Brasil",
            "isFluigIntegrated": 0
        },
        {
            "id": "11",
            "code": 11,
            "nickname": "Teste coligada",
            "name": "Teste coligada",
            "country": "Porto Rico",
            "isFluigIntegrated": 0
        }
    ]
}


1.1.2 - Order (Resultado Ordenado)

Informações
titleParâmetros

Order: parâmetro responsável pela ordenação do resultado, podendo ser ascendente ou descendente. O resultado com a ordem descendente deve ser precedida do caractere "-" (menos).

Exemplo 1: ?order=campo1 (Ascendente)

Exemplo 2: ?order=-campo1 (Descendente)

Múltiplos campos de ordenação: ?order=[-]campo1, [-]campo2, [-]campo3 ...

...

Configuração
Informações
iconfalse
title1.3.1 Post
Expandir
Informações
iconfalse
title
Patch

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/companies/{id}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 12

Url Utilizada: http://localhost:8051/api/framework/v1/companies/12

Informações
iconfalse
titleExemplo de Entrada
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "nickname": "TOTVS SA Teste",
    "name": "TOTVS SA Teste",
    "email": "[email protected]",
}
Informações
iconfalse
titleExemplo de Resultado Positivo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "id": "12",
    "code": 12,
    "nickname": "TOTVS SA Teste",
    "federalId": "19.023.489/0001-45",
    "name": "TOTVS SA Teste",
    "stateId": "062.307.904/0081",
    "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": "30494-170",
    "isRuralProducer": "T",
    "active": "T",
    "externalCode": "651465",
    "isFluigIntegrated": 0
}
Informações
iconfalse
titleExemplo de Resultado Negativo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "Code": "FE019",
    "Message": "O CNPJ, CPF ou CEI utilizado já está cadastrado na base de dados em outra coligada!",
    "DetailMessage": "",
    "HelpUrl": "",
    "Details": null
}

1.4 - DELETE

...

1.4.1 - Delete (Desativa uma Coligada)

...

Configuração
Informações
iconfalse
title1.4.1 Delete
Expandir
titleClique aqui para expandir...
Informações
iconfalse
title

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/companies/{id}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 12

Url Utilizada: http://localhost:8051/api/framework/v1/companies/12

Informações
iconfalse
titleExemplo de Configuração

Ao realizar um "DELETE", a coligada não será excluída será somente desativada.

Informações
iconfalse
titleExemplo de Resultado Positivo Postman

Obs.: Em caso de sucesso, será retornado o respondeCode = 201 e a resposta em branco.

Informações
iconfalse
titleExemplo de Resultado Negativo
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "Code": "FE011",
    "Message": "Registro não encontrado na base de dados.",
    "DetailMessage": "",
    "HelpUrl": "",
    "Details": null
}