/users/enrollments missing "next_link"

Eric Eskildsen

/users/enrollments seems to be missing the next_link property. The property never appears even when there are more responses than the response contains.

PowerShell example:

Call /users/enrollments, requesting 10 records per page:

$SchoolLevelId = ‘123456789’

$YourSubscriptionKey = 'YOUR_SUBSCRIPTION_KEY_HERE'

$YourAccessToken = 'YOUR_ACCESS_TOKEN_HERE'

Invoke-RestMethod "https://api.sky.blackbaud.com/school/v1/users/enrollments?school_year=2024 - 2025&school_level_id=$SchoolLevelId&limit=10&offset=0" -Headers @{'Bb-Api-Subscription-Key' = "$YourSubscriptionKey"; 'Authorization' = "Bearer $YourAccessToken"}

Expected response properties:

• count
• value
• next_link

Actual response properties:

• count
• value

Eric Eskildsen

The SKY OpenAPI schema for this endpoint shows next_link:

"UserEnrollmentCollection": {

"type": "object",

"properties": {

"count": {

"type": "integer",

"description": "The number of items in the collection",

"format": "int32",

"readOnly": true

},

"next_link": {

"type": "string",

"description": "For paginated responses, the URI for the next page of results",

"nullable": true

},

"value": {

"type": "array",

"items": {

"$ref": "#/components/schemas/UserEnrollment"

},

"description": "The set of items included in the response. This may be a subset of the items in the collection",

"nullable": true

}

},

"additionalProperties": false,

"description": "A Collection"

}

Stephen Boyle

@Eric Eskildsen
This is a case of next_link not being removed properly/entirely.

The endpoint does not paginate; all users with an enrollment record for the specified year will be in the response. So the dev meant to remove next_link to eliminate confusion. I'll add a cleanup item to either add it back or remove it properly.

Stephen Boyle

@Eric Eskildsen
Sorry, there is pagination. My mistake.
Doesn't affect the cleanup needed, so that will still happen.