IOP Events service – API Documentation

(v11)

We provide two public APIs:

  1. The Events API
  2. The Tickets API

The goal of these APIs is to enable developers to integrate IOP events into any other digital service.

The APIs provide flexible querying via ElasticSearch's URI Search using Query String Syntax.

To get events:

https://9uvl4xq5xh.execute-api.eu-west-2.amazonaws.com/live/events?<query-string-synax>

To get tickets:

https://z8jgac2kn7.execute-api.eu-west-2.amazonaws.com/live/tickets?<query-string-synax>

A walkthrough using the events API is included in the next section for your convenience.

Quickstart

An example query for events with tag "AstroparticlePhysicsGroup"

https://9uvl4xq5xh.execute-api.eu-west-2.amazonaws.com/live/events?q=tags:AstroparticlePhysicsGroup

Example JSON response

{
  "took": 2,
  "timed_out": false,
  "_shards": {
    "total": 5,
    "successful": 5,
    "failed": 0
  },
  "hits": {
    "total": 1,
    "max_score": null,
    "hits": [
      {
        "_index": "events",
        "_type": "event_type",
        "_id": "AVtDReqnN39CYnMTS-Wb",
        "_score": null,
        "_source": {
          "description": "<p>This is the annual joint meeting of the High Energy Particle Physics group and the Astro-Particle Physics group of the Institute of Physics.<br> <br> The meeting will take place at the University of Sheffield, in the new Diamond facility. It will start on Monday 10th April. Following the end of the conference on Wednesday 12th April, there will be an STFC town hall and then a public lecture.</p> <h4>Event type: Conference</h4> <h4>Organised by: IOP Astroparticle Physics and High Energy Particle Physics groups</h4> <h4>Contact details: Rachael Street<br> Tel: +44 (0)20 7470 4840<br> Email: rachael.street@iop.org<br> </h4> <p><a href=\"http://heppapp2017.iopconfs.org\" rel=\"nofollow\">http://heppapp2017.iopconfs.org</a></p>",
          "start-date": "2017-04-10T00:00:00Z",
          "title": "Joint APP and HEPP Annual Conference",
          "event-id": "118967593",
          "location": "The Diamond, University of Sheffield, 32 Leavygreave Road, Sheffield S3 7RD, UK",
          "location-short": "Sheffield",
          "end-date": "2017-04-13T00:00:00Z",
          "event-page-url": "http://lowcost-env.npk2ktfzix.eu-west-2.elasticbeanstalk.com/e/joint-app-and-hepp-annual-conference-118967593/page.html",
          "banner-image-url": "http://lowcost-env.npk2ktfzix.eu-west-2.elasticbeanstalk.com/img/ui_placeholder_header_1.png",
          "tags": [
            "AstroparticlePhysicsGroup",
            "HighEnergyParticlePhysicsGroup"
          ]
        },
        "sort": [
          1491782400000
        ]
      }
    ]
  }
}

The response includes ElasticSearch metadata plus any applicable event objects, in this case one event has been returned...

{
    "description": "<p>This is the annual joint meeting of the High Energy Particle Physics group and the Astro-Particle Physics group of the Institute of Physics.<br> <br> The meeting will take place at the University of Sheffield, in the new Diamond facility. It will start on Monday 10th AFollowing thend   of the conference on Wednesday 12th April, there will be an STFC town hall and then a public lecture.</p> <h4>Event type: Conference</h4> <h4>Organised by: IOP Astroparticle Physics and High Energy Particle Physics groups</h4> <h4>Contact details: Rachael Street<br>+44 (0)20 7470 4840<brEmail:   rachael.street@iop.org<br> </h4> <p><a href=\"http://heppapp2017.iopconfs.org\" rel=\"nofollow\">http://heppapp2017.iopconfs.org</a></p>",
    "start-date": "2017-04-10T00:00:00Z",
    "title": "Joint APP and HEPP Annual Conference",
    "event-id": "118967593",
    "location": "The Diamond, University of Sheffield, 32 Leavygreave Road, Sheffield S3 7RD, UK",
    "location-short": "Sheffield",
    "end-date": "2017-04-13T00:00:00Z",
    "event-page-url": "http://lowcost-env.npk2ktfzix.eu-west-2.elasticbeanstalk.com/e/joint-app-and-hepp-annual-conference-118967593/page.html",
    "banner-image-url": "http://lowcost-env.npk2ktfzix.eu-west-2.elasticbeanstalk.com/img/ui_placeholder_header_1.png",
    "tags": [
        "AstroparticlePhysicsGroup",
        "HighEnergyParticlePhysicsGroup"
    ]
}

All event content is provided by event organisers so treat this as user-generated content.

Each event object includes the following supported fields: * event-id: (string) unique identifier for this event. If this event was created in trumba then this is the Trumba ID, else it will be a UUID. This id number is also used to route to the event page e.g. http://lowcost-env.npk2ktfzix.eu-west-2.elasticbeanstalk.com/e/id-122832400/page.html * title: (string) the title of the event * start-date: (ISO 8601) event start datetime in ISO 8601 format * end-date: (ISO 8601) event end datetime in ISO 8601 format * tags: (list of strings) arbitrary user-generated tags used to segment events by IOP group or speaker etc. * event-page-url: (url) the authorative web page for this event * banner-image-url: (url) the banner image for this event as provided by the organiser

All other fields should be considered as likely to change, use them at your peril.

To query future events by IOP group

The following query gets events with tag "AppliedMechanicsGroup", starting after 2017-01-01, sorted in ascending order of date:

https://9uvl4xq5xh.execute-api.eu-west-2.amazonaws.com/live/events?q=start-date:[2017-01-01 TO *] AND tags:AppliedMechanicsGroup&sort=start-date:asc

Group tags are applied algorithmically to events organised by, sponsored by or co-sponsored by a given group. Soon we expect these tags to be added by the event organiser. See the code here in tag_events.py.

The tags used for each group are as follows:

Applied Mechanics Group: AppliedMechanicsGroup
Astroparticle Physics Group: AstroparticlePhysicsGroup
Atomic and Molecular Interactions Group: AtomicAndMolecularInteractionsGroup
Biological Physics Group: BioPhysicsGroup
BRSG: Magnetic Resonance Group: MagneticResonanceGroup
British Carbon Group: BritishCarbonGroup
Combustion Physics Group: CombustionPhysicsGroup
Computational Physics Group: ComputationalPhysicsGroup
Dielectrics and Electrostatics Group: DielectricsAndElectrostaticsGroup
Electron Microscopy and Analysis Group: ElectronMicroscopyAndAnalysisGroup
Energy Group: EnergyGroup
Environmental Physics Group: EnvironmentalPhysicsGroup
Gravitational Physics Group: GravitationalPhysicsGroup
High Energy Particle Physics Group: HighEnergyParticlePhysicsGroup
Higher Education Group: HigherEducationGroup
History of Physics Group: HistoryOfPhysicsGroup
Instrument Science and Technology Group: InstrumentScienceAndTechGroup
Ion and Plasma Surface Interactions Grou: IonAndPlasmaSurfaceInteractionsGroup
Liquids and Complex Fluids Group: LiquidsAndComplexFluidsGroup
Low Temperature Group: LowTempGroup
Magnetism Group: MagnetismGroup
Materials and Characterisation Group: MaterialsAndCharacterisationGroup
Mathematical and Theoretical Physics Group: MathematicalAndTheoreticalPhysicsGroup
Medical Physics Group: MedicalPhysicsGroup
Molecular Physics Group: MolecularPhysicsGroup
Nanoscale Physics and Technology Group: NanoPhysicsAndTechGroup
Neutron Scattering Group: NeutronScatteringGroup
Nonlinear and Complex Physics Group: NonlinearAndComplexPhysicsGroup
Nuclear Industry Group: NuclearIndustryGroup
Nuclear Physics Group: NuclearPhysicsGroup
Optical Group: OpticalGroup
Particle Accelerators and Beams Group: ParticleAcceleratorsAndBeamsGroup
Physical Acoustics Group: PhysicalAcousticsGroup
Physics Communicators Group: PhysicsCommunicatorsGroup
Plasma Physics Grou: PlasmaPhysicsGroup
Polymer Physics Group: PolymerPhysicsGroup
Printing and Graphics Science Group: PrintingAndGraphicsScienceGroup
Quantum Electronics and Photonics Group: QuantumElectronicsAndPhotonicsGroup
Quantum Optics, Quantum Information and Quantum Control Group: QuantumOpticsInformationAndControlGroup
Semiconductor Physics Group: SemiconductorPhysicsGroup
Shock Wave and Extreme Conditions Group: ShockWaveAndExtremeConditionsGroup
Structural Condensed Matter Physics Group: StructuralCondensedMatterPhysicsGroup
Superconductivity Group: SuperconductivityGroup
Theory of Condensed Matter Group: TheoryOfCondensedMatterGroup
Thin Films and Surfaces Group: ThinFilmsAndSurfacesGroup
Tribology Group: TribologyGroup
Vacuum Group: VacuumGroup
Women in Physics Group: WomenInPhysicsGroup