Using these APIs, you can manage invites to make a person signup for a club, optionally making the person a member for that club. An invite represents a multi-step process for onboarding new people for a club. The steps are:
invite created: The Club API client creates an invite, and an
e-mail is sent to the user where they can signup. Additionally, the
signup page URL is available at the openHref response property.
A club_person_invite event is triggered on creation.
invite email sent: An email is sent to the user, and sentAt
is set every time the email is (re)sent. Every time the email is sent,
a club_person_invite event might be triggered. The email might
have been sent at creation of the invite, skipping any additional
events unless the email is resent.
Club API clients can update or delete the invite, triggering events on every change.
invite opened: The user clicks the url in the email and starts
signup process, updating openedAt at the first time the page is
visited and triggering a club_person_invite.
Club API clients can update or delete the invite, triggering events
on every change. The user will never be notified about updates or
deletions done via Club API. For every change, another
club_person_invite is triggered, even if the change is via Club
API.
invite deleted: Either the user or a Club API client deletes the
invite. A final club_person_invite is triggered. Deletion can be
done at any point until the invite is completed.
invite completed: The user completes the invite and the signup
will be completed soon. A club_person_invite event is triggered,
and userCompletedAt will be set.
invite processed: The final state of an invite, and there will be
one final club_person_invite event. clubiProcessedAt is now
set and the invite can no longer change. personId, referring to
the person ID of your new club person or member, is guaranteed to be
set and final.
Between invite completed and processed, additional events might have been generated representing the club person changes. If the signup includes a name, birth date, or gender change, other clubs might have been notified about these changes.
Any Club API client and the person can modify their signup before
completing it. An invite can be completed using an existing person or a
new one. Use clubPersonInvite to check the latest changes on an
invite, including any person ID set to that invite. Only when an invite
is processed (clubiProcessedAt is set), the personId is final.
For every change on invites, including changes you make yourself, a
club_person_invite event is generated.
Once the invite is completed, the person (referred by personId) will
be added to clubPeople for that club until deleteClubPerson is
called.
The role XR ("Club relatie") will be attached to the person at all
times. Club API clients cannot modify this role except by using
deleteClubPerson. The person will be made a club member if
makeMember is true at time of completion.
For testing purposes, mock* API calls. These APIs are available in
any environment (including production), but access is whitelisted per
club and per person. If no personId is set on completion, one will
be created.
Regardless whether completion was done by a user or done using
mockCompleteClubPersonInvite, processing is done asynchronously.
Once the processing is completed, a final club_person_invite event
is triggered. Additionally, other events are likely generated as part of
updating or creating resources related to the new club person or member.
The invite APIs are experimental and subject to change.
clubId: ID!, id: ID! → ClubPersonInvite!
Find an invite
clubId: ID!, search: ClubPersonInviteSearch! → ClubPersonInvitePaginated!
Find all invites for a club
clubId: ID!search: ClubPersonInviteSearch!clubId: ID!, request: CreateClubPersonInviteRequest! → ClubPersonInvite!
Create a new invite to signup a person for a club, optionally as a member.
clubId: ID!request: CreateClubPersonInviteRequest!changes: [ClubPersonInviteChangeRequest!]!, clubId: ID!, id: ID! → ClubPersonInvite!
Update one or more properties of an invite. Only invites that have not been completed can be updated.
clubId: ID!, id: ID! → Boolean!
Delete an invite. Only invites that have not been completed can be deleted.
Returns true if the club person invite existed at one point, and is now
deleted.
clubId: ID!, id: ID! → Boolean!
For automated testing purposes, simulate an invite to be completed.
If personId was not set (use mockUpdateClubPersonInvitePerson), a new
person will be created. If makeMember is true, the person will be
made a club member.
Note that the processing of invites is done asynchronously. This mock API
marks an invite for completion, queueing it for processing.
club_person_invite Events will be triggered while the invite is being
processed. Only when clubiProcessedAt is set, the invite is final and
no more club_person_invite events are triggered.
clubId: ID!, id: ID!, ownerPersonId: ID, personId: ID → Boolean!
For automated testing purposes, assign an owner and/or person to an invite.
id: ID!clubId: ID!email: String!telephone: StringbirthDate: LocalDategender: GendergivenName: StringnamePrefix: StringfamilyName: Stringinitials: Stringaddress: ClubPersonInviteAddresspersonId: IDownerPersonId: IDmakeMember: BooleanopenHref: String!sentAt: InstantuserCompletedAt: InstantclubiProcessedAt: InstantopenedAt: Instantkey: String! — A property of CreateClubPersonInviteRequestprev: ClubPersonInviteValue — The current value of the property referred to by key.next: ClubPersonInviteValue — The desired value of the property referred to by key.A value compatible with the ClubPersonInvite's property referred to by key. EG, if key is "givenName",
value should be a String.
Using these APIs, you can manage people associated to a club, and their personal details. For managing contact details, see Club Person Contacts.
clubId: ID!, personId: ID! → ClubPerson!
clubId: ID! — Federation reference id of the club, EG XX11AA01.personId: ID! — Person reference id of the club, EG J82SC4X.clubId: ID!, limit: Int, membership: Boolean, offset: Int → ClubPeopleResponse!
clubId: ID! — Federation reference id of the club, EG XX11AA01.limit: Intmembership: Boolean — Filter club people by whether they have a membership or notoffset: IntclubId: ID!, id: ID! → ClubPersonChangeset!
clubId: ID! — Federation reference id of the club, EG XX11AA01.id: ID! — ID as returned by createClubPersonChangesetchanges: [ClubPeopleChangeRequestChange!]!, clubId: ID!, personId: ID! → ClubPersonChangeset
Create a set of changes for a person in a club. Only when all changes are accepted, they'll be applied. Otherwise, the changeset will be rejected, even if some of the changes would be valid.
All updates on the person (name, birth date and gender) will be propagated to all other clubs where the person is a 'club person'.
For every property you want to change, you need to provide the key of the
property (EG "familyName"), the current value (EG "Flodder") and the
desired value (EG "Flodeur").
Every change is validated either automatically or manually (or both), and only when all changes are accepted, and the provided current values still match the actual current values (IE none of the properties were changed by some other process or changeset) the changeset's changes are actually applied.
In some cases, the accepted value is different from the requested value. This
should only happen when the requested value and accepted value are
functionally identical, but are formatted differently. However, this behaviour
is not guaranteed: You should always check what the actual accepted value is
by fetching the clubPersonChange again, looking at the changes[].value
property, or by just using clubPerson to fetch the updated person.
You can create multiple changesets at once. Because the provided current value needs to match actual current value when the changeset is accepted, any conflicting changeset will fail.
The changeset will be updated upon validation and processing. Once they changeset is accepted or rejected, their state is final and they will no longer be updated.
For every create, update or delete on the changeset, a
club_person_changeset event is triggered. In some cases, the changeset is
accepted immediately.
When updating the person based on a changeset, additional events related to the person or club_person might be triggered. In some cases, other clubs will also receive events about the updated person. In some cases, other changesets in other clubs are invalidated because of the person updates.
changes: [ClubPeopleChangeRequestChange!]! — A list of changes. If one change is rejected, the whole changeset will be
rejected. If all changeset are accepted, the changeset will be accepted and
the person will be updated.clubId: ID! — Federation reference id of the club, EG "XX11AA01".personId: ID! — ID of the person, EG "J82SC4X".clubId: ID!, id: ID! → Boolean!
Delete a pending changeset, canceling all pending changes, both accepted and
rejected. This is only possible if the changeset's state is pending.
Idempotent: Invoking this function multiple times should have the same
result.
Returns true on success, or some kind of error on failure.
Also see deleteClubMember to keep the relationship
but make the person no longer a member of this club.
clubId: ID! — Federation reference id of the club, EG "XX11AA01".id: ID! — ID as returned by createClubPersonChangesetclubId: ID!, personId: ID! → Boolean!
Immediately delete all relations of a person within a club, deleting memberships, roles, team roles and contact details. The club will have no more access to this person.
Specifically, the following resources attached to both the person and club get deleted or updated:
startDate after today) will be deleted.endDate set to today.club_assignable roles and club_assignable
team roles (validFrom after now) will be deleted.club_assignable roles and club_assignable
team roles will have their validTo set to now.XR-roles ("Club Relatie") will be deleted.Note that contacts are not deleted or updated. This will be implemented
later. Additionally, the person itself will not be altered, nor will any
resource for any other club be altered.
For every record that's being deleted or updated, some events might be triggered.
To reintroduce the person the club, you have to send a new invite using
createClubPersonInvite.
Returns true on success, or some kind of error on failure.
id: ID!initials: String!givenName: StringnamePrefix: StringfamilyName: String!fullName: String!gender: Gender!birthDate: LocalDatemembership: ClubPersonMembership — The currently active or future membership for this person within this club.
Always check active to verify the person has an active membership.roles: [ClubPersonRole!]! — Currently active and future roles for this person within this club.
Always check active to verify the role is actually active.teamRoles: [ClubPersonTeamRole!]! — Currently active and future team roles for this person within this club's
teams. Always check active to verify the role is actually active.teamPlayers: [ClubPersonTeamPlayer!]! — Currently active and future team players for this person within this club's
teams. Always check active to verify the team_player is actually active.key: ID! — A property of a clubPerson to change. Possible keys: [
'givenName',
'namePrefix',
'familyName',
'gender',
'birthDate',
'initials'
]prev: String — The current value, as a string, or NULL if the current value is NULLnext: String — The desired value as a string, or NULL if the desired value is NULLid: ID!personId: ID!clubId: ID!createdAt: Instant!updatedAt: InstantrejectedAt: Instant — If set, none of the changes were processed. Usually this happens when at least
one change is rejected. rejectedAt and acceptedAt can never both be
set.acceptedAt: Instant — If set, all changes were accepted and processed. This state is final.
rejectedAt and acceptedAt can never both be set.state: ClubPersonChangesetState! — pending if rejectedAt and acceptedAt are blank. rejected or
accepted otherwise. If rejected, none of the changes were processed.
If accepted, all changes were processed.changes: [ClubPersonChangesetChange!]! — An array of changes based on the requested changes. Will have all the input
properties as provided via createClubPersonChangeset, but with additional
fields to inspect the state of each change in the changeset.key: ID! — A property of a clubPerson to change. Permitted keys: [
'givenName',
'namePrefix',
'familyName',
'gender',
'birthDate',
'initials'
]prev: String — The current value, as a string, or NULL if the current value is NULLnext: String — The desired value as a string, or NULL if the desired value is NULLvalue: String — The final, accepted value as a string, or NULL if the accepted value is NULLrejectedAt: Instant — If this change is rejected, this timestamp will be set. Only rejectedAt
or acceptedAt can be set, not both.acceptedAt: Instant — If this change is accepted, this timestamp will be set. Only rejectedAt
or acceptedAt can be set, not both. Note that a change is only processed
when all changes are accepted. IE, if acceptedAt is set, it is only an
indication that the change might be processed in the future, but only if none
of the other changes are rejected. Accepted changes can still be canceled
using deleteClubPersonChangeset.rejectedCode: ID — Some error code that describes why the change was rejected. Should be set when
rejectedAt is set.rejectedMessage: String — Some human-readable message to describe why the change was rejected. Should be
set when rejectedAt is set.Using these APIs, you can manage people's membership for a club
clubId: ID!, personId: ID! → ClubMember2
Get a membership of a person in a club. Returns a currently active or future membership.
clubId: ID! — Federation reference id of the club, EG XX11AA01.personId: ID! — Person reference id of the club, EG J82SC4X.clubId: ID! → [ClubMember2!]!
Get all memberships of people with an active or future membership in a given
club, similar to clubPeople(membership: true)
clubId: ID! — Federation reference id of the club, EG XX11AA01.[ClubMember2!]!clubId: ID!, personId: ID! → ClubMember2!
Immediately make a person member of a club. Requires the person to be a "club
person". If the person isn't already related to the club, use
createClubPersonInvite instead. Idempotent: If invoked multiple times,
the result should be the same.
Specifically, for all club member records for this person in this club, this function will:
validTo on all active club_member records, except for onevalidTo on one active club_member, if setIf the person is not a clubPerson, a "ClubPersonNotFound" error is
returned and nothing will change.
clubId: ID!, personId: ID! → Boolean!
Immediately delete a player's membership and associated roles and team
players. Returns true on success, or an error. Idempotent: If invoked
multiple times, the result should be the same.
Specifically, this function will:
validTo of all active memberships for the person and clubclub_assignable roles for the person and clubYou can make the person a member again using
createClubMember. You can delete the person from the
club using deleteClubPerson.
Using these APIs, you can manage people's roles in a club.
A club role is a role attached to a club member without being attached
to a team. A club role's category is either assignable or
readable. Readable roles are assigned externally and Club API users
can only read them. Assignable roles can be assigned by Club API users.
A role can only be attached by a club member. By deleting a person's membership, all roles will also be deleted.
categoryId: ID!, clubId: ID!, personId: ID! → ClubRole
Get a role of a person in a club. Returns a currently active or future role.
categoryId: ID, clubId: ID!, limit: Int, offset: Int, permission: ClubRolePermission, personId: ID → ClubRolesResponse!
Get all roles in a club, optionally filtered by category or person.
categoryId: ID — Optional. EG "WA".clubId: ID! — EG "XX11AA01".limit: Int — Limit the number of roles returned by this amountoffset: Int — Skip this amount of roles for the purpose of pagination.permission: ClubRolePermission — Optional. Filter roles by their permissionpersonId: ID — Optional. EG "J82SC4X".categoryId: ID, clubId: ID!, personId: ID, siteVisibility: ClubRoleSiteVisibility → ClubRole!
categoryId: ID — Optional. EG "WA".clubId: ID! — EG "XX11AA01".personId: ID — Optional. EG "J82SC4X".siteVisibility: ClubRoleSiteVisibility — Whether this role should be published on KNHB.nl. See RoleSiteVisibility
for behavior per value.categoryId: ID, clubId: ID!, personId: ID → Boolean!
categoryId: ID — Optional. EG "WA".clubId: ID! — EG "XX11AA01".personId: ID — Optional. EG "J82SC4X".NONE — This person role is never returned by ApiClubControl.clubs and therefore not
shown on knhb.nl. This is the default behavior, and this is equal to public=falseONLY_ROLE — This person role is returned but contact info is never shown, even if public
contact info is presentROLE_CLUB_EMAIL — This person role is returned with club email for the same club & role category
if present. Otherwise, only the role is returnedROLE_PERSON_CONTACT — This person role is returned with latest person contact if that person
contact is public. Otherwise, only the role is returned.ROLE_ANY_CONTACT — Combines ROLE_CLUB_EMAIL and ROLE_PERSON_CONTACT to fetch either a public
club email or public person contact, whichever is available.
This value is equal to public=trueUsing these APIS, you can manage people's contact details in a club.
You can only read or update a person's contact details if the person is associated to a club. You can associate a person to a club using an invite. See Signup & Invites.
These APIs replace the updatePersonContact API call. E-mail
addresses and telephone numbers set by updatePersonContact are
returned by this API as legacyEmail and legacyTelephone. When
the person's contact details are updated, the legacy* fields are set
to NULL, and emails and telephones are set instead.
emails and telephones are sorted lists and their order is
stored. The first item in the list is considered the most significant
value, or the primary method of contact.
The value must be a normalized, sanitized value. For emails, the
value must be a well-formatted e-mail address that you have validated.
This API will not validate the e-mail address. emails.value is
validated naively using /^[^@\s]+@[^@\s]+$/.
For telephones.value, the value MUST be an international E.164
formatted number starting with a + and no leading zeroes, EG
"+31612345678". The value is validated using
/^\+[1-9]\d{1,14}$/.
The label is free-form text and should contain a short name of the
phone number or e-mail address, EG "Moeder", "Vader",
"Thuis" or "Mobiel". There is no defined length limit but any
client using the label is free to truncate the value to a reasonable
length.
When updating a club person contact, providing an address, emails and telephones is required. You need to provide the full contact details, including the full address, all telephones and all emails. Any value that is omitted is deleted.
For every update, a club_person_contact event is triggered, with the
club_id and person_id of the club person.
clubId: ID!, personId: ID! → ClubPersonContact!
clubId: ID! — Federation reference id of the club, EG XX11AA01.personId: ID! — ID of the person, EG "J82SC4X".clubId: ID!, params: ClubPersonContactInput!, personId: ID! → ClubPersonContact!
Replace a person's contact details for a club all at once. Be sure to submit all values, any omitted value will be deleted.
clubId: ID! — Federation reference id of the club, EG "XX11AA01".params: ClubPersonContactInput! — All changes at once.personId: ID! — ID of the person, EG "J82SC4X".clubId: ID! — Federation reference id of the club, EG "XX11AA01".personId: ID! — ID of the person, EG "J82SC4X".legacyEmail: String — Old e-mail address as provided by legacy APIs like updatePersonContact.
Will be NULL if updateClubPersonContact is called once.
Unlike emails.value, legacyEmail is just plain text and its value
is not guaranteed to be an actual e-mail address.legacyTelephone: String — Old telephone number as provided by legacy APIs like updatePersonContact.
Will be NULL if updateClubPersonContact is called once.
Unlike telephones.value, legacyTelephone is just plain text and its
value is not guaranteed to be a telephone number.emails: [ClubPersonContactValue!]! — An array of label/value pairs where the value must be a value that
somewhat resembles an e-mail address. This list is sorted by order it was
submitted using updateClubPersonContact where the most significant e-mail
address is the first value.
If updateClubPersonContact is never called, this list will be empty.telephones: [ClubPersonContactValue!]! — An array of label/value pairs where the value must be a E.164
formatted telephone number. This list is sorted by order it was submitted
using updateClubPersonContact where the most significant telephone number
is the first value.
If updateClubPersonContact is never called, this list will be empty.address: ClubPersonContactAddress — This person's address. Note that even though submitting an address in
updateClubPersonContact is required, technically it is possible for the
address to be NULL.emails: [ClubPersonContactValueInput!]! — An array of label/value pairs where the value must be a value that
somewhat resembles an e-mail address. This list's order will be saved, where
the first value is considered to be the most significant.telephones: [ClubPersonContactValueInput!]! — An array of label/value pairs where the value must be a E.164
formatted telephone number. This list's order will be saved, where the first
value is considered to be the most significant.address: ClubPersonContactAddressInput! — This person's address.Uncategorized & undocumented calls
id: ID! → Club!
Get a single club. Attempting to fetch dissolved or deleted clubs rejects with ClubNotFound
id: ID! — Federation reference id of the club, EG XX11AA01Club!category: ID!, clubId: ID!, now: Instant → ClubEmail
category: ID! — ID of the role category. Only role categories with club_staff_assignable
permission can be used.clubId: ID! — Federation reference id of the club, EG XX11AA01.now: Instant — deprecated — Will use the current date and time at all times. This field is ignored.clubId: ID!, now: Instant → [ClubEmail!]!
clubId: ID! — Federation reference id of the club, EG XX11AA01.now: Instant — deprecated — Will use the current date and time at all times. This field is ignored.[ClubEmail!]!clubId: ID!, seasonId: ID!, status: [String] → [ClubMatch!]!
[ClubMatch!]!no args → [Club!]!
Get all active (non-dissolved) clubs
[Club!]!no args → [District!]!
Get all active districts
[District!]!clubId: ID! → [Facility!]
Get all facilities by club id
clubId: ID! — Federation reference id of the club, EG XX11AA01. Club must be active.[Facility!]clubId: ID!, id: ID! → Facility!
Get a facility by club id & facility ID.
clubId: ID! — Federation reference id of the club, EG XX11AA01. Club must be active.id: ID! — Rejects with FacilityNotFound if facility does not exist within this clubclub: String!, facility: ID! → [FacilityField!]!
[FacilityField!]!clubId: ID!, validAt: DateTimeTz → [ClubMember!]!
Get all members of a club at a given point in time
clubId: ID! — Club ID. See clubsvalidAt: DateTimeTz — deprecated — Point in time to get members from. This field is ignored, will always use
current datetime.[ClubMember!]!birthDate: LocalDate!, familyName: String!, givenName: String, initials: Initials! → [Person!]!
Get a list of person IDs by givenName, initials, family name and birth date. Will not include deceased people. Note that creating a person might trigger a PersonAlreadyExists error when creating a person even though this call returns no people with the same givenName, initials, familyName or birthDate.
There is no call to reliably check whether createPerson will succeed or not.
If givenName is omitted, givenName is ignored and all matching people will be returned.
birthDate: LocalDate! — Person's date of birthfamilyName: String! — Person's family- or surnamegivenName: String — Person's first name, or given name. EG 'Paul'. This field is nullable for
backwards compatibility reasons, but any blank value will be rejected.initials: Initials! — Person's initials. Must contain only uppercase letters[Person!]!clubId: ID!, now: DateTimeTz → [RefereePerson!]!
Get a list of person ids for roles having the RF category in a club
clubId: ID! — Fetch roles for this clubnow: DateTimeTz — Ignored and deprecated[RefereePerson!]!no args → [RoleCategory!]!
Get all role categories
[RoleCategory!]!categoryId: ID, clubId: ID, personId: ID, validAt: DateTimeTz → [Role!]!
Fetch all roles for a club or person. You must at least filter by clubId or personId.
categoryId: ID — Optionally filter roles by category id. Should be a role category with
'club_assignable' permission.clubId: ID — Filter roles by club idpersonId: ID — Filter roles by person idvalidAt: DateTimeTz — deprecated — Optionally only return roles active at this point in time.
If omitted, the current date/time is used.[Role!]!no args → [SportType!]!
Get sport-types
[SportType!]!validAt: DateTimeTz → [StaffMemberPerson!]!
Get all staff member people from all clubs, valid at a given point in time.
This call returns alive people with at least one active role with role category having the 'club_staff_assignable' permission. A person is only returned once for one club, even if the person is a staff member in multiple clubs.
staffMemberPeople attempts to fetch contact info for the person.
validAt: DateTimeTz — Ignored and deprecatedteamId: ID!, clubId: ID, date: LocalDate, seasonId: ID, sportTypeId: ID → [TeamPlayer!]!
Get a list of team players in a team. Because a team can only be uniquely identified by teamId, clubId and sportTypeId, these 3 fields are all required.
teamId: ID! — Fetch players from this team's id. EG 'MD1' (if clubId & sportTypeId
are included) or '1234' (without clubId or sportTypeId)clubId: ID — deprecated — Fetch players from the team found in this club.date: LocalDate — deprecated — Fetch team players active on this dayseasonId: ID — deprecatedsportTypeId: ID — deprecated — Fetch players from the team found with this sporttype[TeamPlayer!]!teamId: ID!, clubId: ID, seasonId: ID, sportTypeId: ID, validAt: DateTimeTz → [TeamRole!]!
Get all active team roles in a team by club, sportType and team id,for role categories with permission 'team_assignable'.
teamId: ID!clubId: ID — deprecatedseasonId: ID — deprecatedsportTypeId: ID — deprecatedvalidAt: DateTimeTz — deprecated[TeamRole!]!clubId: ID!, seasonId: ID!, sportTypeId: ID! → [TeamSubmissionTeam!]!
Find a team submission by season, club and sporttype and return its submitted teams.
clubId: ID, seasonId: ID, sportTypeId: ID → [Team!]!
Get a list of teams by club and sportType
clubId: ID — Fetch teams for this club. If NULL or omitted, all teams are returned.seasonId: ID — Only fetch teams active in this season. If NULL or omitted, all teams
are returned.sportTypeId: ID — Fetch teams for this sport type. If NULL or omitted, all teams are
returned.[Team!]!input: PersonInput! → ID!
Create a person for the given params. Rejects with PersonAlreadyExists error if:
Returns the created person's ID.
input: PersonInput!ID!categoryId: ID!, clubId: ID!, personId: ID!, reason: String, siteVisibility: RoleSiteVisibility, public: Boolean, validFrom: DateTimeTz → Role!
Ensure a role is active for a person in a club with a certain role category. In addition to ensuring the role is active, siteVisibility is updated. The person must be an active member of that club in the given point in time. The person must be alive, and the club must not be dissolved. The updated or created role is returned, or the call is rejected with an error.
categoryId: ID! — A role category id with 'club_assignable' permission. See roleCategoriesclubId: ID! — Club ID for the new role. See clubspersonId: ID! — Person ID for the new role. See peoplereason: String — Optional reason why you're creating this role.siteVisibility: RoleSiteVisibility — Whether this role should be published on KNHB.nl. See RoleSiteVisibility
for behavior per value.public: Boolean — deprecated — Whether this role should be published on KNHB.nl. If false, this role will
not be published. If true, this role will be published together with
either an e-mail set using updateClubEmail of updatePersonContact.
For forward compatibility (public is deprecated), replace public=false
with siteVisibility=NONE and public=true with
siteVisibility=ROLE_ANY_CONTACT.validFrom: DateTimeTz — deprecated — No longer usedRole!categoryId: ID!, personId: ID, teamId: ID!, clubId: ID, seasonId: ID, sportTypeId: ID, validFrom: DateTimeTz → TeamRole!
Ensure a team role with this role category is active from validFrom for a person in a team. Returns one of the team roles affected.
categoryId: ID!personId: IDteamId: ID!clubId: ID — deprecatedseasonId: ID — deprecatedsportTypeId: ID — deprecatedvalidFrom: DateTimeTz — deprecatedcategory: ID!, clubId: ID!, now: Instant → ClubEmail!
Remove an e-mail address by club id and category id from a point in time. Returns any deleted e-mail.
category: ID! — ID of the role category. Only role categories with club_staff_assignable
permission can be used.clubId: ID! — Federation reference id of the club, EG XX11AA01.now: Instant — deprecated — Will use the current date and time at all times. This field is ignored.clubId: ID!, personId: ID!, validTo: DateTimeTz → Boolean!
Ensure a member is no longer active from a point in time by removing active open memberships.
In addition to ending memberships, all active team players and roles are also ended at the same point in time. This is not reversible, but one could create the members, roles and team players.
This operation always returns true, or rejects with error.
clubId: ID! — Club ID. See clubspersonId: ID! — Person ID. See peoplevalidTo: DateTimeTz — deprecated — The membership will be no longer valid at this point in time. This field
is ignored, will always use current datetime.categoryId: ID!, clubId: ID!, personId: ID!, reason: String, public: Boolean, validTo: DateTimeTz → Role!
categoryId: ID! — A role category id with 'club_assignable' permission. See roleCategoriesclubId: ID! — Club ID for the new role. See clubspersonId: ID! — Person ID for the new role. See peoplereason: String — Optional reason why you're deleting this role.public: Boolean — deprecated — This field makes absolutely no sense and is ignored.validTo: DateTimeTz — deprecated — No longer usedRole!categoryId: ID!, personId: ID, teamId: ID!, clubId: ID, seasonId: ID, sportTypeId: ID, validTo: DateTimeTz → TeamRole!
Ensure a team role with this role category is no longer active from validTo for a person in a team. Returns one of the team roles deleted, or rejects with RoleNotFound if no role exists.
categoryId: ID!personId: IDteamId: ID!clubId: ID — deprecatedseasonId: ID — deprecatedsportTypeId: ID — deprecatedvalidTo: DateTimeTz — deprecatedpersonId: ID!, teamId: ID!, clubId: ID, endDate: LocalDateOrDateTimeTz, seasonId: ID, sportTypeId: ID → TeamPlayer!
Ensure there is no active team player for the given team (by sporttype, club and team) and member (by person id & club id) by updating all active team players with the given enddate.
personId: ID!teamId: ID!clubId: ID — deprecatedendDate: LocalDateOrDateTimeTz — deprecatedseasonId: ID — deprecatedsportTypeId: ID — deprecateddate: LocalDateOrDateTimeTz!, id: ID! → Boolean!
Notify a person is no longer alive. This operation is final and cannot be undone.
Upon this call, the person's decease-date is logged, and all relations are ended at the given date. Memberships (members), Roles (teamRoles, roles), Contacts (updatePersonContact) and team players (teamPlayers) are all ended, deleted or removed permanently.
After this call, referring the deceased person in any other API call will reject with PersonDeceased error, and all other API calls will never include any deceased person or relation of a deceased person.
date: LocalDateOrDateTimeTz!id: ID!clubId: ID!, personId: ID!, validFrom: DateTimeTz → Boolean!
Ensure a member is active from a point in time Rejects with MemberIntersection or MemberAlreadyActive error if another membership is already active at that point in time.
This operation always returns true, or rejects with error.
clubId: ID! — Club ID. See clubspersonId: ID! — Person ID. See peoplevalidFrom: DateTimeTz — deprecated — The membership will be valid from this point. This field is ignored, will
always use current datetime.jerseyNumber: Int, personId: ID!, position: Int, teamId: ID!, clubId: ID, seasonId: ID, sportTypeId: ID, startDate: LocalDateOrDateTimeTz → TeamPlayer!
Ensure a person is member of a team in a club, and update it's jerseyNumber and position. Unless the target team is in a poule period category one of D7 DB DVW DW H7 HB HW XB XW, all existing team players for the same person (even in other clubs) are ended. Using startTeamPlayer to update the jerseyNumber of position will reset the startDate. Given person must be an active member of the club.
jerseyNumber: IntpersonId: ID!position: IntteamId: ID!clubId: ID — deprecatedseasonId: ID — deprecatedsportTypeId: ID — deprecatedstartDate: LocalDateOrDateTimeTz — deprecatedid: ID!, input: UpdateClubInput! → Club!
Update a non-dissolved club. Will fail with ClubNotFound when trying to update non-dissolved club. For other possible failures, see UpdateClubInput.
id: ID! — Federation reference id of the club, EG XX11AA01input: UpdateClubInput! — Params to updateClub!category: ID!, clubId: ID!, email: String, public: Boolean, name: String, now: Instant, publicEmail: Boolean → ClubEmail!
Set or update an e-mail address for a given role category in a club. If an e-mail address is already active for the same club and role category, it will be deactivated from the given timestamp.
category: ID! — ID of the role category. Only role categories with club_staff_assignable
permission can be used.clubId: ID! — Federation reference id of the club, EG XX11AA01. Club must be active.email: String — E-mail to set. Club API will not attempt validate or verify the e-mail
address. The e-mail address might exposed in other API calls or other
APIs. To set exposure on KNHB.nl, use public=true or false.public: Boolean — When true, the e-mail might be shown on KNHB.nl.
When false or omitted, the e-mail is guaranteed to be NOT shown on KNHB.nl.
If a person role exists within the club with the same role category, that
person's name might be used with this e-mail. See createRole.name: String — deprecated — This field is ignored and will be removed in the future.now: Instant — deprecated — Will use the current date and time at all times. This field is ignored.publicEmail: Boolean — deprecated — This field is ignored and will be removed in the future.clubId: ID!, facilityId: ID!, input: UpdateContactInput!, now: DateTimeTz → Boolean!
Update one or more properties of a facility's contact info. Only changed properties are updated. To explicitly unset a property, use NULL. Always returns TRUE, renders an error otherwise.
clubId: ID! — Federation reference id of the club, EG XX11AA01. Club must be active.facilityId: ID! — Federation reference id of the person, EG 123.input: UpdateContactInput! — The new contact info properties.now: DateTimeTz — deprecated — The new contact info will be active from this point in time.clubId: String!, description: String!, seasonId: String!, sportTypeId: String!, teams: [JuniorTeamSubmissionTeamInput!]! → JuniorTeamSubmission!
Create or update a junior team submission with a complete set of teams
clubId: String! — ID of club. See clubsdescription: String! — Description of this team submission. Usually left blankseasonId: String! — ID of season. See seasonssportTypeId: String! — ID of sport type. See sportTypesteams: [JuniorTeamSubmissionTeamInput!]! — List of teams in this submissionclub: String, facility: ID, field: ID, id: ID!, input: UpdateMatchInput! → Match!
id: ID!, input: PersonInput! → Boolean!
Update a person by a subset of params. Only provided params are updated. Person must be alive to be updated.
id: ID!input: PersonInput!clubId: ID!, input: UpdateContactInput!, personId: ID!, now: DateTimeTz → Boolean!
Update one or more properties of a person's contact info. Only changed properties are updated. To explicitly unset a property, use NULL. Always returns TRUE, renders an error otherwise.
clubId: ID! — Federation reference id of the club, EG XX11AA01. Club must be active.input: UpdateContactInput! — The new contact info properties.personId: ID! — Federation reference id of the person, EG X11X11. Person must be alive.now: DateTimeTz — deprecated — The new contact info will be active from this point in time.id: ID!name: String!abbreviation: Stringdistrict: Stringwebsite: Stringhomekit: Stringawaykit: Stringemail: StringpaymentMethods: StringwaterPitches: IntsemiWaterPitches: IntsandPitches: IntjerseyPictureUrl: StringlogoPictureUrl: Stringfacebook: Stringtwitter: Stringinstagram: Stringyoutube: StringrouteInformation: StringparkingInformation: Stringtelephone: Stringdescription: StringfoundingDate: LocalDatedissolvingDate: LocalDateid: ID!date: LocalDateTime!subfield: StringfacilityId: IDhomeTeam: ClubMatchTeam!awayTeam: ClubMatchTeam!pouleId: IDofficialRemarks: Stringstatus: StringhomeScore: IntawayScore: IntfacilityOfficialClubId: IDfacilityFieldId: IDmatchCode: StringhomeShootoutScore: IntawayShootoutScore: IntisMutable: Boolean!category: ClubMatchCategoryperiod: ClubMatchPeriodpouleClass: ClubMatchPouleClasscompetition: ClubMatchCompetitionA deprecated, ISO datetime with timezone. Format must match exactly
"2018-12-25 23:59:59+01:00".
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
undefined
MALE — This person identifies as maleFEMALE — This person identifies as femaleUNKNOWN — This person's gender is unknown or kept privateOTHER — This person identifies as neither male or femaleThe ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
undefined
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
undefined
sportTypeId: String!clubId: String!seasonId: String!description: String!teams: [JuniorTeamSubmissionTeam!]!A deprecated, lossy input date-timeformat, either a
DateTimeTz or a LocalDate. Providing a
LocalDate is not recommended, but supported due to backwards compatibility.
A ISO local datetime. Format must match exactly "2018-12-25T23:59:59".
Seconds can be omitted if they're ":00".
Note the absense of a timezone or offset. The local date & time represents the
calendar date and wall time relevant to the associated location. IE if a match
date is "2018-12-25T14:00" in the Netherlands (Europe/Amsterdam, GMT+01:00),
the match is played at "2018-12-25T13:00:00Z".
The timezone or offset is usually implied from the location. Unless specified, it is usually Europe/Amsterdam.
categoryId: IDpersonId: IDclubId: ID!validFrom: DateTimeTzvalidTo: DateTimeTzpublic: BooleansiteVisibility: RoleSiteVisibility!NONE — This person role is never returned by ApiClubControl.clubs and therefore not
shown on knhb.nl. This is the default behavior, and this is equal to public=falseONLY_ROLE — This person role is returned but contact info is never shown, even if public
contact info is presentROLE_CLUB_EMAIL — This person role is returned with club email for the same club & role category
if present. Otherwise, only the role is returnedROLE_PERSON_CONTACT — This person role is returned with latest person contact if that person
contact is public. Otherwise, only the role is returned.ROLE_ANY_CONTACT — Combines ROLE_CLUB_EMAIL and ROLE_PERSON_CONTACT to fetch either a public
club email or public person contact, whichever is available.
This value is equal to public=trueThe String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
undefined
name: Stringabbreviation: Stringdistrict: Stringwebsite: Stringhomekit: Stringawaykit: Stringemail: StringpaymentMethods: StringwaterPitches: IntsemiWaterPitches: IntsandPitches: IntjerseyPictureUrl: StringlogoPictureUrl: Stringfacebook: Stringtwitter: Stringinstagram: Stringyoutube: StringrouteInformation: StringparkingInformation: Stringtelephone: Stringdescription: StringfoundingDate: LocalDatedissolvingDate: LocalDateA Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.
In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.
undefined
A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.
undefined
One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.
undefined
Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.
undefined
Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.
undefined
A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.
undefined
The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the __TypeKind enum.
Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.
undefined