KBRSF documentation

# PSV - Certifications

# Types

Certificaat
Brevet eerste graad
Ruiterbrevet A
Brevet A dressuur
Brevet A mennen
Brevet A Amerikaanse rijkunst
Ruiterbrevet B
Brevet B dressuur
Brevet B mennen
Brevet B Amerikaanse rijkunst
Bekwaamheidsattest ruiterbrevet
Bekwaamheidsattest Amerikaanse rijkunst
Rijvaardigheidsbrevet initiator
Rijvaardigheidsbrevet trainer B dressuur
Rijvaardigheidsbrevet trainer B springen
Rijvaardigheidsbrevet trainer B eventing
Rijvaardigheidsbrevet trainer A dressuur
Rijvaardigheidsbrevet trainer A springen
Rijvaardigheidsbrevet trainer A eventing
Rijvaardigheidsbrevet instructeur B springen
Rijvaardigheidsbrevet instructeur B dressuur
Rijvaardigheidsbrevet instructeur B eventing
Rijvaardigheidsbrevet instructeur B reining
Rijvaardigheidsbrevet trainer B reining
Rijvaardigheidsbrevet trainer A reining

# Events

--- PSV_CERTIFICATIONS_UPDATED ---
{
    "event": "PSV_CERTIFICATIONS_UPDATED",
    "data": {
        "person_id": 123
    }
}

# Validation

Tip

Validation mentioned will trigger for each entry in the payload array. In case of an error, the index of the element in that array will be included in the response with error messages as mentioned in the general information

{
    "club_id": [
        "required",
        "a valid club"    
    ],
    "certificate": [
        "required",
        "distinct",
        "a valid certification type",
    ],
    "date": [
        "required",
        "date:Y-m-d"
    ]
}

# List

--- ENDPOINT --- 

Domain: equidata 
Url: /people/123/psv/certificates
Method: GET
--- EXAMPLE RESPONSE ---
[
  {
    "club_id": 123,
    "certificate": "Brevet eerste graad",
    "date": "2005-01-13"
  },
  {
    "club_id": 123,
    "certificate": "Ruiterbrevet A",
    "date": "2010-01-13"
  }
]

# Update

Warning

Make sure to add all data to the payload every time you call this endpoint.

  • If your intention is to add a new entry, include the existing entries in the payload.
  • If your intention is to delete an existing entry, add all remaining entries in the payload.

Warning

This is a specific endpoint for PSV. When trying to call this endpoint as a different liga, you'll get an unauthorized response.

--- ENDPOINT --- 

Domain: equidata 
Url: /people/123/psv/certificates
Method: PUT
--- EXAMPLE PAYLOAD ---
{
  "certificates": [
    {
      "club_id": 123,
      "certificate": "Brevet eerste graad",
      "date": "2005-01-13"
    },
    {
      "club_id": 123,
      "certificate": "Ruiterbrevet A",
      "date": "2010-01-13"
    }
  ]
}
--- EXAMPLE RESPONSE ---
[
  {
    "club_id": 123,
    "certificate": "Brevet eerste graad",
    "date": "2005-01-13"
  },
  {
    "club_id": 123,
    "certificate": "Ruiterbrevet A",
    "date": "2010-01-13"
  }
]

← PSV - Diplomas →