Events: Save Event Details Catalogue

Updated June 14, 2023 16:13

Save Event Details Catalogue

POST /v2/event/save/catl/eventDetails

This API creates Event Details Catalogue in an event and returns a unique Id and its associated details. This same API allows you to update an existing event detail catalogue e.g. change the comments or the qty etc.

Parameters

Id Long

The Id of the event details catalogue. Required only if you are updating an event detail catalogue.

StartDate DateTime

The start date and time of the catalogue item.

EndDate DateTime

The end date and time of the catalogue item.

TemplateId Long

The Id of an event detail item.

Event Object {Id}

The event to which the catalogue item should be associated. The event must exist in your Priava Account. Passed in JSON format where:
Id = Id of the Event.

Contact Object {Id}

The contact to whom the catalogue item should be associated. The contact must exist in your Priava Account. Passed in JSON format where:
Id = Id of the contact.

Venue (optional) Object {Id}

The venue with which the catalogue item should be associated with. The venue must exist in your Priava Account. Passed in JSON format where:
Id = Id of the Venue.

VenueBookingId (optional) Array [Id]

List of Venue Booking with which the catalogue item should be associated. The booking must exist in your Priava Account. Passed in an Array format where:
Id = Id of the Venue Booking.
Can pass multiple Venue Booking Ids in the Array in Create case and single Venue Booking Id in Update case.

In the case of Create scenario, it will create one Event Catalogue per booking passed.

In the case of Update scenario, it will accept only one value in the array. As you can not associate multiple venue Booking to a single Event Catalogue Item.

NOTE: If both VenueBookingId and Venue data are passed, VenueBookingId arrays takes precedence over Venue.

Qty Integer

The required quantity of the catalogue item.

CatalogueComments String

The comment to be associated with the catalogue item.

JSON

{
   "StartDate": "30/03/2019 14:30",
   "Venue": {
      "Id": 100280085,
      "Name": "Venue Name"
   },
   "Qty": 5,
   "VenueBookingId":[102953627],
   "Event": {
      "Id": 101347493,
      "Name": "Catalogue Item DND"
   },
   "Id": "",
   "EndDate": "30/03/2019 23:00",
   "CatalogueComments": "testing line for comments",
   "TemplateId": 3602,
   "Contact": {
      "ContactId": 100400252
   }
}

Response:

{
   "success": true,
   "result": {
      "StartDate": "30/03/2019 14:30",
      "Venue": {
         "Id": 100280085,
         "Name": "Venue Name"
      },
      "Qty": 5,
      "VenueBookings": {},
      "Event": {
         "Id": 101347493,
         "Name": "Catalogue Item DND"
      },
      "Id": 102371352,
      "EndDate": "30/03/2019 23:00",
      "CatalogueComments": "testing line for comments",
      "TemplateId": 3602,
      "Name": "Education Group i",
      "Contact": {
         "Firstname": "Test",
         "Email": "test@gmail.com",
         "Organisation": "Ted Baker",
         "Phone": "+61-450450450",
         "Lastname": "Test1",
         "ContactId": 100400252,
         "JobTitle": "QA"
      }
   }
}

Was this article helpful?

Have more questions? Submit a request