KBRSF documentation

# LEWB - Certifications

# Types

Certificate
Etrier de Bronze
Etrier d'Argent
Premier Degré
Etrier d'Or
Licol Blanc
Licol Rouge
Licol Noir
Licol Bleu
Deuxième Degré
Troisième Degré
Etrier Blanc
Etrier Bleu
Etrier Rouge
Etrier Noir
Etrier Vert
Etrier d'Or Western
Premier Degré Western
Etrier de Bronze Western
Etrier d'Argent Western
Aspirant Accompagnateur
Randonneur
Aspirant Randonneur
Guides d'Or
Etrier de Diamant
Premières Guides

# Events

--- LEWB_CERTIFICATIONS_UPDATED ---
{
    "event": "LEWB_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",
         "a valid certification type",
    ],
    "date": [
        "required",
        "date:Y-m-d"
    ]
}

# List

--- ENDPOINT --- 

Domain: equidata 
Url: /people/123/lewb/certificates
Method: GET
--- EXAMPLE RESPONSE ---
[
  {
    "club_id": 123,
    "certificate": "Etrier de Bronze",
    "date": "2005-01-13"
  },
  {
    "club_id": 123,
    "certificate": "Etrier d'Or'",
    "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 LEWB. When trying to call this endpoint as a different liga, you'll get an unauthorized response.

--- ENDPOINT --- 

Domain: equidata 
Url: /people/123/lewb/certificates
Method: PUT
--- EXAMPLE PAYLOAD ---
{
  "certificates": [
    {
      "club_id": 123,
      "certificate": "Etrier de Bronze",
      "date": "2005-01-13"
    },
    {
      "club_id": 123,
      "certificate": "Etrier d'Or'",
      "date": "2010-01-13"
    }
  ]
}
--- EXAMPLE RESPONSE ---
[
  {
    "club_id": 123,
    "certificate": "Etrier de Bronze",
    "date": "2005-01-13"
  },
  {
    "club_id": 123,
    "certificate": "Etrier d'Or'",
    "date": "2010-01-13"
  }
]

← LEWB - Diplomas →