Changelog

Added

New API endpoint for viewing Agencies

This adds a new API endpoint for Agencies. It can be scoped for agencies that accept cross agency placements from the user's own agency. The intent is for agencies to find the slugs of the agencies where they can create cross-agency placements. These slugs can then be used to create cross agency placements using the placements periods API endpoint. The API serializer also now supplies the agency slug.

Added

New filters on /application_key_dates

Added a compound filter filter[agency_key_date] GET /application_key_dates to allow filtering on custom agency key date information.

2024 Changes

  • 2024-11-20: Added is-estimated-dob to POST and PUT /children endpoints, and to POST /social-connections within the connection-person relationship.
  • 2024-11-20: Added GET application-status-changes endpoint.
  • 2024-09-25: Added 'form-version' to '/application-forms' to help track version changes.
  • 2024-09-04: Added email-addresses to POST /social-connections and primary-email-address to GET /people.
  • 2024-08-28: Added 'address' and 'mailing-address' to applications type.
  • 2024-08-21: Added document links to the GET /applications/:application_id/documents response body
  • 2024-08-07: Added external_group_id field to the children type
  • 2024-08-07: Added GET application_key_dates and GET application_key_dates/{:application_key_date_id}
  • 2024-07-10: Added email field to the agency-workers type
  • 2024-07-10: Added POST /family_finding_searches and POST /children/:child_id/relationships/family_finding_searches endpoints for creating new Family Finding Searches.
  • 2024-07-02: Added name field to the GET /applications/:application_id/documents response body
  • 2024-06-25: Added 'portal-self' and 'portal-relationships-dashboard' links to Children
  • 2024-06-25: Added GET /family_finding_searches, GET /family_finding_searches/:family_finding_search_id, and GET /children/:child_id/relationships/family_finding_searches endpoints.
  • 2024-06-19: Added /contact_logs, /contact_logs/:id, and /children/:child_id/relationships/contact_logs GET endpoints.
  • 2024-06-19: Added 'licenses' to 'case-notes' type
  • 2024-06-19: Added 'protected-tribe' and 'protected-tribe-names' to 'user-agency-profiles' type
  • 2024-06-19: Added POST /social_connections and POST /children/:child_id/relationships/social_connections endpoints for creating new Social Connections.
  • 2024-05-30: Added /social_connections, /social_connections/:social_connection_id, and /children/:child_id/relationships/social_connections GET endpoints.
  • 2024-05-30: Added GET /people and GET /people/:id endpoints
  • 2024-05-15: Added the ability to filter by document_slug on the GET /applications/:application_id/documents endpoint.
  • 2024-05-01: Added owner-agency-slug to /applications, /documents, and /applications/:application_id/documents GET endpoints.
  • 2024-04-10: Added provider-external-identifier to agency-placements
  • 2024-01-10: Updated docs to include all relationships for initial-applications and renewal-applications

2023 Changes

  • 2023-12-05: Added ability to set applicant address information and lead source information via POST /applications endpoint.
  • 2023-10-04: Added new fields to PUT /user_agency_profiles to update demographic data.
  • 2023-10-04: Added the option to sort by status_date on our GET /applications endpoint.
  • 2023-09-20: Added new "Partner Agency Access" section to group endpoints avaliable for partner agencies to use.
  • 2023-08-31: Updated "placement_providers" schema to include a reference to a provider's license(s). Added "application-type" to "application_template" schema
  • 2023-07-27: Originally slated for 2022-01-07, the URL query parameter "api_token" is now officially deprecated and undocumented (but will continue to function for the foreseeable future.)
  • 2023-07-12: Training Curriculums can now be listed via the GET /training_curriculums endpoint.
  • 2023-07-05: It is now possible to delete Worker Assignments on Applications via the DELETE /worker_assignments/:worker_assignment_id endpoint.
  • 2023-06-30: Placement Providers can now be listed via the GET /placement_providers endpoint.
  • 2023-06-21: Worker Assignments can now be created for arbitrary Applications.
  • 2023-06-21: Worker Assignments can now be included when creating a new Application.
  • 2023-05-19: GET /applications endpoints now return status override state, reason and explanation when present.
  • 2023-05-19: Worker Assignments index can now be filtered by created_start_date and created_end_date.
  • 2023-05-12: Agency-configured Application Templates are now enumerable via the GET /application_templates endpoint.
  • 2023-05-04: Added ability to associate and dissociate tags with Applications (Licenses) via POST|DELETE /applications/:application_id/tags.
  • 2023-05-04: Added the fields parental-rights-status and date-parental-rights-terminated to the child API.
  • 2023-04-28: License payloads now include a tag-summary.
  • 2023-04-24: Added POST /background_check_logs and GET /background_check_log/:id endpoints.
  • 2023-04-24: Agency-configured Tags are now enumerable via the GET /tags endpoint.
  • 2023-04-14: Added days-of-notice, placement-ended-reason-explanation, placement-ended-requester, and new options to placement-ended-reason to the placement periods API.
  • 2023-04-11: The /placement-periods endpoints now return (and accept) pre-adoption as an optional boolean flag.
  • 2023-03-18: Added ability to assign workers to applications via POST /applications/:id/relationships/worker_assignments.
  • 2023-03-15: Index and show endpoints can now make use of the ?included=a,b,c query param to limit how much associated data is returned in the payload. Pass ?included with no arguments to exclude all associated data. For backwards compatibility, the default behavior when this query param is absent continues to be "include all available associations". These docs have been updated to include lists of available associations for each endpoint.
  • 2023-03-02: Added ability to set "recruiting" status on POST /applications.
  • 2023-02-14: Added a new field "training-or-waiver-date" to /training_requirements body
  • 2023-01-31: Added POST and PUT for /case-notes endpoint.