Índice

exclude	Sumário

Objetivo

...

Esse documento tem o objetivo de exemplificar o uso da API utilizando todos os métodos implementados.

Para mais informações sobre consumo de

...

Licença, Veja Aqui.

1 - Métodos

...

Serão apresentados 4 métodos, os quais foram implementados na API de Usuários, são eles:

...

Máscara

fMáscara de Url:

http

http://{domínio}:{porta}/api/framework/v1/companies/

Informações

icon	false
title	1.1.1 GetAll

Expandir

Informações

icon	false
title	Configuração

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

Aviso

title	Importante

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

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "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

title	Parâ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

icon	false
title	1.1.2 Order (Asc)

Expandir

Informações

icon

false

title

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: nickname

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/framework/v1/companies?order=nickname

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "items": [
        {
            "id": "10",
            "code": 10,
            "nickname": "Colligada",
            "federalId": "38.737.259/0001-92",
            "name": "Coligada",
            "country": "Brasil",
            "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": "11",
            "code": 11,
            "nickname": "Teste coligada",
            "name": "Teste coligada",
            "country": "Porto Rico",
            "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": "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
        }
    ]
}

icon

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/companies?order=[-]{campo}

Informações

icon	false
title	1.1.2 Order (Desc)

Expandir

Informações

false

title

Configuração

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: nickname

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/framework/v1/companies?order=-nickname

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

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

1.1.3 - Filter (Resultado filtrado)

...

info

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

Informações

icon	false
title	1.1.3 Filter

Expandir

icon	false
title	Configuração

Informações

icon	false
title	Exemplo 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

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "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

title	Parâ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

Máscara

de Url: http://{domínio}:{porta}/api/framework/v1/companies?page={valor1}&pageSize={valor2}

Informações

icon	false
title	1.1.4 Paginacao	Paginação

Máscara

Expandir

Informações

icon	false
title	Configuração

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Valor1: 1

Valor2: 2

Url Utilizada: http://localhost:8051/api/framework/v1/companies?page=1&pageSize=2

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": true,
    "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
        }
    ]
}

1.1.5 - Fields (Retorno de campos específicos no resultado)

...

title

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/companies?fields={campos}

Informações

icon	false
title	1.1.5 Fields

Expandir

Informações

icon

false

Configuração

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo 1: nickname

Campo 2: federalId

Url Utilizada: http://localhost:8051/api/framework/v1/companies?fields=nickname,federalId

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "items": [
        {
            "nickname": "TOTVS SA",
            "federalId": "21.867.387/0001-58"
        },
        {
            "nickname": "INSTITUTO TOTVS DE ENSINO SA",
            "federalId": "25.578.337/0001-01"
        },
        {
            "nickname": "INSTITUTO TOTVS DE ENSINO SUPERIOR SA",
            "federalId": "05.295.401/0001-30"
        },
        {
            "nickname": "Teste"
        },
        {
            "nickname": "Teste PUT",
            "federalId": "82.122.163/0001-01"
        },
        {
            "nickname": "Colligada",
            "federalId": "38.737.259/0001-92"
        },
        {
            "nickname": "Teste coligada"
        }
    ]
}

1.1.6 - GetOne (Recuperar coligada pelo identificador)

...

Configuração

Informações

icon	false
title	1.1.6 GetOne

Expandir

Informações

icon

false

title

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8099

Id: 00001

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

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "_expandables": [
        "subsidiary"
    ],
    "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",
    "imageId": 491,
    "isRuralProducer": "F",
    "active": "T",
    "image": "/9j/4AAQSkZJRgABAQEAAAAAAAD/7gAOQWRvYmUAZAAAAAAB/+IMWElDQ19QUk9GSUxFAAEBAAAMSExpbm8CEAAAbW50clJHQiBYWVogB84AAgAJAAYAMQAAYWNzcE1TRlQAAAAASUVDIHNSR0IAAAAAAAAAAAAAAAAAAPbWAAEAAAAA0y1IUCAgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAARY3BydAAAAVAAAAAzZGVzYwAAAYQAAABsd3RwdAAAAfAAAAAUYmtwdAAAAgQAAAAUclhZWgAAAhgAAAAUZ1hZWgAAAiwAAAAUYlhZWgAAAkAAAAAUZG1uZAAAAlQAAABwZG1kZAAAAsQAAACIdnVlZAAAA0wAAACGdmlldwAAA9QAAAAkbHVtaQAAA/gAAAAUbWVhcwAABAwAAAAkdGVjaAAABDAAAAAMclRSQwAABDwAAAgMZ1RSQwAABDwAAAgMYlRSQwAABDwAAAgMdGV4dAAAAABDb3B5cmlnaHQgKGMpIDE5OTggSGV3bGV0dC1QYWNrYXJkIENvbXBhbnkAAGRlc2MAAAAAAAAAEnNSR0IgSUVDNjE5NjYtMi4xAAAAAAAAAAAAAAASc1JHQiBJRUM2MTk2Ni0yLjEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAFhZWiAAAAAAAADzUQABAAAAARbMWFlaIAAAAAAAAAAAAAAAAAAAAABYWVogAAAAAAAAb6IAADj1AAADkFhZWiAAAAAAAABimQAAt4UAABjaWFlaIAAAAAAAACSgAAAPhAAAts9kZXNjAAAAAAAAABZJRUMgaHR0cDovL3d3dy5pZWMuY2gAAAAAAAAAAAAAABZJRUMgaHR0cDovL3d3dy5pZWMuY2gAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAZGVzYwAAAAAAAAAuSUVDIDYxOTY2LTIuMSBEZWZhdWx0IFJHQiBjb2xvdXIgc3BhY2UgLSBzUkdCAAAAAAAAAAAAAAAuSUVDIDYxOTY2LTIuMSBEZWZhdWx0IFJHQiBjb2xvdXIgc3BhY2UgLSBzUkdCAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGRlc2MAAAAAAAAALFJlZmVyZW5jZSBWaWV3aW5nIENvbmRpdGlvbiBpbiBJRUM2MTk2Ni0yLjEAAAAAAAAAAAAAACxSZWZlcmVuY2UgVmlld2luZyBDb25kaXRpb24gaW4gSUVDNjE5NjYtMi4xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAB2aWV3AAAAAAATpP4AFF8uABDPFAAD7cwABBMLAANcngAAAAFYWVogAAAAAABMCVYAUAAAAFcf521lYXMAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAKPAAAAAnNpZyAAAAAAQ1JUIGN1cnYAAAAAAAAEAAAAAAUACgAPABQAGQAeACMAKAAtADIANwA7AEAARQBKAE8AVABZAF4AYwBoAG0AcgB3AHwAgQCGAIsAkACVAJoAnwCkAKkArgCyALcAvADBAMYAywDQANUA2wDgAOUA6wDwAPYA+wEBAQcBDQETARkBHwElASsBMgE4AT4BRQFMAVIBWQFgAWcBbgF1AXwBgwGLAZIBmgGhAakBsQG5AcEByQHRAdkB4QHpAfIB+gIDAgwCFAIdAiYCLwI4AkECSwJUAl0CZwJxAnoChAKOApgCogKsArYCwQLLAtUC4ALrAvUDAAMLAxYDIQMtAzgDQwNPA1oDZgNyA34DigOWA6IDrgO6A8cD0wPgA+wD+QQGBBMEIAQtBDsESARVBGMEcQR+BIwEmgSoBLYExATTBOEE8AT+BQ0FHAUrBToFSQVYBWcFdwWGBZYFpgW1BcUF1QXlBfYGBgYWBicGNwZIBlkGagZ7BowGnQavBsAG0QbjBvUHBwcZBysHPQdPB2EHdAeGB5kHrAe/B9IH5Qf4CAsIHwgyCEYIWghuCIIIlgiqCL4I0gjnCPsJEAklCToJTwlkCXkJjwmkCboJzwnlCfsKEQonCj0KVApqCoEKmAquCsUK3ArzCwsLIgs5C1ELaQuAC5gLsAvIC+EL+QwSDCoMQwxcDHUMjgynDMAM2QzzDQ0NJg1ADVoNdA2ODakNww3eDfgOEw4uDkkOZA5/DpsOtg7SDu4PCQ8lD0EPXg96D5YPsw/PD+wQCRAmEEMQYRB+EJsQuRDXEPURExExEU8RbRGMEaoRyRHoEgcSJhJFEmQShBKjEsMS4xMDEyMTQxNjE4MTpBPFE+UUBhQnFEkUahSLFK0UzhTwFRIVNBVWFXgVmxW9FeAWAxYmFkkWbBaPFrIW1hb6Fx0XQRdlF4kXrhfSF/cYGxhAGGUYihivGNUY+hkgGUUZaxmRGbcZ3RoEGioaURp3Gp4axRrsGxQbOxtjG4obshvaHAIcKhxSHHscoxzMHPUdHh1HHXAdmR3DHeweFh5AHmoelB6+HukfEx8+H2kflB+/H+ogFSBBIGwgmCDEIPAhHCFIIXUhoSHOIfsiJyJVIoIiryLdIwojOCNmI5QjwiPwJB8kTSR8JKsk2iUJJTglaCWXJccl9yYnJlcmhya3JugnGCdJJ3onqyfcKA0oPyhxKKIo1CkGKTgpaymdKdAqAio1KmgqmyrPKwIrNitpK50r0SwFLDksbiyiLNctDC1BLXYtqy3hLhYuTC6CLrcu7i8kL1ovkS/HL/4wNTBsMKQw2zESMUoxgjG6MfIyKjJjMpsy1DMNM0YzfzO4M/E0KzRlNJ402DUTNU01hzXCNf02NzZyNq426TckN2A3nDfXOBQ4UDiMOMg5BTlCOX85vDn5OjY6dDqyOu87LTtrO6o76DwnPGU8pDzjPSI9YT2hPeA+ID5gPqA+4D8hP2E/oj/iQCNAZECmQOdBKUFqQaxB7kIwQnJCtUL3QzpDfUPARANER0SKRM5FEkVVRZpF3kYiRmdGq0bwRzVHe0fASAVIS0iRSNdJHUljSalJ8Eo3Sn1KxEsMS1NLmkviTCpMcky6TQJNSk2TTdxOJU5uTrdPAE9JT5NP3VAnUHFQu1EGUVBRm1HmUjFSfFLHUxNTX1OqU/ZUQlSPVNtVKFV1VcJWD1ZcVqlW91dEV5JX4FgvWH1Yy1kaWWlZuFoHWlZaplr1W0VblVvlXDVchlzWXSddeF3JXhpebF69Xw9fYV+zYAVgV2CqYPxhT2GiYfViSWKcYvBjQ2OXY+tkQGSUZOllPWWSZedmPWaSZuhnPWeTZ+loP2iWaOxpQ2maafFqSGqfavdrT2una/9sV2yvbQhtYG25bhJua27Ebx5veG/RcCtwhnDgcTpxlXHwcktypnMBc11zuHQUdHB0zHUodYV14XY+dpt2+HdWd7N4EXhueMx5KnmJeed6RnqlewR7Y3vCfCF8gXzhfUF9oX4BfmJ+wn8jf4R/5YBHgKiBCoFrgc2CMIKSgvSDV4O6hB2EgITjhUeFq4YOhnKG14c7h5+IBIhpiM6JM4mZif6KZIrKizCLlov8jGOMyo0xjZiN/45mjs6PNo+ekAaQbpDWkT+RqJIRknqS45NNk7aUIJSKlPSVX5XJljSWn5cKl3WX4JhMmLiZJJmQmfyaaJrVm0Kbr5wcnImc951kndKeQJ6unx2fi5/6oGmg2KFHobaiJqKWowajdqPmpFakx6U4pammGqaLpv2nbqfgqFKoxKk3qamqHKqPqwKrdavprFys0K1ErbiuLa6hrxavi7AAsHWw6rFgsdayS7LCszizrrQltJy1E7WKtgG2ebbwt2i34LhZuNG5SrnCuju6tbsuu6e8IbybvRW9j74KvoS+/796v/XAcMDswWfB48JfwtvDWMPUxFHEzsVLxcjGRsbDx0HHv8g9yLzJOsm5yjjKt8s2y7bMNcy1zTXNtc42zrbPN8+40DnQutE80b7SP9LB00TTxtRJ1MvVTtXR1lXW2Ndc1+DYZNjo2WzZ8dp22vvbgNwF3IrdEN2W3hzeot8p36/gNuC94UThzOJT4tvjY+Pr5HPk/OWE5g3mlucf56noMui86Ubp0Opb6uXrcOv77IbtEe2c7ijutO9A78zwWPDl8XLx//KM8xnzp/Q09ML1UPXe9m32+/eK+Bn4qPk4+cf6V/rn+3f8B/yY/Sn9uv5L/tz/bf///9sAQwAGBAQEBQQGBQUGCQYFBgkLCAYGCAsMCgoLCgoMEAwMDAwMDBAMDg8QDw4MExMUFBMTHBsbGxwfHx8fHx8fHx8f/9sAQwEHBwcNDA0YEBAYGhURFRofHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8f/8AAEQgAyADIAwERAAIRAQMRAf/EABwAAQEAAgMBAQAAAAAAAAAAAAAHBggDBAUCCf/EAEIQAAEEAQIDAwcIBwgDAAAAAAABAgMEBREGIRIHMUETUWFxobEiFJEyQlKydDYIgXKSoiMzJMFigsJzNBUW0UNj/8QAGwEBAAIDAQEAAAAAAAAAAAAAAAUGAgMEAQf/xAA6EQEAAgECAwQFCQcFAAAAAAAAAQIDEQQxEgUhQVFhcaEyEzOBkbEiQlIUNAbwwdFicoIj4fGSJBX/2gAMAwEAAhEDEQA/ANqQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAB0szm8RhMfLkctbipUYf5k8zka1PInHtVe5E4ntazM6Q8mdEY3H+aTExSvg21ipMhpwS5ad4ES+drER0ip6dDsps5njLnybmK8GNJ+Y/qFNJzMq4+Ji/Q8KV3r8RDojY083DfqFo8Hv4X8x2YR7UzGHhmi+lJUe5j/Tyycyes8t06O6WqOsae1X5lY2nv8A2zuiNf8AjLP9S1NZKcqckzf8K9qeduqHDl298fGEnt95jzezPb4d7IjS6QAAAAAAAAAAAAAAAAAAAAHjbv3Zh9p7euZ3LSeHTqN1VqfPkevBkbE73PdwQypWbTpA0u3x1C3Fv7NuyGVkVlRjl+AxrVXwYGL2aJ9J6/SevFfQSuLFFY7HJmyO7s7ajs1PNEkvgNhYj1fy82qquiJpqhttblhH6c8zGrK16aZiJNYJYbCeTVY19eqGVc9e9xZtnk7pifU6tjbWYpprYpStan00bzN+Vup1UvWeEojPjy041lx1H2KlmO1UldBZhcjopo1Vr2uTvRUNk0iY0ng467mazzROkw2F6YdRE3LTWjfVrMzVbrJpwSaNOHiNTy/WQgd5tPdTrHsyufSupxuK6T7cevzZ2cKYAAAAAAAAAAAAAAAAAAAA1N/NVvebJ7xrbTryf0GFY2e2xF4Otzt1TX/TiVNP1lO/a00jVjedIYpt7p5fu46tdisxIthiPSF6ORURez3k1On3kRLiyYpmNVa6adPszV+MfJAjkVsac0bkcna5fSas2aOxhhwTGrOVwE8XBzFRfIqaGqMkMrY5cbqckfamhnFmmazDzb2BxF1F+Kqse5f/AGInK/8AabopupltXhLkzbXFk9qsSn8Vuba+7Us03LrQn1airxdH3sX9Zq6ElNYy4tJ74Vf3k7Tda1+zPqbN07UNupDahXmhnY2SNf7r01T2lXtXSdJfR6Xi0RMcJcp4yAAAAAAAAAAAAAAAAAAB+fe/cjLkeo25rsq6vlyVlPQjJFY1P0I0lsUaVhhl4LXs5rW4fGt7krxfZQ124tU8Fv2HypWm07VRuvrOPMzxspcxj00c1HJ5FTU0tujystiarqskjGcr2pronYptpedWjLijRhVmPkkVDtrKOtCT7xTTcd3zuav7jSZ23w4Uvqn5i3yfRC89LrTrOxMU5y6qyN0WvmjerU9hXt7XTLZeukX5ttSfJlRypIAAAAAAAAAAAAAAAAAAH5/dSMZJiepu56MiKisyE72a8NWTO8Vi/pa9CVxTrWGOWNYWLaM6Lhcc9Oxa8X2UQwtxap4KptHcTaTveTmY9OVya6fIaMlNWNb6M8q5zH2ERUfyKvc7/wAnPNJhui8S5rssbqMzmuRyIxV4LqeVjtLz2Sn956LIuh31Rl+KQ7wmRdxXl7keifIxqEzt/hwpnUY13Fv27oX/AKY031Ni4iN6aPfD4qovd4rlenqUr28trltK89Lx8m3pHkyg5kgAAAAAAAAAAAAAAAAAADVj822wp6uZpb4pxqtS21lLKuanzJmfyJHeZ7Pc18yeU7drfs0e6axowrZnUSjUx9ahfie1IGoxtiP3kVEXhzN4Kh0zTXg57W04qZhN14e5y/CXY3uX6Cu5Xfsu0Uwmkw0zaJ4Sy2plpWInvLoYaMZ1M9uCaLB3ZGvVqtiXRUVUXydxnipE2hz7nJNcdp8k3/7tnYnfwrj1T6siI9P3uJJe5pPGFctvM0T2S+duYy/u3dMFFFV8lyXxLkqJwZEnGR/Ds4cE84y5YxU18GO32ttxm0nvnWW1UEEUEEcETeWKJqMjanc1qaInyFbmdV7iIiNIfZ49AAAAAAAAAAAAAAAAAAB0M9g8XnsPbw+VgbZx92NYrELu9rvIvcqdqL3KexMxOsDSvqj0c3H07yUkvI+9tqR/9HlWpryovZHY0+Y9OzXsd3eQksWaLeljemrFad1NE4nTEo/LiZJjNz5Wnp8NdliT6qPVW/IuqGWkTxhyWraOEvasb6zVyi+lZmZJDJoj15ER6oi69qaeTyHtaVidYaMtslq8s8HHhKOXzuQjx2IrPt3JOyNnY1PrPd2NaneqmdssVjWXLTZzadIhtB0z6dVdn4t3iOSxmLaIt20nYmnFIo9foN9a8SG3O4nJPksWz2dcNf5p4szOZ2AAAAAAAAAAAAAAAAAAAAAOOxWr2YJK9mJk0ErVbLDI1Hsc1e1HNXVFQCSbp/LB08y8r7GL8fA2Xqqq2oqOr6r3+DJqif4VQ6Kbm0ebGaxLD3flLyLJNIdzRui7lfVVHafok0N0bzyabYIl7+C/K3g68jX5nM2bzU4rBAxtdq+ZXayO09Gh5be27oYxtK96tbc2pt3bdP4PCUYqUK/PViaveqd73rq5y+lTlvktadZlvpSKxpEPWMGYAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAATfqjHv1+Upf9b+M+GSBfH+FXRvic6/O49uhJ7GcPLPvNNfNXusxu5vX3HNpp26JpktzdQ8XZWrkMleq2EajlikkVHcruxSUx4MF41rETCtZ99vcVuW9rRL0669YrEMdiu/JyQyoj4pGvXRzV4oqcTTb8LE6Tyuun/pWiJjn0lnvUnqLZ27Xr43Ho1cvYjSSWV6I5IWdmvL3ucuumpwbLZxlmbT7MJzrHVp20RSnxJj5k1rXOp2XidkKs2StQoq6zRK/k1Tt5UbonDzEnau3pPLPLCt48u/zRz1m8w93Y3VfNU8nDj89M61SmekSzSp/Fhcq6Iqu01VNe1FOfdbCk15qdku7pnXMtckUzTrWZ0174ez1Ej6kv3NI7AfHf8b4UfJ8M7SPm097Tj2mjZzg5Pr6czu6tXezm/w83JpHBP7m7d+0rUlS3lbsNmJeWSJ8io5q+RSSrt8No1isaK9k6hu8dpra9otDJcPF1fXKUXWFyS1VniWZXu9zw+ZObXj2cpy5J23LOnLrolNvXqPvK83Py6xr6Hx1L3BuzD7wuVq2VtRVpEZPXjbIqNa17exE8nMinuyw474omaxqw6zvNxh3E1reYrOkws2AyCZHB0L6Lr8TBHIq+dzUVfWQmWnLaY8JXHbZfeY63+9ESkXVfeeeqbsfSxuQmqwVoY2vZC9Wor3avVV079HIhMdP21LY9bRrrKpdd6jlpn5cdprERHDxe/uHeWZ2vsPCt8VZ85kIkc6xP76sRUR73Lr2qnOjU1OfDtq5c1vuQkN51DJtdrTt1y2jjPrYBStdTs819ulPkLkbXcrpInq1iO7dE0VqfISN67fH2TFYQGLJv88c1ZvaGR7RXqpW3HjosgmQTHuma2ykyK+Pw17dVXm0OXcfh5pPLy8yS2H4+uasZOfk17dVpIRcAAAAAAAAAAAAa/8AWj8by/dofYpYumfC+VQf1H+Z/thadofhbE/dIfsIQe4+Jb0rpsvg0/phCOq1iSXfeU5l/lLHGz0JE1f7SwdPrphhROu3md3bXu0+hf8Ab9WGrgsfXhajIo68SNanBPmIV3LaZvMz4r/tqRXHWI4REID1WqQ1t85FsTUa2Tw5XIn1nsRXL8pYen2mcUKD17HFd1bTv0lf8FK+bCY+V66vkrQucvnWNFUruWNLT6V/28646z5Q136ifjnL/eP8rSy7P4NfQ+edX/N39P7obJVf9tD+o32FYtxfRq8ISLrzjOWxi8m1OD2vrSL52++z2uJnpN+y1flVL9UYfYv6YZV0dyPxeyYInLq+lJJAvo5udvqccfUaaZZ80r0DNz7Wsfd1hIL/ADbj6gStanMl/IeGn+nz8v2GkzT/ABYPRVUsv/Y3sx96/q/2VPrBtK7lsLUt46JZpsYruauzi50T0RF5U71bypwIrp24il5i32ln6/sLZsUWpGs07vJPdi9S7+1mOoTV0tY10ivfF82WNy8HK1V9HYpI7rZRl+tE6WV/pnWb7WOS0a01+WFt23u7BbirrNjLCPexEWWu73ZWa/WavtTgQWbb3xzpaF12m+xbiutJ1+l7BpdYAAAAAAAAAAANf+tH43l+7Q+xSxdM+F8qhfqP8z/bC07Q/C2J+6w/YQg9x8S3pXPZfBp/TCFdWKskG+skrk4T+HKz0LG1vtaT/T7a4YUXr2Oa7q0z36T6l52zkK1/b+Pt13o+J8EfFO5UaiORfOilfzUmt5ifFfNplrkxVtXhMQgXU+/Bf3vkZKzkkYxWQo5q6oro2I1dNPPwLDsaTXFGqhdbyxk3VuXt00hsJhIH18NQgfwfFXiY5PO1iIpXMk62mfN9AwV5aVjwiGuvUT8c5f7x/laWXZ/Br6Hzzq/5u/p/g2Sq/wC2h/Ub7CsW4vo1eEMO6v4z43ZNmRqavpPZYb6Gryu/dcp29Ovy5Y8+xE9dw8+2t/L2sC6V7hTG4Lc8bl08Gt8XF+sjVjX1q0kOoYea9POdEF0Ld+7xZY8I5v29To9G8Yt3ecdh7eZlGJ87l/vqnI37SqbOpX5cWni5v07h59zzT9mJn9zYArq/MR3h00wG4mvnRiUskqLy24k05l/+jex3tOzb72+Ps418ETv+j4dxGunLfxj9/iiG1r1zDbupPryfxY7Ta8isX3Xsc/w3p52qT24rF8U6+Gqk7HJbDua6T9rT09ujZ0qr6YAAAAAAAAAAACO9UdjbpzG6pLuNorYrOgiYkiOYnvNRdU0VUUmtjusdMelp7dVR630zPmz81K6xywqO26tipgMdVsN5J4a8bJWaoujmtRFTVCJzWibzMeKz7Wk1xVrPGIhjfUfp43dEEdqo9sOVrNVsbn68kjO3kcqdnHsU6tlvPdTpPsyjer9KjdViazpeP20StNhdS6PiVa9S02Jy++kEyJG79l6IS34vBbtmY+ZV46Xvsf1axbTyt2fSyfYvR/Ix5GDI7gRsMFdySR0kVHue9vFvOqcEai93ecu66jWazWnf3pLpn6fvW8Xzd3d/FYiFW9DN69PN4ZDdmSu08estaebnik52Iit0TjxUntrvMVccRM9qk9S6RuMm4tetfqzPiuEDXMgja7g5rURU86IQU8V1rHY4cnQhyGOs0Zv5VqJ8L+/g9qt19Z7S81tEx3MMuOL0ms8JjRr/AG+mW/sfZnrV6ck8T0WN01d7eSSPXXiiuRdF0RdFLFXfYbREzKg36Lu8dprWNYnvieMKX0o2Pf27TtWsm1rL13lRIUVHKyNmqojlThqqqRe/3UZZiK8IWXofTbbaszf2rO51RwW4Mxha0WD5viYbCSyIyTwnKzkcnBdU14qhhsctKWmb8NG7rO2zZcURi9qLa8dEtdtbqzyOhWHIOjdwc34jVFT9slvf7bj9X5lX/BdR00+v/wAv9WTdP+kmSq5SDK55GQsquSSCm1Ue5z0+ar1TgiN7dDl3fUK2rNad/ekuldBvTJGTL3cI/irxDLaAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD/2Q=="
}

Configuração

Informações

icon	false
title	1.1.6 GetOne expandable

Expandir

Informações

icon

false

title

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 6

Url Utilizada: http://localhost:8051/api/framework/v1/companies/6?expand=subsidiary

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "_expandables": [
        "subsidiary"
    ],
    "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",
    "imageId": 491,
    "isRuralProducer": "F",
    "active": "T",
    "image": "/9j/4AAQSkZJRgABAQEAAAAAAAD/7gAOQWRvYmUAZAAAAAAB/+IMWElDQ19QUk9GSUxFAAEBAAAMSExpbm8CEAAAbW50clJHQiBYWVogB84AAgAJAAYAMQAAYWNzcE1TRlQAAAAASUVDIHNSR0IAAAAAAAAAAAAAAAAAAPbWAAEAAAAA0y1IUCAgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAARY3BydAAAAVAAAAAzZGVzYwAAAYQAAABsd3RwdAAAAfAAAAAUYmtwdAAAAgQAAAAUclhZWgAAAhgAAAAUZ1hZWgAAAiwAAAAUYlhZWgAAAkAAAAAUZG1uZAAAAlQAAABwZG1kZAAAAsQAAACIdnVlZAAAA0wAAACGdmlldwAAA9QAAAAkbHVtaQAAA/gAAAAUbWVhcwAABAwAAAAkdGVjaAAABDAAAAAMclRSQwAABDwAAAgMZ1RSQwAABDwAAAgMYlRSQwAABDwAAAgMdGV4dAAAAABDb3B5cmlnaHQgKGMpIDE5OTggSGV3bGV0dC1QYWNrYXJkIENvbXBhbnkAAGRlc2MAAAAAAAAAEnNSR0IgSUVDNjE5NjYtMi4xAAAAAAAAAAAAAAASc1JHQiBJRUM2MTk2Ni0yLjEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAFhZWiAAAAAAAADzUQABAAAAARbMWFlaIAAAAAAAAAAAAAAAAAAAAABYWVogAAAAAAAAb6IAADj1AAADkFhZWiAAAAAAAABimQAAt4UAABjaWFlaIAAAAAAAACSgAAAPhAAAts9kZXNjAAAAAAAAABZJRUMgaHR0cDovL3d3dy5pZWMuY2gAAAAAAAAAAAAAABZJRUMgaHR0cDovL3d3dy5pZWMuY2gAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAZGVzYwAAAAAAAAAuSUVDIDYxOTY2LTIuMSBEZWZhdWx0IFJHQiBjb2xvdXIgc3BhY2UgLSBzUkdCAAAAAAAAAAAAAAAuSUVDIDYxOTY2LTIuMSBEZWZhdWx0IFJHQiBjb2xvdXIgc3BhY2UgLSBzUkdCAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGRlc2MAAAAAAAAALFJlZmVyZW5jZSBWaWV3aW5nIENvbmRpdGlvbiBpbiBJRUM2MTk2Ni0yLjEAAAAAAAAAAAAAACxSZWZlcmVuY2UgVmlld2luZyBDb25kaXRpb24gaW4gSUVDNjE5NjYtMi4xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAB2aWV3AAAAAAATpP4AFF8uABDPFAAD7cwABBMLAANcngAAAAFYWVogAAAAAABMCVYAUAAAAFcf521lYXMAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAKPAAAAAnNpZyAAAAAAQ1JUIGN1cnYAAAAAAAAEAAAAAAUACgAPABQAGQAeACMAKAAtADIANwA7AEAARQBKAE8AVABZAF4AYwBoAG0AcgB3AHwAgQCGAIsAkACVAJoAnwCkAKkArgCyALcAvADBAMYAywDQANUA2wDgAOUA6wDwAPYA+wEBAQcBDQETARkBHwElASsBMgE4AT4BRQFMAVIBWQFgAWcBbgF1AXwBgwGLAZIBmgGhAakBsQG5AcEByQHRAdkB4QHpAfIB+gIDAgwCFAIdAiYCLwI4AkECSwJUAl0CZwJxAnoChAKOApgCogKsArYCwQLLAtUC4ALrAvUDAAMLAxYDIQMtAzgDQwNPA1oDZgNyA34DigOWA6IDrgO6A8cD0wPgA+wD+QQGBBMEIAQtBDsESARVBGMEcQR+BIwEmgSoBLYExATTBOEE8AT+BQ0FHAUrBToFSQVYBWcFdwWGBZYFpgW1BcUF1QXlBfYGBgYWBicGNwZIBlkGagZ7BowGnQavBsAG0QbjBvUHBwcZBysHPQdPB2EHdAeGB5kHrAe/B9IH5Qf4CAsIHwgyCEYIWghuCIIIlgiqCL4I0gjnCPsJEAklCToJTwlkCXkJjwmkCboJzwnlCfsKEQonCj0KVApqCoEKmAquCsUK3ArzCwsLIgs5C1ELaQuAC5gLsAvIC+EL+QwSDCoMQwxcDHUMjgynDMAM2QzzDQ0NJg1ADVoNdA2ODakNww3eDfgOEw4uDkkOZA5/DpsOtg7SDu4PCQ8lD0EPXg96D5YPsw/PD+wQCRAmEEMQYRB+EJsQuRDXEPURExExEU8RbRGMEaoRyRHoEgcSJhJFEmQShBKjEsMS4xMDEyMTQxNjE4MTpBPFE+UUBhQnFEkUahSLFK0UzhTwFRIVNBVWFXgVmxW9FeAWAxYmFkkWbBaPFrIW1hb6Fx0XQRdlF4kXrhfSF/cYGxhAGGUYihivGNUY+hkgGUUZaxmRGbcZ3RoEGioaURp3Gp4axRrsGxQbOxtjG4obshvaHAIcKhxSHHscoxzMHPUdHh1HHXAdmR3DHeweFh5AHmoelB6+HukfEx8+H2kflB+/H+ogFSBBIGwgmCDEIPAhHCFIIXUhoSHOIfsiJyJVIoIiryLdIwojOCNmI5QjwiPwJB8kTSR8JKsk2iUJJTglaCWXJccl9yYnJlcmhya3JugnGCdJJ3onqyfcKA0oPyhxKKIo1CkGKTgpaymdKdAqAio1KmgqmyrPKwIrNitpK50r0SwFLDksbiyiLNctDC1BLXYtqy3hLhYuTC6CLrcu7i8kL1ovkS/HL/4wNTBsMKQw2zESMUoxgjG6MfIyKjJjMpsy1DMNM0YzfzO4M/E0KzRlNJ402DUTNU01hzXCNf02NzZyNq426TckN2A3nDfXOBQ4UDiMOMg5BTlCOX85vDn5OjY6dDqyOu87LTtrO6o76DwnPGU8pDzjPSI9YT2hPeA+ID5gPqA+4D8hP2E/oj/iQCNAZECmQOdBKUFqQaxB7kIwQnJCtUL3QzpDfUPARANER0SKRM5FEkVVRZpF3kYiRmdGq0bwRzVHe0fASAVIS0iRSNdJHUljSalJ8Eo3Sn1KxEsMS1NLmkviTCpMcky6TQJNSk2TTdxOJU5uTrdPAE9JT5NP3VAnUHFQu1EGUVBRm1HmUjFSfFLHUxNTX1OqU/ZUQlSPVNtVKFV1VcJWD1ZcVqlW91dEV5JX4FgvWH1Yy1kaWWlZuFoHWlZaplr1W0VblVvlXDVchlzWXSddeF3JXhpebF69Xw9fYV+zYAVgV2CqYPxhT2GiYfViSWKcYvBjQ2OXY+tkQGSUZOllPWWSZedmPWaSZuhnPWeTZ+loP2iWaOxpQ2maafFqSGqfavdrT2una/9sV2yvbQhtYG25bhJua27Ebx5veG/RcCtwhnDgcTpxlXHwcktypnMBc11zuHQUdHB0zHUodYV14XY+dpt2+HdWd7N4EXhueMx5KnmJeed6RnqlewR7Y3vCfCF8gXzhfUF9oX4BfmJ+wn8jf4R/5YBHgKiBCoFrgc2CMIKSgvSDV4O6hB2EgITjhUeFq4YOhnKG14c7h5+IBIhpiM6JM4mZif6KZIrKizCLlov8jGOMyo0xjZiN/45mjs6PNo+ekAaQbpDWkT+RqJIRknqS45NNk7aUIJSKlPSVX5XJljSWn5cKl3WX4JhMmLiZJJmQmfyaaJrVm0Kbr5wcnImc951kndKeQJ6unx2fi5/6oGmg2KFHobaiJqKWowajdqPmpFakx6U4pammGqaLpv2nbqfgqFKoxKk3qamqHKqPqwKrdavprFys0K1ErbiuLa6hrxavi7AAsHWw6rFgsdayS7LCszizrrQltJy1E7WKtgG2ebbwt2i34LhZuNG5SrnCuju6tbsuu6e8IbybvRW9j74KvoS+/796v/XAcMDswWfB48JfwtvDWMPUxFHEzsVLxcjGRsbDx0HHv8g9yLzJOsm5yjjKt8s2y7bMNcy1zTXNtc42zrbPN8+40DnQutE80b7SP9LB00TTxtRJ1MvVTtXR1lXW2Ndc1+DYZNjo2WzZ8dp22vvbgNwF3IrdEN2W3hzeot8p36/gNuC94UThzOJT4tvjY+Pr5HPk/OWE5g3mlucf56noMui86Ubp0Opb6uXrcOv77IbtEe2c7ijutO9A78zwWPDl8XLx//KM8xnzp/Q09ML1UPXe9m32+/eK+Bn4qPk4+cf6V/rn+3f8B/yY/Sn9uv5L/tz/bf///9sAQwAGBAQEBQQGBQUGCQYFBgkLCAYGCAsMCgoLCgoMEAwMDAwMDBAMDg8QDw4MExMUFBMTHBsbGxwfHx8fHx8fHx8f/9sAQwEHBwcNDA0YEBAYGhURFRofHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8f/8AAEQgAyADIAwERAAIRAQMRAf/EABwAAQEAAgMBAQAAAAAAAAAAAAAHBggDBAUCCf/EAEIQAAEEAQIDAwcIBwgDAAAAAAABAgMEBREGIRIHMUETUWFxobEiFJEyQlKydDYIgXKSoiMzJMFigsJzNBUW0UNj/8QAGwEBAAIDAQEAAAAAAAAAAAAAAAUGAgMEAQf/xAA6EQEAAgECAwQFCQcFAAAAAAAAAQIDEQQxEgUhQVFhcaEyEzOBkbEiQlIUNAbwwdFicoIj4fGSJBX/2gAMAwEAAhEDEQA/ANqQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAB0szm8RhMfLkctbipUYf5k8zka1PInHtVe5E4ntazM6Q8mdEY3H+aTExSvg21ipMhpwS5ad4ES+drER0ip6dDsps5njLnybmK8GNJ+Y/qFNJzMq4+Ji/Q8KV3r8RDojY083DfqFo8Hv4X8x2YR7UzGHhmi+lJUe5j/Tyycyes8t06O6WqOsae1X5lY2nv8A2zuiNf8AjLP9S1NZKcqckzf8K9qeduqHDl298fGEnt95jzezPb4d7IjS6QAAAAAAAAAAAAAAAAAAAAHjbv3Zh9p7euZ3LSeHTqN1VqfPkevBkbE73PdwQypWbTpA0u3x1C3Fv7NuyGVkVlRjl+AxrVXwYGL2aJ9J6/SevFfQSuLFFY7HJmyO7s7ajs1PNEkvgNhYj1fy82qquiJpqhttblhH6c8zGrK16aZiJNYJYbCeTVY19eqGVc9e9xZtnk7pifU6tjbWYpprYpStan00bzN+Vup1UvWeEojPjy041lx1H2KlmO1UldBZhcjopo1Vr2uTvRUNk0iY0ng467mazzROkw2F6YdRE3LTWjfVrMzVbrJpwSaNOHiNTy/WQgd5tPdTrHsyufSupxuK6T7cevzZ2cKYAAAAAAAAAAAAAAAAAAAA1N/NVvebJ7xrbTryf0GFY2e2xF4Otzt1TX/TiVNP1lO/a00jVjedIYpt7p5fu46tdisxIthiPSF6ORURez3k1On3kRLiyYpmNVa6adPszV+MfJAjkVsac0bkcna5fSas2aOxhhwTGrOVwE8XBzFRfIqaGqMkMrY5cbqckfamhnFmmazDzb2BxF1F+Kqse5f/AGInK/8AabopupltXhLkzbXFk9qsSn8Vuba+7Us03LrQn1airxdH3sX9Zq6ElNYy4tJ74Vf3k7Tda1+zPqbN07UNupDahXmhnY2SNf7r01T2lXtXSdJfR6Xi0RMcJcp4yAAAAAAAAAAAAAAAAAAB+fe/cjLkeo25rsq6vlyVlPQjJFY1P0I0lsUaVhhl4LXs5rW4fGt7krxfZQ124tU8Fv2HypWm07VRuvrOPMzxspcxj00c1HJ5FTU0tujystiarqskjGcr2pronYptpedWjLijRhVmPkkVDtrKOtCT7xTTcd3zuav7jSZ23w4Uvqn5i3yfRC89LrTrOxMU5y6qyN0WvmjerU9hXt7XTLZeukX5ttSfJlRypIAAAAAAAAAAAAAAAAAAH5/dSMZJiepu56MiKisyE72a8NWTO8Vi/pa9CVxTrWGOWNYWLaM6Lhcc9Oxa8X2UQwtxap4KptHcTaTveTmY9OVya6fIaMlNWNb6M8q5zH2ERUfyKvc7/wAnPNJhui8S5rssbqMzmuRyIxV4LqeVjtLz2Sn956LIuh31Rl+KQ7wmRdxXl7keifIxqEzt/hwpnUY13Fv27oX/AKY031Ni4iN6aPfD4qovd4rlenqUr28trltK89Lx8m3pHkyg5kgAAAAAAAAAAAAAAAAAADVj822wp6uZpb4pxqtS21lLKuanzJmfyJHeZ7Pc18yeU7drfs0e6axowrZnUSjUx9ahfie1IGoxtiP3kVEXhzN4Kh0zTXg57W04qZhN14e5y/CXY3uX6Cu5Xfsu0Uwmkw0zaJ4Sy2plpWInvLoYaMZ1M9uCaLB3ZGvVqtiXRUVUXydxnipE2hz7nJNcdp8k3/7tnYnfwrj1T6siI9P3uJJe5pPGFctvM0T2S+duYy/u3dMFFFV8lyXxLkqJwZEnGR/Ds4cE84y5YxU18GO32ttxm0nvnWW1UEEUEEcETeWKJqMjanc1qaInyFbmdV7iIiNIfZ49AAAAAAAAAAAAAAAAAAB0M9g8XnsPbw+VgbZx92NYrELu9rvIvcqdqL3KexMxOsDSvqj0c3H07yUkvI+9tqR/9HlWpryovZHY0+Y9OzXsd3eQksWaLeljemrFad1NE4nTEo/LiZJjNz5Wnp8NdliT6qPVW/IuqGWkTxhyWraOEvasb6zVyi+lZmZJDJoj15ER6oi69qaeTyHtaVidYaMtslq8s8HHhKOXzuQjx2IrPt3JOyNnY1PrPd2NaneqmdssVjWXLTZzadIhtB0z6dVdn4t3iOSxmLaIt20nYmnFIo9foN9a8SG3O4nJPksWz2dcNf5p4szOZ2AAAAAAAAAAAAAAAAAAAAAOOxWr2YJK9mJk0ErVbLDI1Hsc1e1HNXVFQCSbp/LB08y8r7GL8fA2Xqqq2oqOr6r3+DJqif4VQ6Kbm0ebGaxLD3flLyLJNIdzRui7lfVVHafok0N0bzyabYIl7+C/K3g68jX5nM2bzU4rBAxtdq+ZXayO09Gh5be27oYxtK96tbc2pt3bdP4PCUYqUK/PViaveqd73rq5y+lTlvktadZlvpSKxpEPWMGYAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAATfqjHv1+Upf9b+M+GSBfH+FXRvic6/O49uhJ7GcPLPvNNfNXusxu5vX3HNpp26JpktzdQ8XZWrkMleq2EajlikkVHcruxSUx4MF41rETCtZ99vcVuW9rRL0669YrEMdiu/JyQyoj4pGvXRzV4oqcTTb8LE6Tyuun/pWiJjn0lnvUnqLZ27Xr43Ho1cvYjSSWV6I5IWdmvL3ucuumpwbLZxlmbT7MJzrHVp20RSnxJj5k1rXOp2XidkKs2StQoq6zRK/k1Tt5UbonDzEnau3pPLPLCt48u/zRz1m8w93Y3VfNU8nDj89M61SmekSzSp/Fhcq6Iqu01VNe1FOfdbCk15qdku7pnXMtckUzTrWZ0174ez1Ej6kv3NI7AfHf8b4UfJ8M7SPm097Tj2mjZzg5Pr6czu6tXezm/w83JpHBP7m7d+0rUlS3lbsNmJeWSJ8io5q+RSSrt8No1isaK9k6hu8dpra9otDJcPF1fXKUXWFyS1VniWZXu9zw+ZObXj2cpy5J23LOnLrolNvXqPvK83Py6xr6Hx1L3BuzD7wuVq2VtRVpEZPXjbIqNa17exE8nMinuyw474omaxqw6zvNxh3E1reYrOkws2AyCZHB0L6Lr8TBHIq+dzUVfWQmWnLaY8JXHbZfeY63+9ESkXVfeeeqbsfSxuQmqwVoY2vZC9Wor3avVV079HIhMdP21LY9bRrrKpdd6jlpn5cdprERHDxe/uHeWZ2vsPCt8VZ85kIkc6xP76sRUR73Lr2qnOjU1OfDtq5c1vuQkN51DJtdrTt1y2jjPrYBStdTs819ulPkLkbXcrpInq1iO7dE0VqfISN67fH2TFYQGLJv88c1ZvaGR7RXqpW3HjosgmQTHuma2ykyK+Pw17dVXm0OXcfh5pPLy8yS2H4+uasZOfk17dVpIRcAAAAAAAAAAAAa/8AWj8by/dofYpYumfC+VQf1H+Z/thadofhbE/dIfsIQe4+Jb0rpsvg0/phCOq1iSXfeU5l/lLHGz0JE1f7SwdPrphhROu3md3bXu0+hf8Ab9WGrgsfXhajIo68SNanBPmIV3LaZvMz4r/tqRXHWI4REID1WqQ1t85FsTUa2Tw5XIn1nsRXL8pYen2mcUKD17HFd1bTv0lf8FK+bCY+V66vkrQucvnWNFUruWNLT6V/28646z5Q136ifjnL/eP8rSy7P4NfQ+edX/N39P7obJVf9tD+o32FYtxfRq8ISLrzjOWxi8m1OD2vrSL52++z2uJnpN+y1flVL9UYfYv6YZV0dyPxeyYInLq+lJJAvo5udvqccfUaaZZ80r0DNz7Wsfd1hIL/ADbj6gStanMl/IeGn+nz8v2GkzT/ABYPRVUsv/Y3sx96/q/2VPrBtK7lsLUt46JZpsYruauzi50T0RF5U71bypwIrp24il5i32ln6/sLZsUWpGs07vJPdi9S7+1mOoTV0tY10ivfF82WNy8HK1V9HYpI7rZRl+tE6WV/pnWb7WOS0a01+WFt23u7BbirrNjLCPexEWWu73ZWa/WavtTgQWbb3xzpaF12m+xbiutJ1+l7BpdYAAAAAAAAAAANf+tH43l+7Q+xSxdM+F8qhfqP8z/bC07Q/C2J+6w/YQg9x8S3pXPZfBp/TCFdWKskG+skrk4T+HKz0LG1vtaT/T7a4YUXr2Oa7q0z36T6l52zkK1/b+Pt13o+J8EfFO5UaiORfOilfzUmt5ifFfNplrkxVtXhMQgXU+/Bf3vkZKzkkYxWQo5q6oro2I1dNPPwLDsaTXFGqhdbyxk3VuXt00hsJhIH18NQgfwfFXiY5PO1iIpXMk62mfN9AwV5aVjwiGuvUT8c5f7x/laWXZ/Br6Hzzq/5u/p/g2Sq/wC2h/Ub7CsW4vo1eEMO6v4z43ZNmRqavpPZYb6Gryu/dcp29Ovy5Y8+xE9dw8+2t/L2sC6V7hTG4Lc8bl08Gt8XF+sjVjX1q0kOoYea9POdEF0Ld+7xZY8I5v29To9G8Yt3ecdh7eZlGJ87l/vqnI37SqbOpX5cWni5v07h59zzT9mJn9zYArq/MR3h00wG4mvnRiUskqLy24k05l/+jex3tOzb72+Ps418ETv+j4dxGunLfxj9/iiG1r1zDbupPryfxY7Ta8isX3Xsc/w3p52qT24rF8U6+Gqk7HJbDua6T9rT09ujZ0qr6YAAAAAAAAAAACO9UdjbpzG6pLuNorYrOgiYkiOYnvNRdU0VUUmtjusdMelp7dVR630zPmz81K6xywqO26tipgMdVsN5J4a8bJWaoujmtRFTVCJzWibzMeKz7Wk1xVrPGIhjfUfp43dEEdqo9sOVrNVsbn68kjO3kcqdnHsU6tlvPdTpPsyjer9KjdViazpeP20StNhdS6PiVa9S02Jy++kEyJG79l6IS34vBbtmY+ZV46Xvsf1axbTyt2fSyfYvR/Ix5GDI7gRsMFdySR0kVHue9vFvOqcEai93ecu66jWazWnf3pLpn6fvW8Xzd3d/FYiFW9DN69PN4ZDdmSu08estaebnik52Iit0TjxUntrvMVccRM9qk9S6RuMm4tetfqzPiuEDXMgja7g5rURU86IQU8V1rHY4cnQhyGOs0Zv5VqJ8L+/g9qt19Z7S81tEx3MMuOL0ms8JjRr/AG+mW/sfZnrV6ck8T0WN01d7eSSPXXiiuRdF0RdFLFXfYbREzKg36Lu8dprWNYnvieMKX0o2Pf27TtWsm1rL13lRIUVHKyNmqojlThqqqRe/3UZZiK8IWXofTbbaszf2rO51RwW4Mxha0WD5viYbCSyIyTwnKzkcnBdU14qhhsctKWmb8NG7rO2zZcURi9qLa8dEtdtbqzyOhWHIOjdwc34jVFT9slvf7bj9X5lX/BdR00+v/wAv9WTdP+kmSq5SDK55GQsquSSCm1Ue5z0+ar1TgiN7dDl3fUK2rNad/ekuldBvTJGTL3cI/irxDLaAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD/2Q==",
    "subsidiary": [
        {
            "code": 12,
            "name": "ESCOLA EXEMPLO 1",
            "federalId": "25.578.337/0006-16"
        },
        {
            "code": 14,
            "name": "ESCOLA EXEMPLO 2",
            "federalId": "25.578.337/0003-73"
        }
    ]
}

1.2 - POST

...

1.2.1 - Post (Inserir uma Coligada)

...

Configuração

Informações

icon	false
title	1.2.1 Post

Expandir

Informações

icon

false

title

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

Informações

icon	false
title	Observação:

Para incluir uma imagem no corpo (Body) na hora de realizar um POST (inclusão de registro), a imagem deve ser informada no formato Array de Byte.

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "id": "12",
    "code": 12,
    "nickname": "TOTVS SA CNPJ",
    "federalId": "19.023.489/0001-45",
    "name": "TOTVS SA CNPJ",
    "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

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "id": "testeapiusuario",
    "meta": {
        "resourceType": "User",
        "created": "2018-09-21T16:49:57.336Z",
        "lastModified": "2018-09-21T16:49:57.336Z"
    },
    "externalId": "0001e",
    "name": {
        "givenName": "TesteAPI",
        "familyName": "Usuário"
    },
    "userName": "testeapiusuario",
    "phoneNumbers": [
        {
            "value": "31974964158"
        }
    ],
    "emails": [
        {
            "value": "[email protected]",
            "type": "string",
            "primary": true
        }
    ],
    "active": true,
    "groups": [
        {
            "value": "01",
            "display": "geral"
        }
    ],
    "title": "Mr",
    "manager": [
        {
            "managerId": "01",
            "displayName": "Geral"
        }
    ]
}

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "Code": "FE006",
    "Message": "Chave duplicada\r\n\r\nPossíveis causas:\r\n  - inclusão de registro cujo valor da chave primária já existe\r\n  - inclusão de registro cujo valor do índice único já existe",
    "DetailMessage": "Violation of PRIMARY KEY constraint 'PKGCOLIGADA'. Cannot insert duplicate key in object 'dbo.GCOLIGADA'. The duplicate key value is (12).\r\nThe statement has been terminated.\r\n\r\nINSERT INTO [GCOLIGADA] ([CODCOLIGADA], [NOMEFANTASIA], [CGC], [NOME], [INSCRICAOESTADUAL], [TELEFONE], [FAX], [EMAIL], [RUA], [NUMERO], [COMPLEMENTO], [BAIRRO], [CIDADE], [ESTADO], [PAIS], [CEP], [CONTROLACGC], [CONTROLE1], [CONTROLE2], [CONTROLE3], [PRODUTORRURAL], [ATIVO], [CODEXTERNO], [IMPORTADA], [IDIMAGEM], [DATALIMITELICENCAS], [RECCREATEDBY], [RECCREATEDON], [RECMODIFIEDBY], [RECMODIFIEDON]) VALUES (12, 'TOTVS SA CNPJ', '19.023.489/0001-45', 'TOTVS SA CNPJ', '062.307.904/0081', '31-21229000', '31-21229155', '[email protected]', 'AVENIDA RAJA GABAGLIA', '2664', '2º ANDAR', 'SANTA LÚCIA', 'Belo Horizonte', 'MG', 'Brasil', '30494-170', , -32479, 4788, 4865, 'T', 'T', '651465', 'F', , null, 'mestre', CONVERT ( DATETIME, CONVERT ( VARCHAR, GETDATE(), 120) ), 'mestre', CONVERT ( DATETIME, CONVERT ( VARCHAR, GETDATE(), 120) ))",
    "HelpUrl": "",
    "Details": null
}

1.3 - PUT

...

1.3.1 - Put (Atualizar uma Coligada)

...

icon

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

Informações

icon	false
title	1.3.1 Post

Expandir

Informações

false

title

Configuração

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 12

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

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "id": "12",
    "code": 12,
    "nickname": "TOTVS SA",
    "federalId": "19.023.489/0001-45",
    "name": "TOTVS SA",
    "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",
    "isRuralProducer": "T",
    "active": "T",
    "externalCode": "651465",
    "isFluigIntegrated": 0
}

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "id": "12",
    "code": 12,
    "nickname": "TOTVS SA",
    "federalId": "19.023.489/0001-45",
    "name": "TOTVS SA",
    "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",
    "isRuralProducer": "T",
    "active": "T",
    "externalCode": "651465",
    "isFluigIntegrated": 0
}

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "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 - PATCH

...

1.4.1 - Patch (Atualização parcial de uma Coligada)

...

Configuração

Informações

icon	false
title	1.3.1 Post

Expandir

Informações

icon

false

title

Patch

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 12

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

Informações

icon	false
title	Exemplo de Entrada

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "nickname": "TOTVS SA Teste",
    "name": "TOTVS SA Teste",
    "email": "[email protected]",
}

Informações

icon	false
title	Exemplo de Resultado Positivo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "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

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "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

icon	false
title	1.4.1 Delete

Expandir

title	Clique aqui para expandir...

Informações

icon

false

title

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 12

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

Informações

icon	false
title	Exemplo de Configuração

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

Informações

icon	false
title	Exemplo de Resultado Positivo Postman

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

Informações

icon	false
title	Exemplo de Resultado Negativo

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "Code": "FE011",
    "Message": "Registro não encontrado na base de dados.",
    "DetailMessage": "",
    "HelpUrl": "",
    "Details": null
}

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 20

Nova versão Atual

Chave

Objetivo

1 - Métodos

1.1.2 - Order (Resultado Ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

1.1.5 - Fields (Retorno de campos específicos no resultado)

1.1.6 - GetOne (Recuperar coligada pelo identificador)

1.2 - POST

1.2.1 - Post (Inserir uma Coligada)

1.3 - PUT

1.3.1 - Put (Atualizar uma Coligada)

1.4 - PATCH

1.4.1 - Patch (Atualização parcial de uma Coligada)

1.4 - DELETE

1.4.1 - Delete (Desativa uma Coligada)

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 20

Nova versão Atual

Chave

Objetivo

1 - Métodos

1.1.2 - Order (Resultado Ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

1.1.5 - Fields (Retorno de campos específicos no resultado)

1.1.6 - GetOne (Recuperar coligada pelo identificador)

1.2 - POST

1.2.1 - Post (Inserir uma Coligada)

1.3 - PUT

1.3.1 - Put (Atualizar uma Coligada)

1.4 - PATCH

1.4.1 - Patch (Atualização parcial de uma Coligada)

1.4 - DELETE

1.4.1 - Delete (Desativa uma Coligada)