Introduction

Welcome to EquiRatings API for Eventing. You can use this API to upload and manage all aspects of your eventing records. Through the Eventing API endpoints you can upload and get ERQI information.

Currently our API supports REST Https calls which you can consume using cURL or directly using whatever HTTP wrapper your language of choice supports.

Currently the API is in Beta, and it is subject to change. Don't worry we will inform our partners about any changes long before we deploy.

Authentication

The Eventing API uses JWT tokens for authentication. Please contact EquiRatings in order to get set-up on our system. Once you have been assigned a user for your provider account, you will be able to login to the API using the Sessions endpoint.

With each request you will need to supply an authorization header. The header should look like this:

Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9

Except your real token will be a lot longer.

You must replace eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9 with your own token.

Your token will be valid for two weeks from when you create a new session.

Sessions

Create a session

curl -XPOST
     -H "Content-type: application/json"
     -d '{"email": "user@domain.com", "password": "abcd1234"}'
         'https://eventing.api.equiratings.com/v1/sessions'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "token",
    "links": {
      "self": "/sessions"
    },
    "id": "",
    "attributes": {
      "refresh_token": "jsdlka;fjl;kfjaljfslkjfslkjflkjoiwejwi232434$#%##",
      "access_token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9"
    }
  }
}

Provided the user credentials are correct the endpoint will return a valid authorization token for the API.

HTTP Request

POST https://eventing.api.equiratings.com/v1/sessions

Query Parameters

This endpoint does not support query parameters.

Get a Session

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/sessions'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "user",
    "relationships": {
      "token": {
        "data": null
      }
    },
    "links": {
      "self": "/users/103"
    },
    "id": "103",
    "attributes": {
      "surname": "Surname",
      "role": "provider_admin",
      "id": 103,
      "first_name": "First",
      "email": "email@domain.com"
    }
  }
}

Gets the user information for the supplied authorization token.

HTTP Request

GET https://eventing.api.equiratings.com/v1/sessions

Query Parameters

This endpoint does not support query parameters.

Token

Create a token

curl -XPOST
     -H "Content-type: application/json"
     -d '{"refresh_token": "jsdlka;fjl;kfjaljfslkjfslkjflkjoiwejwi232434$#%##"}'
         'https://eventing.api.equiratings.com/v1/tokens'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "token",
    "links": {
      "self": "/v1/tokens"
    },
    "id": "",
    "attributes": {
      "refresh_token": "jsdlka;fjl;kfjaljfslkjfslkjflkjoiwejwi232434$#%##",
      "access_token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9"
    }
  }
}

Provided the refresh token has not expired. It will be used to generate a new access token.

HTTP Request

POST https://eventing.api.equiratings.com/v1/tokens

Query Parameters

This endpoint does not support query parameters.

Users

Get all Users

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/users'

{
  "links": {
    "self": "/v1/users?page[page]=1&page[page_size]=50"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "data": [
    {
      "type": "user",
      "relationships": {
        "token": {
          "data": null
        }
      },
      "links": {
        "self": "/users/90"
      },
      "id": "90",
      "attributes": {
        "surname": "Surname",
        "role": "provider_admin",
        "id": 90,
        "first_name": "First",
        "email": "email90@domain.com"
      }
    }
  ]
}

Returns all users for the current user's organization.

HTTP Request

GET https://eventing.api.equiratings.com/v1/users

Query Parameters

This endpoint supports query parameters for paging:

Parameter	Description
page[page]	Integer The number of the page to be returned.
page[page_size]	Integer The number of records per page. This is a read-only parameter and is locked at 50.

Predefined paging URLs are also returned within the json payload.

Get a Specific User

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/users/1'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "user",
    "relationships": {
      "token": {
        "data": null
      }
    },
    "links": {
      "self": "/users/96"
    },
    "id": "96",
    "attributes": {
      "surname": "Surname",
      "role": "provider_admin",
      "id": 96,
      "first_name": "First",
      "email": "email13@domain.com"
    }
  }
}

Returns a user for the supplied ID parameter.

HTTP Request

GET https://eventing.api.equiratings.com/v1/users/:id

URL Parameters

Parameter	Description
ID	Integer (required) The internal EquiRatings API ID of the user to retrieve

Query Parameters

This endpoint does not support query parameters.

Create a User

curl -XPOST
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     -d '{"user": {"first_name": "New", "surname": "User", "email": "new_user@domain.com", "password": "abcd1234", "role": "provider_user"}}'
     'https://eventing.api.equiratings.com/v1/users'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "user",
    "relationships": {
      "token": {
        "data": null
      }
    },
    "links": {
      "self": "/users/11"
    },
    "id": "11",
    "attributes": {
      "surname": "User",
      "role": "provider_user",
      "id": 11,
      "first_name": "New",
      "email": "new_user@domain.com"
    }
  }
}

Create a user for the supplied data.

HTTP Request

POST https://eventing.api.equiratings.com/v1/users/

Attributes

Parameter	Description
first_name	String (required) The first name of the user
surname	String (required) The surname of the user
email	String (required) The email of the user
password	String (required) The password of the user, must be at least 8 characters
roles	String (required) The user role, valid roles are as follows: ["provider_admin", "provider_user"]

Query Parameters

This endpoint does not support query parameters.

Update a User

curl -XPUT
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     -d '{"user": {"first_name": "Updated", "password": "abcd1234"}}'
     'https://eventing.api.equiratings.com/v1/users/11'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "user",
    "relationships": {
      "token": {
        "data": null
      }
    },
    "links": {
      "self": "/users/11"
    },
    "id": "11",
    "attributes": {
      "surname": "User",
      "role": "provider_user",
      "id": 11,
      "first_name": "Updated",
      "email": "new_user@domain.com"
    }
  }
}

Update a user for the supplied data.

HTTP Request

PUT https://eventing.api.equiratings.com/v1/users/:id

Attributes

Parameter	Description
first_name	String The first name of the user
surname	String The surname of the user
email	String The email of the user
password	String (required) The password of the user, must be at least 8 characters
roles	String The user role, valid roles are as follows: ["provider_admin", "provider_user"]

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the user to update

Query Parameters

This endpoint does not support query parameters.

Delete a User

curl -XDELETE
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/users/11'

Deletes a user with the supplied id.

HTTP Request

DELETE https://eventing.api.equiratings.com/v1/users/:id

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the user to delete

Query Parameters

This endpoint does not support query parameters.

Federations

Get all Federations

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/federations'

{
  "links": {
    "self": "/v1/federations?page[page]=1&page[page_size]=50",
    "next": "/v1/federations?page[page]=2&page[page_size]=50",
    "last": "/v1/federations?page[page]=3&page[page_size]=50"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "data": [
    {
      "type": "federation",
      "links": {
        "self": "/federations/188"
      },
      "id": "188",
      "attributes": {
        "name": "HORSE SPORT IRELAND",
        "id": 188,
        "code": "IRL"
      }
    },
    {
      "type": "federation",
      "links": {
        "self": "/federations/176"
      },
      "id": "176",
      "attributes": {
        "name": "BRITISH EQUESTRIAN FEDERATION",
        "id": 176,
        "code": "GBR"
      }
    }
  ]
}

Returns all federation for the current user's organization.

HTTP Request

GET https://eventing.api.equiratings.com/v1/federations

Query Parameters

This endpoint supports query parameters for paging:

Parameter	Description
page[page]	Integer The number of the page to be returned.
page[page_size]	Integer The number of records per page. This is a read-only parameter and is locked at 50.

Predefined paging URLs are also returned within the json payload.

Get a Specific Federation

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/federations/188'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "federation",
    "links": {
      "self": "/federations/188"
    },
    "id": "188",
    "attributes": {
      "name": "HORSE SPORT IRELAND",
      "id": 188,
      "code": "IRL"
    }
  }
}

Returns a federation for the supplied ID parameter.

HTTP Request

GET https://eventing.api.equiratings.com/v1/federations/:id

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the federation to retrieve

Query Parameters

This endpoint does not support query parameters.

Athletes

Get all Athletes

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/athletes'

{
  "links": {
    "self": "/v1/athletes?page[page]=1&page[page_size]=50"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "data": [
    {
      "type": "athlete",
      "links": {
        "self": "/v1/athletes/27996"
      },
      "id": "27996",
      "attributes": {
        "surname": "Taylor",
        "source_id": "002",
        "nationality": "GBR",
        "id": 27996,
        "gender": "female",
        "first_name": "Isabelle",
        "fei_id": 10004377,
        "federation_id": 176,
        "dob": "1983-06-11",
        "display_name": "Izzy Taylor"
      }
    },
    {
      "type": "athlete",
      "links": {
        "self": "/v1/athletes/27995"
      },
      "id": "27995",
      "attributes": {
        "surname": "Watson",
        "source_id": "001",
        "nationality": "IRL",
        "id": 27995,
        "gender": "male",
        "first_name": "Sam",
        "fei_id": 10007367,
        "federation_id": 188,
        "dob": "1982-01-14",
        "display_name": "Sam Watson"
      }
    }
  ]
}

Returns all athlete for the current user's organization.

HTTP Request

GET https://eventing.api.equiratings.com/v1/athletes

Query Parameters

This endpoint supports query parameters for paging and finding by a athletes by source_id:

Parameter	Description
page[page]	Integer The number of the page to be returned.
page[page_size]	Integer The number of records per page. This is a read-only parameter and is locked at 50.
source_id	The source_id of a specific athlete

Predefined paging URLs are also returned within the json payload.

Get a Specific Athlete

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/athletes/27995'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "athlete",
    "links": {
      "self": "/v1/athletes/27995"
    },
    "id": "27995",
    "attributes": {
      "surname": "Watson",
      "source_id": "001",
      "nationality": "IRL",
      "id": 27995,
      "gender": "male",
      "first_name": "Sam",
      "fei_id": 10007367,
      "federation_id": 188,
      "dob": "1982-01-14",
      "display_name": "Sam Watson"
    }
  }
}

Returns a athlete for the supplied ID parameter.

HTTP Request

GET https://eventing.api.equiratings.com/v1/athletes/:id

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the athlete to retrieve

Query Parameters

This endpoint does not support query parameters.

Create a Athlete

curl -XPOST
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     -d '{"athlete": {"surname": "Athlete", "nationality": "IRL", "gender": "non binary", "first_name": "New", "fei_id": 12345678, "dob": "1900-01-01", "source_id": "003", "display_name": "New Athlete", "federation_id": "188"}}'
     'https://eventing.api.equiratings.com/v1/athletes'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "athlete",
    "links": {
      "self": "/v1/athletes/27997"
    },
    "id": "27997",
    "attributes": {
      "surname": "Athlete",
      "source_id": "003",
      "nationality": "IRL",
      "id": 27997,
      "gender": "non binary",
      "first_name": "New",
      "fei_id": 12345678,
      "federation_id": 188,
      "dob": "1900-01-01",
      "display_name": "New Athlete"
    }
  }
}

Create a athlete for the supplied data.

HTTP Request

POST https://eventing.api.equiratings.com/v1/athletes/

Attributes

Parameter	Description
first_name	String (required) The first name of the athlete
surname	String (required) The surname of the athlete
gender	String (required) The gender of the athlete
nationality	String (required) The nationality of the athlete (ISO country code)
dob	Date The date of birth of the athlete (YYYY-MM-DD)
display_name	String The name that is displayed for the athlete if it is different to their name
fei_id	Integer The fei_id of the athlete
federation_id	Integer The internal EquiRatings API ID of the federation the athlete belongs to
source_id	String (required) The ID that the Provider uses locally on their own system

Query Parameters

This endpoint does not support query parameters.

Update an Athlete

curl -XPUT
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     -d '{"athlete": {"display_name": "Updated Athlete"}'
     'https://eventing.api.equiratings.com/v1/athletes/27997'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "athlete",
    "links": {
      "self": "/v1/athletes/27997"
    },
    "id": "27997",
    "attributes": {
      "surname": "Athlete",
      "source_id": "003",
      "nationality": "IRL",
      "id": 27997,
      "gender": "non binary",
      "first_name": "New",
      "fei_id": 12345678,
      "federation_id": 188,
      "dob": "1900-01-01",
      "display_name": "Updated Athlete"
    }
  }
}

Update a athlete for the supplied data.

HTTP Request

PUT https://eventing.api.equiratings.com/v1/athletes/:id

Attributes

Parameter	Description
first_name	String The first name of the athlete
surname	String The surname of the athlete
gender	String The gender of the athlete
nationality	String The nationality of the athlete (ISO country code)
dob	Date The date of birth of the athlete (YYYY-MM-DD)
display_name	String The name that is displayed for the athlete if it is different to their name
fei_id	Integer The fei_id of the athlete
federation_id	Integer The internal EquiRatings API ID of the federation the athlete belongs to
source_id	String The ID that the Provider uses locally on their own system

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the athlete to retrieve

Query Parameters

This endpoint does not support query parameters.

Delete a Athlete

curl -XDELETE
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/athletes/27997'

Deletes a athlete with the supplied id.

HTTP Request

DELETE https://eventing.api.equiratings.com/v1/athletes/:id

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the athlete to retrieve

Query Parameters

This endpoint does not support query parameters.

Horses

Get all Horses

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/horses'

{
  "links": {
    "self": "/v1/horses?page[page]=1&page[page_size]=50"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "data": [
    {
      "type": "horse",
      "links": {
        "self": "/v1/horses/54738"
      },
      "id": "54738",
      "attributes": {
        "ueln": null,
        "source_id": "001",
        "risk_data": [],
        "name": "Horseware Bushman",
        "id": 54738,
        "gender": "Gelding",
        "fei_id": "IRL03630",
        "dob": "1999-05-24",
        "display_name": "Horseware Bushman"
      }
    },
    {
      "type": "horse",
      "links": {
        "self": "/v1/horses/54739"
      },
      "id": "54739",
      "attributes": {
        "ueln": null,
        "source_id": "002",
        "risk_data": [],
        "name": "Mr Bass",
        "id": 54739,
        "gender": "Gelding",
        "fei_id": "104KA86",
        "dob": "2008-06-19",
        "display_name": "Mr Bass"
      }
    }
  ]
}

Returns all horse for the current user's organization.

HTTP Request

GET https://eventing.api.equiratings.com/v1/horses

Query Parameters

This endpoint supports query parameters for paging and finding by a horse by source_id:

Parameter	Description
page[page]	Integer The number of the page to be returned.
page[page_size]	Integer The number of records per page. This is a read-only parameter and is locked at 50.
source_id	The source_id of a specific horse

Predefined paging URLs are also returned within the json payload.

Get a Specific Horse

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/horses/54738'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "horse",
    "links": {
      "self": "/v1/horses/54738"
    },
    "id": "54738",
    "attributes": {
      "ueln": null,
      "source_id": "001",
      "risk_data": [],
      "name": "Horseware Bushman",
      "id": 54738,
      "gender": "Gelding",
      "fei_id": "IRL03630",
      "dob": "1999-05-24",
      "display_name": "Horseware Bushman"
    }
  }
}

Returns a horse for the supplied ID parameter.

HTTP Request

GET https://eventing.api.equiratings.com/v1/horses/:id

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the horse to retrieve

Query Parameters

This endpoint does not support query parameters.

Create a Horse

curl -XPOST
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     -d '{"horse": {"name": "New Horse", "gender": "Gelding", "fei_id": "", "dob": "1900-01-01", "ueln": "", "source_id": "003", "display_name": "New Horse"}}'
     'https://eventing.api.equiratings.com/v1/horses'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "horse",
    "links": {
      "self": "/v1/horses/54740"
    },
    "id": "54740",
    "attributes": {
      "ueln": null,
      "source_id": "003",
      "risk_data": [],
      "name": "New Horse",
      "id": 54740,
      "gender": "Gelding",
      "fei_id": null,
      "dob": "1900-01-01",
      "display_name": "New Horse"
    }
  }
}

Create a horse for the supplied data.

HTTP Request

POST https://eventing.api.equiratings.com/v1/horses/

Attributes

Parameter	Description
name	String (required) The name of the horse
gender	String (required) The gender of the horse
dob	Date (required) The date of birth of the horse (YYYY-MM-DD)
fei_id	String The fei id for the horse
ueln	String The unique equine life number of the horse
display_name	String The display name of the horse if different from the name
source_id	String (required) The ID that the Provider uses locally on their own system

Query Parameters

This endpoint does not support query parameters.

Update a Horse

curl -XPUT
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     -d '{"horse": {"display_name": "Updated Horse"}}'
     'https://eventing.api.equiratings.com/v1/horses/54740'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "horse",
    "links": {
      "self": "/v1/horses/54740"
    },
    "id": "54740",
    "attributes": {
      "ueln": null,
      "source_id": "003",
      "risk_data": [],
      "name": "New Horse",
      "id": 54740,
      "gender": "Gelding",
      "fei_id": null,
      "dob": "1900-01-01",
      "display_name": "Updated Horse"
    }
  }
}

Update a horse for the supplied data.

HTTP Request

PUT https://eventing.api.equiratings.com/v1/horses/:id

Attributes

Parameter	Description
name	String The name of the horse
gender	String The gender of the horse
dob	Date The date of birth of the horse (YYYY-MM-DD)
fei_id	String The fei id for the horse
ueln	String The unique equine life number of the horse
display_name	String The display name of the horse if different from the name
source_id	String The ID that the Provider uses locally on their own system

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the horse to retrieve

Query Parameters

This endpoint does not support query parameters.

Delete a Horse

curl -XDELETE
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/horses/54740'

Deletes a horse with the supplied id.

HTTP Request

DELETE https://eventing.api.equiratings.com/v1/horses/:id

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the horse to retrieve

Query Parameters

This endpoint does not support query parameters.

Risk data

Returned values

When risk data is returned you will find an ERQI for each of the 13 er_levels, these each link to a competition level. Below is a list of what level each number represents:

ER Level	Competition Level
1	Competitions where the XC Course max fixed height is 80cm or 90cm
2	Competitions where the XC Course max fixed height is 95cm or 100cm
3	Competitions where the XC Course max fixed height is 105cm including CCI1* Unified
4	National competitions where the XC course max fixed height is 110cm
5	CCI2-S, CIC1 and FEI Introductory level
6	CCI2-L and CCI1
7	National competitions where the XC Course max fixed height is 115cm
8	CCI3-S and CIC2
9	CCI3-L and CCI2
10	National competitions where the XC Course max fixed height is 120cm
11	CCI4-S and CIC3
12	CCI4-L and CCI3
13	CCI5-L and CCI4

Class Categories

Get all Class Categories

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/class_categories'

{
  "links": {
    "self": "/v1/class_categories?page[page]=1&page[page_size]=50"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "data": [
    {
      "type": "CCI",
      "links": {
        "self": "/v1/class_categories/146"
      },
      "id": "146",
      "attributes": {
        "type": "CCI",
        "name": "CCI1*",
        "level": "1",
        "id": 146,
        "er_level": 6
      }
    },
    {
      "type": "CCI",
      "links": {
        "self": "/v1/class_categories/147"
      },
      "id": "147",
      "attributes": {
        "type": "CCI",
        "name": "CCI2*",
        "level": "2",
        "id": 147,
        "er_level": 9
      }
    }
  ]
}

Returns all class_category records for the current user's organization.

HTTP Request

GET https://eventing.api.equiratings.com/v1/class_categories

Query Parameters

This endpoint supports query parameters for paging:

Parameter	Description
page[page]	Integer The number of the page to be returned.
page[page_size]	Integer The number of records per page. This is a read-only parameter and is locked at 50.

Predefined paging URLs are also returned within the json payload.

Get a Specific ClassCategory

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/class_categories/146'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "CCI",
    "links": {
      "self": "/v1/class_categories/146"
    },
    "id": "146",
    "attributes": {
      "type": "CCI",
      "name": "CCI1*",
      "level": "1",
      "id": 146,
      "er_level": 6
    }
  }
}

Returns a class_category for the supplied ID parameter.

HTTP Request

GET https://eventing.api.equiratings.com/v1/class_categories/:id

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the class_category to retrieve

Query Parameters

This endpoint does not support query parameters.

Create a ClassCategory

curl -XPOST
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     -d '{"class_category": {"type": "CCI-L", "name": "CCI3*-L", "level": "3"}}'
     'https://eventing.api.equiratings.com/v1/class_categories'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "CCI-L",
    "links": {
      "self": "/v1/class_categories/148"
    },
    "id": "148",
    "attributes": {
      "type": "CCI-L",
      "name": "CCI3*-L",
      "level": "3",
      "id": 148,
      "er_level": 9
    }
  }
}

Create a class_category for the supplied data.

HTTP Request

POST https://eventing.api.equiratings.com/v1/class_categories/

Attributes

Parameter	Description
type	String (required) The type of the class category (Allowed Class Types)
name	String (required) The full name of the class category
level	String (required) The level of the class category (Allowed Class Levels)

Allowed Types and Levels

Allowed Class Types

CCN - National 3-day
CNC - National 1-day
CCI - International 3-day
CIC - International 1-day
CCI-L - International 3-day
CCI-S - International 1-day
CCI-U - Used for CCI1* Unified from 2019 onwards

Allowed Class Levels

This is the level of the competition, expressed as either height of jumps or FEI level.

5
4
3
2
1
0
Introductory
105
100
95
90
80

Examples

Class	name	type	level
CCI5*-L	CCI5*-L	CCI-L	5
CCI4*-S	CCI4*-S	CCI-S	4
CCI1* Unified	CCI1*-U	CCI-U	1
CCI4*	CCI4	CCI	4
CIC3*	CIC3	CIC	3
CCI Introductory	CCI Introductory	CCI	Introductory
Advanced	Advanced	CNC	3
Preliminary	Preliminary	CNC	1
CNC1	CNC1	CNC	1
EvA95	EvA95	CNC	95

Query Parameters

This endpoint does not support query parameters.

Update a ClassCategory

curl -XPUT
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     -d '{"class_category": {"name": "Updated CCI3*"}}'
     'https://eventing.api.equiratings.com/v1/class_categories/148'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "CCI",
    "links": {
      "self": "/v1/class_categories/148"
    },
    "id": "148",
    "attributes": {
      "type": "CCI",
      "name": "Updated CCI3*",
      "level": "3",
      "id": 148,
      "er_level": 12
    }
  }
}

Update a class_category for the supplied data.

HTTP Request

PUT https://eventing.api.equiratings.com/v1/class_categories/:id

Attributes

Parameter	Description
type	String The type of the class category
name	String The full name of the class category
level	String The level of the class category

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the class_category to retrieve

Query Parameters

This endpoint does not support query parameters.

Delete a ClassCategory

curl -XDELETE
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/class_categories/146'

Deletes a class_category with the supplied id.

HTTP Request

DELETE https://eventing.api.equiratings.com/v1/class_categories/:id

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the class_category to retrieve

Query Parameters

This endpoint does not support query parameters.

Venues

Get all Venues

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/venues'

{
  "links": {
    "self": "/v1/venues?page[page]=1&page[page_size]=50"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "data": [
    {
      "type": "venue",
      "links": {
        "self": "/v1/venues/1"
      },
      "id": "1",
      "attributes": {
        "source_id": "001",
        "name": "First Venue",
        "id": 1,
        "federation_id": 176
      }
    },
    {
      "type": "venue",
      "links": {
        "self": "/v1/venues/2"
      },
      "id": "2",
      "attributes": {
        "source_id": "002",
        "name": "Second Venue",
        "id": 2,
        "federation_id": 176
      }
    }
  ]
}

Returns all venues for the current user's organization.

HTTP Request

GET https://eventing.api.equiratings.com/v1/venues

Query Parameters

This endpoint supports query parameters for paging and finding by a venue by source_id:

Parameter	Description
page[page]	Integer The number of the page to be returned.
page[page_size]	Integer The number of records per page. This is a read-only parameter and is locked at 50.
source_id	The source_id of a specific venue

Predefined paging URLs are also returned within the json payload.

Get a Specific Venue

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/venues/1'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "venue",
    "links": {
      "self": "/v1/venues/1"
    },
    "id": "1",
    "attributes": {
      "source_id": "001",
      "name": "First Venue",
      "id": 1,
      "federation_id": 176
    }
  }
}

Returns a venue for the supplied ID parameter.

HTTP Request

GET https://eventing.api.equiratings.com/v1/venues/:id

URL Parameters

Parameter	Description
ID	The internal Eventing API ID of the venue to retrieve

Query Parameters

This endpoint does not support query parameters.

Create a Venue

curl -XPOST
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     -d '{"venue": {"name": "New Venue", "federation_id": "176", "source_id": "007"}}'
     'https://eventing.api.equiratings.com/v1/venues'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "venue",
    "links": {
      "self": "/v1/venues/7"
    },
    "id": "7",
    "attributes": {
      "source_id": "007",
      "name": "New Venue",
      "id": 7,
      "federation_id": 176
    }
  }
}

Create a venue for the supplied data.

HTTP Request

POST https://eventing.api.equiratings.com/v1/venues/

Attributes

Parameter	Description
name	String (required) The name of the Venue
federation_id	String (required) The internal EquiRatings API ID of the Federation where the venue is located
source_id	String (required) The ID that the Provider uses locally on their own system

Query Parameters

This endpoint does not support query parameters.

Update a Venue

curl -XPUT
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     -d '{"venue": {"name": "Updated Venue"}}'
     'https://eventing.api.equiratings.com/v1/venues/7'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "venue",
    "links": {
      "self": "/v1/venues/7"
    },
    "id": "7",
    "attributes": {
      "source_id": "007",
      "name": "Updated Venue",
      "id": 7,
      "federation_id": 176
    }
  }
}

Update a venue for the supplied data.

HTTP Request

PUT https://eventing.api.equiratings.com/v1/venues/:id

Attributes

Parameter	Description
name	String The name of the venue
federation_id	Integer The internal EquiRatings API ID of the Federation where the venue is located
source_id	String The ID that the Provider uses locally on their own system

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the venue to retrieve

Query Parameters

This endpoint does not support query parameters.

Delete a Venue

curl -XDELETE
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/venues/7'

Deletes a venue with the supplied id.

HTTP Request

DELETE https://eventing.api.equiratings.com/v1/venues/:id

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the venue to delete

Query Parameters

This endpoint does not support query parameters.

Shows

Get all Shows

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/shows'

{
  "links": {
    "self": "/v1/shows?page[page]=1&page[page_size]=50"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "data": [
    {
      "type": "show",
      "links": {
        "self": "/v1/shows/4975"
      },
      "id": "4975",
      "attributes": {
        "venue_id": 1,
        "start_date": "2018-03-12",
        "source_id": "show_001",
        "name": "First Show",
        "id": 4975,
        "end_date": "2018-03-15"
      }
    },
    {
      "type": "show",
      "links": {
        "self": "/v1/shows/4976"
      },
      "id": "4976",
      "attributes": {
        "venue_id": 1,
        "start_date": "2018-03-19",
        "source_id": "show_002",
        "name": "Second Show",
        "id": 4976,
        "end_date": "2018-03-22"
      }
    }
  ]
}

Returns all show for the current user's organization.

HTTP Request

GET https://eventing.api.equiratings.com/v1/shows

Query Parameters

This endpoint supports query parameters for paging and finding by a show by source_id:

Parameter	Description
page[page]	Integer The number of the page to be returned.
page[page_size]	Integer The number of records per page. This is a read-only parameter and is locked at 50.
source_id	The source_id of a specific show

Predefined paging URLs are also returned within the json payload.

Get a Specific Show

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/shows/4975'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "show",
    "links": {
      "self": "/v1/shows/4975"
    },
    "id": "4975",
    "attributes": {
      "venue_id": 1,
      "start_date": "2018-03-12",
      "source_id": "show_001",
      "name": "First Show",
      "id": 4975,
      "end_date": "2018-03-15"
    }
  }
}

Returns a show for the supplied ID parameter.

HTTP Request

GET https://eventing.api.equiratings.com/v1/shows/:id

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the show to retrieve

Query Parameters

This endpoint does not support query parameters.

Create a Show

curl -XPOST
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     -d '{"show": {"venue_id": 1, "start_date": "2018-03-26", "source_id": "show_003", "name": "New Show", "end_date": "2018-03-29"}}'
     'https://eventing.api.equiratings.com/v1/shows'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "show",
    "links": {
      "self": "/v1/shows/4977"
    },
    "id": "4977",
    "attributes": {
      "venue_id": 1,
      "start_date": "2018-03-26",
      "source_id": "show_003",
      "name": "New Show",
      "id": 4977,
      "end_date": "2018-03-29"
    }
  }
}

Create a show for the supplied data.

HTTP Request

POST https://eventing.api.equiratings.com/v1/shows/

Attributes

Parameter	Description
name	String (required) The name of the show
start_date	Date (required) The start_date of the show (YYYY-MM-DD)
end_date	Date (required) The end_date of the show (YYYY-MM-DD)
venue_id	Integer (required) The internal EquiRatings API ID for the venue of the show
source_id	String (required) The ID that the Provider uses locally on their own system

Query Parameters

This endpoint does not support query parameters.

Update a Show

curl -XPUT
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     -d '{"show": {"name": "Updated Show"}}'
     'https://eventing.api.equiratings.com/v1/shows/4977'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "show",
    "links": {
      "self": "/v1/shows/4977"
    },
    "id": "4977",
    "attributes": {
      "venue_id": 1,
      "start_date": "2018-03-26",
      "source_id": "show_003",
      "name": "Updated Show",
      "id": 4977,
      "end_date": "2018-03-29"
    }
  }
}

Update a show for the supplied data.

HTTP Request

PUT https://eventing.api.equiratings.com/v1/shows/:id

Attributes

Parameter	Description
name	String The name of the show
start_date	Date The start_date of the show (YYYY-MM-DD)
end_date	Date The end_date of the show (YYYY-MM-DD)
venue_id	Integer The internal EquiRatings API ID for the venue of the show
source_id	String The ID that the Provider uses locally on their own system

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the show to retrieve

Query Parameters

This endpoint does not support query parameters.

Delete a Show

curl -XDELETE
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/shows/4977'

Deletes a show with the supplied id.

HTTP Request

DELETE https://eventing.api.equiratings.com/v1/shows/:id

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the show to retrieve

Query Parameters

This endpoint does not support query parameters.

Competitions

Get all Competitions

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/competitions'

{
  "links": {
    "self": "/v1/competitions?page[page]=1&page[page_size]=50"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "included": [
    {
      "type": "result",
      "links": {
        "self": "/v1/results/335818"
      },
      "id": "335818",
      "attributes": {
        "xc_time": null,
        "xc_status": "EL",
        "xc_jump": 0,
        "xc_comment": null,
        "xc_code": "FH",
        "source_id": "001",
        "sj_time": null,
        "sj_status": "NS",
        "sj_jump": null,
        "sj_code": null,
        "second_hi_status": null,
        "id": 335818,
        "horse_id": 54739,
        "first_hi_status": "OK",
        "final_status": "EL",
        "final_score": null,
        "final_position": null,
        "final_comment": null,
        "final_code": "XC",
        "dr_status": "OK",
        "dr_score": "33.2",
        "dr_percentage": "66.8",
        "dr_comment": null,
        "dr_code": null,
        "disqualification_code": null,
        "competition_id": 10650,
        "athlete_id": 27996
      }
    },
    {
      "type": "result",
      "links": {
        "self": "/v1/results/335819"
      },
      "id": "335819",
      "attributes": {
        "xc_time": "0",
        "xc_status": "OK",
        "xc_jump": 0,
        "xc_comment": null,
        "xc_code": null,
        "source_id": "002",
        "sj_time": "0.0",
        "sj_status": "OK",
        "sj_jump": 0,
        "sj_code": null,
        "second_hi_status": null,
        "id": 335819,
        "horse_id": 54738,
        "first_hi_status": "OK",
        "final_status": "OK",
        "final_score": "30.2",
        "final_position": 1,
        "final_comment": null,
        "final_code": null,
        "dr_status": "OK",
        "dr_score": "30.2",
        "dr_percentage": "69.8",
        "dr_comment": null,
        "dr_code": null,
        "disqualification_code": null,
        "competition_id": 10650,
        "athlete_id": 27995
      }
    }
  ],
  "data": [
    {
      "type": "competition",
      "relationships": {
        "results": {
          "data": [
            {
              "type": "result",
              "id": "335819"
            },
            {
              "type": "result",
              "id": "335818"
            }
          ]
        }
      },
      "links": {
        "self": "/v1/competitions/10650"
      },
      "id": "10650",
      "attributes": {
        "source_id": "001",
        "sj_before_xc": false,
        "show_id": 4975,
        "second_hi_order": "Before_SJ",
        "name": "Competition 1",
        "id": 10650,
        "first_hi_order": "Before_DR",
        "display_name": "First Competition",
        "date": "2018-03-12",
        "class_category_id": 148,
        "championship": false
      }
    }
  ]
}

Returns all competition for the current user's organization.

HTTP Request

GET https://eventing.api.equiratings.com/v1/competitions

Query Parameters

This endpoint supports query parameters for paging and finding by a competition by source_id:

Parameter	Description
page[page]	Integer The number of the page to be returned.
page[page_size]	Integer The number of records per page. This is a read-only parameter and is locked at 50.
source_id	The source_id of a specific competition

Predefined paging URLs are also returned within the json payload.

Get a Specific Competition

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/competitions/10650'

{
  "jsonapi": {
    "version": "1.0"
  },
  "included": [
    {
      "type": "result",
      "links": {
        "self": "/v1/results/335818"
      },
      "id": "335818",
      "attributes": {
        "xc_time": null,
        "xc_status": "EL",
        "xc_jump": 0,
        "xc_comment": null,
        "xc_code": "FH",
        "source_id": "001",
        "sj_time": null,
        "sj_status": "NS",
        "sj_jump": null,
        "sj_code": null,
        "second_hi_status": null,
        "id": 335818,
        "horse_id": 54739,
        "first_hi_status": "OK",
        "final_status": "EL",
        "final_score": null,
        "final_position": null,
        "final_comment": null,
        "final_code": "XC",
        "dr_status": "OK",
        "dr_score": "33.2",
        "dr_percentage": "66.8",
        "dr_comment": null,
        "dr_code": null,
        "disqualification_code": null,
        "competition_id": 10650,
        "athlete_id": 27996
      }
    },
    {
      "type": "result",
      "links": {
        "self": "/v1/results/335819"
      },
      "id": "335819",
      "attributes": {
        "xc_time": "0",
        "xc_status": "OK",
        "xc_jump": 0,
        "xc_comment": null,
        "xc_code": null,
        "source_id": "002",
        "sj_time": "0.0",
        "sj_status": "OK",
        "sj_jump": 0,
        "sj_code": null,
        "second_hi_status": null,
        "id": 335819,
        "horse_id": 54738,
        "first_hi_status": "OK",
        "final_status": "OK",
        "final_score": "30.2",
        "final_position": 1,
        "final_comment": null,
        "final_code": null,
        "dr_status": "OK",
        "dr_score": "30.2",
        "dr_percentage": "69.8",
        "dr_comment": null,
        "dr_code": null,
        "disqualification_code": null,
        "competition_id": 10650,
        "athlete_id": 27995
      }
    }
  ],
  "data": {
    "type": "competition",
    "relationships": {
      "results": {
        "data": [
          {
            "type": "result",
            "id": "335819"
          },
          {
            "type": "result",
            "id": "335818"
          }
        ]
      }
    },
    "links": {
      "self": "/v1/competitions/10650"
    },
    "id": "10650",
    "attributes": {
      "source_id": "001",
      "sj_before_xc": false,
      "show_id": 4975,
      "second_hi_order": "Before_SJ",
      "name": "Competition 1",
      "id": 10650,
      "first_hi_order": "Before_DR",
      "display_name": "First Competition",
      "date": "2018-03-12",
      "class_category_id": 148,
      "championship": false
    }
  }
}

Returns a competition for the supplied ID parameter.

HTTP Request

GET https://eventing.api.equiratings.com/v1/competitions/:id

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the competition to retrieve

Query Parameters

This endpoint does not support query parameters.

Create a Competition

curl -XPOST
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     -d '{
         "competition": {
             "source_id": "002",
             "sj_before_xc": false,
             "show_id": 4975,
             "second_hi_order": "Before_SJ",
             "name": "Competition 2",
             "first_hi_order": "Before_DR",
             "display_name": "Second Competition",
             "date": "2018-03-13",
             "class_category_id": 147,
             "championship": false,
             "results": [
                 {
                     "xc_time": null,
                     "xc_status": "EL",
                     "xc_jump": 0,
                     "xc_comment": null,
                     "xc_code": "FH",
                     "source_id": "003",
                     "sj_time": null,
                     "sj_status": "NS",
                     "sj_jump": null,
                     "sj_code": null,
                     "second_hi_status": null,
                     "horse_id": 54739,
                     "first_hi_status": "OK",
                     "final_status": "EL",
                     "final_score": null,
                     "final_position": null,
                     "final_comment": null,
                     "final_code": "XC",
                     "dr_status": "OK",
                     "dr_score": 33.2,
                     "dr_percentage": 66.8,
                     "dr_comment": null,
                     "dr_code": "",
                     "disqualification_code": null,
                     "athlete_id": 27996
                },
                {
                     "xc_time": 0,
                     "xc_status": "OK",
                     "xc_jump": 0,
                     "xc_comment": null,
                     "xc_code": "",
                     "source_id": "004",
                     "sj_time": "0.0",
                     "sj_status": "OK",
                     "sj_jump": 0,
                     "sj_code": "",
                     "second_hi_status": null,
                     "horse_id": 54738,
                     "first_hi_status": "OK",
                     "final_status": "OK",
                     "final_score": 30.2,
                     "final_position": 1,
                     "final_comment": "",
                     "final_code": "",
                     "dr_status": "OK",
                     "dr_score": 30.2,
                     "dr_percentage": 69.8,
                     "dr_comment": "",
                     "dr_code": "",
                     "disqualification_code": "",
                     "athlete_id": 27995
                }
             ]
         }
     }'
     'https://eventing.api.equiratings.com/v1/competitions'

{
  "jsonapi": {
    "version": "1.0"
  },
  "included": [
    {
      "type": "result",
      "links": {
        "self": "/v1/results/335821"
      },
      "id": "335821",
      "attributes": {
        "xc_time": null,
        "xc_status": "EL",
        "xc_jump": 0,
        "xc_comment": null,
        "xc_code": "FH",
        "source_id": "003",
        "sj_time": null,
        "sj_status": "NS",
        "sj_jump": null,
        "sj_code": null,
        "second_hi_status": null,
        "id": 335821,
        "horse_id": 54739,
        "first_hi_status": "OK",
        "final_status": "EL",
        "final_score": null,
        "final_position": null,
        "final_comment": null,
        "final_code": "XC",
        "dr_status": "OK",
        "dr_score": "33.2",
        "dr_percentage": "66.8",
        "dr_comment": null,
        "dr_code": null,
        "disqualification_code": null,
        "competition_id": 10652,
        "athlete_id": 27996
      }
    },
    {
      "type": "result",
      "links": {
        "self": "/v1/results/335822"
      },
      "id": "335822",
      "attributes": {
        "xc_time": "0",
        "xc_status": "OK",
        "xc_jump": 0,
        "xc_comment": null,
        "xc_code": null,
        "source_id": "004",
        "sj_time": "0.0",
        "sj_status": "OK",
        "sj_jump": 0,
        "sj_code": null,
        "second_hi_status": null,
        "id": 335822,
        "horse_id": 54738,
        "first_hi_status": "OK",
        "final_status": "OK",
        "final_score": "30.2",
        "final_position": 1,
        "final_comment": null,
        "final_code": null,
        "dr_status": "OK",
        "dr_score": "30.2",
        "dr_percentage": "69.8",
        "dr_comment": null,
        "dr_code": null,
        "disqualification_code": null,
        "competition_id": 10652,
        "athlete_id": 27995
      }
    }
  ],
  "data": {
    "type": "competition",
    "relationships": {
      "results": {
        "data": [
          {
            "type": "result",
            "id": "335821"
          },
          {
            "type": "result",
            "id": "335822"
          }
        ]
      }
    },
    "links": {
      "self": "/v1/competitions/10652"
    },
    "id": "10652",
    "attributes": {
      "source_id": "002",
      "sj_before_xc": false,
      "show_id": 4975,
      "second_hi_order": "Before_SJ",
      "name": "Competition 2",
      "id": 10652,
      "first_hi_order": "Before_DR",
      "display_name": "Second Competition",
      "date": "2018-03-13",
      "class_category_id": 147,
      "championship": false
    }
  }
}

Create a competition for the supplied data.

HTTP Request

POST https://eventing.api.equiratings.com/v1/competitions/

Attributes

Parameter	Description
name	String (required) The name of the competition
date	Date (required) The date that the competition started
sj_before_xc	Boolean (required) If SJ is before XC this will be true, otherwise false
first_hi_order	String If a 1st Horse Inspection takes place and if so before which phase the HI happens
second_hi_order	String If a 2nd Horse Inspection takes place and if so before which phase the HI happens
display_name	String The display name of the competition if different to the competition name
championship	Boolean Is the competition a championship competition
results	Results (required) These are the results for the competition
class_category_id	Integer (required) This is the internal EquiRatings API ID for the class category of this competition
show_id	Integer (required) This is the internal EquiRatings API ID of the show that this competition is part of.
source_id	String (required) The ID that the Provider uses locally on their own system

Query Parameters

This endpoint does not support query parameters.

Update a Competition

curl -XPUT
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     -d '{"competition": {"display_name": "Updated Second Competition"}}'
     'https://eventing.api.equiratings.com/v1/competitions/10652'

{
  "jsonapi": {
    "version": "1.0"
  },
  "included": [
    {
      "type": "result",
      "links": {
        "self": "/v1/results/335821"
      },
      "id": "335821",
      "attributes": {
        "xc_time": null,
        "xc_status": "EL",
        "xc_jump": 0,
        "xc_comment": null,
        "xc_code": "FH",
        "source_id": "003",
        "sj_time": null,
        "sj_status": "NS",
        "sj_jump": null,
        "sj_code": null,
        "second_hi_status": null,
        "id": 335821,
        "horse_id": 54739,
        "first_hi_status": "OK",
        "final_status": "EL",
        "final_score": null,
        "final_position": null,
        "final_comment": null,
        "final_code": "XC",
        "dr_status": "OK",
        "dr_score": "33.2",
        "dr_percentage": "66.8",
        "dr_comment": null,
        "dr_code": null,
        "disqualification_code": null,
        "competition_id": 10652,
        "athlete_id": 27996
      }
    },
    {
      "type": "result",
      "links": {
        "self": "/v1/results/335822"
      },
      "id": "335822",
      "attributes": {
        "xc_time": "0",
        "xc_status": "OK",
        "xc_jump": 0,
        "xc_comment": null,
        "xc_code": null,
        "source_id": "004",
        "sj_time": "0.0",
        "sj_status": "OK",
        "sj_jump": 0,
        "sj_code": null,
        "second_hi_status": null,
        "id": 335822,
        "horse_id": 54738,
        "first_hi_status": "OK",
        "final_status": "OK",
        "final_score": "30.2",
        "final_position": 1,
        "final_comment": null,
        "final_code": null,
        "dr_status": "OK",
        "dr_score": "30.2",
        "dr_percentage": "69.8",
        "dr_comment": null,
        "dr_code": null,
        "disqualification_code": null,
        "competition_id": 10652,
        "athlete_id": 27995
      }
    }
  ],
  "data": {
    "type": "competition",
    "relationships": {
      "results": {
        "data": [
          {
            "type": "result",
            "id": "335822"
          },
          {
            "type": "result",
            "id": "335821"
          }
        ]
      }
    },
    "links": {
      "self": "/v1/competitions/10652"
    },
    "id": "10652",
    "attributes": {
      "source_id": "002",
      "sj_before_xc": false,
      "show_id": 4975,
      "second_hi_order": "Before_SJ",
      "name": "Competition 2",
      "id": 10652,
      "first_hi_order": "Before_DR",
      "display_name": "Updated Second Competition",
      "date": "2018-03-13",
      "class_category_id": 147,
      "championship": false
    }
  }
}

Update a competition for the supplied data.

Important documentation for embedded Results

Because Results are managed through the Competitions endpoint. They must always be included when updating a Competition. If they are not included, they will be deleted.

Updating Results

To update a Result, include all of a Competitions results including the updated Result embedded within the Competition. The system will then handle the updating of Results and re-generation of ERQI's.

Deleting Results

To delete a Result, simply omit it from the Competitions embedded Results and it will be deleted along with the relevant ERQI's.

HTTP Request

PUT https://eventing.api.equiratings.com/v1/competitions/:id

Attributes

Parameter	Description
name	String The name of the competition
date	Date The date that the competition started
sj_before_xc	Boolean If SJ is before XC this will be true, otherwise false
first_hi_order	String If a 1st Horse Inspection takes place and if so before which phase the HI happens
second_hi_order	String If a 2nd Horse Inspection takes place and if so before which phase the HI happens
display_name	String The display name of the competition if different to the competition name
championship	Boolean Is the competition a championship competition
results	Results These are the results for the compeition
class_category_id	Integer This is the internal EquiRatings API ID for the class category of this competition
show_id	Integer This is the internal EquiRatings API ID of the show that this competition is part of.
source_id	String The ID that the Provider uses locally on their own system

URL Parameters

Parameter	Description
ID	the internal EquiRatings API ID of the competition to retrieve

Query Parameters

This endpoint does not support query parameters.

Delete a Competition

curl -XDELETE
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/competitions/10652'

Deletes a competition with the supplied id. Also deletes all results from that competition and there respective ERQIs.

HTTP Request

DELETE https://eventing.api.equiratings.com/v1/competitions/:id

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the competition to retrieve

Query Parameters

This endpoint does not support query parameters.

Results

Result fields

Here you will find support for results:

List of fields in results
Descriptions of each field
Allowed values for fields

Key Term's Explained

Phase Status: Shows if a combination is Eliminated or Retires in this phase, does not start the phase or completes the phase
Phase Code: A code to represent the reason for a given status
Phase comment: Used to give further context for a given status, and code combination

Result Fields

Field	Definition
dr_status	Dressage Phase Status (Allowed Phase Statuses)
dr_code	Dressage Phase Code (Allowed Phase Codes)
dr_score	Dressage score in penalty points (1 decimal point)
dr_percentage	The percentage of good marks
dr_comment	Dressage Phase Comment
xc_status	Cross Country Phase Status (Allowed Phase Statuses)
xc_code	Cross Country Phase Code (Allowed Phase Codes)
xc_jump	Cross Country Obstacle penalties (integer)
xc_time	Cross country time penalties (only multiples of 0.4)
xc_comment	Cross Country Phase Comment
sj_status	Show Jumping Phase Status (Allowed Phase Statuses)
sj_code	Show Jumping Phase Code (Allowed Phase Codes)
sj_jump	Show Jumping obstacle penalties (integer)
sj_time	Show Jumping time penalties
sj_comment	Show Jumping Phase Comment
final_status	The outcome of the combination in the competition (Allowed Final Statuses)
final_code	When final_status is not OK, explains at which phase the final_status applies to. (e.g. XC-FR would be a final_code of XC) (Allowed Final Codes)
final_comment	The final comment
final_score	The final score of the combination (only when final_status is OK or DSQ)
final_position	The final position of the combination (only when final_status is OK)
first_hi_status	First Horse Inspection Phase Status (Allowed Phase Statuses)
second_hi_status	Second Horse Inspection Phase Status (Allowed Phase Statuses)
disqualification_code	Codes for dangerous riding
source_id	The ID that the Provider uses locally on their own system

Allowed Statuses and Codes

Phase Statuses

OK – Completed the phase
EL – Eliminated in the phase
RET – Retired in the phase
NS – Did not start the phase

Phase Codes

Code	Description
3E	3 errors of course (dressage)
AH	abuse of horse
AR	Accumulated Refusals (British Eventing)
CR	compulsory retirement
DR	dangerous riding
F2	rider unseated twice (national federation specific)
FH	fall of horse
FOF	fall on the flat
FR	fall of rider
MJ	missed jump
OT	other
R	multiple refusals
TH	trapped horse
nil	when no code is required

Final Statuses

OK – Completed the competition
EL- Eliminated in the competition
RET – Retired in the competition
WD – Withdrew from the competition
DSQ – Disqualified from the competition

Final Codes

H1 – 1st Horse Inspection
H2 – 2nd Horse Inspection
DR – Dressage
XC – Cross Country
SJ – Show Jumping

Disqualification Codes

Warning_DR – a warning given for dangerous riding
Minor_DR – a minor dangerous riding
Major_DR – a major dangerous riding fault

Constraints on Result data

Rules have been implemented around results to insure the continued quality of data received, these rules have been laid out below:

Phase Statuses

When phase status = OK


DR phase	dr_score must be not nil
XC phase	xc_jump must be not nil xc_time must be not nil
SJ phase	sj_jump must not be nil sj_time must not be nil

When phase status = NS


XC phase	xc_jump must be nil xc_time must be nil
SJ phase	sj_jump must be nil sj_time must be nil

When phase status = EL or phase status = RET


XC phase	xc_time must be nil
SJ phase	sj_time must be nil

Final Status

When final_status=OK

Final_score must not be nil
Final_position must not be nil
All Phase Statuses must be OK

When final_status=EL

Final_score must be nil
Final_position must be nil
At least one phase status must be EL
Final code must not be nil

When final_status=RET

Final_score must be nil
Final_position must be nil
At least one phase status must be RET
Final code must not be nil

When final_status=WD

Final_score must be nil
Final_position must be nil
All phase statuses must be OK or NS, and at least one phase status must be NS
Final code must not be nil

When final_status=DSQ

No rules have been implemented around Disqualifications

Final Code

When final_code=DR

The final_status will match dr_status when dr_status is EL or RET
The dr_status will be NS when final_status=WD

When final_code=XC

The final_status will match xc_status when xc_status is EL or RET
The xc_status will be NS when final_status=WD

When final_code=SJ

The final_status will match sj_status when sj_status is EL or RET
The sj_status will be NS when final_status=WD

Get all Results

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/results'

{
  "links": {
    "self": "/v1/results?page[page]=1&page[page_size]=50"
  },
  "jsonapi": {
    "version": "1.0"
  },
  "data": [
    {
      "type": "result",
      "links": {
        "self": "/v1/results/335818"
      },
      "id": "335818",
      "attributes": {
        "xc_time": null,
        "xc_status": "EL",
        "xc_jump": 0,
        "xc_comment": null,
        "xc_code": "FH",
        "source_id": "001",
        "sj_time": null,
        "sj_status": "NS",
        "sj_jump": null,
        "sj_code": null,
        "second_hi_status": null,
        "id": 335818,
        "horse_id": 54739,
        "first_hi_status": "OK",
        "final_status": "EL",
        "final_score": null,
        "final_position": null,
        "final_comment": null,
        "final_code": "XC",
        "dr_status": "OK",
        "dr_score": "33.2",
        "dr_percentage": "66.8",
        "dr_comment": null,
        "dr_code": null,
        "disqualification_code": null,
        "competition_id": 10650,
        "athlete_id": 27996
      }
    },
    {
      "type": "result",
      "links": {
        "self": "/v1/results/335819"
      },
      "id": "335819",
      "attributes": {
        "xc_time": "0",
        "xc_status": "OK",
        "xc_jump": 0,
        "xc_comment": null,
        "xc_code": null,
        "source_id": "002",
        "sj_time": "0.0",
        "sj_status": "OK",
        "sj_jump": 0,
        "sj_code": null,
        "second_hi_status": null,
        "id": 335819,
        "horse_id": 54738,
        "first_hi_status": "OK",
        "final_status": "OK",
        "final_score": "30.2",
        "final_position": 1,
        "final_comment": null,
        "final_code": null,
        "dr_status": "OK",
        "dr_score": "30.2",
        "dr_percentage": "69.8",
        "dr_comment": null,
        "dr_code": null,
        "disqualification_code": null,
        "competition_id": 10650,
        "athlete_id": 27995
      }
    }
  ]
}

Returns all result for the current user's organization.

HTTP Request

GET https://eventing.api.equiratings.com/v1/results

Query Parameters

This endpoint supports query parameters for paging and finding by a result by source_id:

Parameter	Description
page[page]	Integer The number of the page to be returned.
page[page_size]	Integer The number of records per page. This is a read-only parameter and is locked at 50.
source_id	The source_id of a specific result

Predefined paging URLs are also returned within the json payload.

Get a Specific Result

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/results/335818'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "result",
    "links": {
      "self": "/v1/results/335818"
    },
    "id": "335818",
    "attributes": {
      "xc_time": null,
      "xc_status": "EL",
      "xc_jump": 0,
      "xc_comment": null,
      "xc_code": "FH",
      "source_id": "001",
      "sj_time": null,
      "sj_status": "NS",
      "sj_jump": null,
      "sj_code": null,
      "second_hi_status": null,
      "id": 335818,
      "horse_id": 54739,
      "first_hi_status": "OK",
      "final_status": "EL",
      "final_score": null,
      "final_position": null,
      "final_comment": null,
      "final_code": "XC",
      "dr_status": "OK",
      "dr_score": "33.2",
      "dr_percentage": "66.8",
      "dr_comment": null,
      "dr_code": null,
      "disqualification_code": null,
      "competition_id": 10650,
      "athlete_id": 27996
    }
  }
}

Returns a result for the supplied ID parameter.

HTTP Request

GET https://eventing.api.equiratings.com/v1/results/:id

URL Parameters

Parameter	Description
ID	The internal EquiRatings API ID of the result to retrieve

Query Parameters

This endpoint does not support query parameters.

Delete a Result

To delete a Result you must handle the deletion through the update a Competition endpoint. See documentation here

Risk Data

Get a Specific Horses Data

curl -XGET
     -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9'
     -H "Content-type: application/json"
     'https://eventing.api.equiratings.com/v1/horses/:horse_id/risk_data/'

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": [
    {
      "type": "risk_data",
      "links": {
        "self": "/v1/horses/3000/risk_data/1000"
      },
      "id": "1000",
      "attributes": {
        "result_id": 2000,
        "id": 1000,
        "horse_id": 3000,
        "erqi": null,
        "er_level": 1
      }
    },
    {
      "type": "risk_data",
      "links": {
        "self": "/v1/horses/3000/risk_data/1001"
      },
      "id": "1001",
      "attributes": {
        "result_id": 2000,
        "id": 1001,
        "horse_id": 3000,
        "erqi": "0.82669",
        "er_level": 2
      }
    },
    {
      "type": "risk_data",
      "links": {
        "self": "/v1/horses/3000/risk_data/1002"
      },
      "id": "1002",
      "attributes": {
        "result_id": 2000,
        "id": 1002,
        "horse_id": 3000,
        "erqi": "0.78671",
        "er_level": 3
      }
    },
    {
      "type": "risk_data",
      "links": {
        "self": "/v1/horses/3000/risk_data/1003"
      },
      "id": "1003",
      "attributes": {
        "result_id": 2000,
        "id": 1003,
        "horse_id": 3000,
        "erqi": "0.733908",
        "er_level": 4
      }
    },
    {
      "type": "risk_data",
      "links": {
        "self": "/v1/horses/3000/risk_data/1004"
      },
      "id": "1004",
      "attributes": {
        "result_id": 2000,
        "id": 1004,
        "horse_id": 3000,
        "erqi": "0.7783746",
        "er_level": 5
      }
    },
    {
      "type": "risk_data",
      "links": {
        "self": "/v1/horses/3000/risk_data/1005"
      },
      "id": "1005",
      "attributes": {
        "result_id": 2000,
        "id": 1005,
        "horse_id": 3000,
        "erqi": "0.742637",
        "er_level": 6
      }
    },
    {
      "type": "risk_data",
      "links": {
        "self": "/v1/horses/3000/risk_data/1006"
      },
      "id": "1006",
      "attributes": {
        "result_id": 2000,
        "id": 1006,
        "horse_id": 3000,
        "erqi": "0.670112",
        "er_level": 7
      }
    },
    {
      "type": "risk_data",
      "links": {
        "self": "/v1/horses/3000/risk_data/1007"
      },
      "id": "1007",
      "attributes": {
        "result_id": 2000,
        "id": 1007,
        "horse_id": 3000,
        "erqi": "0.647961",
        "er_level": 8
      }
    },
    {
      "type": "risk_data",
      "links": {
        "self": "/v1/horses/3000/risk_data/1008"
      },
      "id": "1008",
      "attributes": {
        "result_id": 2000,
        "id": 1008,
        "horse_id": 3000,
        "erqi": "0.625094",
        "er_level": 9
      }
    },
    {
      "type": "risk_data",
      "links": {
        "self": "/v1/horses/3000/risk_data/1009"
      },
      "id": "1009",
      "attributes": {
        "result_id": 2000,
        "id": 1009,
        "horse_id": 3000,
        "erqi": "0.4789486666666666666666666667",
        "er_level": 10
      }
    },
    {
      "type": "risk_data",
      "links": {
        "self": "/v1/horses/3000/risk_data/1010"
      },
      "id": "1010",
      "attributes": {
        "result_id": 2000,
        "id": 1010,
        "horse_id": 3000,
        "erqi": "0.53055",
        "er_level": 11
      }
    },
    {
      "type": "risk_data",
      "links": {
        "self": "/v1/horses/3000/risk_data/1011"
      },
      "id": "1011",
      "attributes": {
        "result_id": 2000,
        "id": 1011,
        "horse_id": 3000,
        "erqi": "0.161742",
        "er_level": 12
      }
    },
    {
      "type": "risk_data",
      "links": {
        "self": "/v1/horses/3000/risk_data/1012"
      },
      "id": "1012",
      "attributes": {
        "result_id": 2000,
        "id": 1012,
        "horse_id": 3000,
        "erqi": "0.0000",
        "er_level": 13
      }
    }
  ]
}

Returns a list of erqis for the given horse id. If date is provided then erqi will be on that date, otherwise erqis will be the horses current erqi. If the horse has competed on the date given the erqi will include data from that competition.

HTTP Request

GET https://eventing.api.equiratings.com/v1/horses/:horse_id/risk_data/:date

URL Parameters

Parameter	Description
Horse ID	The internal EquiRatings API ID of the horse whose current erqis are to be retrieve
Date (optional)	To get a set of erqis from on a specific date. Date must be iso8601

Query Parameters

This endpoint does not support query parameters.

ERQIs

An ERQI between 0 and 1 is provided for a horse at every level from 1 to 13, if you see something other than a number between 0 and 1 it is a status code.

        {
            "type": "risk_data",
            "links": {
                "self": "/v1/horses/3000/risk_data/1000"
            },
            "id": "1000",
            "attributes": {
                "result_id": 2000,
                "id": 1000,
                "horse_id": 3000,
                "erqi": "0.587",
                "er_level": 1
            }
        },
        {
            "type": "risk_data",
            "links": {
                "self": "/v1/horses/3000/risk_data/1001"
            },
            "id": "1001",
            "attributes": {
                "result_id": 2000,
                "id": 1001,
                "horse_id": 3000,
                "erqi": 8001,
                "er_level": 2
            }
        },
        {
            "type": "risk_data",
            "links": {
                "self": "/v1/horses/3000/risk_data/1002"
            },
            "id": "1002",
            "attributes": {
                "result_id": 2000,
                "id": 1002,
                "horse_id": 3000,
                "erqi": null,
                "er_level": 3
            }
        }

ERQI Status Codes

Codes	Description
8001	This means that there is insufficient data to provide an ERQI for this horse at this level
null	This means that we do not provide an ERQI for this level

Errors

The Kittn API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong.
403	Forbidden -- The resource requested is hidden for administrators only.
404	Not Found -- The specified resource could not be found.
405	Method Not Allowed -- You tried to access a resource with an invalid method.
406	Not Acceptable -- You requested a format that isn't json.
410	Gone -- The resource requested has been removed from our servers.
418	I'm a teapot.
429	Too Many Requests -- You're requesting too many resources! Slow down!
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.