Examples
Sections
- Authentication
- Returns all addresses for a member
- Updates an address record for a member
- Returns all contact information for a member
- Updates contact information for a member
- Returns all emergency contact details for a member
- Create an emergency contact for a member
- Updates an emergency contact record
- Delete an emergency contact record
- Returns online consent, privacy policy, signed date of terms and conditions and health commitment along with gdpr consent preferences for a member
- Updates online consent and privacy policy details. you cannot update a members campaign consent, these can only be added or removed. date and times should be utc
- Give consent to a member to receive information about marketing or data processing campaigns
- Give consent to a member to receive information by various types of communication methods
- Gets all documents associated with a given member.
- Uploads a document that will be associated with a given member. a form data request is expected with a 'file' parameter (with the value of the file being uploaded) and a 'json' parameter (with the value of the json request)
- Gets a link to a specific document based on a given member and document id.
- Uploads a templated document that will be associated with a given member. the request contains the template type as well as placeholders required to populate the template.
- Uploads a templated confirmed direct debit document that will be associated with a given member.
- Generates unconfirmed document of type direct debit mandate for the given member.
- Gets all form profiles. if a form type id filter is provided then only form profiles associated with the form type will be returned.
- Creates a form profile for the given form type identifier.
- Gets a form profile by id. optionally pass in an array of membership type ids which will filter user fields that are assigned.
- Updates a form profile
- Deletes a form profile
- Returns all identifiers for a member and their type such as card, smartband, keyfob etc
- Create primary and additional identifiers for a member
- Deletes an identifier associated with a member whether it is a primary or an additional identifier type
- Delete an additional method of identification for a member
- Returns all membership type groups
- Creates a membership type group
- Returns a membership type group by id
- Updates a membership type group <param name="id" example="member">the id of the membership type group to update.</param><param name="request">the request for updating a membership type group.</param>
- Deletes a membership type group
- Returns a membership type based on the id.
- Updates the tags that are assigned to a membership type based on the id.
- Updates the imageref for the given membership type id.
- Returns basic details of all membership types.
- Retrieve the best suited price level
- Updates the document types that are assigned to a membership type based on the id.
- Updates the capacity and price level restrictions for a membership type.
- /api/configuration/membership-types/{id}/restrictions
- /api/members/{memberid}/bookings/{bookingid}
- Gets a members past-bookings, this is similar to get booking-history but returns a smaller response. endpoint will return any bookings within date range supplied. if no date range is supplied than all past bookings are returned. if only a datetimefrom is supplied then all past bookings from that date time will be returned. if only a datetimeto is supplied then all past bookings before that date time will be returned.
- Gets a members past-bookings, this is similar to get booking-history but returns a smaller response. endpoint will return any bookings within date range supplied. the results are paginated and meta data with navigation urls are provided. if no date range is supplied then all past bookings are returned. if only a datetimefrom is supplied then all past bookings from that date time will be returned. if only a datetimeto is supplied then all past bookings before that date time will be returned. if no limit is supplied then this will default to 10 records. if no offset is supplied then this will default to 0 (the first page). start and end urls in meta data provide navigation for pagination. in swagger, it just provides query params to be added to url.
- Deletes memberships allocated to a given member.
- List memberships and next payment information
- Removes access for a secondary member to all the shared memberships between this member and the primary member
- Adds access for a secondary member to all the shared memberships belonging to the primary member.
- Returns all basic profile details for a member
- Updates basic profile details for a member
- Deletes a member and all related records
- /api/members/profiles
- Create a member with a basic profile
- Confirms a previously unconfirmed member creation, triggering further business rules that were skipped at creation.
- Get progress of members profile
- Update a members profile progress
- Returns the configuration value for the specified configkey and siteid
- Update the system configuration for a specific configuration key
- Returns all system configuration for the given group ids
- Returns all the configuration groups for system configuration
- List all allowed languages
- Updates system configuration for a specified group id