PUT api/Events/SaveEvent

Allows an event to be update or created by passing an APIEvent within the body.

Request Information

URI Parameters

None.

Body Parameters

The APIEvent object to be updated or created as an event.

APIEvent
NameDescriptionTypeAdditional information
EventResourceID

integer

None.
EventCode

integer

None.
EventName

string

None.
EventDescription

string

None.
EventDate

date

None.
EventStartTime

string

None.
EventEndTime

string

None.
EventNotes

string

None.
ValidFrom

date

None.
ValidTo

date

None.
Capacity

integer

None.
ProductMapID

integer

None.
Adults

integer

None.
Children

integer

None.
TotalBooked

integer

None.
ProductList

Collection of Object

None.
EventUDFs

Collection of Object

None.

Request Formats

application/json, text/json

Sample: 
{"EventResourceID":0,"EventCode":0,"EventName":"","EventDescription":"","EventDate":"0001-01-01T00:00:00","EventStartTime":"","EventEndTime":"","EventNotes":"","ValidFrom":"0001-01-01T00:00:00","ValidTo":"0001-01-01T00:00:00","Capacity":0,"ProductMapID":0,"Adults":0,"Children":0,"TotalBooked":0,"ProductList":[{"PLU":"","ProductDescription":"","TicketDescription":"","GiftAidProduct":false,"GiftAidPortion":0.0,"Adults":0,"Children":0,"CategoryCode":0,"CategoryName":"","SubCategory":"","Department":"","PriceDescription":"","Price":0.0,"OnHand":0.0,"ProductImage":"","Notes":"","IsKit":false,"LowestKitItemPLU":"","Quantity":0,"SeatReservationID":0,"GiftVoucherReference":"","Donation":false,"ProductUDFs":null}],"EventUDFs":null}

application/xml, text/xml

Sample: 
<?xml version="1.0" encoding="utf-16"?>
<APIEvent xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <EventResourceID>0</EventResourceID>
  <EventCode>0</EventCode>
  <EventName />
  <EventDescription />
  <EventDate>0001-01-01T00:00:00</EventDate>
  <EventStartTime />
  <EventEndTime />
  <EventNotes />
  <ValidFrom>0001-01-01T00:00:00</ValidFrom>
  <ValidTo>0001-01-01T00:00:00</ValidTo>
  <Capacity>0</Capacity>
  <ProductMapID>0</ProductMapID>
  <Adults>0</Adults>
  <Children>0</Children>
  <TotalBooked>0</TotalBooked>
  <ProductList>
    <APIProduct>
      <PLU />
      <ProductDescription />
      <TicketDescription />
      <GiftAidProduct>false</GiftAidProduct>
      <GiftAidPortion>0</GiftAidPortion>
      <Adults>0</Adults>
      <Children>0</Children>
      <CategoryCode>0</CategoryCode>
      <CategoryName />
      <SubCategory />
      <Department />
      <PriceDescription />
      <Price>0</Price>
      <OnHand>0</OnHand>
      <ProductImage />
      <Notes />
      <IsKit>false</IsKit>
      <LowestKitItemPLU />
      <Quantity>0</Quantity>
      <SeatReservationID>0</SeatReservationID>
      <GiftVoucherReference />
      <Donation>false</Donation>
    </APIProduct>
  </ProductList>
</APIEvent>

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.

Response Formats

application/json, text/json

Sample: 
{"Result":"The Event: Test Event has been saved under ID: 001","Message":""}

application/xml, text/xml

Sample: 
<?xml version="1.0" encoding="utf-16"?>
<InformationResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Result>The Event: Test Event has been saved under ID: 001</Result>
  <Message />
</InformationResponse>