Skip to main content

2025-03-10

JSON Schema updates​

The JSON Schema library that FastAuth system uses has been changed.

JSON Schema generation​

This change directly affects endpoints returning JSON Schema:

Generated JSON schema with the new library will be almost identical with one exception of items property, which before was an object:

{
    "type": "array",
    "items": {
        "type": "string"
    }
}

and now will be an array of all schemas describing all possible array values:

{
    "type": "array",
    "items": [
        {
            "type": "string"
        },
        {
            "type": "number"
        }
    ]
}

JSON Schema validation​

This change affects endpoints using JSON Schema to validate the payload as well:

The biggest changes are in errors returned as validation result. Previously, they were returned in the following form:

{
    "succeeded": false,
    "errors": [
        "serviceTypeCode: Value \"30\" is not defined in enum.",
        "placeOfServiceCode: Value \"11\" is not defined in enum.",
        ": Required properties are missing from object: admissionTypeCode."
    ],
    "type": "none"
}

Now they will start from the full JSON document path, using / as a node separator and including array position if applicable. Then an error type will follow, possible a value and lastly a inner message from the JSON Schema library:

{
    "succeeded": false,
    "errors": [
        "/requestingProvider/roleCode: Enum error for value \"Ordering Physician\". Message: Value should match one of the values specified by the enum.",
        "/renderingProviders/0/roleCode: Enum error for value \"Facility\". Message: Value should match one of the values specified by the enum.",
        "/: Required error. Required properties [\"admissionTypeCode\"] are not present.",
    ],
    "type": "none"
}

Message format​

Depending on whether the incorrect value is small enough to be included in the message, the following message format will be used:

{valuePath}: {errorType} error for value "{value}". Message: {message}.

When the validated value is an array or object, the value will not be included in the message, and an alternative message format will be used:

{valuePath}: {errorType} error. {message}.

JSON Schema error types as of 2025-03-10, refer to API documentation for current version:

  • Required
  • Not
  • Const
  • MinLength
  • MaxLength
  • MinItems
  • MaxItems
  • Pattern
  • Enum
  • Type
  • Format
  • Minimum
  • Maximum

Changes in other endpoints​

New endpoints​

  • add new "Portals v1.1" endpoints for managing portals credentials:
    • POST /api/external/v1.1/Portals/accounts - creates a new portal account
    • GET /api/external/v1.1/Portals/accounts/{clientUserId}/list - Gets accounts for given organization by clientUserId
    • GET /api/external/v1.1/Portals/accounts/{externalId} - Gets an account
    • PUT /api/external/v1.1/Portals/accounts/{externalId} - Updates a portal account
    • DELETE /api/external/v1.1/Portals/accounts/{externalId} - Deletes account
    • POST /api/external/v1.1/Portals/accounts/filter - Gets paginated accounts for given organization
  • mark all v1/Portals endpoints as obsolete
  • add new Service Review RPA endpoints:
    • POST /api/external/v1/ServiceReviews/requests/{requestExternalId}/rpa/view-on-page - triggers an RPA script which only shows the submitted data on the page.
    • POST /api/external/v1/ServiceReviews/requests/rpa/batch/check-auth-status - runs an RPA script which checks auth status and updates the request

Endpoints changed​

  • Service Review RPA endpoint was changed from:
/api/external/v1/ServiceReviews/requests/{requestExternalId}/rpa/url

to:

/api/external/v1/ServiceReviews/requests/{requestExternalId}/rpa

Also the response model of this endpoint was changed from:

string

to

{
  "accessToken": "string",
  "scraperUri": "string"
}

This endpoint requires now also a request body:

{
  "clientUserId": "string"
}