GET api/v2/tenant/getCidades?TenantId={TenantId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
TenantId

globally unique identifier

None.

Body Parameters

None.

Response Information

Resource Description

GetCidadesResult
NameDescriptionTypeAdditional information
Cidades

Collection of Cidade

None.

Succeeded

boolean

None.

Errors

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Cidades": [
    {
      "Municipio": "sample string 1",
      "UnidadeFederativa": "sample string 2",
      "TenantMatriz": "0a9df70c-9f0d-4831-8624-59cf967fd320"
    },
    {
      "Municipio": "sample string 1",
      "UnidadeFederativa": "sample string 2",
      "TenantMatriz": "0a9df70c-9f0d-4831-8624-59cf967fd320"
    }
  ],
  "Succeeded": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<GetCidadesResult 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>
  <Cidades>
    <Cidade>
      <Municipio>sample string 1</Municipio>
      <TenantMatriz>0a9df70c-9f0d-4831-8624-59cf967fd320</TenantMatriz>
      <UnidadeFederativa>sample string 2</UnidadeFederativa>
    </Cidade>
    <Cidade>
      <Municipio>sample string 1</Municipio>
      <TenantMatriz>0a9df70c-9f0d-4831-8624-59cf967fd320</TenantMatriz>
      <UnidadeFederativa>sample string 2</UnidadeFederativa>
    </Cidade>
  </Cidades>
</GetCidadesResult>