POST Benefits/ConsultaSaldo

Metodo que permite consultar el saldo por medio del rut titular

Request, Información

URI, Parametros

No registra.

Body, Parametros de Entrada

Parametro que contiene la informacion necesaria para consultar

InputBenefitsConsultaSaldo
ParametroDescripciónTipoInformación Adicional
RutTitular

Numero de rut del titular a buscar (formato 0012345678-9)

string

Required

String length: inclusive between 12 and 12

TokenUser

Nombre de usuario autorizado para acceder a la API

string

Required

String length: inclusive between 3 and 25

TokenPass

Contraseña del usuario autorizado para acceder a la API

string

Required

String length: inclusive between 3 and 25

NumConvenio

Indica (averiguar)

integer

Required

Request, Formato

application/json, text/json

Muestra:
{
  "RutTitular": "sample string 1",
  "TokenUser": "sample string 2",
  "TokenPass": "sample string 3",
  "NumConvenio": 4
}

application/xml, text/xml

Muestra:
<InputBenefitsConsultaSaldo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WEBAPI_Liquidadores.Models.IO.Benefits">
  <NumConvenio>4</NumConvenio>
  <TokenPass>sample string 3</TokenPass>
  <TokenUser>sample string 2</TokenUser>
  <RutTitular>sample string 1</RutTitular>
</InputBenefitsConsultaSaldo>

application/x-www-form-urlencoded

Muestra:

Ejemplo no disponible.

Response, Información

Resource, Descripción

OutputBenefitsConsultaSaldo
ParametroDescripciónTipoInformación Adicional
NumRegistros

Cantidad de registros.

integer

No registra.

ListaSaldos

Listado en detalle de los saldo

Collection of BenefitsConsultaSaldo

No registra.

CodError

Parametro que indica estado de la respuesta de la API

TipoRespuestaBenefit

No registra.

MsgError

Parametro que contine un mensaje descriptivo del CodError entregado por la API

string

No registra.

Response, Formato

application/json, text/json

Muestra:
{
  "NumRegistros": 1,
  "ListaSaldos": [
    {
      "Cobertura": 1,
      "NombreCobertura": "sample string 2",
      "TipoTope": "sample string 3",
      "Duracion": 4,
      "FechaLimite": "sample string 5",
      "MontoTope": 6,
      "MontoUtilizado": 7,
      "Saldo": 8,
      "EstadoConsultaBd": 1,
      "GlosaEstado": "sample string 9"
    },
    {
      "Cobertura": 1,
      "NombreCobertura": "sample string 2",
      "TipoTope": "sample string 3",
      "Duracion": 4,
      "FechaLimite": "sample string 5",
      "MontoTope": 6,
      "MontoUtilizado": 7,
      "Saldo": 8,
      "EstadoConsultaBd": 1,
      "GlosaEstado": "sample string 9"
    }
  ],
  "CodError": 0,
  "MsgError": "sample string 2"
}

application/xml, text/xml

Muestra:
<OutputBenefitsConsultaSaldo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WEBAPI_Liquidadores.Models.IO.Benefits">
  <CodError>Ok</CodError>
  <MsgError>sample string 2</MsgError>
  <ListaSaldos xmlns:d2p1="http://schemas.datacontract.org/2004/07/WEBAPI_Liquidadores.Models.Entidades.Benefits">
    <d2p1:BenefitsConsultaSaldo>
      <d2p1:EstadoConsultaBd>Ok</d2p1:EstadoConsultaBd>
      <d2p1:GlosaEstado>sample string 9</d2p1:GlosaEstado>
      <d2p1:Cobertura>1</d2p1:Cobertura>
      <d2p1:Duracion>4</d2p1:Duracion>
      <d2p1:FechaLimite>sample string 5</d2p1:FechaLimite>
      <d2p1:MontoTope>6</d2p1:MontoTope>
      <d2p1:MontoUtilizado>7</d2p1:MontoUtilizado>
      <d2p1:NombreCobertura>sample string 2</d2p1:NombreCobertura>
      <d2p1:Saldo>8</d2p1:Saldo>
      <d2p1:TipoTope>sample string 3</d2p1:TipoTope>
    </d2p1:BenefitsConsultaSaldo>
    <d2p1:BenefitsConsultaSaldo>
      <d2p1:EstadoConsultaBd>Ok</d2p1:EstadoConsultaBd>
      <d2p1:GlosaEstado>sample string 9</d2p1:GlosaEstado>
      <d2p1:Cobertura>1</d2p1:Cobertura>
      <d2p1:Duracion>4</d2p1:Duracion>
      <d2p1:FechaLimite>sample string 5</d2p1:FechaLimite>
      <d2p1:MontoTope>6</d2p1:MontoTope>
      <d2p1:MontoUtilizado>7</d2p1:MontoUtilizado>
      <d2p1:NombreCobertura>sample string 2</d2p1:NombreCobertura>
      <d2p1:Saldo>8</d2p1:Saldo>
      <d2p1:TipoTope>sample string 3</d2p1:TipoTope>
    </d2p1:BenefitsConsultaSaldo>
  </ListaSaldos>
  <NumRegistros>1</NumRegistros>
</OutputBenefitsConsultaSaldo>