Rest api

[Roger]

Ive given this a look and can’t find anything. Are you going to include a rest api for this like wp-api? Then it could be used as a back end for a calendar app 🙂

[Stephen Harris]

Hi Roger,

Yes, this is planned for the 3.1.0 release (3.0.0 is due later this month).

[Andrew Shankie]

Hi Stephen,

I’m working on a project that will really want this! We’re building an app that’s going to interact with Event Organiser (starting in June), so we’re very keen for this!

In doing a bit of research on this, I came across Drupal’s Open Event extension, which appears to implement an API that complies with the schema.org Events model.

I was wondering if you were planning on having EO’s implementation compatible with the schema.org schema? If you are, it means that I can start developing some of the guts of my app now in advance of your Rest API implementation.

Cheers,

Andrew

[Stephen Harris]

Hi Andrew,

I’ve had chance to review that schema and its very unlikely to form the basis of Event Organiser’s API. this is for two reasons:

1) That Event schema is actually for instances of a recurring event, or at least there are no fields for indicating a recurrence schedule.
2) I’ll be building on WordPress’ API which already has a schema, and keeping it consistent will make compatibility with existing clients easier..

(Although there is no reason why the two schemas can’t be exposed via different routes).

Unfortunately, this is now likely to be pushed back to 3.2 as it would otherwise hold back the 3.1 release. Furthermore I had anticipated that the REST would be fully in core by then.

What I can do is bump this up in priority and publish the schema for you to work against.

[Neeraj Malve]

I am also very keen on using this API for the mobile app development. any idea which month Rest API is expected to be out?
Thanks

[Stephen Harris]

Hi Neeraj,

Apologies for the delay in getting back to you. There is unfortunately no ETA for this yet, but it’s likely that REST API support will be rolled out as a separate plug-in so it’s iteration is not restricted by Event Organiser’s release schedule.

So, tentatively, an alpha-release of the REST API support will be made available in June. It will not, however, be feature-complete. I’ve published this document which gives a brief summary of the endpoints that are complete: https://gist.github.com/stephenharris/0357cc7491fc15f7964d6eadf14fffe3

(It will also require the REST API plug-in until that plug-in is included in WordPress core)

[Neeraj Malve]

Hi Stephen,

Dont want to push on this much but very much waiting for this to come out! I am sure many like me are waiting for their Mobile App.. Any update on this will be helpful.

Thanks
Neeraj

[Stephen Harris]

Hi Neeraj,

My apologies, this is a bit behind schedule.

All “read” parts of the API have been completed. The “write” parts of the API for venues, tags and categories are effectively complete, and the “write” parts of the API for events and occurrences are currently being developed.

A first release is expected in the next few weeks, although if you’re only interested in the read aspects, then I can provide something for you now.

Stephen

[Neeraj Malve]

Thanks for your reply. “Read” api would be good to start with. Atleast the Mobile App development work will get going with this.

Thanks
Neeraj

[Stephen Harris]

Hi Neeraj,

The plug-ins is available here: https://github.com/stephenharris/event-organiser-rest-api

Listed in the readme are the available endpoints. Please note however, this is still in alpha, and so the schema is subjec to change.

[Neeraj Malve]

Stephen,

Cant Thank you enough for providing this plugin. It works well. Just a small glitch with the event-categories.

http://bmcadventures.com/wp-json/wp/v2/event-categories Does not work, I will also try to see whats wrong in the code.

Thanks
Neeraj

[Stephen Harris]

Hi Neeraj,

There’s a typo here: https://github.com/stephenharris/event-organiser-rest-api/blob/a6cfec8cb5e883d003e1951b80228ca9c9d4a143/event-organiser-rest-api.php#L52

The hook should be eventorganiser_register_taxonomy_event-category not eventorganiser_register_taxonomy_event-categories. I’ll update that shortly but you can just apply the change yourself in the mean time.

[Neeraj Malve]

Thank you for looking into it Stephen!

[Author]

Posts