POST Api/Documentos/{id}/Cancelar

Envía un documento a la cola cancelaciones para ser procesado

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Identificador FG del documento a cancelar

string

Required

Body Parameters

Modelo de datos para datos de la cancelación

CancelarModel
NameDescriptionTypeAdditional information
Razon

Razón para cancelar el documento

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Razon": "sample string 1"
}

application/xml, text/xml

Sample:
<CancelarModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BSX.FG.APIv2.Models">
  <Razon>sample string 1</Razon>
</CancelarModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Envía un documento a la cola cancelaciones para ser procesado

OperationResult
NameDescriptionTypeAdditional information
ErrorCode

Código de error para mostrar al usuario

ErrorCodeEnum

None.

Result

Resultado obtenido en la operación

ResultTypeEnum

None.

ErrorCodeName

Descripción del código de error

string

None.

Info

Información obtenida durante el proceso

Collection of OperationMessage

None.

Messages

Lista de mensajes generados al presentar los resultados

Collection of string

None.

SingleLineErrors

Mensajes mostrados en una línea única

string

None.

Success

Indica si la operación a tratar ha sido exitosa o no

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "ErrorCode": 0,
  "Result": 0,
  "ErrorCodeName": "NONE",
  "Info": [
    {
      "Text": "sample string 1",
      "MessageType": 0
    },
    {
      "Text": "sample string 1",
      "MessageType": 0
    }
  ],
  "Messages": [
    "sample string 1",
    "sample string 1"
  ],
  "SingleLineErrors": "sample string 1, sample string 1",
  "Success": true
}

application/xml, text/xml

Sample:
<OperationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BSX.Base.BL">
  <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 1</d2p1:string>
  </Messages>
</OperationResult>