Resources

Main Resources

The API end points return resources. There is a different resource for each end point. For example the events end point returns an event resource and the location end point returns a location resource.

Dependent Resources

There are also dependent resources which do not have their own end point because they only make sense in the context of one of the main resources.

Fields

Each resource has several fields which are described for each resource. When using the end points you can specify which fields should be returned using the fields parameter in the format fields=resource_name:(field_name[,field_name,...])[,resource_name:(field_name[,field_name,...])]. For example

http://api.eventfinda.co.nz/v2/events.xml?rows=1&fields=event:(id,images),image:(transforms),transform:(url)

Will return only the id and images fields of the event resource. The images field contains a collection of image resources and we've specified to only return the transforms field which is a collection of transform resources and we've specified to only return the url field of that.

<?xml version="1.0"?>
<events count="6526">
 <event>
  <id>503921</id>
  <images count="2">
   <image>
    <transforms count="4">
     <transform>
      <url>http://cdn.eventfinda.co.nz/uploads ... ts/transformed/1120157-503921-2.jpg</url>
     </transform>
     <transform>
      <url>http://cdn.eventfinda.co.nz/uploads ... s/transformed/1120157-503921-15.jpg</url>
     </transform>
     <transform>
      <url>http://cdn.eventfinda.co.nz/uploads ... ts/transformed/1120157-503921-8.jpg</url>
     </transform>
     <transform>
      <url>http://cdn.eventfinda.co.nz/uploads ... ts/transformed/1120157-503921-7.jpg</url>
     </transform>
    </transforms>
   </image>
   <image>
    <transforms count="5">
     <transform>
      <url>http://cdn.eventfinda.co.nz/uploads ... ransformed/1120155-503921-2.jpg?v=2</url>
     </transform>
     <transform>
      <url>http://cdn.eventfinda.co.nz/uploads ... ansformed/1120155-503921-15.jpg?v=2</url>
     </transform>
     <transform>
      <url>http://cdn.eventfinda.co.nz/uploads ... ransformed/1120155-503921-8.jpg?v=2</url>
     </transform>
     <transform>
      <url>http://cdn.eventfinda.co.nz/uploads ... ansformed/1120155-503921-27.jpg?v=2</url>
     </transform>
     <transform>
      <url>http://cdn.eventfinda.co.nz/uploads ... ransformed/1120155-503921-7.jpg?v=2</url>
     </transform>
    </transforms>
   </image>
  </images>
 </event>
</events>

Access

Each resource description has a table of fields with a description and an access column. The Access column will contain either All or Full. Full means the information is only available with full access and All means the field is available to all API users. Some fields will have an asterisk (*) with more information about the access in the description.

Please contact us if you would like to discuss upgrading your account to full access.