GET api/v1/coops/cidade/estadoV2?siglaEstado={siglaEstado}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siglaEstado

string

Required

Body Parameters

None.

Response Information

Resource Description

ResponseApiOfListOfCidadeModel
NameDescriptionTypeAdditional information
errors

Collection of ResultMessage

None.

warnings

Collection of ResultMessage

None.

informations

Collection of ResultMessage

None.

result

Collection of CidadeModel

None.

Response Formats

application/json, text/json

Sample:
{
  "errors": [
    {
      "code": 1,
      "msg": "sample string 2"
    },
    {
      "code": 1,
      "msg": "sample string 2"
    }
  ],
  "warnings": [
    {
      "code": 1,
      "msg": "sample string 2"
    },
    {
      "code": 1,
      "msg": "sample string 2"
    }
  ],
  "informations": [
    {
      "code": 1,
      "msg": "sample string 2"
    },
    {
      "code": 1,
      "msg": "sample string 2"
    }
  ],
  "result": [
    {
      "Oid": "af4e801e-2d3c-46b6-96fa-ab265c4e6064",
      "Nome": "sample string 2",
      "CodigoIBGE": 3,
      "Estado": {
        "Oid": "f8109407-d86d-4065-891c-84202ccee783",
        "Nome": "sample string 2",
        "Sigla": "sample string 3"
      }
    },
    {
      "Oid": "af4e801e-2d3c-46b6-96fa-ab265c4e6064",
      "Nome": "sample string 2",
      "CodigoIBGE": 3,
      "Estado": {
        "Oid": "f8109407-d86d-4065-891c-84202ccee783",
        "Nome": "sample string 2",
        "Sigla": "sample string 3"
      }
    }
  ]
}

application/xml, text/xml

Sample:
<ResponseApiOfArrayOfCidadeModelaSoNMbvP xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apollo.API.Results">
  <errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/Apollo.API.Models">
    <d2p1:ResultMessage>
      <d2p1:code>1</d2p1:code>
      <d2p1:msg>sample string 2</d2p1:msg>
    </d2p1:ResultMessage>
    <d2p1:ResultMessage>
      <d2p1:code>1</d2p1:code>
      <d2p1:msg>sample string 2</d2p1:msg>
    </d2p1:ResultMessage>
  </errors>
  <informations xmlns:d2p1="http://schemas.datacontract.org/2004/07/Apollo.API.Models">
    <d2p1:ResultMessage>
      <d2p1:code>1</d2p1:code>
      <d2p1:msg>sample string 2</d2p1:msg>
    </d2p1:ResultMessage>
    <d2p1:ResultMessage>
      <d2p1:code>1</d2p1:code>
      <d2p1:msg>sample string 2</d2p1:msg>
    </d2p1:ResultMessage>
  </informations>
  <result xmlns:d2p1="http://schemas.datacontract.org/2004/07/Apollo.API.Models">
    <d2p1:CidadeModel>
      <d2p1:CodigoIBGE>3</d2p1:CodigoIBGE>
      <d2p1:Estado>
        <d2p1:Nome>sample string 2</d2p1:Nome>
        <d2p1:Oid>f8109407-d86d-4065-891c-84202ccee783</d2p1:Oid>
        <d2p1:Sigla>sample string 3</d2p1:Sigla>
      </d2p1:Estado>
      <d2p1:Nome>sample string 2</d2p1:Nome>
      <d2p1:Oid>af4e801e-2d3c-46b6-96fa-ab265c4e6064</d2p1:Oid>
    </d2p1:CidadeModel>
    <d2p1:CidadeModel>
      <d2p1:CodigoIBGE>3</d2p1:CodigoIBGE>
      <d2p1:Estado>
        <d2p1:Nome>sample string 2</d2p1:Nome>
        <d2p1:Oid>f8109407-d86d-4065-891c-84202ccee783</d2p1:Oid>
        <d2p1:Sigla>sample string 3</d2p1:Sigla>
      </d2p1:Estado>
      <d2p1:Nome>sample string 2</d2p1:Nome>
      <d2p1:Oid>af4e801e-2d3c-46b6-96fa-ab265c4e6064</d2p1:Oid>
    </d2p1:CidadeModel>
  </result>
  <warnings xmlns:d2p1="http://schemas.datacontract.org/2004/07/Apollo.API.Models">
    <d2p1:ResultMessage>
      <d2p1:code>1</d2p1:code>
      <d2p1:msg>sample string 2</d2p1:msg>
    </d2p1:ResultMessage>
    <d2p1:ResultMessage>
      <d2p1:code>1</d2p1:code>
      <d2p1:msg>sample string 2</d2p1:msg>
    </d2p1:ResultMessage>
  </warnings>
</ResponseApiOfArrayOfCidadeModelaSoNMbvP>