Events Api v1

Events Management APIs

Get Event by Name

/api/v1/events/{name}

Retrieves an Existing Event by name

Request parameters

Responses

{
  "id": "b80bb774-0288-3da1-b201-890375a60c8f",
  "name": "example",
  "description": "example",
  "location": "example",
  "occursAt": "1974-12-18T09:21:05Z",
  "endTime": "1993-01-22T03:30:05Z",
  "salesStartTime": "2008-05-05T00:16:08Z",
  "salesEndTime": "1998-09-03T18:16:33Z",
  "ticketsAvailable": [
    {
      "type": {
        "id": 55,
        "name": "example"
      },
      "count": 43,
      "costPerTicket": 48.0,
      "maxPerCustomer": 87,
      "prefix": "example",
      "active": true,
      "costCurrency": "example",
      "order": 50
    }
  ]
}

Get Event by ID

/api/v1/events/{id}

Retrieves an Existing Event by ID

Request parameters

Responses

{
  "id": "b80bb774-0288-3da1-b201-890375a60c8f",
  "name": "example",
  "description": "example",
  "location": "example",
  "occursAt": "1974-12-18T09:21:05Z",
  "endTime": "1993-01-22T03:30:05Z",
  "salesStartTime": "2008-05-05T00:16:08Z",
  "salesEndTime": "1998-09-03T18:16:33Z",
  "ticketsAvailable": [
    {
      "type": {
        "id": 55,
        "name": "example"
      },
      "count": 43,
      "costPerTicket": 48.0,
      "maxPerCustomer": 87,
      "prefix": "example",
      "active": true,
      "costCurrency": "example",
      "order": 50
    }
  ]
}

{}

Get All Events

/api/v1/events

Retrieves All Events

Request parameters

Responses

[
  {
    "id": "b80bb774-0288-3da1-b201-890375a60c8f",
    "name": "example",
    "description": "example",
    "location": "example",
    "occursAt": "1974-12-18T09:21:05Z",
    "endTime": "1993-01-22T03:30:05Z",
    "salesStartTime": "2008-05-05T00:16:08Z",
    "salesEndTime": "1998-09-03T18:16:33Z",
    "ticketsAvailable": [
      {
        "type": {
          "id": 55,
          "name": "example"
        },
        "count": 43,
        "costPerTicket": 48.0,
        "maxPerCustomer": 87,
        "prefix": "example",
        "active": true,
        "costCurrency": "example",
        "order": 50
      }
    ]
  }
]

{}

Create New Event

/api/v1/events

Creates a New Event

Request parameters

{
  "name": "example",
  "location": "example",
  "occursAt": "1974-12-18T09:21:05Z",
  "salesStartTime": "2008-05-05T00:16:08Z",
  "salesEndTime": "1998-09-03T18:16:33Z",
  "tickets": {},
  "endTime": "1993-01-22T03:30:05Z"
}

Responses

{
  "id": "b80bb774-0288-3da1-b201-890375a60c8f",
  "name": "example",
  "description": "example",
  "location": "example",
  "occursAt": "1974-12-18T09:21:05Z",
  "endTime": "1993-01-22T03:30:05Z",
  "salesStartTime": "2008-05-05T00:16:08Z",
  "salesEndTime": "1998-09-03T18:16:33Z",
  "ticketsAvailable": [
    {
      "type": {
        "id": 55,
        "name": "example"
      },
      "count": 43,
      "costPerTicket": 48.0,
      "maxPerCustomer": 87,
      "prefix": "example",
      "active": true,
      "costCurrency": "example",
      "order": 50
    }
  ]
}

"example"

Get all Ticket Types for Event

/api/v1/events/{eventId}/ticketType

Get all Ticket Types for Event

Request parameters

Responses

[
  {
    "type": {
      "id": 55,
      "name": "example"
    },
    "count": 43,
    "costPerTicket": 48.0,
    "maxPerCustomer": 87,
    "prefix": "example",
    "active": true,
    "costCurrency": "example",
    "order": 50
  }
]

{}

Add Ticket Type

/api/v1/events/{eventId}/ticketType

Adds a Ticket Type to an Event

Request parameters

{
  "eventId": "53cc4db5-43d7-3569-a51c-1d76ac6f278e",
  "ticketType": "example",
  "ticket": {
    "count": 43,
    "cost": 61.0,
    "customerMax": 38,
    "prefix": "example",
    "currency": "example"
  }
}

Responses

{
  "id": "b80bb774-0288-3da1-b201-890375a60c8f",
  "name": "example",
  "description": "example",
  "location": "example",
  "occursAt": "1974-12-18T09:21:05Z",
  "endTime": "1993-01-22T03:30:05Z",
  "salesStartTime": "2008-05-05T00:16:08Z",
  "salesEndTime": "1998-09-03T18:16:33Z",
  "ticketsAvailable": [
    {
      "type": {
        "id": 55,
        "name": "example"
      },
      "count": 43,
      "costPerTicket": 48.0,
      "maxPerCustomer": 87,
      "prefix": "example",
      "active": true,
      "costCurrency": "example",
      "order": 50
    }
  ]
}

Customer Management

Get Customer by Phone

/api/v1/customers/{phone}

Request parameters

Responses

{
  "id": "b80bb774-0288-3da1-b201-890375a60c8f",
  "firstName": "example",
  "lastName": "example",
  "phoneNumber": "example"
}

Get Customer by First and Last Name

/api/v1/customers

Request parameters

Responses

{
  "id": "b80bb774-0288-3da1-b201-890375a60c8f",
  "firstName": "example",
  "lastName": "example",
  "phoneNumber": "example"
}

Creates a new Customer

/api/v1/customers

Creates a new Customer

Request parameters

{
  "firstName": "example",
  "lastName": "example",
  "phoneNumber": "example"
}

Responses

{
  "id": "b80bb774-0288-3da1-b201-890375a60c8f",
  "firstName": "example",
  "lastName": "example",
  "phoneNumber": "example"
}

Bookings

Create Ticket Booking

/api/v1/bookings/purchase

Create Ticket Booking with Payment Details for a specific customer ID

Request parameters

{
  "customerId": "c7fe6c0d-a028-3abd-8e96-b311aeb9eedc",
  "eventId": "53cc4db5-43d7-3569-a51c-1d76ac6f278e",
  "ticketType": {
    "id": 55,
    "name": "example"
  },
  "ticketCount": 87,
  "payment": {
    "payee": "example",
    "amount": 96.0,
    "currency": "example",
    "narration": "example",
    "appliedDiscount": 62.0,
    "appliedDiscountType": "example"
  }
}

Responses

Tickets

Validate Ticket

/api/v1/tickets/verifyticket

Validates a Ticket

Request parameters

{
  "prefix": "example",
  "number": "example",
  "agentId": "example"
}

Responses

{
  "isValid": true,
  "lastValidated": "1995-12-03T16:50:27Z",
  "count": 43,
  "ticketTypeName": "example",
  "verificationStatus": "example",
  "message": "example"
}

Last modified: 12 September 2024