1.2.2. The result data format

JSON schema

The event listing call should return an object of type eventListImport. this schema references the eventImport schema, which in turn references the eventDisciplineImport schema.

eventListImport schema

The result of the eventList call should be an array of eventImport objects.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://scoreexpress.io/schema/v1/eventListImport.schema.json",
  "title": "Event Import",
  "description": "default schema for importing events from third party systems, such as federations competition management",
  "type": "array",
  "items": {
    "$ref": "eventImport.schema.json"
  }
}

eventImport schema

For each event, following fields are used:

• id: ID of the event in the source system.
• title: title of the event.
• titleShort: Optional shorter version of the title, optional.
• dateFrom: first date of the event, format YYYY-MM-DD
• dateTo: last date of the event, format YYYY-MM-DD
• venue: place or venue name for the event.
• disciplines: array of eventDisciplineImport objects included in the event, see below for details.

Following fields can be provided with the import data, but should actually already be set automatically from the default values configured in the ScoreExpress user account:

• copyright: copyright line to include in documents.
• logo: base64 content of the logo file.
• country: 3 character code of the country of the event (e.g. ‘BEL’). See https://en.wikipedia.org/wiki/List_of_IOC_country_codes for the list of country codes.
• language: 2 character code of the language preference for the event, current options: ‘en’, ‘nl’, ‘fr’.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://scoreexpress.io/schema/v1/eventImport.schema.json",
  "title": "Event Import",
  "description": "default schema for importing events from third party systems, such as federations competition management",
  "type": "object",
  "properties": {
    "id": {
      "description": "ID of the event in the source system",
      "type": "string"
    },
    "title": {
      "description": "Title of the event",
      "type": "string"
    },
    "titleShort": {
      "description": "Shortened title of the event, optional",
      "type": "string"
    },
    "dateFrom": {
      "description": "first date of the event",
      "type": "string",
      "pattern": "\\d\\d\\d\\d-\\d\\d-\\d\\d",
      "format": "date"
    },
    "dateTo": {
      "description": "last date of the event",
      "type": "string",
      "pattern": "\\d\\d\\d\\d-\\d\\d-\\d\\d",
      "format": "date"
    },
    "venue": {
      "description": "name of the venue or city of the event",
      "type": "string"
    },
    "country": {
      "description": "IOC code of the country, optional, defaults to the organizer country",
      "type": "string",
      "minLength": 3,
      "maxLength": 3
    },
    "language": {
      "description": "two character code for the language, optional, defaults to organizer language",
      "type": "string",
      "minLength": 2,
      "maxLength": 2
    },
    "copyright": {
      "description": "event copyright line, optional, defaults to organizer copyright",
      "type": "string"
    },
    "logo": {
      "description": "base64 string with the logo image, svg, png or jpeg, optional",
      "type": "string"
    },
    "disciplines": {
      "description": "list of disciplines included in the event",
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "eventDisciplineImport.schema.json"
      }
    }
  },
  "required": ["id", "title", "dateFrom", "dateTo", "disciplines"]
}

eventDisciplineImport schema

This object type contains the general information of the event discipline included in an event.
Following fields apply:

• id: id of the eventDiscipline in the source system.
• title: title of the eventDiscipline.
• titleShort: optional shorter version of the title.
• code: code used to link the eventDiscipline the corresponding ScoreExpress discipline.
• copyright: optional copyright line, defaults to value set on the event level.
• logo; optional, base64 logo file contents.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://scoreexpress.io/schema/v1/eventDisciplineImport.schema.json",
  "title": "Event Discipline Import",
  "description": "default schema for importing event disciplines from third party systems, such as federations competition management",
  "type": "object",
  "properties": {
    "id": {
      "description": "ID of the event discipline in the source system",
      "type": "string"
    },
    "title": {
      "description": "Title of the event discipline",
      "type": "string"
    },
    "titleShort": {
      "description": "Shortened title of the event, optional",
      "type": "string"
    },
    "code": {
      "description": "ScoreExpress code for the discipline",
      "type": "string"
    },
    "copyright": {
      "description": "event discipline copyright line, optional, defaults to event copyright",
      "type": "string"
    },
    "logo": {
      "description": "base64 string with the logo image, svg, png or jpeg",
      "type": "string"
    }
  },
  "required": ["id", "title", "code"]
}

Example

[{
  "id": "123455767",
  "title": "National Championships Acrobatic & Rhythmic Gymnastics of Neverland",
  "titleShort": "NC Acrobatic & Rhythmic Gymnastics",
  "dateFrom": "2019-11-29",
  "dateTo": "2019-11-30",
  "venue": "Neverland Sports Centre",
  "country": "BEL",
  "language": "en",
  "copyright": "www.scoreexpress.be",
  "logo": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxzdmcgd2lkdGg9IjE0cHgiIGhlaWdodD0iMTRweCIgdmlld0JveD0iMCAwIDE0IDE0IiB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiPg0KICAgIDwhLS0gR2VuZXJhdG9yOiBTa2V0Y2ggNTIuNSAoNjc0NjkpIC0gaHR0cDovL3d3dy5ib2hlbWlhbmNvZGluZy5jb20vc2tldGNoIC0tPg0KICAgIDx0aXRsZT5hZGQtaWNvbjwvdGl0bGU+DQogICAgPGRlc2M+Q3JlYXRlZCB3aXRoIFNrZXRjaC48L2Rlc2M+DQogICAgPGcgaWQ9IlN5bWJvbHMiIHN0cm9rZT0ibm9uZSIgc3Ryb2tlLXdpZHRoPSIxIiBmaWxsPSJub25lIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPg0KICAgICAgICA8cG9seWdvbiBpZD0iYWRkLWljb24iIGZpbGw9IiMwNTE5MzEiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDcuMDAwMDAwLCA3LjAwMDAwMCkgcm90YXRlKC0yMjUuMDAwMDAwKSB0cmFuc2xhdGUoLTcuMDAwMDAwLCAtNy4wMDAwMDApICIgcG9pbnRzPSIxIDEwLjQyNTEwMTIgNC40MjUxMDEyMSA3IDEgMy41NzQ4OTg3OSAzLjU3NDg5ODc5IDEgNyA0LjQyNTEwMTIxIDEwLjQyNTEwMTIgMSAxMyAzLjU3NDg5ODc5IDkuNTc0ODk4NzkgNyAxMyAxMC40MjUxMDEyIDEwLjQyNTEwMTIgMTMgNyA5LjU3NDg5ODc5IDMuNTc0ODk4NzkgMTMiPjwvcG9seWdvbj4NCiAgICA8L2c+DQo8L3N2Zz4=",
  "disciplines": [{
    "id": "36998456",
    "title": "National Championships Acrobatic Gymnastics of Neverland",
    "titleShort": "NC Acrobatic Gymnastics",
    "code": "gym-acro"
  }, {
    "id": "36998457",
    "title": "National Championships Rhythmic Gymnastics of Neverland",
    "titleShort": "NC Rhythmic Gymnastics",
    "code": "gym-rg"
  }]
}]