GET api/beneficiarios?nome={nome}&cpf={cpf}&cartao={cartao}&offset={offset}&limit={limit}&orderby={orderby}&sort={sort}

Request Information

URI Parameters

Name	Type	Additional information
nome	string	Default value is
cpf	string	Default value is
cartao	string	Default value is
offset	integer	Default value is 0
limit	integer	Default value is 20
orderby	string	Default value is Nome
sort	string	Default value is ASC

Body Parameters

None.

Response Information

Resource Description

BeneficiarioRetorno

Name	Type	Additional information
total	integer	None.
offset	integer	None.
limit	integer	None.
orderby	string	None.
sort	string	None.
data	Collection of Beneficiario	None.

Response Formats

application/json, text/json

Sample:

{
  "total": 1,
  "offset": 1,
  "limit": 1,
  "orderby": "sample string 1",
  "sort": "sample string 2",
  "data": [
    {
      "Handle": 1,
      "Nome": "sample string 1",
      "Cartao": "sample string 2",
      "Sexo": "sample string 3",
      "Email": "sample string 4",
      "Telefone": "sample string 5",
      "Telefone2": "sample string 6",
      "Celular": "sample string 7",
      "Cpf": "sample string 8",
      "DataNascimento": "sample string 9",
      "Logradouro": "sample string 10",
      "Numero": 1,
      "Complemento": "sample string 11",
      "Bairro": "sample string 12",
      "Cep": "sample string 13",
      "Municipio": "sample string 14",
      "Estado": "sample string 15",
      "Ativo": true
    },
    {
      "Handle": 1,
      "Nome": "sample string 1",
      "Cartao": "sample string 2",
      "Sexo": "sample string 3",
      "Email": "sample string 4",
      "Telefone": "sample string 5",
      "Telefone2": "sample string 6",
      "Celular": "sample string 7",
      "Cpf": "sample string 8",
      "DataNascimento": "sample string 9",
      "Logradouro": "sample string 10",
      "Numero": 1,
      "Complemento": "sample string 11",
      "Bairro": "sample string 12",
      "Cep": "sample string 13",
      "Municipio": "sample string 14",
      "Estado": "sample string 15",
      "Ativo": true
    }
  ]
}

application/xml, text/xml

Sample:

<BeneficiarioRetorno xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsultaProcedIpes.Models">
  <data>
    <Beneficiario>
      <Ativo>true</Ativo>
      <Bairro>sample string 12</Bairro>
      <Cartao>sample string 2</Cartao>
      <Celular>sample string 7</Celular>
      <Cep>sample string 13</Cep>
      <Complemento>sample string 11</Complemento>
      <Cpf>sample string 8</Cpf>
      <DataNascimento>sample string 9</DataNascimento>
      <Email>sample string 4</Email>
      <Estado>sample string 15</Estado>
      <Handle>1</Handle>
      <Logradouro>sample string 10</Logradouro>
      <Municipio>sample string 14</Municipio>
      <Nome>sample string 1</Nome>
      <Numero>1</Numero>
      <Sexo>sample string 3</Sexo>
      <Telefone>sample string 5</Telefone>
      <Telefone2>sample string 6</Telefone2>
    </Beneficiario>
    <Beneficiario>
      <Ativo>true</Ativo>
      <Bairro>sample string 12</Bairro>
      <Cartao>sample string 2</Cartao>
      <Celular>sample string 7</Celular>
      <Cep>sample string 13</Cep>
      <Complemento>sample string 11</Complemento>
      <Cpf>sample string 8</Cpf>
      <DataNascimento>sample string 9</DataNascimento>
      <Email>sample string 4</Email>
      <Estado>sample string 15</Estado>
      <Handle>1</Handle>
      <Logradouro>sample string 10</Logradouro>
      <Municipio>sample string 14</Municipio>
      <Nome>sample string 1</Nome>
      <Numero>1</Numero>
      <Sexo>sample string 3</Sexo>
      <Telefone>sample string 5</Telefone>
      <Telefone2>sample string 6</Telefone2>
    </Beneficiario>
  </data>
  <limit>1</limit>
  <offset>1</offset>
  <orderby>sample string 1</orderby>
  <sort>sample string 2</sort>
  <total>1</total>
</BeneficiarioRetorno>