Obtener Solicitudes de Cancelación

Este método permite que Colaborador obtenga un listado de sus solicitudes de cancelación en el sistema de Experticket.

1. Método de Acceso

Parámetro

Descripción

URL

{baseurl}/api/cancellationrequest

Verbo HTTP

GET

Longitud máxima de URL

2048 caracteres

 

2. Estructura de Datos de Envío (QueryString)

El listado de solicitudes de cancelación puede filtrarse mediante distintos parámetros.

Campo

Descripción

ApiKey

Clave única y privada del colaboradorDebe mantenerse en secreto.

TransactionId (Obsoleto)

Identificador de la transacción.

SaleId

Opcional. Identificador de la venta.

FromCreatedDateTime

Opcional. Fecha desde la cual se buscan solicitudes de cancelación (ISO 8601).

ToCreatedDateTime

Opcional. Fecha hasta la cual se buscan solicitudes de cancelación (ISO 8601).

FromUpdatedDateTime

Opcional. Fecha desde la cual se han actualizado las solicitudes de cancelación (ISO 8601).

ToUpdatedDateTime

Opcional. Fecha hasta la cual se han actualizado las solicitudes de cancelación (ISO 8601).

Status

Opcional. Estado de la solicitud:

1 = En proceso2 = Aceptada3 = Rechazada4 = Fallida

PageSize

Opcional. Número máximo de solicitudes a devolver (máx: 200).

Page

Opcional. Número de página que se desea obtener (por defecto: 1).

api-version

Opcional. Versión del API (3.47 por defecto).

 


 

3. Ejemplo de Solicitud GET

🔹 Obtener todas las solicitudes de cancelación

 

GET /api/cancellationrequest?ApiKey=xyz123 HTTP/1.1

Host: demo.api.experticket.com

Content-Type: application/json

 

🔹 Obtener solicitudes de cancelación entre el 1 y el 15 de enero de 2024

 

GET /api/cancellationrequest?ApiKey=xyz123&FromCreatedDateTime=2024-01-01T00:00:00&ToCreatedDateTime=2024-01-15T23:59:59 HTTP/1.1

Host: demo.api.experticket.com

Content-Type: application/json

 

4. Estructura de la Respuesta

Campo

Descripción

Success

true si la solicitud se ejecutó correctamente.

Timestamp

Marca de tiempo de la respuesta.

ErrorMessage

Mensaje de error si la solicitud falla.

ErrorCodes

Códigos de error, si aplica.

ErrorEntityBreakDown

Información detallada en caso de error.

PageNumber

Número de página solicitada.

PageSize

Número de solicitudes por página.

HasPreviousPage

true si hay una página anterior.

HasNextPage

true si hay una página siguiente.

IsFirstPage

true si es la primera página.

CancellationRequests

Array de solicitudes de cancelación con detalles.

 

5. Ejemplo de Respuesta Exitosa

{

    "CancellationRequests": [

        {

            "CancellationRequestId": "syw353uykd3qc",

            "TransactionId": "5056615501717130434",

            "SaleId": "5056615501717130434",

            "CreatedDateTime": "2024-01-05T18:57:00",

            "UpdatedDateTime": "2024-01-06T10:30:00",

            "Status": 1

        },

        {

            "CancellationRequestId": "1f48ahtxzphdg",

            "TransactionId": "1546555501487130138",

            "SaleId": "5056615501717130434",

            "CreatedDateTime": "2024-01-05T15:57:00",

            "UpdatedDateTime": "2024-01-06T11:45:00",

            "Status": 2

        }

    ],

    "PageNumber": 1,

    "PageSize": 200,

    "HasPreviousPage": false,

    "HasNextPage": false,

    "IsFirstPage": true,

    "Success": true,

    "Timestamp": "2024-01-06T12:00:00"

}

6. Estado de la Solicitud

Los valores posibles para Status son:

Código

Descripción

1

En proceso

2

Aceptada

3

Rechazada

4

Fallida

 

7. Consideraciones Finales

  • ✅ Este método permite obtener el historial de solicitudes de cancelación con filtros específicos.
  • 📌 Permite paginación con PageSizePage para controlar el volumen de datos.
  • 🕒 Los filtros por fechas ayudan a limitar la consulta y mejorar la eficiencia.
  • ⚠️ Si Success = false, revisar ErrorMessageErrorCodes para más detalles.

¿Te ha parecido útil este artículo?