Change Updates

Do not miss any PPEAM API changes, ever again

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

RSS
PPEAM

Mar 12, 2024

main
1.0
Compare

API structure has changed

79 structure changes including:
18 Breaking changes
14 Additions
47 Modifications
18 Removals
Modified 47 Breaking
PUT /api/users/{id}
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
GET /api/assignments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
GET /api/assignments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
GET /api/attachments/{id}
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
GET /api/circuits
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
GET /api/circuits/{id}
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
GET /api/congregations
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
GET /api/congregations/{id}
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
GET /api/labels
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
GET /api/locations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
  • Query
  • circuitId query parameter Added
GET /api/locations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • labels property Modified
      • description, circuit properties Added
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
GET /api/organizations/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • alias property Added
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
GET /api/stats/availability
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
GET /api/users
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
  • Query
  • availableForLocation query parameter Added
GET /api/users/{id}
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
POST /api/announcements
  • Body
  • application/json content type Modified
    • description property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • description property Added
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
POST /api/assignments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • user property Modified
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
POST /api/assignments/duplicate
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
POST /api/assignments/recommendations
  • Response
  • 200 response Modified
    • application/json content type Modified
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
POST /api/assignments/{id}/substitute
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
POST /api/attachments
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
POST /api/circuits
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
POST /api/congregations
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
POST /api/labels
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
POST /api/locations
  • Body
  • application/json content type Modified
    • description, circuit properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • labels property Modified
      • description, circuit properties Added
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
PUT /api/locations/{id}
  • Body
  • application/json content type Modified
    • description, circuit properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • labels property Modified
      • description, circuit properties Added
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
PUT /api/labels/{id}
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
PUT /api/congregations/{id}
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
PUT /api/circuits/{id}
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
PUT /api/assignments/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
PUT /api/announcements/{id}
  • Body
  • application/json content type Modified
    • description property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • description property Added
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
POST /api/users/{user_id}/labels
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
POST /api/users/{user_id}/instalink
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
POST /api/users
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
POST /api/notifications
  • Body
  • application/json content type Modified
    • body property Modified
      • html property Modified
        • Combinator is now anyOf
      • text property Added
    • recipients property Modified
    • channel property Added
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
POST /api/locations/{location_id}/labels
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
DELETE /api/announcements/{id}
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
DELETE /api/assignments/{id}
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
DELETE /api/circuits/{id}
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
DELETE /api/congregations/{id}
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
DELETE /api/labels/{id}
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
DELETE /api/locations/{location_id}
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
DELETE /api/locations/{location_id}/labels
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
DELETE /api/users/{user_id}
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
DELETE /api/users/{user_id}/labels
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
GET /api/announcements
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
GET /api/announcements/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • description property Added
  • Authentication
  • OAuth2PasswordBearer authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Http bearer authentication method Added
Removed 18 Breaking
GET /api/follow_up_forms
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/users/{user_id}/availability/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/follow_up_forms/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/locations/shifts/reports
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /api/locations/shifts/reports/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /auth/instalink
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/follow_up_forms
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/locations/shifts/reports
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/locations/{location_id}/shifts
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/users/{user_id}/availability
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /api/users/{user_id}/web_push_subscriptions
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /auth/instalink
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /auth/password
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/locations/shifts/reports/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/locations/{location_id}/shifts/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /api/users/{user_id}/availability/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/locations/{location_id}/shifts/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /api/locations/shifts/reports/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 14
PUT /api/users/{user_id}/availability/{id}
PUT /api/locations/{location_id}/shifts/{id}
PUT /api/locations/shifts/reports/{id}
POST /auth/password
POST /auth/instalink
POST /api/users/{user_id}/availability
POST /api/locations/{location_id}/shifts
POST /api/locations/shifts/reports
GET /auth/instalink
GET /api/locations/shifts/reports/{id}
GET /api/locations/shifts/reports
DELETE /api/users/{user_id}/availability/{id}
DELETE /api/locations/{location_id}/shifts/{id}
DELETE /api/locations/shifts/reports/{id}