URL/titulo-ocorrencia

Estimated reading: 1 minute 6 views

Parâmetros (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`	ATENÇÃO: Ao informar o `idApresentante`, o campo `tipoApresentante` deve ser preenchido com 0.	X
`apenasDevedoresEnderecoCompleto`	Filtra títulos em que o apresentante informou um endereço de devedor maior que 45 caracteres (limite do layout FEBRABAN).	X
`apenasTitulosDadosComplementares`	Retorna apenas os títulos que possuem dados complementares (telefone e e-mail) do devedor.

Exemplo de Resposta (JSON)

{
  "_links": {
    "self": {
      "href": "http://craUF.api.crabr.com.br/titulo-ocorrencia?dataInicial=03012017&dataFinal=03012017"
    }
  },
  "_embedded": {
    "titulo_ocorrencia": [
      {
        "ocorrencia": "Pago",
        "total": "4066",
        "saldo": "4863246.97"
      },
      {
        "ocorrencia": "Protestado",
        "total": "7889",
        "saldo": "15177935.09"
      },
      {
        "ocorrencia": "Retirada por edital",
        "total": "23",
        "saldo": "73716.36"
      },
      {
        "ocorrencia": "Retirado",
        "total": "964",
        "saldo": "3889964.85"
      }
    ]
  },
  "total_items": 4
}