CommunalEvents is hosted on
world-class infrastructure.
Scalability is built in by design.
CommunalEvents API
save
Create a new User or update an existing User.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| FirstName | Text | 20 | Mandatory | - |
| FamilyName | Text | 20 | Mandatory | - |
| Alias | Text | 20 | - | - |
| Summary | Text | 500 | - | - |
| Description | Text | 2000 | - | - |
| PhoneInternationalCode | Text | 5 | - | - |
| Phone | Text | 20 | - | - |
| EmailAddress | Text | 50 | Mandatory | - |
| PasswordEncrypted | Text | 50 | - | - |
| DoNotMailFlag | Bit | - | Mandatory | - |
| RoleCode | Enumeration | - | Mandatory | ClientAdmin | Host | VenueManager | Booker |
| VenueID | ID | - | - | - |
| UserID | ID | - | - | - |
| CreatorID | ID | - | - | - |
| SendEmailFlag | Bit | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| UserID | ID | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- Venue ID is used to link the user to a venue as a manager. For new records, if SendEmailFlag=TRUE, the UserCreated email is sent. For existing records if SendEmailFlag=TRUE, the UserUpdated email is sent. If the Alias is NULL, then it is automatically set to the first 20 characters of the email address. Alias and Email address must be unique i.e. two users cannot have the same Alias or Email address. RoleCode must be VenueManager if Venue ID included. And conversely if Venue ID is included the RoleCode must be VenueManager. CreatorID is the person who is adding/updating the record.
authenticate
Authenticate CommunalEvents User credentials.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EmailAddress | Text | 50 | Mandatory | - |
| OnlySubscribedFlag | Bit | - | Mandatory | - |
| PasswordEncrypted | Text | 50 | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| UserID | ID | - | Mandatory | - |
| Token | Text | 50 | Mandatory | - |
| FirstName | Text | 20 | Mandatory | - |
| Family Name | Text | 20 | Mandatory | - |
| Alias | Text | 20 | - | |
| Summary | Text | 500 | - | |
| RoleCode | Text | 15 | Mandatory | - |
| VenueAdministeredID | ID | - | - | |
| EmailAddressConfirmedTimestamp | DateTime | - | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- A Token will be generated that can be used to uniquely identify the user-session. It must be used for all subsequent web-service calls for which authentication is required. The Token does not currently expire. The User will not be authenticated if it has been Deactivated. If OnlySubscribedFlag = True, then the credentials will only be authenticated if the user has a current subscription.
authenticateExternally
Authenticate external User credentials (e.g. Facebook).
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| ExternalID | Text (50) | 50 | Mandatory | - |
| ExternalSystem | Text (20) | 20 | Mandatory | - |
| FirstName | Text (20) | 20 | Mandatory | - |
| FamilyName | Text (20) | 20 | Mandatory | - |
| EmailAddress | Text (50) | 50 | Mandatory | - |
| DoNotMailFlag | Bit | - | Mandatory | - |
| RoleCodeDefault | Enumeration | - | Mandatory | ClientAdmin |Host | Venue Manager | Booker |
| SendEmailFlag | Bit | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| UserID | ID | - | Mandatory | - |
| Token | Text | 50 | Mandatory | - |
| FirstName | Text | 20 | Mandatory | - |
| Family Name | Text | 20 | Mandatory | - |
| Alias | Text | 20 | - | |
| Summary | Text | 500 | - | |
| RoleCode | Text | 15 | Mandatory | - |
| VenueAdministeredID | ID | - | - | |
| EmailAddressConfirmedTimestamp | DateTime | - | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- Login Token is provided by the external authentication service upon successful authentication. Normally, authenticateExternally will be called immediately after the user has been successfully externally authenticated (e.g. via social login). The service requires an External ID, which is a unique persistent account identifier from the external authority (e.g. a social media username). Also required is the External System, which is a code to identify the authority that was used to authenticate (e.g. Facebook). This is useful because a choice of authority may be offered to the user. A Token will be generated that can be used for your session management. The Token does not currently expire so to reset it, consume the users/logout method. Where a session has timed out at your application, the user may log in again and this will trigger your application to call authenticateExternally again. This will generate another token. Note that only a single External System is supported for a user so if they authenticate with Facebook first, they will not be permitted to log in with Twitter the next time. The user will not be authenticated if it has been deactivated. If this is the first time the user has been authenticated in CommunalEvents, a new User record will be created with the supplied parameters. If the user has been authenticated previously in CommunalEvents then the existing User record will be updated with the supplied parameters (except RoleCodeDefault, FirstName & FamilyName). If Role Code is omitted, it will default to Booker.
confirmEmailAddress
Record that a User has verified their email address.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| Code | Text | 100 | Mandatory | - |
| UserIDCode | ID | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| "Success" | Text | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- This method verifies that a Code is valid. It does not check the email address. The Code is encapsulated in a hyperlink that is included in the UserCreated email. The user will click on the link which should trigger your application to call the confirmEmailAddress method. The Email Address Confirmed Timestamp is set to Now. It is NOT checked whether the user has been deactivated and it is NOT checked that they have an active Subscription.
forgottenPassword
Send a forgotten password email.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EmailAddress | Text | 50 | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
| SendEmailFlag | Bit | - | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| UserID | ID | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- If SendEmailFlag = True, send the UserForgottenPassword email. It is NOT checked whether the user has been deactivated and it is NOT checked that they have an active Subscription.
logout
Log a User out.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| UserID | ID | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| "Success" | Text | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- The Login Token is cleared.
getByID
Retrieve User details for a given User ID.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| UserID | ID | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| UserID | ID | - | Mandatory | - |
| Token | Text | 50 | Mandatory | - |
| FirstName | Text | 20 | Mandatory | - |
| Family Name | Text | 20 | Mandatory | - |
| Alias | Text | 20 | - | |
| Summary | Text | 500 | - | |
| Description | Text | 2000 | - | |
| PhoneInternationalCode | Text | 5 | - | |
| Phone | Text | 20 | - | |
| EmailAddress | Text | 50 | Mandatory | - |
| EmailAddressConfirmedTimestamp | DateTime | - | - | |
| DonotmailFlag | Bit | - | Mandatory | - |
| RoleCode | Text | 15 | Mandatory | - |
| VenueAdministered | ID | - | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- It is NOT checked whether the user has been deactivated and it is NOT checked that they have an active Subscription.
getByLoginToken
Retrieve User details for a given User Login Token.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| LoginToken | Text | 50 | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| UserID | ID | - | Mandatory | - |
| Token | Text | 50 | Mandatory | - |
| FirstName | Text | 20 | Mandatory | - |
| Family Name | Text | 20 | Mandatory | - |
| Alias | Text | 20 | - | |
| Summary | Text | 500 | - | |
| Description | Text | 2000 | - | |
| PhoneInternationalCode | Text | 5 | - | |
| Phone | Text | 20 | - | |
| EmailAddress | Text | 50 | Mandatory | - |
| EmailAddressConfirmedTimestamp | DateTime | - | - | |
| DonotmailFlag | Bit | - | Mandatory | - |
| RoleCode | Text | 15 | Mandatory | - |
| VenueAdministered | ID | - | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- It is NOT checked whether the user has been deactivated and it is NOT checked that they have an active Subscription.
getByVenueAdministered
Retrieve a list of Users (Venue Managers), with their details for a given Venue.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| VenueID | ID | - | Mandatory | - |
| OnlySubscribedFlag | Bit | - | Mandatory | - |
| SortByCode | Enumeration | - | Mandatory | FirstName | FamilyName | Alias |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| UserID | ID | - | Mandatory | - |
| Token | Text | 50 | Mandatory | - |
| FirstName | Text | 20 | Mandatory | - |
| Family Name | Text | 20 | Mandatory | - |
| Alias | Text | 20 | - | |
| Summary | Text | 500 | - | |
| Description | Text | 2000 | - | |
| PhoneInternationalCode | Text | 5 | - | |
| Phone | Text | 20 | - | |
| EmailAddress | Text | 50 | Mandatory | - |
| EmailAddressConfirmedTimestamp | DateTime | - | - | |
| DonotmailFlag | Bit | - | Mandatory | - |
| RoleCode | Text | 15 | Mandatory | - |
| VenueAdministered | ID | - | - |
Response - Ordering
SortByCode
Response - Not Successful
Human-readable error message
Guidance
- Deactivated users will not be returned. If OnlySubscribedFlag = True, then users will only be returned if the venue administered has a current subscription.
getByCityAndCategories
Retrieve a list of Users who have Hosted categorised events in a city.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| City | Text | 20 | Mandatory | - |
| CategoryIDs | ID collection | - | Mandatory | - |
| OnlySubscribedFlag | Bit | - | Mandatory | - |
| SortByCode | Enumeration | - | Mandatory | FirstName | FamilyName | Alias |
| MaxReturnCount | Integer | - | Mandatory | - |
| StartIndex | Integer | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| UserID | ID | - | Mandatory | - |
| Token | Text | 50 | Mandatory | - |
| FirstName | Text | 20 | Mandatory | - |
| Family Name | Text | 20 | Mandatory | - |
| Alias | Text | 20 | - | |
| Summary | Text | 500 | - | |
| Description | Text | 2000 | - | |
| PhoneInternationalCode | Text | 5 | - | |
| Phone | Text | 20 | - | |
| EmailAddress | Text | 50 | Mandatory | - |
| EmailAddressConfirmedTimestamp | DateTime | - | - | |
| DonotmailFlag | Bit | - | Mandatory | - |
| RoleCode | Text | 15 | Mandatory | - |
| VenueAdministered | ID | - | - |
Response - Ordering
SortByCode
Response - Not Successful
Human-readable error message
Guidance
- The Categories relate to Events that are Hosted by the retrieved Users. Events just need to be related to at least one of the Categories, not all of the supplied categories. MaxReturnCount and StartIndex are used for paging i.e. fetching batches of records. Deactivated users will not be returned. If OnlySubscribedFlag = True, then users will only be returned if the venue administered has a current subscription.
getByRole
Retrieve a list of all Users that belong to a give Role.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| RoleCode | Enumeration | - | Mandatory | Host | VenueManager | Booker | Organiser |
| OnlySubscribedFlag | Bit | - | Mandatory | - |
| SortByCode | Enumeration | - | Mandatory | FirstName | FamilyName | Alias |
| MaxReturnCount | Integer | - | Mandatory | - |
| StartIndex | Integer | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| UserID | ID | - | Mandatory | - |
| Token | Text | 50 | Mandatory | - |
| FirstName | Text | 20 | Mandatory | - |
| Family Name | Text | 20 | Mandatory | - |
| Alias | Text | 20 | - | |
| Summary | Text | 500 | - | |
| Description | Text | 2000 | - | |
| PhoneInternationalCode | Text | 5 | - | |
| Phone | Text | 20 | - | |
| EmailAddress | Text | 50 | Mandatory | - |
| EmailAddressConfirmedTimestamp | DateTime | - | - | |
| DonotmailFlag | Bit | - | Mandatory | - |
| RoleCode | Text | 15 | Mandatory | - |
| VenueAdministered | ID | - | - |
Response - Ordering
SortByCode
Response - Not Successful
Human-readable error message
Guidance
- MaxReturnCount and StartIndex are used for paging i.e. fetching batches of records. Deactivated users will not be returned. If OnlySubscribedFlag = True, then users will only be returned if the venue administered has a current subscription.
getByNameAndState
Retrieve a list of Suburbs that partially match the given Name within the given State.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| Name | Text | 50 | Mandatory | - |
| State | Text | 10 | - | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| SuburbID | ID | - | Mandatory | - |
| Name | Text | 50 | Mandatory | - |
| StateCode | Text | 10 | Mandatory | - |
Response - Ordering
Alphabetical by Name
Response - Not Successful
Human-readable error message
Guidance
- The partial match on suburb name is by prefix e.g. “Syd” (in NSW) will return Sydney, Sydenham and Sydney Olympic Park.
save
Create a new Venue or updates an existing Venue.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| VenueID | ID | - | - | - |
| Name | Text | 100 | Mandatory | - |
| Summary | Text | 500 | - | - |
| Description | Text | 2000 | - | - |
| Phone | Text | 20 | - | - |
| EmailAddress | Text | 50 | - | - |
| Website | Text | 50 | - | - |
| Street1 | Text | 50 | Mandatory | - |
| Street2 | Text | 50 | - | - |
| SuburbID | ID | - | Mandatory | - |
| Postcode | Text | 10 | Mandatory | - |
| City | Text | 20 | - | - |
| Latitude | Decimal | - | - | - |
| Longitude | Decimal | - | - | - |
| OpeningHoursMonday | Text | 50 | - | - |
| OpeningHoursTuesday | Text | 50 | - | - |
| OpeningHoursWednesday | Text | 50 | - | - |
| OpeningHoursThursday | Text | 50 | - | - |
| OpeningHoursFriday | Text | 50 | - | - |
| OpeningHoursSaturday | Text | 50 | - | - |
| OpeningHoursSunday | Text | 50 | - | - |
| OpeningHoursOther | Text | 100 | - | - |
| CapacityMin | Integer | - | - | - |
| CapacityMax | Integer | - | - | - |
| KeyUserID | ID | - | - | - |
| CreatorID | ID | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| VenueID | ID | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- CreatorID is the person who is adding/updating the record. Rule: CapacityMin <= CapacityMax
getByID
Retrieve Venue details for a given Venue ID.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| VenueID | ID | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| VenueID | ID | - | Mandatory | - |
| Name | Text | 100 | Mandatory | - |
| Summary | Text | 500 | - | |
| Description | Text | 2000 | - | |
| Phone | Text | 20 | - | |
| EmailAddress | Text | 50 | - | |
| Website | Text | 50 | - | |
| Street1 | Text | 50 | Mandatory | - |
| Street2 | Text | 50 | - | |
| SuburbName | Text | 50 | Mandatory | - |
| StateCode | Text | 10 | Mandatory | - |
| Postcode | Text | 10 | Mandatory | - |
| City | Text | 20 | - | |
| Latitude | Decimal | - | - | |
| Longitude | Decimal | - | - | |
| OpeningHoursMonday | Text | 50 | - | |
| OpeningHoursTuesday | Text | 50 | - | |
| OpeningHoursWednesday | Text | 50 | - | |
| OpeningHoursThursday | Text | 50 | - | |
| OpeningHoursFriday | Text | 50 | - | |
| OpeningHoursSaturday | Text | 50 | - | |
| OpeningHoursSunday | Text | 50 | - | |
| OpeningHoursOther | Text | 100 | - | |
| CapacityMin | Integer | - | - | |
| CapacityMax | Integer | - | - | |
| ExternalID | Text | 50 | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- It is NOT checked whether the Venue has been deactivated and it is NOT checked that they have an active Subscription.
getByExternalID
Retrieve Venue details for a given external Venue ID, for example a Google Place ID.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| ExternalVenueID | Text | 50 | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| VenueID | ID | - | Mandatory | - |
| Name | Text | 100 | Mandatory | - |
| Summary | Text | 500 | - | |
| Description | Text | 2000 | - | |
| Phone | Text | 20 | - | |
| EmailAddress | Text | 50 | - | |
| Website | Text | 50 | - | |
| Street1 | Text | 50 | Mandatory | - |
| Street2 | Text | 50 | - | |
| SuburbName | Text | 50 | Mandatory | - |
| StateCode | Text | 10 | Mandatory | - |
| Postcode | Text | 10 | Mandatory | - |
| City | Text | 20 | - | |
| Latitude | Decimal | - | - | |
| Longitude | Decimal | - | - | |
| OpeningHoursMonday | Text | 50 | - | |
| OpeningHoursTuesday | Text | 50 | - | |
| OpeningHoursWednesday | Text | 50 | - | |
| OpeningHoursThursday | Text | 50 | - | |
| OpeningHoursFriday | Text | 50 | - | |
| OpeningHoursSaturday | Text | 50 | - | |
| OpeningHoursSunday | Text | 50 | - | |
| OpeningHoursOther | Text | 100 | - | |
| CapacityMin | Integer | - | - | |
| CapacityMax | Integer | - | - | |
| ExternalID | Text | 50 | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- It is NOT checked whether the Venue has been deactivated and it is NOT checked that they have an active Subscription.
getBySearch
Retrieve a list of Venues along with a limited subset of data. Search on Event date, Venue categorisation and Venue location.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventFromDate | Timestamp | - | - | - |
| EventToDate | Timestamp | - | - | - |
| CategoryIDs | ID collection | - | - | - |
| SuburbID | ID | - | - | - |
| City | Text | 20 | - | - |
| OnlySubscribedFlag | Bit | - | Mandatory | - |
| SortByCode | Enumeration | - | Mandatory | Name | SuburbName |
| MaxReturnCount | Integer | - | Mandatory | - |
| StartIndex | Integer | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| VenueID | ID | - | Mandatory | - |
| Name | Text | 100 | Mandatory | - |
| Summary | Text | 500 | - | |
| Website | Text | 50 | - | |
| Street1 | Text | 50 | Mandatory | - |
| Street2 | Text | 50 | - | |
| SuburbName | Text | 50 | Mandatory | - |
| StateCode | Text | 10 | Mandatory | - |
| Postcode | Text | 10 | Mandatory | - |
| City | Text | 20 | - | |
| Latitude | Decimal | - | - | |
| Longitude | Decimal | - | - | |
| ExternalID | Text | 50 | - |
Response - Ordering
SortByCode
Response - Not Successful
Human-readable error message
Guidance
- If Categories are included in the request, Venues must be Categorised by one or more of them to be returned. CityName is an exact match. If the 5 search parameters are omitted, then all Venues are returned. If OnlySubscribedFlag = True, then Venues will only be returned if the Venue has a current subscription: Deactivated Venues will not be returned. Max Return Count and Start Index are used for paging i.e. fetching batches of records.
getBySearchCount
Get the count for the equivalent Venues/getBySearch request.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventFromDate | Timestamp | - | - | - |
| EventToDate | Timestamp | - | - | - |
| CategoryIDs | ID collection | - | - | - |
| SuburbID | ID | - | - | - |
| City | Text | 20 | - | - |
| OnlySubscribedFlag | Bit | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| Count | Integer | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- See Venues/getBySearch.
save
Create a new event or updates an existing event.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventID | ID | - | - | - |
| Name | Text | 50 | Mandatory | - |
| Summary | Text | 500 | - | - |
| Description | Text | 2000 | - | - |
| DealDescription | Text | 2000 | - | - |
| DealOrganisation | Text | 100 | - | - |
| CapacityMin | Integer | - | - | - |
| CapacityMax | Integer | - | - | - |
| PrivateFlag | Boolean | - | Mandatory | - |
| StartTimestamp | DateTime | - | Mandatory | - |
| DurationHours | Decimal | - | - | - |
| PriceGross | Decimal | - | - | - |
| PriceGrossRangeLow | Decimal | - | - | - |
| PriceGrossRangeHigh | Decimal | - | - | - |
| Deposit | Decimal | - | - | - |
| HostUserID | ID | - | - | - |
| VenueID | ID | - | Mandatory | - |
| ReminderHours | Integer | - | - | - |
| FinalisationHours | Integer | - | - | - |
| ExternalID | Text | 50 | - | - |
| CreatorID | ID | - | Mandatory | - |
| SendEmailFlag | Bit | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventID | ID | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- A Deal is intended to be a special offer, possibly provided by a third party (the Deal Organisation). Capacity is how many people can book onto the event. The Private Flag can be used to prevent an event from being displayed to the public. PriceGross means price including sales tax. Deposit can be used where an initial amount is paid to reserve a place. HostUser is the organiser of the event. Reminder Hours can be used to send a reminder email prior to the event. Finalisation Hours can be used to request final payment for example. CreatorID is the person who is adding/updating the record. For new records, if SendEmailFlag=TRUE, the EventCreated email is sent. For record updates, if SendEmailFlag=TRUE, the EventUpdated email is sent. PriceGrossRangeLow <= PriceGrossRangeHigh CapacityMin <= CapacityMax
request
Allow a User to request an Event
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventID | ID | - | - | - |
| Name | Text | 50 | Mandatory | - |
| Summary | Text | 500 | - | - |
| Description | Text | 2000 | - | - |
| DealDescription | Text | 2000 | - | - |
| DealOrganisation | Text | 100 | - | - |
| CapacityMin | Integer | - | - | - |
| CapacityMax | Integer | - | - | - |
| PrivateFlag | Boolean | - | - | - |
| StartTimestamp | DateTime | - | Mandatory | - |
| DurationHours | Decimal | - | - | - |
| PriceGross | Decimal | - | - | - |
| PriceGrossRangeLow | Decimal | - | - | - |
| PriceGrossRangeHigh | Decimal | - | - | - |
| Deposit | Decimal | - | - | - |
| HostUserID | ID | - | - | - |
| VenueID | ID | - | Mandatory | - |
| ReminderHours | Integer | - | - | - |
| FinalisationHours | Integer | - | - | - |
| ExternalID | Text | 50 | - | - |
| CreatorID | ID | - | Mandatory | - |
| SendEmailFlag | Bit | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
| RequestAlternativeTimestamp1 | DateTime | - | - | - |
| RequestAlternativeTimestamp2 | DateTime | - | - | - |
| RequestAlternativeTimestamp3 | DateTime | - | - | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventID | ID | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- See Events/save. If SendEmailFlag=TRUE, the EventRequested email is sent.
respond
Allow a User (usually a VenueManager or ClientAdmin) to respond to an Event request
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventID | ID | - | Mandatory | - |
| RequestStateCode | Enumeration | - | Mandatory | Decline | Alternative | Cancel |
| AlternativeTimestamp | DateTime | - | - | - |
| ResponseReason | Text | 500 | - | - |
| CreatorID | ID | - | Mandatory | - |
| SendEmailFlag | Bit | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventID | ID | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- CreatorID is the person who is adding/updating the record. If SendEmailFlag=TRUE, the EventRejected/EventAlternative/EventDeactivated email is sent, depending on the response type.
publish
Publishes an event so that it is publicly available.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventID | ID | - | Mandatory | - |
| CreatorID | ID | - | Mandatory | - |
| SendEmailFlag | Bit | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventID | ID | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- CreatorID is the person who is adding/updating the record. If SendEmailFlag=TRUE, the EventPublished email is sent.
unpublish
Unpublishes an event so that it is not longer publicly available.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventID | ID | - | Mandatory | - |
| CreatorID | ID | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventID | ID | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- CreatorID is the person who is unpublishing the record.
cancel
Cancel an event.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventID | ID | - | Mandatory | - |
| Reason | Text | 500 | - | - |
| CreatorID | ID | - | Mandatory | - |
| SendEmailFlag | Bit | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventID | ID | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- CreatorID is the person who is adding/updating the record. If SendEmailFlag=TRUE, the EventDeactivated email is sent.
getByID
Retrieve Event details for a given Event ID.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventID | ID | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| ID | ID | - | Mandatory | - |
| Name | Text | 50 | Mandatory | - |
| Summary | Text | 500 | - | |
| Description | Text | 2000 | - | |
| DealDescription | Text | 2000 | - | |
| DealOrganisation | Text | 100 | - | |
| CapacityMin | Integer | - | - | |
| CapacityMax | Integer | - | - | |
| CapacityReachedTimestamp | DateTime | - | - | |
| PrivateFlag | Bit | - | Mandatory | - |
| PublishedTimestamp | DateTime | - | - | |
| PublishedUser | ID | - | - | |
| StartTimestamp | DateTime | - | Mandatory | - |
| DurationHours | Decimal | - | - | |
| PriceGross | SmallMoney | - | - | |
| PriceGrossRangeLow | SmallMoney | - | - | |
| PriceGrossRangeHigh | SmallMoney | - | - | |
| Deposit | SmallMoney | - | - | |
| HostUser | ID | - | - | |
| Venue | ID | - | - | |
| ReminderHours | Decimal | - | - | |
| FinalisationHours | Decimal | - | - | |
| RequestStateCode | Text | 20 | - | |
| RequestAlternativeTimestamp1 | DateTime | - | - | |
| RequestAlternativeTimestamp2 | DateTime | - | - | |
| RequestAlternativeTimestamp3 | DateTime | - | - | |
| RequestResponseReason | Text | 500 | - | |
| CancellationReason | Text | 200 | - | |
| ExternalID | Text | 50 | - | |
| CreatedTimestamp | DateTime | - | Mandatory | - |
| CreatedUser | ID | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- It is NOT checked whether the Event has been deactivated/cancelled.
getBySearch
Retrieve a list of Events along with a limited subset of data. Search on date, categorisation, location, venue, name, average rating and/or organiser.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| FromDate | DateTime | - | - | - |
| ToDate | DateTime | - | - | - |
| CategoryIDs | ID collection | - | - | - |
| SuburbID | ID | - | - | - |
| VenueCityName | Text | 20 | - | - |
| VenueSuburbID | ID | - | - | - |
| VenueID | ID | - | - | - |
| VenueName | Text | 100 | - | - |
| EventName | Text | 50 | - | - |
| EventAverageRating1 | Integer | - | - | - |
| HostUserID | ID | - | - | - |
| OnlySubscribedFlag | Bit | - | Mandatory | - |
| includeUnpublishedFlag | Bit | - | Mandatory | - |
| SortByCode | Enumeration | - | Mandatory | Name | SuburbName | VenueName | VenueCity | StartDate | StartDateAscending |
| MaxReturnCount | Integer | - | Mandatory | - |
| StartIndex | Integer | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| ID | ID | - | Mandatory | - |
| Name | Text | 50 | Mandatory | - |
| Summary | Text | 500 | - | |
| Description | Text | 2000 | - | |
| DealDescription | Text | 2000 | - | |
| DealOrganisation | Text | 100 | - | |
| CapacityMin | Integer | - | - | |
| CapacityMax | Integer | - | - | |
| CapacityReachedTimestamp | DateTime | - | - | |
| PrivateFlag | Bit | - | Mandatory | - |
| PublishedTimestamp | DateTime | - | - | |
| PublishedUser | ID | - | - | |
| StartTimestamp | DateTime | - | Mandatory | - |
| DurationHours | Decimal | - | - | |
| PriceGross | SmallMoney | - | - | |
| PriceGrossRangeLow | SmallMoney | - | - | |
| PriceGrossRangeHigh | SmallMoney | - | - | |
| Deposit | SmallMoney | - | - | |
| HostUserID | ID | - | - | |
| HostUser | Text | 41 | - | |
| HostEmail | Text | 50 | - | |
| HostPhone | Text | 20 | - | |
| HostAlias | Text | 20 | - | |
| PublishedUserID | ID | - | - | |
| Venue | Text | 100 | - | |
| VenueID | ID | - | - | |
| VenueCity | Text | 20 | - | |
| SuburbName | Text | 50 | - | |
| ReminderHours | Decimal | - | - | |
| FinalisationHours | Decimal | - | - | |
| RequestStateCode | Text | 20 | - | |
| RequestAlternativeTimestamp1 | DateTime | - | - | |
| RequestAlternativeTimestamp2 | DateTime | - | - | |
| RequestAlternativeTimestamp3 | DateTime | - | - | |
| RequestResponseReason | Text | 500 | - | |
| CancellationReason | Text | 200 | - | |
| ExternalID | Text | 50 | - | |
| CreatedTimestamp | DateTime | - | Mandatory | - |
| CreatedUserID | ID | - | Mandatory | - |
| CreatedUserRole | Text | 15 | Mandatory | ClientAdmin |Host |Booker |
Response - Ordering
SortByCode
Response - Not Successful
Human-readable error message
Guidance
- The 10 search parameters are each optional. If all are omitted, then all records are returned. Where values are entered for parameters, all of those values must be matched for an event to be returned. There is an exception for Event Name and Venue Name: only one of the two needs to match. This enables a keyword search to be implemented. If categories are included in the request, events must be categorised by one or more of them to be returned. CityName is an exact match. VenueName and EventName require a partial match – a wildcard is appended to the input text. The EventAverageRating relates to Review.Rating1. Reviews must be published to be included in the average. HostUser is the Organiser of the Event. MaxReturnCount and StartIndex are used for paging i.e. fetching batches of records. The OnlySubscribedFlag is not implemented. The includeUnpublishedFlag allows unpublised events to be included. Only active & published Event records are returned. It is NOT checked whether the Venue has been deactivated.
getBySearchCount
Get the count for the equivalent Events/getBySearch request.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| FromDate | DateTime | - | - | - |
| ToDate | DateTime | - | - | - |
| CategoryIDs | ID collection | - | - | - |
| SuburbID | ID | - | - | - |
| VenueCityName | Text | 20 | - | - |
| VenueSuburbID | ID | - | - | - |
| VenueID | ID | - | - | - |
| VenueName | Text | 100 | - | - |
| EventName | Text | 50 | - | - |
| EventAverageRating1 | Integer | - | - | - |
| HostUserID | ID | - | - | - |
| OnlySubscribedFlag | Bit | - | Mandatory | - |
| includeUnpublishedFlag | Bit | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| Count | Integer | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- See Events/getBySearch.
getByVenue
Retrieve a list of Events, with their details that are held at a given Venue.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| VenueID | ID | - | - | - |
| FromDate | DateTime | - | - | - |
| ToDate | DateTime | - | - | - |
| ClosestFlag | Bit | - | - | - |
| HostUserExistsFlag | Bit | - | - | - |
| OnlySubscribedFlag | Bit | - | Mandatory | - |
| OnlyPublishedFlag | Bit | - | Mandatory | - |
| SortByCode | Enumeration | - | Mandatory | Name | Suburb Name |
| MaxReturnCount | Integer | - | Mandatory | - |
| StartIndex | Integer | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| ID | ID | - | Mandatory | - |
| Name | Text | 50 | Mandatory | - |
| Summary | Text | 500 | - | |
| Description | Text | 2000 | - | |
| DealDescription | Text | 2000 | - | |
| DealOrganisation | Text | 100 | - | |
| CapacityMin | Integer | - | - | |
| CapacityMax | Integer | - | - | |
| CapacityReachedTimestamp | DateTime | - | - | |
| PrivateFlag | Bit | - | Mandatory | - |
| PublishedTimestamp | DateTime | - | - | |
| PublishedUser | ID | - | - | |
| StartTimestamp | DateTime | - | Mandatory | - |
| DurationHours | Decimal | - | - | |
| PriceGross | SmallMoney | - | - | |
| PriceGrossRangeLow | SmallMoney | - | - | |
| PriceGrossRangeHigh | SmallMoney | - | - | |
| Deposit | SmallMoney | - | - | |
| HostUser | ID | - | - | |
| Venue | ID | - | - | |
| ReminderHours | Decimal | - | - | |
| FinalisationHours | Decimal | - | - | |
| RequestStateCode | Text | 20 | - | |
| RequestAlternativeTimestamp1 | DateTime | - | - | |
| RequestAlternativeTimestamp2 | DateTime | - | - | |
| RequestAlternativeTimestamp3 | DateTime | - | - | |
| RequestResponseReason | Text | 500 | - | |
| CancellationReason | Text | 200 | - | |
| ExternalID | Text | 50 | - | |
| CreatedTimestamp | DateTime | - | Mandatory | - |
| CreatedUser | ID | - | Mandatory | - |
Response - Ordering
SortByCode
Response - Not Successful
Human-readable error message
Guidance
- HostUser is the Organiser of the Event. If the HostUserExistsFlag is set then Events are only returned if an Organiser has been set. If the OnlyPublishedFlag is set, then only Published Events are returned. If there is a FromDate and/or ToDate and the ClosestFlag is set then events on dates around this period are returned and ordered by proximity. MaxReturnCount and StartIndex are used for paging i.e. fetching batches of records. The OnlySubscribedFlag is not implemented Only active Event records are returned.
getByFailed
Retrieve a list of Events along with a limited subset of data that have failed to be held.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| OnlySubscribedFlag | Bit | - | Mandatory | - |
| SortByCode | Enumeration | - | Mandatory | Name | Suburb Name | StartDate |
| MaxReturnCount | Integer | - | Mandatory | - |
| StartIndex | Integer | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| ID | ID | - | Mandatory | - |
| Name | Text | 50 | Mandatory | - |
| Summary | Text | 500 | - | |
| Description | Text | 2000 | - | |
| DealDescription | Text | 2000 | - | |
| DealOrganisation | Text | 100 | - | |
| CapacityMin | Integer | - | - | |
| CapacityMax | Integer | - | - | |
| CapacityReachedTimestamp | DateTime | - | - | |
| PrivateFlag | Bit | - | Mandatory | - |
| PublishedTimestamp | DateTime | - | - | |
| PublishedUser | ID | - | - | |
| StartTimestamp | DateTime | - | Mandatory | - |
| DurationHours | Decimal | - | - | |
| PriceGross | SmallMoney | - | - | |
| PriceGrossRangeLow | SmallMoney | - | - | |
| PriceGrossRangeHigh | SmallMoney | - | - | |
| Deposit | SmallMoney | - | - | |
| HostUser | ID | - | - | |
| Venue | ID | - | - | |
| ReminderHours | Decimal | - | - | |
| FinalisationHours | Decimal | - | - | |
| RequestStateCode | Text | 20 | - | |
| RequestAlternativeTimestamp1 | DateTime | - | - | |
| RequestAlternativeTimestamp2 | DateTime | - | - | |
| RequestAlternativeTimestamp3 | DateTime | - | - | |
| RequestResponseReason | Text | 500 | - | |
| CancellationReason | Text | 200 | - | |
| ExternalID | Text | 50 | - | |
| CreatedTimestamp | DateTime | - | Mandatory | - |
| CreatedUser | ID | - | Mandatory | - |
Response - Ordering
SortByCode
Response - Not Successful
Human-readable error message
Guidance
- Events are returned that have not met the minimum booking number (Event.CapacityMin) within the Event.FinalisationHours MaxReturnCount and StartIndex are used for paging i.e. fetching batches of records. The OnlySubscribedFlag is not implemented Only active Event records are returned.
save
Create a new Booking or updates an existing Booking.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| BookingID | ID | - | - | - |
| PaymentAmount | SmallMoney | - | - | - |
| PaymentReference | Text | 20 | - | - |
| PaymentCCEndDigits | Text | 4 | - | - |
| PaymentCCExpiryDate | Text | 7 | - | - |
| Street1 | Text | 50 | - | - |
| Street2 | Text | 50 | - | - |
| SuburbID | ID | - | - | - |
| Postcode | Text | 10 | - | - |
| CountryName | Text | 30 | - | - |
| PaymentTypeCode | Enumeration | - | - | FlatPrice | Deposit | BookingFee |
| EventID | ID | - | Mandatory | - |
| CreatorID | ID | - | Mandatory | - |
| SendEmailFlag | Bit | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| BookingID | ID | - | Mandatory | - |
| BookingCode | Text | 10 | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- The booking code is a unique code generated for a new booking. For new records, if SendEmailFlag=TRUE, the BookingCreated email is sent. Event information is stored with the event as a record of the event at the time of booking.
cancel
Cancel a Booking.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| BookingID | ID | - | Mandatory | - |
| UserID | ID | - | Mandatory | - |
| SendEmailFlag | Bit | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| "Success" | ID | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- If SendEmailFlag=TRUE, the BookingCancelled email is sent.
getByUser
Retrieve a list of Bookings, with their details for a given User.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| UserID | ID | - | Mandatory | - |
| EventID | ID | - | - | - |
| SortByCode | Enumeration | - | Mandatory | Name | SuburbName |
| MaxReturnCount | Integer | - | Mandatory | - |
| StartIndex | Integer | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| BookingID | ID | - | Mandatory | - |
| PaymentAmount | SmallMoney | - | - | |
| PaymentReference | Text | - | - | |
| PaymentTypeCode | Text | 10 | - | |
| Code | Text | 10 | - | |
| ConfirmedTimestamp | DateTime | - | - | |
| EventDeal | Text | 200 | - | |
| EventStartTimestamp | DateTime | - | Mandatory | - |
| EventDurationHours | Decimal | - | - | |
| EventPriceGross | SmallMoney | - | - | |
| EventPriceGrossRangeLow | SmallMoney | - | - | |
| EventPriceGrossRangeHigh | SmallMoney | - | - | |
| EventHostUserID | ID | - | - | |
| EventHostUser | Text | 41 | - | |
| EventVenueID | ID | - | - | |
| EventVenue | Text | 100 | - | |
| EventID | ID | - | Mandatory | - |
| Suburb | Text | 50 | - | |
| CreatedTimestamp | DateTime | - | Mandatory | - |
| CreateUserID | ID | - | Mandatory | - |
| CreateUser | Text | 41 | Mandatory | - |
Response - Ordering
SortByCode
Response - Not Successful
Human-readable error message
Guidance
- MaxReturnCount and StartIndex are used for paging i.e. fetching batches of records. Events are NOT checked to see if they are Published, Cancelled or Deactivated. Venues and Users are NOT checked to see if they hold a valid subscription.
getByCode
Retrieve the Booking with the code Booking Code
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| Code | Text | 10 | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| BookingID | ID | - | Mandatory | - |
| PaymentAmount | SmallMoney | - | - | |
| PaymentReference | Text | - | - | |
| PaymentTypeCode | Text | 10 | - | |
| Code | Text | 10 | - | |
| ConfirmedTimestamp | DateTime | - | - | |
| EventDeal | Text | 200 | - | |
| EventStartTimestamp | DateTime | - | Mandatory | - |
| EventDurationHours | Decimal | - | - | |
| EventPriceGross | SmallMoney | - | - | |
| EventPriceGrossRangeLow | SmallMoney | - | - | |
| EventPriceGrossRangeHigh | SmallMoney | - | - | |
| EventHostUserID | ID | - | - | |
| EventHostUser | Text | 41 | - | |
| EventVenueID | ID | - | - | |
| EventVenue | Text | 100 | - | |
| EventID | ID | - | Mandatory | - |
| Suburb | Text | 50 | - | |
| CreatedTimestamp | DateTime | - | Mandatory | - |
| CreatedUserID | ID | - | Mandatory | - |
| CreateUser | Text | 41 | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- Events are not checked to see if they are Published, Cancelled or Deactivated. Venues and Users are not checked to see if they hold a valid subscription.
getByID
Retrieve Plan details for a given Plan ID.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| PlanID | ID | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| PlanID | ID | - | Mandatory | - |
| Name | Text | 50 | Mandatory | - |
| DurationMonths | Integer | - | - | |
| MaxEventsPerMonth | Integer | - | - | |
| MaxBookingsPerMonth | Integer | - | - | |
| FeePerBooking | SmallMoney | - | - | |
| FeePercentofPriceGross | Decimal | - | - | |
| FeeMonthly | SmallMoney | - | - | |
| FeeAnnual | SmallMoney | - | - | |
| AllowPublicEventRequestsFlag | Bit | - | Mandatory | - |
| DisplayOrder | Integer | - | Mandatory | - |
| EmphasisFlag | Bit | - | Mandatory | - |
| TypeCode | Text | 10 | Mandatory | User | Venue |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
getByType
Retrieve a list of Plans with their details for a given Plan Type.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| TypeCode | Text | 10 | Mandatory | User | Venue |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| PlanID | ID | - | Mandatory | - |
| Name | Text | 50 | Mandatory | - |
| DurationMonths | Integer | - | - | |
| MaxEventsPerMonth | Integer | - | - | |
| MaxBookingsPerMonth | Integer | - | - | |
| FeePerBooking | SmallMoney | - | - | |
| FeePercentofPriceGross | Decimal | - | - | |
| FeeMonthly | SmallMoney | - | - | |
| FeeAnnual | SmallMoney | - | - | |
| AllowPublicEventRequestsFlag | Bit | - | Mandatory | - |
| DisplayOrder | Integer | - | Mandatory | - |
| EmphasisFlag | Bit | - | Mandatory | - |
| TypeCode | Text | 10 | Mandatory | User | Venue |
Response - Ordering
None specified
Response - Not Successful
Human-readable error message
Guidance
- Both Users and Venues can subscribe to Plans. The Plan Type distinguishes between them.
save
Create a new Subscription or updates an existing Subscription.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| SubscriptionID | ID | - | Mandatory | - |
| OrganisationName | Text | 100 | Mandatory | - |
| OrganisationReference | Text | 20 | Mandatory | - |
| Street1 | Text | 50 | Mandatory | - |
| Street2 | Text | 50 | - | - |
| Suburb | ID | - | Mandatory | - |
| Postcode | Text | 10 | Mandatory | - |
| SubscriptionStartDate | Date | - | - | - |
| SubscriptionEndDate | Date | - | - | - |
| FeePerBooking | SmallMoney | - | - | - |
| FeePercentofPriceGross | Decimal | - | - | - |
| FeeMonthly | SmallMoney | - | - | - |
| FeeAnnual | SmallMoney | - | - | - |
| StandardDeposit1 | SmallMoney | - | - | - |
| StandardDeposit2 | SmallMoney | - | - | - |
| AllowPublicEventRequestsFlag | Bit | - | Mandatory | - |
| EmailFromAddress | Text | 50 | - | - |
| EmailFromName | Text | 50 | - | - |
| HoursBeforeConfirmation1 | Decimal | - | - | - |
| HoursBeforeConfirmation2 | Decimal | - | - | - |
| HoursBeforeFinalisation | Decimal | - | - | - |
| BankSortcode | Text | 10 | - | - |
| BankAccount | Text | 10 | - | - |
| PaymentGatewayCustomerID | Text | 50 | - | - |
| LastPaymentAmount | SmallMoney | - | - | - |
| LastPaymentReference | Text | 50 | - | - |
| LastPaymentDate | DateTime | - | - | - |
| LastPaymentCCEndDigits | Text | 4 | - | - |
| LastPaymentCCExpiryDate | Text | 7 | - | - |
| CancellationTimestamp | DateTime | - | - | - |
| PlanID | ID | - | Mandatory | - |
| VenueID | ID | - | - | - |
| UserID | ID | - | Mandatory | - |
| SendEmailFlag | Bit | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| SubscriptionID | ID | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- For new records, if SendEmailFlag=TRUE, the SubscriptionCreated email is sent.
cancel
Cancel a Subscription.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| SubscriptionID | ID | - | Mandatory | - |
| UserID | ID | - | - | - |
| SendEmailFlag | Bit | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| SubscriptionID | ID | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- For new records, if SendEmailFlag=TRUE, the SubscriptionCancelled email is sent.
getByID
Retrieve Subscription details for a given Subscription ID.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| SubscriptionID | ID | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| SubscriptionID | ID | - | Mandatory | - |
| OrganisationName | Text | 100 | Mandatory | - |
| OrganisationReference | Text | 20 | Mandatory | - |
| Street1 | Text | 50 | Mandatory | - |
| Street2 | Text | 50 | - | |
| SuburbID | ID | - | Mandatory | - |
| Postcode | Text | 10 | Mandatory | - |
| SubscriptionStartDate | Date | - | - | |
| SubscriptionEndDate | Date | - | - | |
| FeePerBooking | SmallMoney | - | - | |
| FeePercentofPriceGross | Decimal | - | - | |
| FeeMonthly | SmallMoney | - | - | |
| FeeAnnual | SmallMoney | - | - | |
| StandardDeposit1 | SmallMoney | - | - | |
| StandardDeposit2 | SmallMoney | - | - | |
| AllowPublicEventRequestsFlag | Bit | - | Mandatory | - |
| EmailFromAddress | Text | 50 | - | |
| EmailFromName | Text | 50 | - | |
| HoursBeforeConfirmation1 | Decimal | - | - | |
| HoursBeforeConfirmation2 | Decimal | - | - | |
| HoursBeforeFinalisation | Decimal | - | - | |
| BankSortcode | Text | 10 | - | |
| BankAccount | Text | 10 | - | |
| PaymentGatewayCustomerID | Text | 50 | - | |
| LastPaymentAmount | SmallMoney | - | - | |
| LastPaymentReference | Text | 50 | - | |
| LastPaymentDate | DateTime | - | - | |
| LastPaymentCCEndDigits | Text | 4 | - | |
| LastPaymentCCExpiryDate | Text | 7 | - | |
| CreatedTimestamp | DateTime | - | Mandatory | - |
| CancellationTimestamp | DateTime | - | - | |
| PlanID | ID | - | Mandatory | - |
| VenueID | ID | - | - | |
| UserID | ID | - | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- It is NOT checked whether the Subscription has been deactivated/cancelled.
getByUser
Retrieve a list of Subscriptions with their details for a given User.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| UserID | ID | - | - | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| SubscriptionID | ID | - | Mandatory | - |
| OrganisationName | Text | 100 | Mandatory | - |
| OrganisationReference | Text | 20 | Mandatory | - |
| Street1 | Text | 50 | Mandatory | - |
| Street2 | Text | 50 | - | |
| SuburbID | ID | - | Mandatory | - |
| Postcode | Text | 10 | Mandatory | - |
| SubscriptionStartDate | Date | - | - | |
| SubscriptionEndDate | Date | - | - | |
| FeePerBooking | SmallMoney | - | - | |
| FeePercentofPriceGross | Decimal | - | - | |
| FeeMonthly | SmallMoney | - | - | |
| FeeAnnual | SmallMoney | - | - | |
| StandardDeposit1 | SmallMoney | - | - | |
| StandardDeposit2 | SmallMoney | - | - | |
| AllowPublicEventRequestsFlag | Bit | - | Mandatory | - |
| EmailFromAddress | Text | 50 | - | |
| EmailFromName | Text | 50 | - | |
| HoursBeforeConfirmation1 | Decimal | - | - | |
| HoursBeforeConfirmation2 | Decimal | - | - | |
| HoursBeforeFinalisation | Decimal | - | - | |
| BankSortcode | Text | 10 | - | |
| BankAccount | Text | 10 | - | |
| PaymentGatewayCustomerID | Text | 50 | - | |
| LastPaymentAmount | SmallMoney | - | - | |
| LastPaymentReference | Text | 50 | - | |
| LastPaymentDate | DateTime | - | - | |
| LastPaymentCCEndDigits | Text | 4 | - | |
| LastPaymentCCExpiryDate | Text | 7 | - | |
| CreatedTimestamp | DateTime | - | Mandatory | - |
| CancellationTimestamp | DateTime | - | - | |
| PlanID | ID | - | Mandatory | - |
| VenueID | ID | - | - | |
| UserID | ID | - | - |
Response - Ordering
CreatedTimestamp (descending)
Response - Not Successful
Human-readable error message
Guidance
- Returns Subscriptions for Venues that the given User is a VenueManager as well as the User's own Subscriptions. It is NOT checked whether the Subscription has been deactivated/cancelled.
save
Create a new Review or updates an existing Review.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| ReviewID | ID | - | - | - |
| Summary | Text | 500 | - | - |
| Description | Text | 2000 | - | - |
| Question1 | Text | 500 | - | - |
| Question2 | Text | 500 | - | - |
| Question3 | Text | 500 | - | - |
| Question4 | Text | 500 | - | - |
| Question5 | Text | 500 | - | - |
| Rating1 | Integer | - | - | - |
| Rating2 | Integer | - | - | - |
| Rating3 | Integer | - | - | - |
| Rating4 | Integer | - | - | - |
| PublishNowFlag | Bit | - | Mandatory | - |
| EventID | ID | - | - | - |
| VenueID | ID | - | - | - |
| UserID | ID | - | - | - |
| CreatorID | ID | - | Mandatory | - |
| SendEmailFlag | Bit | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| ReviewID | ID | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- One or more of EventID, VenueID and UserID must be entered. This is the entity being reviewed. For new records, if SendEmailFlag=TRUE, the ReviewCreated email is sent.
addResponse
Update a Review record with a response.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| ReviewID | ID | - | Mandatory | - |
| Response | Text | 500 | Mandatory | - |
| UserID | ID | - | Mandatory | - |
| SendEmailFlag | Bit | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | - | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| ReviewID | ID | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- If SendEmailFlag=TRUE, the ReviewResponded email is sent.
getByUserHosted
Retrieve a list of Reviews for Events that were hosted by a given User.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| UserID | ID | - | Mandatory | - |
| MaxReturnCount | Integer | - | Mandatory | - |
| StartIndex | Integer | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| ReviewID | ID | - | Mandatory | - |
| Summary | Text | 500 | - | |
| Description | Text | 2000 | - | |
| Question1 | Text | 500 | - | |
| Question2 | Text | 500 | - | |
| Question3 | Text | 500 | - | |
| Question4 | Text | 500 | - | |
| Question5 | Text | 500 | - | |
| Rating1 | Integer | - | - | |
| Rating2 | Integer | - | - | |
| Rating3 | Integer | - | - | |
| Rating4 | Integer | - | - | |
| PublishedTimestamp | DateTime | - | - | |
| PublishedUser | ID | - | - | |
| Response | Text | 500 | - | |
| ResponseTimestamp | DateTime | - | - | |
| EventID | ID | - | - | |
| VenueID | ID | - | - | |
| UserID | ID | - | - | |
| CreatedTimestamp | DateTime | - | Mandatory | - |
| CreateUserID | ID | - | Mandatory | - |
| CreateFirstName | Text | 20 | Mandatory | - |
| CreateLastName | Text | 20 | Mandatory | - |
| CreateUserAlias | Text | 20 | - | |
| UpdateUserID | ID | 0 | Mandatory | - |
| UpdateFirstName | Text | 20 | Mandatory | - |
| UpdateLastName | Text | 20 | Mandatory | - |
| UpdateUserAlias | Text | 20 | - |
Response - Ordering
Created Timestamp (descending)
Response - Not Successful
Human-readable error message
Guidance
- Max Return Count and Start Index are used for paging i.e. fetching batches of records.
getByEvent
Retrieve a list of Reviews for a given Event.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventID | ID | - | - | - |
| MaxReturnCount | Integer | - | Mandatory | - |
| StartIndex | Integer | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| ID | ID | - | Mandatory | - |
| Summary | Text | 500 | - | |
| Description | Text | 2000 | - | |
| Question1 | Text | 500 | - | |
| Question2 | Text | 500 | - | |
| Question3 | Text | 500 | - | |
| Question4 | Text | 500 | - | |
| Question5 | Text | 500 | - | |
| Rating1 | Integer | - | - | |
| Rating2 | Integer | - | - | |
| Rating3 | Integer | - | - | |
| Rating4 | Integer | - | - | |
| PublishedTimestamp | DateTime | - | - | |
| PublishedUser | ID | - | - | |
| Response | Text | 500 | - | |
| ResponseTimestamp | DateTime | - | - | |
| EventID | ID | - | - | |
| VenueID | ID | - | - | |
| UserID | ID | - | - | |
| CreatedTimestamp | DateTime | - | Mandatory | - |
| CreateUserID | ID | - | Mandatory | - |
| CreateFirstName | Text | 20 | Mandatory | - |
| CreateLastName | Text | 20 | Mandatory | - |
| CreateUserAlias | Text | 20 | - | |
| UpdateUserID | ID | 0 | Mandatory | - |
| UpdateFirstName | Text | 20 | Mandatory | - |
| UpdateLastName | Text | 20 | Mandatory | - |
| UpdateUserAlias | Text | 20 | - |
Response - Ordering
Created Timestamp (descending)
Response - Not Successful
Human-readable error message
Guidance
- Max Return Count and Start Index are used for paging i.e. fetching batches of records.
getByEventCount
Get the count for the equivalent Reviews/getByEvent request.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventID | ID | - | - | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| Count | Integer | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
getAverageEventRating
Retrieve average Event ratings for an Event, User or Venue.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventID | ID | - | - | - |
| UserID | ID | - | - | - |
| VenueID | ID | - | - | - |
| EventName | Text | 50 | - | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| Rating | Integer | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- Exactly one of the following must be present: EventID, VenueID, UserID, EventName. This is the entity that was reviewed. Average ratings are returned for Events that the User has created or that has been held in a Venue. This is different to ratings for Users and Venues. Only published reviews are included in the calculation. But it is not checked if the Event is published. It is NOT checked whether Events or Users have current Subscriptions or whether Events/Users/Venues have been deactivated.
getByType
Retrieves a list of Categories, for a given Category Type.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| CategoryTypeCode | Text | 20 | Mandatory | - |
| EventID | ID | - | - | - |
| UserID | ID | - | - | - |
| VenueID | ID | - | - | - |
| ReviewID | ID | - | - | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| CategoryID | ID | - | Mandatory | - |
| Name | Text | 50 | Mandatory | - |
| URI | Text | 500 | - |
Response - Ordering
Category.Sequence
Response - Not Successful
Human-readable error message
Guidance
- Exactly one (or none) of the following must be present: Event ID, User ID, Venue ID or Review ID. Only active Category records are returned.
getByTypeForEvents
Retrieves a list of Categories that have been applied to Events that have been held at a Venue or organised by a Host User.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| CategoryTypeCode | Text | 20 | Mandatory | - |
| HostUserID | ID | - | - | - |
| VenueID | ID | - | - | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| CategoryID | ID | - | Mandatory | - |
| Name | Text | 50 | Mandatory | - |
| URI | Text | 500 | - |
Response - Ordering
Category.Sequence
Response - Not Successful
Human-readable error message
Guidance
- Exactly one of the following must be present: HostUserID or VenueID. Only active Category records are returned. Results are not included for Events that have been deleted.
save
Manages categorisations fo an Event, User, Venue or Review.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EventID | ID | - | - | - |
| UserID | ID | - | - | - |
| VenueID | ID | - | - | - |
| ReviewID | ID | - | - | - |
| CategoryCollection | ID & Operation | - | Mandatory | INSERT | DELETE |
| CreatorID | ID | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| "Success" | Text | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- Exactly one of the following must be present: EventID, VenueID, UserID. This is the entity being categorised. CategoryCollection is a list of insert/delete actions to perform on the paired CategoryID.
getByType
Retrieves a list of Categories for a given Category Type together with how an entity is categorised by them.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| CategoryTypeCode | Text | 20 | Mandatory | - |
| EventID | ID | - | - | - |
| UserID | ID | - | - | - |
| VenueID | ID | - | - | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| CategoryID | ID | - | Mandatory | - |
| Name | Text | 50 | Mandatory | - |
| URI | Text | 500 | - | |
| Selected | Bit | - | Mandatory | - |
Response - Ordering
Sequence
Response - Not Successful
Human-readable error message
Guidance
- The Selected response parameter indicates which Categories have been associated with the given entity. Exactly one of the following must be present: EventID, UserID or VenueID.
save
Create a new Media item or updates an existing Media item.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| MediaID | ID | - | - | - |
| EventID | ID | - | - | - |
| UserID | ID | - | - | - |
| VenueID | ID | - | - | - |
| ReviewID | ID | - | - | - |
| Name | Text | 20 | Mandatory | - |
| URI | Text | 500 | Mandatory | - |
| Sequence | Integer | - | Mandatory | - |
| MediaTypeCode | Text | 20 | Mandatory | - |
| CreatorID | ID | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| MediaID | ID | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- Exactly one of the following must be present: EventID, UserID, VenueID or ReviewID.
remove
Deletes a Media item.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| MediaID | ID | - | - | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| "Success" | Text | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- Both the record and the file are permanently deleted.
getByType
Retrieves a list of Media items, for a given Media Type.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| MediaTypeCode | Text | 20 | Mandatory | - |
| EventID | ID | - | - | - |
| UserID | ID | - | - | - |
| VenueID | ID | - | - | - |
| ReviewID | ID | - | - | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| MediaID | ID | - | Mandatory | - |
| Name | Text | 50 | Mandatory | - |
| URI | Text | 500 | - |
Response - Ordering
Sequence
Response - Not Successful
Human-readable error message
Guidance
- Exactly one (or none) of the following must be present: EventID, UserID, VenueID or ReviewID.
getByTypeForEvents
Retrieves a list of Media items, for a given Media Type that have been linked to Events that have been held at a Venue or organised by a Host User.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| MediaTypeCode | Text | 20 | Mandatory | - |
| HostUserID | ID | - | - | - |
| VenueID | ID | - | - | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| MediaID | ID | - | Mandatory | - |
| Name | Text | 50 | Mandatory | - |
| URI | Text | 500 | - |
Response - Ordering
Sequence
Response - Not Successful
Human-readable error message
Guidance
- Exactly one of the following must be present: HostUserID or VenueID. Results are not included for Events that have been deleted.
getByTypeForReviews
Retrieves a list of Media items, for a given Media Type that have been linked to Reviews of an Event, User or Venue.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| MediaTypeCode | Text | 20 | Mandatory | - |
| HostUserID | ID | - | - | - |
| EventID | ID | - | - | - |
| VenueID | ID | - | - | - |
| UserID | ID | - | - | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| MediaID | ID | - | Mandatory | - |
| Name | Text | 50 | Mandatory | - |
| URI | Text | 500 | - |
Response - Ordering
Sequence
Response - Not Successful
Human-readable error message
Guidance
- Exactly one of the following must be present: EventID, UserID or VenueID.
save
Create a new Link or updates an existing Link.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| LinkID | ID | - | - | - |
| EventID | ID | - | - | - |
| UserID | ID | - | - | - |
| VenueID | ID | - | - | - |
| ReviewID | ID | - | - | - |
| Name | Text | 20 | Mandatory | - |
| URI | Text | 500 | Mandatory | - |
| Sequence | Integer | - | Mandatory | - |
| LinkTypeCode | Text | 20 | Mandatory | - |
| CreatorID | ID | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| LinkID | ID | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Guidance
- Exactly one of the following must be present: Event ID, User ID, Venue ID or Review ID.
remove
Deletes a Link.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| LinkID | ID | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| "Success" | Text | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
getByType
Retrieves a list of Links, for a given LinkType.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| LinkTypeCode | Text | 20 | Mandatory | - |
| EventID | ID | - | - | - |
| UserID | ID | - | - | - |
| VenueID | ID | - | - | - |
| ReviewID | ID | - | - | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| LinkID | ID | - | Mandatory | - |
| Name | Text | 50 | Mandatory | - |
| URI | Text | 500 | - |
Response - Ordering
Sequence
Response - Not Successful
Human-readable error message
Guidance
- Exactly one (or none) of the following must be present: EventID, UserID, VenueID or ReviewID.
getByType
Retrieves a list of Email Templates, for a given EmailTemplateType.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| TypeCode | Text | 30 | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| EmailTemplateID | ID | - | Mandatory | - |
| EmailTemplateTypeID | ID | - | Mandatory | - |
| Subject | Text | 100 | Mandatory | - |
| Content | Text | 2000 | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
save
Log an email as being sent.
Input Parameters
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| To | Text | 10 | Mandatory | - |
| Subject | Text | 50 | Mandatory | - |
| Result | Text | 500 | Mandatory | - |
| EmailTemplateID | Integer | - | Mandatory | - |
| CreatorID | ID | - | Mandatory | - |
| ClientID | ID | - | Mandatory | - |
| SecretCode | Text | 20 | Mandatory | - |
Response - Successful
| Name | Data Type | Max Size | Is Mandatory | Enumeration |
|---|---|---|---|---|
| "Success" | Text | - | Mandatory | - |
Response - Ordering
n/a
Response - Not Successful
Human-readable error message
Other Services
We are also happy to build new CommunalEvents features for you, build your application itself, provide data services and provide support.