Admin Functions

There are certain calls that are made available only to administrators of the site. They are listed here.

Booking Functions

adminMarkAsPaid

Type Name Description
Method adminMarkAsPaid This method is used to mark the booking as paid. This will cause the slot to be a different color in the Administrator view.
Return True True is returned if the booking was successfully marked as paid. Otherwise an error will be returned.
Parameter 1 sessionId This is the sessionId you got from logging in.
Parameter 2 Event Id This is the id of the event you want to load the details of. This can be gotten from the listEvents method.
Parameter 3 Slot Id This is the slot id of the booking that you want to mark as paid

adminUpdateBooking

Type Name Description
Method adminUpdateBooking This method is used to modify the details of a booking.
Return True True is returned if the booking was successfully updated. Otherwise an error will be returned.
Parameter 1 sessionId This is the sessionId you got from logging in.
Parameter 2 Booking This is the booking you want to update. Note you should load the booking object first as you will need to use the correct ids and the like.

adminDeleteBooking

Type Name Description
Method adminDeleteBooking This method is used to delete of a booking.
Return True True is returned if the booking was successfully deleted. Otherwise an error will be returned.
Parameter 1 sessionId This is the sessionId you got from logging in.
Parameter 2 Booking This is the booking you want to delete. Only the booking id on this object is needed.

Slot Functions

adminAddSlot

Type Name Description
Method adminAddSlot This method is used to add a booking slot to the Event.
Return True True is returned if the slot was successfully updated. Otherwise an error will be returned.
Parameter 1 sessionId This is the sessionId you got from logging in.
Parameter 2 Event Id This is the id of the event you want to create the slot onto.
Parameter 3 Slot This is the slot you want to add. Note: You will have to load the event to get the slot id.

adminUpdateSlot

Type Name Description
Method adminUpdateSlot This method is used to modify a booking slot.
Return True True is returned if the slot was successfully updated. Otherwise an error will be returned.
Parameter 1 sessionId This is the sessionId you got from logging in.
Parameter 2 Slot This is the slot you want to update.

adminDeleteSlot

Type Name Description
Method adminDeleteSlot This method is used to delete a booking slot.
Return True True is returned if the slot was successfully deleted. Otherwise an error will be returned.
Parameter 1 sessionId This is the sessionId you got from logging in.
Parameter 2 Slot This is the slot you want to delete. Only the slot id is needed.

Image Functions

adminUploadImage

Type Name Description
Method adminUploadImage This method is used to upload a binary image to the server. This can then be added to the event by calling addImage.
Return Path The relative path to the image file url is returned.
Parameter 1 sessionId This is the sessionId you got from logging in.
Parameter 2 byte[] This is a binary array of the image you wish to upload.
Parameter 3 Image Suffix This is a string corresponding to the suffix of the byte array image. E.g. (png,gif,jpeg,jpg).

adminAddImage

Type Name Description
Method adminAddImage This method is used to add an image to the Event. Note the image file will have to be uploaded through the uploadImage call.
Return True True is returned if the image was successfully added. Otherwise an error will be returned.
Parameter 1 sessionId This is the sessionId you got from logging in.
Parameter 2 Event Id This is the id of the event you want to create the image onto.
Parameter 3 Image This is the image you want to add. Note: You will have specify the path as the string returned by the uploadImage call.

adminUpdateImage

Type Name Description
Method adminUpdateImage This method is used to update an image already on the Event.
Return True True is returned if the image was successfully updated. Otherwise an error will be returned.
Parameter 1 sessionId This is the sessionId you got from logging in.
Parameter 2 Image This is the image you want to update.

adminDeleteImage

Type Name Description
Method adminDeleteImage This method is used to delete an image already on the Event.
Return True True is returned if the image was successfully deleted. Otherwise an error will be returned.
Parameter 1 sessionId This is the sessionId you got from logging in.
Parameter 2 Image This is the image you want to delete. Only the image id is required.

Text Functions

adminAddText

Type Name Description
Method adminAddText This method is used to add some Text to the Event.
Return True True is returned if the text was successfully added. Otherwise an error will be returned.
Parameter 1 sessionId This is the sessionId you got from logging in.
Parameter 2 Event Id This is the id of the event you want to add the text onto.
Parameter 3 Text This is the text you want to add.

adminUpdateText

Type Name Description
Method adminUpdateText This method is used to update text already on the Event.
Return True True is returned if the text was successfully updated. Otherwise an error will be returned.
Parameter 1 sessionId This is the sessionId you got from logging in.
Parameter 2 Text This is the text you want to update.

adminDeleteText

Type Name Description
Method adminDeleteText This method is used to delete a text object already on the Event.
Return True True is returned if the text was successfully deleted. Otherwise an error will be returned.
Parameter 1 sessionId This is the sessionId you got from logging in.
Parameter 2 Image This is the text you want to delete. Only the text id is required.