GET api/Prefeitura/GetPage

Request Information

URI Parameters

NameDescriptionTypeAdditional information
PageNumber

integer

None.

UseCaseId

integer

None.

LogicalOperator

LogicalOperatorEnum

None.

SearchFieldsSet

Collection of SearchFields

None.

SortFieldsSet

Dictionary of string [key] and ListSortDirection [value]

None.

PageSize

integer

None.

Body Parameters

None.

Response Information

Resource Description

SearchResultDtoOfPrefeituraViewDto
NameDescriptionTypeAdditional information
data

Collection of PrefeituraViewDto

None.

page

integer

None.

totalRows

integer

None.

pageSize

integer

None.

tipoPaginacao

TipoPaginacaoEnum

None.

Response Formats

application/json, text/json

Sample:
{
  "data": [
    {
      "nome": "sample string 1",
      "dominio": "sample string 2",
      "enderecoId": 3,
      "enderecoCompleto": "sample string 4",
      "bucketName": "sample string 5",
      "zApiIdInstancia": "sample string 6",
      "zApiToken": "sample string 7",
      "zApiClientToken": "sample string 8",
      "googleMapsApiKey": "sample string 9",
      "primaryMainColor": "sample string 10",
      "primaryDarkColor": "sample string 11",
      "primaryLightColor": "sample string 12",
      "secondaryMainColor": "sample string 13",
      "secondaryDarkColor": "sample string 14",
      "secondaryLightColor": "sample string 15",
      "logoHeaderUrl": "sample string 16",
      "logoHorizontalUrl": "sample string 17",
      "logoVerticalUrl": "sample string 18",
      "key": 19,
      "id": 19,
      "isNew": true
    },
    {
      "nome": "sample string 1",
      "dominio": "sample string 2",
      "enderecoId": 3,
      "enderecoCompleto": "sample string 4",
      "bucketName": "sample string 5",
      "zApiIdInstancia": "sample string 6",
      "zApiToken": "sample string 7",
      "zApiClientToken": "sample string 8",
      "googleMapsApiKey": "sample string 9",
      "primaryMainColor": "sample string 10",
      "primaryDarkColor": "sample string 11",
      "primaryLightColor": "sample string 12",
      "secondaryMainColor": "sample string 13",
      "secondaryDarkColor": "sample string 14",
      "secondaryLightColor": "sample string 15",
      "logoHeaderUrl": "sample string 16",
      "logoHorizontalUrl": "sample string 17",
      "logoVerticalUrl": "sample string 18",
      "key": 19,
      "id": 19,
      "isNew": true
    }
  ],
  "page": 1,
  "totalRows": 2,
  "pageSize": 3,
  "tipoPaginacao": 1
}

application/xml, text/xml

Sample:
<SearchResultDtoOfPrefeituraViewDto6Qbk6Ywu xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Zenite.Pi.Web.Models.Pesquisa">
  <data xmlns:d2p1="http://schemas.datacontract.org/2004/07/CidConnectada.Webapi.Models.Organograma">
    <d2p1:PrefeituraViewDto>
      <isNew xmlns="http://schemas.datacontract.org/2004/07/Zenite.Pi.Web.Models">true</isNew>
      <key xmlns="http://schemas.datacontract.org/2004/07/Zenite.Pi.Web.Models">19</key>
      <d2p1:bucketName>sample string 5</d2p1:bucketName>
      <d2p1:dominio>sample string 2</d2p1:dominio>
      <d2p1:enderecoCompleto>sample string 4</d2p1:enderecoCompleto>
      <d2p1:enderecoId>3</d2p1:enderecoId>
      <d2p1:googleMapsApiKey>sample string 9</d2p1:googleMapsApiKey>
      <d2p1:logoHeaderUrl>sample string 16</d2p1:logoHeaderUrl>
      <d2p1:logoHorizontalUrl>sample string 17</d2p1:logoHorizontalUrl>
      <d2p1:logoVerticalUrl>sample string 18</d2p1:logoVerticalUrl>
      <d2p1:nome>sample string 1</d2p1:nome>
      <d2p1:primaryDarkColor>sample string 11</d2p1:primaryDarkColor>
      <d2p1:primaryLightColor>sample string 12</d2p1:primaryLightColor>
      <d2p1:primaryMainColor>sample string 10</d2p1:primaryMainColor>
      <d2p1:secondaryDarkColor>sample string 14</d2p1:secondaryDarkColor>
      <d2p1:secondaryLightColor>sample string 15</d2p1:secondaryLightColor>
      <d2p1:secondaryMainColor>sample string 13</d2p1:secondaryMainColor>
      <d2p1:zApiClientToken>sample string 8</d2p1:zApiClientToken>
      <d2p1:zApiIdInstancia>sample string 6</d2p1:zApiIdInstancia>
      <d2p1:zApiToken>sample string 7</d2p1:zApiToken>
    </d2p1:PrefeituraViewDto>
    <d2p1:PrefeituraViewDto>
      <isNew xmlns="http://schemas.datacontract.org/2004/07/Zenite.Pi.Web.Models">true</isNew>
      <key xmlns="http://schemas.datacontract.org/2004/07/Zenite.Pi.Web.Models">19</key>
      <d2p1:bucketName>sample string 5</d2p1:bucketName>
      <d2p1:dominio>sample string 2</d2p1:dominio>
      <d2p1:enderecoCompleto>sample string 4</d2p1:enderecoCompleto>
      <d2p1:enderecoId>3</d2p1:enderecoId>
      <d2p1:googleMapsApiKey>sample string 9</d2p1:googleMapsApiKey>
      <d2p1:logoHeaderUrl>sample string 16</d2p1:logoHeaderUrl>
      <d2p1:logoHorizontalUrl>sample string 17</d2p1:logoHorizontalUrl>
      <d2p1:logoVerticalUrl>sample string 18</d2p1:logoVerticalUrl>
      <d2p1:nome>sample string 1</d2p1:nome>
      <d2p1:primaryDarkColor>sample string 11</d2p1:primaryDarkColor>
      <d2p1:primaryLightColor>sample string 12</d2p1:primaryLightColor>
      <d2p1:primaryMainColor>sample string 10</d2p1:primaryMainColor>
      <d2p1:secondaryDarkColor>sample string 14</d2p1:secondaryDarkColor>
      <d2p1:secondaryLightColor>sample string 15</d2p1:secondaryLightColor>
      <d2p1:secondaryMainColor>sample string 13</d2p1:secondaryMainColor>
      <d2p1:zApiClientToken>sample string 8</d2p1:zApiClientToken>
      <d2p1:zApiIdInstancia>sample string 6</d2p1:zApiIdInstancia>
      <d2p1:zApiToken>sample string 7</d2p1:zApiToken>
    </d2p1:PrefeituraViewDto>
  </data>
  <page>1</page>
  <pageSize>3</pageSize>
  <tipoPaginacao>PorPagina</tipoPaginacao>
  <totalRows>2</totalRows>
</SearchResultDtoOfPrefeituraViewDto6Qbk6Ywu>