POST Benefits/SubirDocumento

Metodo que permite almacenar archivos en los servidores de Mpro ya sea a traves de una url o serializado en formato string base64

Request, Información

URI, Parametros

No registra.

Body, Parametros de Entrada

Parametro que contiene la informacion necesaria para recibir y guardar archivos o documentos enviados en servidores de Mpro

InputBenefitsSubirDocumento
ParametroDescripciónTipoInformación Adicional
NumeroFolio

Folio interno de solicitud generada

integer

Required

NombreDocumento

Nombre del documento (ej: nombre.extension)

string

Required

String length: inclusive between 3 and 100

UrlDocumento

Url en donde se encuentra el documento a guardar

string

String length: inclusive between 0 and 1000000000

ImagenBase64

Documento o archivo serializado en base 64

string

No registra.

CorrelativoImg

Indica numero correlativo de la imagen a subir (debe ser mayor a 1)

integer

No registra.

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:
{
  "NumeroFolio": 1,
  "NombreDocumento": "sample string 2",
  "UrlDocumento": "sample string 3",
  "ImagenBase64": "sample string 4",
  "CorrelativoImg": 5,
  "TokenUser": "sample string 6",
  "TokenPass": "sample string 7",
  "NumConvenio": 8
}

application/xml, text/xml

Muestra:
<InputBenefitsSubirDocumento xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WEBAPI_Liquidadores.Models.IO.Benefits">
  <NumConvenio>8</NumConvenio>
  <TokenPass>sample string 7</TokenPass>
  <TokenUser>sample string 6</TokenUser>
  <CorrelativoImg>5</CorrelativoImg>
  <ImagenBase64>sample string 4</ImagenBase64>
  <NombreDocumento>sample string 2</NombreDocumento>
  <NumeroFolio>1</NumeroFolio>
  <UrlDocumento>sample string 3</UrlDocumento>
</InputBenefitsSubirDocumento>

application/x-www-form-urlencoded

Muestra:

Ejemplo no disponible.

Response, Información

Resource, Descripción

OutputBenefits
ParametroDescripciónTipoInformación Adicional
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:
{
  "CodError": 0,
  "MsgError": "sample string 1"
}

application/xml, text/xml

Muestra:
<OutputBenefits 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 1</MsgError>
</OutputBenefits>