Versões comparadas

Chave

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

...

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

Informações
iconfalse
title1.3.1 PostPatch
Expandir
Informações
iconfalse
titleConfiguração
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
}