Change Updates

Do not miss any AZAV Pilot API changes, ever again

Subscribe to the AZAV Pilot API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
43 structure changes including:
43 Modifications
Modified 43 Breaking
DELETE /v1/coachings/{id}
  • Response
  • 204 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
DELETE /v1/contacts/{id}
  • Response
  • 204 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
        • funding_agency_id property Added
DELETE /v1/courses/{id}
  • Response
  • 204 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
DELETE /v1/participants/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
GET /v1/coachings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
GET /v1/coachings/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
GET /v1/contacts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
        • funding_agency_id property Added
GET /v1/contacts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
        • funding_agency_id property Added
GET /v1/courses
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
GET /v1/courses/{course_id}/notes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
GET /v1/courses/{course_id}/notes/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
GET /v1/courses/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
GET /v1/locations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
GET /v1/participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
GET /v1/participants/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
GET /v1/participants/{participant_id}/notes
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
GET /v1/participants/{participant_id}/notes/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
GET /v1/permissionGroups
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
GET /v1/programs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
GET /v1/programs/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
GET /v1/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
GET /v1/users/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
PATCH /v1/coachings/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
PATCH /v1/contacts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
        • funding_agency_id property Added
PATCH /v1/courses/{course_id}/notes/{id}
  • Body
  • application/json content type Modified
    • note property Modified
      • id property Modified
        • Type went from integer to string
          Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
PATCH /v1/courses/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
PATCH /v1/participants/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
PATCH /v1/participants/{participant_id}/notes/{id}
  • Body
  • application/json content type Modified
    • note property Modified
      • id property Modified
        • Type went from integer to string
          Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
PATCH /v1/programs/{id}
  • Body
  • application/json content type Modified
    • Program property Modified
      • id property Modified
        • Type went from integer to string
          Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
POST /v1/coachings
  • Body
  • application/json content type Modified
    • Coaching property Modified
      • id property Modified
        • Type went from integer to string
          Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
POST /v1/contacts
  • Body
  • application/json content type Modified
    • Contact property Modified
      • id property Modified
        • Type went from integer to string
          Breaking
      • funding_agency_id property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
        • funding_agency_id property Added
POST /v1/courses
  • Body
  • application/json content type Modified
    • Course property Modified
      • id property Modified
        • Type went from integer to string
          Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
POST /v1/courses/{course_id}/notes
  • Body
  • application/json content type Modified
    • note property Modified
      • id property Modified
        • Type went from integer to string
          Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
POST /v1/participants
  • Body
  • application/json content type Modified
    • Participant property Modified
      • id property Modified
        • Type went from integer to string
          Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
POST /v1/participants/{participant_id}/notes
  • Body
  • application/json content type Modified
    • note property Modified
      • id property Modified
        • Type went from integer to string
          Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
POST /v1/users
  • Body
  • application/json content type Modified
    • user property Modified
      • id property Modified
        • Type went from integer to string
          Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
PUT /v1/coachings/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
PUT /v1/contacts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
        • funding_agency_id property Added
PUT /v1/courses/{course_id}/notes/{id}
  • Body
  • application/json content type Modified
    • note property Modified
      • id property Modified
        • Type went from integer to string
          Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
PUT /v1/courses/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
PUT /v1/participants/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
PUT /v1/participants/{participant_id}/notes/{id}
  • Body
  • application/json content type Modified
    • note property Modified
      • id property Modified
        • Type went from integer to string
          Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
PUT /v1/programs/{id}
  • Body
  • application/json content type Modified
    • Program property Modified
      • id property Modified
        • Type went from integer to string
          Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
6 structure changes including:
6 Modifications
Modified 6
DELETE /v1/participants/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • contactInformation property Added
GET /v1/participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • contactInformation property Added
GET /v1/participants/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • contactInformation property Added
PATCH /v1/participants/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • contactInformation property Added
POST /v1/participants
  • Body
  • application/json content type Modified
    • Participant property Modified
      • contactInformation property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • contactInformation property Added
PUT /v1/participants/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • contactInformation property Added
9 structure changes including:
9 Modifications
Modified 9 Breaking
DELETE /v1/participants/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • date_of_birth property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • address, dateOfBirth properties Added
GET /v1/participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • date_of_birth property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • address, dateOfBirth properties Added
GET /v1/participants/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • date_of_birth property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • address, dateOfBirth properties Added
GET /v1/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • address property Modified
GET /v1/users/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • address property Modified
PATCH /v1/participants/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • date_of_birth property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • address, dateOfBirth properties Added
POST /v1/participants
  • Body
  • application/json content type Modified
    • Participant property Modified
      • date_of_birth property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • address, dateOfBirth properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • date_of_birth property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • address, dateOfBirth properties Added
POST /v1/users
  • Body
  • application/json content type Modified
    • user property Modified
      • address property Modified
        • house_number, zip_code properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • houseNumber, zipCode properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • address property Modified
PUT /v1/participants/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • date_of_birth property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • address, dateOfBirth properties Added
12 structure changes including:
12 Modifications
Modified 12
DELETE /v1/contacts/{id}
  • Response
  • 204 response Modified
    • application/json content type Modified
      • data property Modified
        • email property Modified
          • Property is no longer required
        • category, function, tags properties Added
DELETE /v1/fundingAgencies/{id}
  • Response
  • 204 response Modified
    • application/json content type Modified
      • data property Modified
        • partnerType, type properties Added
GET /v1/contacts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • email property Modified
          • Property is no longer required
        • category, function, tags properties Added
GET /v1/contacts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • email property Modified
          • Property is no longer required
        • category, function, tags properties Added
GET /v1/fundingAgencies
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • partnerType, type properties Added
GET /v1/fundingAgencies/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • partnerType, type properties Added
PATCH /v1/contacts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • email property Modified
          • Property is no longer required
        • category, function, tags properties Added
PATCH /v1/fundingAgencies/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • partnerType, type properties Added
POST /v1/contacts
  • Body
  • application/json content type Modified
    • Contact property Modified
      • email property Modified
        • Property is no longer required
      • category, function, tags properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • email property Modified
          • Property is no longer required
        • category, function, tags properties Added
POST /v1/fundingAgencies
  • Body
  • application/json content type Modified
    • FundingAgency property Modified
      • partnerType, type properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • partnerType, type properties Added
PUT /v1/contacts/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • email property Modified
          • Property is no longer required
        • category, function, tags properties Added
PUT /v1/fundingAgencies/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • partnerType, type properties Added
16 structure changes including:
13 Additions
3 Modifications
Modified 3 Breaking
GET /v1/permissionGroups
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • permissions property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /v1/users
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • first_name, last_name, roles properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • address, firstName, groups, lastName, locations properties Added
GET /v1/users/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • first_name, last_name, roles properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • address, firstName, groups, lastName, locations properties Added
Added 13
DELETE /v1/courses/{course_id}/notes/{id}
DELETE /v1/participants/{participant_id}/notes/{id}
GET /v1/courses/{course_id}/notes
GET /v1/courses/{course_id}/notes/{id}
GET /v1/participants/{participant_id}/notes
GET /v1/participants/{participant_id}/notes/{id}
PATCH /v1/courses/{course_id}/notes/{id}
PATCH /v1/participants/{participant_id}/notes/{id}
POST /v1/courses/{course_id}/notes
POST /v1/participants/{participant_id}/notes
POST /v1/users
PUT /v1/courses/{course_id}/notes/{id}
PUT /v1/participants/{participant_id}/notes/{id}
7 structure changes including:
1 Addition
6 Modifications
Modified 6 Breaking
DELETE /v1/fundingAgencies/{id}
  • Response
  • 204 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
        • slug property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • email property Added
GET /v1/fundingAgencies
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
        • slug property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • email property Added
GET /v1/fundingAgencies/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
        • slug property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • email property Added
PATCH /v1/fundingAgencies/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
        • slug property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • email property Added
POST /v1/fundingAgencies
  • Body
  • application/json content type Modified
    • FundingAgency property Modified
      • id property Modified
        • Type went from integer to string
          Breaking
      • slug property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • email property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
        • slug property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • email property Added
PUT /v1/fundingAgencies/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Type went from integer to string
            Breaking
        • slug property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • email property Added
Added 1
GET /v1/permissionGroups
7 structure changes including:
4 Additions
3 Modifications
Modified 3 Breaking
DELETE /v1/participants/{id}
  • Response
  • 204 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
GET /v1/programs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • admission_criteria property Added
GET /v1/programs/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • admission_criteria property Added
Added 4
GET /v1/org
PATCH /v1/participants/{id}
PATCH /v1/programs/{id}
PUT /v1/programs/{id}
10 structure changes including:
10 Additions
Added 10
DELETE /v1/coachings/{id}
DELETE /v1/courses/{id}
GET /v1/coachings
GET /v1/coachings/{id}
PATCH /v1/coachings/{id}
PATCH /v1/courses/{id}
POST /v1/coachings
POST /v1/courses
PUT /v1/coachings/{id}
PUT /v1/courses/{id}
21 structure changes including:
19 Additions
2 Modifications
Modified 2 Breaking
POST /v1/participants
  • Body
  • application/json content type Modified
    • user property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • participant property Added
GET /v1/participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • Full types went from object to array[object]
          Breaking
Added 19
PUT /v1/fundingAgencies/{id}
PUT /v1/contacts/{id}
POST /v1/fundingAgencies
POST /v1/contacts
PATCH /v1/fundingAgencies/{id}
PATCH /v1/contacts/{id}
GET /v1/users/{id}
GET /v1/users
GET /v1/programs/{id}
GET /v1/programs
GET /v1/locations
GET /v1/fundingAgencies/{id}
GET /v1/fundingAgencies
GET /v1/courses/{id}
GET /v1/courses
GET /v1/contacts/{id}
GET /v1/contacts
DELETE /v1/fundingAgencies/{id}
DELETE /v1/contacts/{id}
21 structure changes including:
16 Breaking changes
5 Modifications
16 Removals
Modified 5 Breaking
DELETE /v1/participants/{id}
  • Response
  • 204 response Modified
    • application/json content type Modified
      • data property Modified
GET /v1/participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
GET /v1/participants/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
POST /v1/participants
  • Body
  • application/json content type Modified
    • user property Modified
      • birthday, inserted_at, name, updated_at properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • birthCity, birthCountry, customerNumber, date_of_birth, firstName, gender, insertedAt, internalCustomerNumber, lastName, marketingChannel, preferredName, salutation, status, updatedAt properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
PUT /v1/participants/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
Removed 16 Breaking
DELETE /v1/coaching/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /v1/courses/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /v1/programs/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/coaching
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/coaching/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/courses
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/courses/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/programs
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/programs/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/coaching
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/courses
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/programs
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /v1/coaching/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /v1/courses/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /v1/participants/{id}/add_to_course/{course_id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /v1/programs/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
1 structure change including:
1 Addition
Added 1
PUT /v1/participants/{id}/add_to_course/{course_id}
18 structure changes including:
18 Additions
Added 18
DELETE /v1/coaching/{id}
DELETE /v1/courses/{id}
DELETE /v1/participants/{id}
DELETE /v1/programs/{id}
GET /v1/coaching
GET /v1/coaching/{id}
GET /v1/courses
GET /v1/courses/{id}
GET /v1/participants
GET /v1/programs
GET /v1/programs/{id}
POST /v1/coaching
POST /v1/courses
POST /v1/programs
PUT /v1/coaching/{id}
PUT /v1/courses/{id}
PUT /v1/participants/{id}
PUT /v1/programs/{id}