GET api/v2/institucional/getdetalhes?TenantId={TenantId}&Version={Version}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
TenantId

globally unique identifier

None.

Version

integer

None.

Body Parameters

None.

Response Information

Resource Description

InstitucionalDetalhesResult
NameDescriptionTypeAdditional information
Institucional

InstitucionalUpdateBindingModel

None.

Succeeded

boolean

None.

Errors

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Institucional": {
    "Version": "sample string 1",
    "FacebookId": "sample string 2",
    "Twitter": "sample string 3",
    "WebSite": "sample string 4",
    "GooglePlus": "sample string 5",
    "YouTube": "sample string 6",
    "WhatsApp": "sample string 7",
    "Sobre": "sample string 8",
    "Unidades": [
      {
        "TenantId": "dff8435a-6b63-4b1f-817c-493b5a457000",
        "Descricao": "sample string 2",
        "Endereco": {
          "EnderecoId": 1,
          "NomeEndereco": "sample string 2",
          "Endereco": "sample string 3",
          "Cidade": "sample string 4",
          "Estado": "sample string 5",
          "Cep": "sample string 6",
          "Numero": "sample string 7",
          "Bairro": "sample string 8",
          "Complemento": "sample string 9",
          "Latitude": "sample string 10",
          "Longitude": "sample string 11",
          "Distancia": "sample string 12",
          "Duracao": "sample string 13",
          "DistanciaValue": 14
        },
        "Filiais": [
          {
            "EnderecoId": 1,
            "NomeEndereco": "sample string 2",
            "Endereco": "sample string 3",
            "Cidade": "sample string 4",
            "Estado": "sample string 5",
            "Cep": "sample string 6",
            "Numero": "sample string 7",
            "Bairro": "sample string 8",
            "Complemento": "sample string 9",
            "Latitude": "sample string 10",
            "Longitude": "sample string 11",
            "Distancia": "sample string 12",
            "Duracao": "sample string 13",
            "DistanciaValue": 14
          },
          {
            "EnderecoId": 1,
            "NomeEndereco": "sample string 2",
            "Endereco": "sample string 3",
            "Cidade": "sample string 4",
            "Estado": "sample string 5",
            "Cep": "sample string 6",
            "Numero": "sample string 7",
            "Bairro": "sample string 8",
            "Complemento": "sample string 9",
            "Latitude": "sample string 10",
            "Longitude": "sample string 11",
            "Distancia": "sample string 12",
            "Duracao": "sample string 13",
            "DistanciaValue": 14
          }
        ],
        "DescrFiliais": [
          {
            "Id": 1,
            "TpFarmacia": "sample string 2",
            "TenantId": "sample string 3",
            "SubClientId": "sample string 4",
            "CdFilial": "sample string 5",
            "Nome": "sample string 6",
            "TenantGroupId": "sample string 7",
            "EnderecoId": 8,
            "Ender": "sample string 9",
            "EndNr": "sample string 10",
            "Bairr": "sample string 11",
            "Munic": "sample string 12",
            "Estado": "sample string 13",
            "NrCep": "sample string 14",
            "Distancia": "sample string 15",
            "DistanciaOrdenar": 16.1
          },
          {
            "Id": 1,
            "TpFarmacia": "sample string 2",
            "TenantId": "sample string 3",
            "SubClientId": "sample string 4",
            "CdFilial": "sample string 5",
            "Nome": "sample string 6",
            "TenantGroupId": "sample string 7",
            "EnderecoId": 8,
            "Ender": "sample string 9",
            "EndNr": "sample string 10",
            "Bairr": "sample string 11",
            "Munic": "sample string 12",
            "Estado": "sample string 13",
            "NrCep": "sample string 14",
            "Distancia": "sample string 15",
            "DistanciaOrdenar": 16.1
          }
        ],
        "Destino": "aef2a8ea-ef32-431d-9a09-77fc5903c6be"
      },
      {
        "TenantId": "dff8435a-6b63-4b1f-817c-493b5a457000",
        "Descricao": "sample string 2",
        "Endereco": {
          "EnderecoId": 1,
          "NomeEndereco": "sample string 2",
          "Endereco": "sample string 3",
          "Cidade": "sample string 4",
          "Estado": "sample string 5",
          "Cep": "sample string 6",
          "Numero": "sample string 7",
          "Bairro": "sample string 8",
          "Complemento": "sample string 9",
          "Latitude": "sample string 10",
          "Longitude": "sample string 11",
          "Distancia": "sample string 12",
          "Duracao": "sample string 13",
          "DistanciaValue": 14
        },
        "Filiais": [
          {
            "EnderecoId": 1,
            "NomeEndereco": "sample string 2",
            "Endereco": "sample string 3",
            "Cidade": "sample string 4",
            "Estado": "sample string 5",
            "Cep": "sample string 6",
            "Numero": "sample string 7",
            "Bairro": "sample string 8",
            "Complemento": "sample string 9",
            "Latitude": "sample string 10",
            "Longitude": "sample string 11",
            "Distancia": "sample string 12",
            "Duracao": "sample string 13",
            "DistanciaValue": 14
          },
          {
            "EnderecoId": 1,
            "NomeEndereco": "sample string 2",
            "Endereco": "sample string 3",
            "Cidade": "sample string 4",
            "Estado": "sample string 5",
            "Cep": "sample string 6",
            "Numero": "sample string 7",
            "Bairro": "sample string 8",
            "Complemento": "sample string 9",
            "Latitude": "sample string 10",
            "Longitude": "sample string 11",
            "Distancia": "sample string 12",
            "Duracao": "sample string 13",
            "DistanciaValue": 14
          }
        ],
        "DescrFiliais": [
          {
            "Id": 1,
            "TpFarmacia": "sample string 2",
            "TenantId": "sample string 3",
            "SubClientId": "sample string 4",
            "CdFilial": "sample string 5",
            "Nome": "sample string 6",
            "TenantGroupId": "sample string 7",
            "EnderecoId": 8,
            "Ender": "sample string 9",
            "EndNr": "sample string 10",
            "Bairr": "sample string 11",
            "Munic": "sample string 12",
            "Estado": "sample string 13",
            "NrCep": "sample string 14",
            "Distancia": "sample string 15",
            "DistanciaOrdenar": 16.1
          },
          {
            "Id": 1,
            "TpFarmacia": "sample string 2",
            "TenantId": "sample string 3",
            "SubClientId": "sample string 4",
            "CdFilial": "sample string 5",
            "Nome": "sample string 6",
            "TenantGroupId": "sample string 7",
            "EnderecoId": 8,
            "Ender": "sample string 9",
            "EndNr": "sample string 10",
            "Bairr": "sample string 11",
            "Munic": "sample string 12",
            "Estado": "sample string 13",
            "NrCep": "sample string 14",
            "Distancia": "sample string 15",
            "DistanciaOrdenar": 16.1
          }
        ],
        "Destino": "aef2a8ea-ef32-431d-9a09-77fc5903c6be"
      }
    ],
    "Lojas": "sample string 9",
    "Lembrete": true,
    "News": true
  },
  "Succeeded": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<InstitucionalDetalhesResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models.v2.Result">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <Succeeded xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models">true</Succeeded>
  <Institucional xmlns:d2p1="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models.v2.BindingModels">
    <d2p1:FacebookId>sample string 2</d2p1:FacebookId>
    <d2p1:GooglePlus>sample string 5</d2p1:GooglePlus>
    <d2p1:Lembrete>true</d2p1:Lembrete>
    <d2p1:Lojas>sample string 9</d2p1:Lojas>
    <d2p1:News>true</d2p1:News>
    <d2p1:Sobre>sample string 8</d2p1:Sobre>
    <d2p1:Twitter>sample string 3</d2p1:Twitter>
    <d2p1:Unidades xmlns:d3p1="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models.Results">
      <d3p1:Unidade>
        <d3p1:DescrFiliais xmlns:d5p1="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models.v1.Results">
          <d5p1:GetFiliaisItemResult>
            <d5p1:Bairr>sample string 11</d5p1:Bairr>
            <d5p1:CdFilial>sample string 5</d5p1:CdFilial>
            <d5p1:Distancia>sample string 15</d5p1:Distancia>
            <d5p1:DistanciaOrdenar>16.1</d5p1:DistanciaOrdenar>
            <d5p1:EndNr>sample string 10</d5p1:EndNr>
            <d5p1:Ender>sample string 9</d5p1:Ender>
            <d5p1:EnderecoId>8</d5p1:EnderecoId>
            <d5p1:Estado>sample string 13</d5p1:Estado>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Munic>sample string 12</d5p1:Munic>
            <d5p1:Nome>sample string 6</d5p1:Nome>
            <d5p1:NrCep>sample string 14</d5p1:NrCep>
            <d5p1:SubClientId>sample string 4</d5p1:SubClientId>
            <d5p1:TenantGroupId>sample string 7</d5p1:TenantGroupId>
            <d5p1:TenantId>sample string 3</d5p1:TenantId>
            <d5p1:TpFarmacia>sample string 2</d5p1:TpFarmacia>
          </d5p1:GetFiliaisItemResult>
          <d5p1:GetFiliaisItemResult>
            <d5p1:Bairr>sample string 11</d5p1:Bairr>
            <d5p1:CdFilial>sample string 5</d5p1:CdFilial>
            <d5p1:Distancia>sample string 15</d5p1:Distancia>
            <d5p1:DistanciaOrdenar>16.1</d5p1:DistanciaOrdenar>
            <d5p1:EndNr>sample string 10</d5p1:EndNr>
            <d5p1:Ender>sample string 9</d5p1:Ender>
            <d5p1:EnderecoId>8</d5p1:EnderecoId>
            <d5p1:Estado>sample string 13</d5p1:Estado>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Munic>sample string 12</d5p1:Munic>
            <d5p1:Nome>sample string 6</d5p1:Nome>
            <d5p1:NrCep>sample string 14</d5p1:NrCep>
            <d5p1:SubClientId>sample string 4</d5p1:SubClientId>
            <d5p1:TenantGroupId>sample string 7</d5p1:TenantGroupId>
            <d5p1:TenantId>sample string 3</d5p1:TenantId>
            <d5p1:TpFarmacia>sample string 2</d5p1:TpFarmacia>
          </d5p1:GetFiliaisItemResult>
        </d3p1:DescrFiliais>
        <d3p1:Descricao>sample string 2</d3p1:Descricao>
        <d3p1:Destino>aef2a8ea-ef32-431d-9a09-77fc5903c6be</d3p1:Destino>
        <d3p1:Endereco xmlns:d5p1="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models">
          <d5p1:Bairro>sample string 8</d5p1:Bairro>
          <d5p1:Cep>sample string 6</d5p1:Cep>
          <d5p1:Cidade>sample string 4</d5p1:Cidade>
          <d5p1:Complemento>sample string 9</d5p1:Complemento>
          <d5p1:Distancia>sample string 12</d5p1:Distancia>
          <d5p1:DistanciaValue>14</d5p1:DistanciaValue>
          <d5p1:Duracao>sample string 13</d5p1:Duracao>
          <d5p1:Endereco>sample string 3</d5p1:Endereco>
          <d5p1:EnderecoId>1</d5p1:EnderecoId>
          <d5p1:Estado>sample string 5</d5p1:Estado>
          <d5p1:Latitude>sample string 10</d5p1:Latitude>
          <d5p1:Longitude>sample string 11</d5p1:Longitude>
          <d5p1:NomeEndereco>sample string 2</d5p1:NomeEndereco>
          <d5p1:Numero>sample string 7</d5p1:Numero>
        </d3p1:Endereco>
        <d3p1:Filiais xmlns:d5p1="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models">
          <d5p1:GetEnderecosItemResult>
            <d5p1:Bairro>sample string 8</d5p1:Bairro>
            <d5p1:Cep>sample string 6</d5p1:Cep>
            <d5p1:Cidade>sample string 4</d5p1:Cidade>
            <d5p1:Complemento>sample string 9</d5p1:Complemento>
            <d5p1:Distancia>sample string 12</d5p1:Distancia>
            <d5p1:DistanciaValue>14</d5p1:DistanciaValue>
            <d5p1:Duracao>sample string 13</d5p1:Duracao>
            <d5p1:Endereco>sample string 3</d5p1:Endereco>
            <d5p1:EnderecoId>1</d5p1:EnderecoId>
            <d5p1:Estado>sample string 5</d5p1:Estado>
            <d5p1:Latitude>sample string 10</d5p1:Latitude>
            <d5p1:Longitude>sample string 11</d5p1:Longitude>
            <d5p1:NomeEndereco>sample string 2</d5p1:NomeEndereco>
            <d5p1:Numero>sample string 7</d5p1:Numero>
          </d5p1:GetEnderecosItemResult>
          <d5p1:GetEnderecosItemResult>
            <d5p1:Bairro>sample string 8</d5p1:Bairro>
            <d5p1:Cep>sample string 6</d5p1:Cep>
            <d5p1:Cidade>sample string 4</d5p1:Cidade>
            <d5p1:Complemento>sample string 9</d5p1:Complemento>
            <d5p1:Distancia>sample string 12</d5p1:Distancia>
            <d5p1:DistanciaValue>14</d5p1:DistanciaValue>
            <d5p1:Duracao>sample string 13</d5p1:Duracao>
            <d5p1:Endereco>sample string 3</d5p1:Endereco>
            <d5p1:EnderecoId>1</d5p1:EnderecoId>
            <d5p1:Estado>sample string 5</d5p1:Estado>
            <d5p1:Latitude>sample string 10</d5p1:Latitude>
            <d5p1:Longitude>sample string 11</d5p1:Longitude>
            <d5p1:NomeEndereco>sample string 2</d5p1:NomeEndereco>
            <d5p1:Numero>sample string 7</d5p1:Numero>
          </d5p1:GetEnderecosItemResult>
        </d3p1:Filiais>
        <d3p1:TenantId>dff8435a-6b63-4b1f-817c-493b5a457000</d3p1:TenantId>
      </d3p1:Unidade>
      <d3p1:Unidade>
        <d3p1:DescrFiliais xmlns:d5p1="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models.v1.Results">
          <d5p1:GetFiliaisItemResult>
            <d5p1:Bairr>sample string 11</d5p1:Bairr>
            <d5p1:CdFilial>sample string 5</d5p1:CdFilial>
            <d5p1:Distancia>sample string 15</d5p1:Distancia>
            <d5p1:DistanciaOrdenar>16.1</d5p1:DistanciaOrdenar>
            <d5p1:EndNr>sample string 10</d5p1:EndNr>
            <d5p1:Ender>sample string 9</d5p1:Ender>
            <d5p1:EnderecoId>8</d5p1:EnderecoId>
            <d5p1:Estado>sample string 13</d5p1:Estado>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Munic>sample string 12</d5p1:Munic>
            <d5p1:Nome>sample string 6</d5p1:Nome>
            <d5p1:NrCep>sample string 14</d5p1:NrCep>
            <d5p1:SubClientId>sample string 4</d5p1:SubClientId>
            <d5p1:TenantGroupId>sample string 7</d5p1:TenantGroupId>
            <d5p1:TenantId>sample string 3</d5p1:TenantId>
            <d5p1:TpFarmacia>sample string 2</d5p1:TpFarmacia>
          </d5p1:GetFiliaisItemResult>
          <d5p1:GetFiliaisItemResult>
            <d5p1:Bairr>sample string 11</d5p1:Bairr>
            <d5p1:CdFilial>sample string 5</d5p1:CdFilial>
            <d5p1:Distancia>sample string 15</d5p1:Distancia>
            <d5p1:DistanciaOrdenar>16.1</d5p1:DistanciaOrdenar>
            <d5p1:EndNr>sample string 10</d5p1:EndNr>
            <d5p1:Ender>sample string 9</d5p1:Ender>
            <d5p1:EnderecoId>8</d5p1:EnderecoId>
            <d5p1:Estado>sample string 13</d5p1:Estado>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Munic>sample string 12</d5p1:Munic>
            <d5p1:Nome>sample string 6</d5p1:Nome>
            <d5p1:NrCep>sample string 14</d5p1:NrCep>
            <d5p1:SubClientId>sample string 4</d5p1:SubClientId>
            <d5p1:TenantGroupId>sample string 7</d5p1:TenantGroupId>
            <d5p1:TenantId>sample string 3</d5p1:TenantId>
            <d5p1:TpFarmacia>sample string 2</d5p1:TpFarmacia>
          </d5p1:GetFiliaisItemResult>
        </d3p1:DescrFiliais>
        <d3p1:Descricao>sample string 2</d3p1:Descricao>
        <d3p1:Destino>aef2a8ea-ef32-431d-9a09-77fc5903c6be</d3p1:Destino>
        <d3p1:Endereco xmlns:d5p1="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models">
          <d5p1:Bairro>sample string 8</d5p1:Bairro>
          <d5p1:Cep>sample string 6</d5p1:Cep>
          <d5p1:Cidade>sample string 4</d5p1:Cidade>
          <d5p1:Complemento>sample string 9</d5p1:Complemento>
          <d5p1:Distancia>sample string 12</d5p1:Distancia>
          <d5p1:DistanciaValue>14</d5p1:DistanciaValue>
          <d5p1:Duracao>sample string 13</d5p1:Duracao>
          <d5p1:Endereco>sample string 3</d5p1:Endereco>
          <d5p1:EnderecoId>1</d5p1:EnderecoId>
          <d5p1:Estado>sample string 5</d5p1:Estado>
          <d5p1:Latitude>sample string 10</d5p1:Latitude>
          <d5p1:Longitude>sample string 11</d5p1:Longitude>
          <d5p1:NomeEndereco>sample string 2</d5p1:NomeEndereco>
          <d5p1:Numero>sample string 7</d5p1:Numero>
        </d3p1:Endereco>
        <d3p1:Filiais xmlns:d5p1="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models">
          <d5p1:GetEnderecosItemResult>
            <d5p1:Bairro>sample string 8</d5p1:Bairro>
            <d5p1:Cep>sample string 6</d5p1:Cep>
            <d5p1:Cidade>sample string 4</d5p1:Cidade>
            <d5p1:Complemento>sample string 9</d5p1:Complemento>
            <d5p1:Distancia>sample string 12</d5p1:Distancia>
            <d5p1:DistanciaValue>14</d5p1:DistanciaValue>
            <d5p1:Duracao>sample string 13</d5p1:Duracao>
            <d5p1:Endereco>sample string 3</d5p1:Endereco>
            <d5p1:EnderecoId>1</d5p1:EnderecoId>
            <d5p1:Estado>sample string 5</d5p1:Estado>
            <d5p1:Latitude>sample string 10</d5p1:Latitude>
            <d5p1:Longitude>sample string 11</d5p1:Longitude>
            <d5p1:NomeEndereco>sample string 2</d5p1:NomeEndereco>
            <d5p1:Numero>sample string 7</d5p1:Numero>
          </d5p1:GetEnderecosItemResult>
          <d5p1:GetEnderecosItemResult>
            <d5p1:Bairro>sample string 8</d5p1:Bairro>
            <d5p1:Cep>sample string 6</d5p1:Cep>
            <d5p1:Cidade>sample string 4</d5p1:Cidade>
            <d5p1:Complemento>sample string 9</d5p1:Complemento>
            <d5p1:Distancia>sample string 12</d5p1:Distancia>
            <d5p1:DistanciaValue>14</d5p1:DistanciaValue>
            <d5p1:Duracao>sample string 13</d5p1:Duracao>
            <d5p1:Endereco>sample string 3</d5p1:Endereco>
            <d5p1:EnderecoId>1</d5p1:EnderecoId>
            <d5p1:Estado>sample string 5</d5p1:Estado>
            <d5p1:Latitude>sample string 10</d5p1:Latitude>
            <d5p1:Longitude>sample string 11</d5p1:Longitude>
            <d5p1:NomeEndereco>sample string 2</d5p1:NomeEndereco>
            <d5p1:Numero>sample string 7</d5p1:Numero>
          </d5p1:GetEnderecosItemResult>
        </d3p1:Filiais>
        <d3p1:TenantId>dff8435a-6b63-4b1f-817c-493b5a457000</d3p1:TenantId>
      </d3p1:Unidade>
    </d2p1:Unidades>
    <d2p1:Version>sample string 1</d2p1:Version>
    <d2p1:WebSite>sample string 4</d2p1:WebSite>
    <d2p1:WhatsApp>sample string 7</d2p1:WhatsApp>
    <d2p1:YouTube>sample string 6</d2p1:YouTube>
  </Institucional>
</InstitucionalDetalhesResult>