v1

latestSwagger 2.0raw.githubusercontent.com2017-02-22106462.8 KB

Publish an event

Since 1.0.0

post/publish/v2/events

Headers

TMPS-Correlation-Idstring required

Unique correlation id to be able to trace the request in our system

Request body

type'event' | 'venue' | 'attraction' required

Type of the entity

distancenumber double

unitsstring

namesobject

Names of the entity - multi-lingual fields

descriptionsobject

Descriptions of the entity - multi-lingual fields

additionalInfosobject

Additional informations of the entity - multi-lingual fields

urlstring

URL of a web site detail page of the entity

infosobject

Any information related to the event - multi-lingual fields

pleaseNotesobject

Any notes related to the event - multi-lingual fields

relationshipsRelationship[]

Relationships on the entity, like if the entity is a duplicate of another one

referencesobject

References of this entity in an other system. Reference is the exact same entity

versioninteger

Version of the entity. Version is to avoid updated an entity with an older version

activeboolean

Indicate if the entity is active, inactive entity won't appear in Discovery API

testboolean

Indicate if this is a test entity, by default test entities won't appear in discovery API

discoverableboolean

True if the entity is dicoverable in discovery API

Example request

{
  "dates": {
    "start": {
      "localDate": "yyyy-MM-dd",
      "dateTime": "yyyy-MM-ddThh:mm:ssZ"
    },
    "end": {
      "dateTime": "yyyy-MM-ddThh-mm-ssZ"
    },
    "access": {
      "startDateTime": "yyyy-MM-ddThh-mm-ssZ",
      "endDateTime": "yyyy-MM-ddThh-mm-ssZ"
    }
  },
  "venue": {
    "social": {
      "twitter": {
        "handle": "@a Twitter handle exampe"
      }
    }
  }
}

Response

successful operation