Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

GET /event

Browse events

Example URI

...

Code Block
bash
bash

 http://example.com/restful_api/event?search[search]=christmas&when=this-month

...


...

Parameters

Parameter

Type

Require ?

Description

searchsearch

string

no

Keyword for searching

user_id

string

no

Browse by owner id

sort

string

no

Support sort return results, available options: latest, most-liked, most-talked

when

string

no

Browse events by start time, available options: all-time, this-month, this-week, today, upcoming, ongoing

limit

number

no

Limit return results

page

number

no

Paging return results

item_id

number

no

Support browse events on item (pages/groups)

module_id

string

no

Support search events on item (pages/groups)

category

number

no

Support search events by category id

view

string

no

Support some view mode: featured, pending, my, attending, may-attend, not-attending, invites

...

Post new event

Example URI

Code Block
bash
bash

 http://example.com/restful_api/event

...

Parameters

Parameter

Type

Require ?

Description

val[category]

id

no

Event category id

val[title]

string

yes

Event title

val[description]

string

no

Event description

val[start_hour]

number

yes

Start hour

val[start_minute]

number

yes

Start minute

val[start_month]

number

yes

Start month

val[start_year]

number

yes

Start year

val[start_day]

number

yes

Start day

val[end_hour]

number

yes

End hour

val[end_minute]

number

yes

End minute

val[end_day]

number

yes

End day

val[end_month]

number

yes

End month

val[end_year]

number

yes

End year

val[location]

string

yes

Event location

val[address]

string

no

Address

val[city]

string

no

City

val[postal_code]

string

no

Postal Code

val[country_iso]

string

no

Country ISO

val[country_child_id]

number

no

State id/ Province id

val[privacy]

number

yes

Event privacy

val[privacy_comment]

number

yes

Share provicy

val[module_id]

string

no

parent module id, support post event on item (groups, pages...)

val[item_id]

number

no

parent item id, support post event on item (groups, pages...)

...

Get information of a specific event

Example URI

Code Block
bash
bash

 http://example.com/restful_api/event/1

...

Parameters

Parameter

Type

Require ?

Description

id

number

yes

Event id

...

Update information for a specific event

Example URI

Code Block
bash
bash

 http://example.com/restful_api/event/1

...

Parameters

Parameter

Type

Require ?

Description

id

number

yes

Event id

val[category]

number

no

Event category id

val[title]

string

no

Event title

val[description]

string

no

Event description

val[start_hour]

number

no

Start hour

val[start_minute]

number

no

Start minute

val[start_month]

number

no

Start month

val[start_year]

number

no

Start year

val[start_day]

number

no

Start day

val[end_hour]

number

no

End hour

val[end_minute]

number

no

End minute

val[end_day]

number

no

End day

val[end_month]

number

no

End month

val[end_year]

number

no

End year

val[location]

string

bo

Event location

val[address]

string

no

Address

val[city]

string

no

City

val[postal_code]

string

no

Postal Code

val[country_iso]

string

no

Country ISO

val[country_child_id]

number

no

State id/ Province id

val[privacy]

number

no

Event privacy

val[privacy_comment]

number

no

Share provicy

val[invite][]

array

no

Friend id list to invite

val[personal_message]

number

no

Invite message

val[emails]

string

no

Email list to invite

val[delete_image]

boolean

no

Remove event photo

image

file

no

Upload event photo

...

Delete a specific event

Example URI

Code Block
bash
bash

 http://example.com/restful_api/event/1

...

Parameters

Parameter

Type

Require ?

Description

id

number

yes

Event id

...

Update RSVP on a specific event

Example URI

Code Block
bash
bash

 http://example.com/restful_api/event/1/rsvp

...

Parameters

Parameter

Type

Require ?

Description

id

number

yes

Event id

rsvp

number

yes

RSVP id, available values: 1(attending), 2(may be attending), 3(not attending)

...

Get guests list of a specific event

Example URI

Code Block
bash
bash

 http://example.com/restful_api/event/1/guests

...

Parameters

Parameter

Type

Require ?

Description

id

number

yes

Event id

rsvp

number

no

RSVP id (default is 1 - attending)

limit

number

no

Limit return results

page

number

no

Paging return results

...