Skip to main content
Help Center
< All Topics
Print

Rosters – Scheduler

Posted
Updated
ByVBSchedule Help Desk

IMPORTANT: These are not necessarily the officially submitted team rosters. The Scheduler component allows for the event administrator to use the Scheduler separate from Team Registration and can upload rosters to the scheduler from other resources. If you are looking for the official rosters, if the event is using Team Registration (see events api endpoint) then you should query the Team Registration Rosters endpoint. If the event is not using team registration, please contact the event administrator directly to obtain official roster information.

Returns a list of roster members for the specified event. Roster members can belong to multiple divisions and teams and can generally be grouped using the teamIdentifier field to identify the team within in the governing organization or event. There may be situations where multiple records for an individual are returned as they could belong to multiple teams within an event.

For example a USA Volleyball team identifier would resemble "G14PRLKE1NO" where an AAU team identifier or JVA team identifier and unaffiliated team identifiers may not be available and in such cases, the teamName should be used to identify the teams within a governing organization or event. In some cases, where the governing organization is unspecified there may be another integer value for the teamIdentifier field however, this would be specific to that team within the event and should not be used as an identifier across multiple events.

Endpoint

/partners/schedule/events/:eventId/rosters

Available Filters

updatedSince – returns records updated greater than the datetime provided

?filter[updatedSince]=2023-01-14T15:03:47.000000Z
OR
?filter[updatedSince]=2023-01-14 15:03
OR
?filter[updatedSince]=2023-01-14

isPlayer – filter by player or staff – Accepts true or false

?filter[isPlayer]=true
OR
?filter[isPlayer]=false

isStaff – filter by player or staff – Accepts true or false

?filter[isStaff]=true
OR
?filter[isStaff]=false

teamIdentifier – filter by team identifier (if available) – Accepts array of values

?filter[teamIdentifier]=G16CRSFR1NO
OR
?filter[teamIdentifier][]=G16CRSFR1NO&?filter[teamIdentifier][]=G17CRSFR2NO
OR
?filter[teamIdentifier]=G16CRSFR1NO,G17CRSFR2NO

trashed – filter trashed/deleted records – responds to particular values

filter[trashed]=only will only return soft-deleted models
filter[trashed]=with will include soft-deleted records to the result set

Response

{
    "data": [
        {
            "id": "258297",
            "first_name": "Elexis",
            "last_name": "Doe",
            "name": "Elexis Doe",
            "email": "nobody@example.com",
            "birthDate": "2008-07-17",
            "gender": "F",
            "teamName": "Mizuno Northern Lights 16-2",
            "clubName": "Mizuno Northern Lights",
            "teamIdentifier": "G16NLITE2NO",
            "usavTeamIdentifier": "G16NLITE2NO",
            "aauTeamIdentifier": null,
            "jvaTeamIdentifier": null,
            "usavClubIdentifier": "NLITE",
            "usavClubRegion": "NO",
            "state": null,
            "uniformNumber": "20",
            "position": null,
            "height": null,
            "graduationYear": "2026",
            "isPlayer": true,
            "jvaMemberIdentifier": null,
            "aauMemberIdentifier": null,
            "usavMemberIdentifier": "4895888",
            "teamRegistrationId": "3324",
            "clubMemberId": null,
            "clubId": "1",
            "clubTeamId": "1",
            "eventId": "36",
            "eventName": "2024 Mizuno Northern Lights Qualifier 11's-14's & 16's bids - 15, 17 & 18 no bid (March 22-24)",
            "divisionId": "178",
            "divisionName": "16 USA",
            "checkedInAt": "2024-03-20T00:57:37.000000Z",
            "updatedAt": "2024-03-20T00:57:37.000000Z",
            "trashed": false,
            "deletedAt": null
        },
        {
            "id": "258298",
            "first_name": "Jane",
            "last_name": "Johnston",
            "name": "Jane Johnston",
            "email": "nobody@example.com",
            "birthDate": "1983-09-21",
            "gender": "F",
            "teamName": "Mizuno Northern Lights 16-2",
            "clubName": "Mizuno Northern Lights",
            "teamIdentifier": "G16NLITE2NO",
            "usavTeamIdentifier": "G16NLITE2NO",
            "aauTeamIdentifier": null,
            "jvaTeamIdentifier": null,
            "usavClubIdentifier": "NLITE",
            "usavClubRegion": "NO",
            "state": null,
            "uniformNumber": null,
            "position": "headCoach",
            "height": null,
            "graduationYear": null,
            "isPlayer": false,
            "jvaMemberIdentifier": null,
            "aauMemberIdentifier": null,
            "usavMemberIdentifier": "12613333",
            "teamRegistrationId": "3324",
            "clubMemberId": null,
            "clubId": "1",
            "clubTeamId": "1",
            "eventId": "36",
            "eventName": "2024 Mizuno Northern Lights Qualifier 11's-14's & 16's bids - 15, 17 & 18 no bid (March 22-24)",
            "divisionId": "178",
            "divisionName": "16 USA",
            "checkedInAt": "2024-03-20T00:57:37.000000Z",
            "updatedAt": "2024-03-20T00:57:37.000000Z",
            "trashed": false,
            "deletedAt": null
        },
        {
            "id": "258299",
            "first_name": "Brooke",
            "last_name": "Doe",
            "name": "Brooke Doe",
            "email": "nobody@example.com",
            "birthDate": "1996-11-21",
            "gender": "F",
            "teamName": "Mizuno Northern Lights 16-2",
            "clubName": "Mizuno Northern Lights",
            "teamIdentifier": "G16NLITE2NO",
            "usavTeamIdentifier": "G16NLITE2NO",
            "aauTeamIdentifier": null,
            "jvaTeamIdentifier": null,
            "usavClubIdentifier": "NLITE",
            "usavClubRegion": "NO",
            "state": null,
            "uniformNumber": null,
            "position": "assistantCoach",
            "height": null,
            "graduationYear": null,
            "isPlayer": false,
            "jvaMemberIdentifier": null,
            "aauMemberIdentifier": null,
            "usavMemberIdentifier": "19794333",
            "teamRegistrationId": "3324",
            "clubMemberId": null,
            "clubId": "1",
            "clubTeamId": "1",
            "eventId": "36",
            "eventName": "2024 Mizuno Northern Lights Qualifier 11's-14's & 16's bids - 15, 17 & 18 no bid (March 22-24)",
            "divisionId": "178",
            "divisionName": "16 USA",
            "checkedInAt": null,
            "updatedAt": "2024-03-20T00:57:37.000000Z",
            "trashed": false,
            "deletedAt": null
        }
    ],
    "links": {
        "first": "https://api.vbschedule.com/partners/schedule/events/36/rosters?limit=3&page=1",
        "last": "https://api.vbschedule.com/partners/schedule/events/36/rosters?limit=3&page=2232",
        "prev": "https://api.vbschedule.com/partners/schedule/events/36/rosters?limit=3&page=3",
        "next": "https://api.vbschedule.com/partners/schedule/events/36/rosters?limit=3&page=5"
    },
    "meta": {
        "current_page": 4,
        "from": 10,
        "last_page": 2232,
        "links": [
            {
                "url": "https://api.vbschedule.com/partners/schedule/events/36/rosters?limit=3&page=3",
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://api.vbschedule.com/partners/schedule/events/36/rosters?limit=3&page=1",
                "label": "1",
                "active": false
            },
            {
                "url": "https://api.vbschedule.com/partners/schedule/events/36/rosters?limit=3&page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "https://api.vbschedule.com/partners/schedule/events/36/rosters?limit=3&page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "https://api.vbschedule.com/partners/schedule/events/36/rosters?limit=3&page=4",
                "label": "4",
                "active": true
            },
            {
                "url": "https://api.vbschedule.com/partners/schedule/events/36/rosters?limit=3&page=5",
                "label": "5",
                "active": false
            },
            {
                "url": "https://api.vbschedule.com/partners/schedule/events/36/rosters?limit=3&page=6",
                "label": "6",
                "active": false
            },
            {
                "url": "https://api.vbschedule.com/partners/schedule/events/36/rosters?limit=3&page=7",
                "label": "7",
                "active": false
            },
            {
                "url": "https://api.vbschedule.com/partners/schedule/events/36/rosters?limit=3&page=8",
                "label": "8",
                "active": false
            },
            {
                "url": "https://api.vbschedule.com/partners/schedule/events/36/rosters?limit=3&page=9",
                "label": "9",
                "active": false
            },
            {
                "url": "https://api.vbschedule.com/partners/schedule/events/36/rosters?limit=3&page=10",
                "label": "10",
                "active": false
            },
            {
                "url": null,
                "label": "...",
                "active": false
            },
            {
                "url": "https://api.vbschedule.com/partners/schedule/events/36/rosters?limit=3&page=2231",
                "label": "2231",
                "active": false
            },
            {
                "url": "https://api.vbschedule.com/partners/schedule/events/36/rosters?limit=3&page=2232",
                "label": "2232",
                "active": false
            },
            {
                "url": "https://api.vbschedule.com/partners/schedule/events/36/rosters?limit=3&page=5",
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://api.vbschedule.com/partners/schedule/events/36/rosters",
        "per_page": 3,
        "to": 12,
        "total": 6695
    }
}

Notes

Possible values for position when isPlayer = "no"

headCoach
assistantCoach
chaperone
manager
teamRepresentative
Table of Contents