RHP_API

<back to all web services

UpdateMyEvent

Update a user's event

Requires Authentication
The following routes are available for this service:
PATCH/User/Event/{EventID}
UserEventDetailForm Parameters:
NameParameterData TypeRequiredDescription
ClientTimeZoneformstringNo
UserEventDetail Parameters:
NameParameterData TypeRequiredDescription
EventIDformintNo
EventTitleformstringNo
GoogleMapPlaceIDformstringNo
LocationLabelformstringNo
GuestTypesformintNo
AgeRangeformAgeRangeNo
DescriptionformstringNo
ThemeformstringNo
DressCodeformstringNo
RulesformstringNo
CostformstringNo
TicketUrlformstringNo
IsTicketPrivateformboolNo
PhoneformstringNo
EmailformstringNo
WebsiteformstringNo
DateHeldformDateTimeNo
DateHeldUtcIsoformstringNo
DateHeldDisplayformstringNo
ApprovalStatusformApprovalStatusNo
TimeZoneInfoIDformstringNo
TimeZoneformTimeZoneLookupItemNo
BannerformEventBannerNo
VideoUrlformstringNo
VideoCodeformstringNo
VideoTypeformVideoTypeNo
VideoThumbUrlformstringNo
AgeRange Parameters:
NameParameterData TypeRequiredDescription
AgeFromformintNo
AgeToformintNo
TimeZoneLookupItem Parameters:
NameParameterData TypeRequiredDescription
IDformstringNo
WindowsNameformstringNo
StandardNameformstringNo
DaylightNameformstringNo
SupportsDaylightSavingTimeformboolNo
IsDaylightSavingTimeformboolNo
IanaNameformstringNo
AbbrGenericformstringNo
AbbrStandardformstringNo
AbbrDaylightformstringNo
BaseUtcOffsetformstringNo
DaylightOffsetformstringNo
EventBanner Parameters:
NameParameterData TypeRequiredDescription
FileNameformstringNo
BannerUrlformstringNo
UserEventDetail Parameters:
NameParameterData TypeRequiredDescription
EventIDformintNo
EventTitleformstringNo
GoogleMapPlaceIDformstringNo
LocationLabelformstringNo
GuestTypesformintNo
AgeRangeformAgeRangeNo
DescriptionformstringNo
ThemeformstringNo
DressCodeformstringNo
RulesformstringNo
CostformstringNo
TicketUrlformstringNo
IsTicketPrivateformboolNo
PhoneformstringNo
EmailformstringNo
WebsiteformstringNo
DateHeldformDateTimeNo
DateHeldUtcIsoformstringNo
DateHeldDisplayformstringNo
ApprovalStatusformApprovalStatusNo
TimeZoneInfoIDformstringNo
TimeZoneformTimeZoneLookupItemNo
BannerformEventBannerNo
VideoUrlformstringNo
VideoCodeformstringNo
VideoTypeformVideoTypeNo
VideoThumbUrlformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PATCH /User/Event/{EventID} HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ClientTimeZone: String,
	EventID: 0,
	EventTitle: String,
	GoogleMapPlaceID: String,
	LocationLabel: String,
	GuestTypes: 0,
	AgeRange: 
	{
		AgeFrom: 0,
		AgeTo: 0
	},
	Description: String,
	Theme: String,
	DressCode: String,
	Rules: String,
	Cost: String,
	TicketUrl: String,
	IsTicketPrivate: False,
	Phone: String,
	Email: String,
	Website: String,
	DateHeld: 0001-01-01,
	DateHeldUtcIso: String,
	DateHeldDisplay: String,
	ApprovalStatus: Approved,
	TimeZoneInfoID: String,
	TimeZone: 
	{
		ID: String,
		WindowsName: String,
		StandardName: String,
		DaylightName: String,
		SupportsDaylightSavingTime: False,
		IsDaylightSavingTime: False,
		IanaName: String,
		AbbrGeneric: String,
		AbbrStandard: String,
		AbbrDaylight: String,
		BaseUtcOffset: String,
		DaylightOffset: String
	},
	Banner: 
	{
		FileName: String,
		BannerUrl: String
	},
	VideoUrl: String,
	VideoCode: String,
	VideoType: NA,
	VideoThumbUrl: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	EventID: 0,
	EventTitle: String,
	GoogleMapPlaceID: String,
	LocationLabel: String,
	GuestTypes: 0,
	AgeRange: 
	{
		AgeFrom: 0,
		AgeTo: 0
	},
	Description: String,
	Theme: String,
	DressCode: String,
	Rules: String,
	Cost: String,
	TicketUrl: String,
	IsTicketPrivate: False,
	Phone: String,
	Email: String,
	Website: String,
	DateHeld: 0001-01-01,
	DateHeldUtcIso: String,
	DateHeldDisplay: String,
	ApprovalStatus: Approved,
	TimeZoneInfoID: String,
	TimeZone: 
	{
		ID: String,
		WindowsName: String,
		StandardName: String,
		DaylightName: String,
		SupportsDaylightSavingTime: False,
		IsDaylightSavingTime: False,
		IanaName: String,
		AbbrGeneric: String,
		AbbrStandard: String,
		AbbrDaylight: String,
		BaseUtcOffset: String,
		DaylightOffset: String
	},
	Banner: 
	{
		FileName: String,
		BannerUrl: String
	},
	VideoUrl: String,
	VideoCode: String,
	VideoType: NA,
	VideoThumbUrl: String
}