GET api/tipos-documento-identificacao?somenteAtivos={somenteAtivos}

Consulta e listagem de tipos de documentos de identificação

Request Information

URI Parameters

NameDescriptionTypeAdditional information
somenteAtivos

se true traz apenas os tipos ativos, valor default=false

 boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

lista de TipoDocumentoIdentificacaoDTO

Collection of TipoDocumentoIdentificacaoDTO
NameDescriptionTypeAdditional information
IdTipoDocumentoIdentificacao

Identificaor do tipo de documento de identificação.

 integer

None.
DescTipoDocumentoIdentificacao

Descrição do tipo de documento de identificação.

 string

None.
IndAtivo

Indicador se o tipo de documento de identificação está ativo ou não.

 boolean

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "IdTipoDocumentoIdentificacao": 1,
    "DescTipoDocumentoIdentificacao": "sample string 2",
    "IndAtivo": true
  },
  {
    "IdTipoDocumentoIdentificacao": 1,
    "DescTipoDocumentoIdentificacao": "sample string 2",
    "IndAtivo": true
  }
]

text/html

Sample: 
[{"IdTipoDocumentoIdentificacao":1,"DescTipoDocumentoIdentificacao":"sample string 2","IndAtivo":true},{"IdTipoDocumentoIdentificacao":1,"DescTipoDocumentoIdentificacao":"sample string 2","IndAtivo":true}]

application/xml, text/xml

Sample: 
<ArrayOfTipoDocumentoIdentificacaoDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ouvidorias.Api.Models.DTO">
  <TipoDocumentoIdentificacaoDTO>
    <DescTipoDocumentoIdentificacao>sample string 2</DescTipoDocumentoIdentificacao>
    <IdTipoDocumentoIdentificacao>1</IdTipoDocumentoIdentificacao>
    <IndAtivo>true</IndAtivo>
  </TipoDocumentoIdentificacaoDTO>
  <TipoDocumentoIdentificacaoDTO>
    <DescTipoDocumentoIdentificacao>sample string 2</DescTipoDocumentoIdentificacao>
    <IdTipoDocumentoIdentificacao>1</IdTipoDocumentoIdentificacao>
    <IndAtivo>true</IndAtivo>
  </TipoDocumentoIdentificacaoDTO>
</ArrayOfTipoDocumentoIdentificacaoDTO>