URL/titulo-especie

Estimated reading: 1 minute 6 views

Parâmetros de Serviço

Parâmetros de Requisição (via GET)

Parâmetro	Descrição	Opcional
`dataInicial`	Data inicial do período de apresentação dos títulos. Preencher da seguinte forma: dmy. Ex: 01012017
`dataFinal`	Data final do período de apresentação dos títulos. Preencher da seguinte forma: dmy. Ex: 01012017
`idCartorio`	Recuperado após autenticação ou através do serviço URL/cartorio. Ao informar esse parâmetro, o serviço irá retornar somente títulos do cartório informado.	X
`tipoApresentante`	Informando este parâmetro, o serviço irá retornar apresentantes do tipo informado. Preencher com 1, 2, 3, 4, 5 ou 0 (1: Todos, 2: Tipo banco, 3: Tipo convênio, 4: Somente convênios públicos, 5: Somente convênios privados, 0: Específico).	X
`idApresentante`	Recuperado após autenticação ou através do serviço URL/apresentante. ATENÇÃO: Ao informar o `idApresentante`, o campo `tipoApresentante` deve ser preenchido com 0.	X

Exemplo de Resposta (JSON)

{
  "_links": {
    "self": {
      "href": "http://craUF.api.crabr.com.br/titulo-especie?dataInicial=03012017&dataFinal=03012017"
    }
  },
  "_embedded": {
    "titulo_especie": [
      {
        "especie": "DMI",
        "total": "7160"
      },
      {
        "especie": "CDA",
        "total": "5582"
      },
      {
        "especie": "DSI",
        "total": "195"
      },
      {
        "especie": "CBI",
        "total": "5"
      }
    ]
  },
  "total_items": 4
}