SwimClub Manager
            Help Center SwimClub Manager General

            API documentation

            The SwimClub Manager API allows you to create applications that can read/update information in your SCM account.

            Each request to the Api must be authenticated with your Api token using an "Authorization-Token" header containing your token.

            For Example:

            Authorization-Token: 6846a9d9eadc4c8bbeae5a1b672309d1
            Content-Type: application/json
            {
                "Firstname""Joseph",
                "Lastname""Bloggs",
                "KnownAs""Jo",
                ...
            }

            When using the authentication token you do not require any additional password.

            Important

            You must treat your Api token as you would treat your login username and password. Anyone that has your Api token can post to the Api on your behalf! If you suspect someone has your Api token you can reset it via the "Setup > Club > Club Details" page link.

            For POST requests, a content-type header of application/json must be included and the body of the request should be valid json in the same format as what is returned in a GET request.

            GET requests are returned in pages of 100. Add a request header or querystring value of "Page = x" to request any page other than the first.

            The number of API calls in a 24 hour period is limited to 5000. You can check your current rate limit status by looking at the "X-Ratelimit-Remaining" HTTP header which is returned in response to every API request.


            Club Events

            Overview

            URLhttps://app.swimclubmanager.co.uk/api/ClubEvents
            Methods SupportedPOST, GET
            DescriptionAllows you to create or get club events in an SCM account

            Elements For Club Events

            GuidThe club event unique id in the system (read only)
            EventTitle requiredThe title of the event (max length = 50)
            EventDetailsThe details of the event (optional max length = 4000)
            EventStartDate requiredThe start date of the event (yyyy-mm-dd format)
            EventStartTime requiredThe start time of the event (24hr format)
            EventEndDate requiredThe end date of the event (yyyy-mm-dd format)
            EventEndTime requiredThe end time of the event (24hr format)
            BusProvidedIs a bus provided? (1 or 0)
            BusSeatsHow many seats on the bus? (number)
            BusDepartureDateThe departure date of the bus (optional yyyy-mm-dd format)
            BusDepartureTimeThe departure time of the bus (optional 24hr format)
            CalendarColourThe colour of the event on the club calendar (0, B, G, O, R, Y, Pu, Gr, Pi, N, T)
            EventVenueThe venue of the event (optional max length = 50)
            Address1The address line 1 of the event (optional max length = 50)
            Address2The address line 2 of the event (optional max length = 50)
            Address3The address line 3 of the event (optional max length = 50)
            Address4The address line 4 of the event (optional max length = 50)
            PostcodeThe postcode of the event (optional max length = 50)
            FeeThe fee per event for swimmers (optional decimal)
            RelayFeeThe fee per relay event for swimmers (optional decimal)
            PoolThe pool size optional (20m, 25m, 33m, 50m, OW)
            AgeOnDateThe age on date for the event (optional yyyy-mm-dd format)
            MeetCodeThe meet code for the event (optional max length = 50)
            SessionNumberThe session number of the event (optional max length = 50)
            LicenceNumberThe licence number of the event (optional max length = 50)
            EntryCloseDateThe closing date for entries (optional yyyy-mm-dd format)
            SwimTimesAny associated swim times for the event (read only)

            GET Club Event

            To get a Club Event, use the following URL where {guid} is the Guid of the Club Event:

            Data Returned

            When you GET a Club Event, the following JSON will be returned:

            {
                "Guid""f6e21c87-1581-4aa6-a15a-791874b1eddf",
                "EventTitle""Club champs",
                "EventDetails""",
                "EventStartDate""2016-05-14",
                "EventStartTime""09:00",
                "EventEndDate""2016-05-14",
                "EventEndTime""19:00",
                "SwimTimes": [
                    {
                        "Time""00:28.65",
                        "Distance""50m",
                        ...
                    },
                    ...
                ]
                ...
            }


            When you POST a new Club Event, the api will return a JSON object with the Club Event's details.


            Incident Book

            Overview

            URLhttps://app.swimclubmanager.co.uk/api/IncidentBook
            Methods SupportedPOST, GET
            DescriptionAllows you to create or get incidents in an SCM account

            Elements For Incodents

            GuidThe incident unique id in the system (read only)
            IncidentTitle requiredThe title of the incident (max length = 50)
            IncidentDate requiredThe date of the incident (yyyy-mm-dd format)
            IncidentDetailsThe details of the incident (optional max length = 4000)
            ProposedActionThe proposed action for the incident (optional max length = 4000)
            Status requiredThe status of the incident (Open, In Progress, On Hold, Closed)
            AddedBy requiredThe member that added the incident
            CommentsAny comments made to the incident (read only)

            GET Incident

            To get an Incident, use the following URL where {guid} is the Guid of the Incident:

            Data Returned

            When you GET an Incident, the following JSON will be returned:

            {
                "Guid""f6e21c87-1581-4aa6-a15a-791874b1eddf",
                "IncidentTitle""Banged head on pool wall",
                "IncidentDate""2016-05-14",
                "IncidentDetails""...",
                "ProposedAction""...",
                "Status""Closed",
                "AddedBy": [
                    {
                        "Guid""46C33DEC-3D26-4151-A8CE-38B152DE2A16",
                        "Firstname""Joseph",
                        "KnownAs""Jo",
                        "Lastname""Bloggs"
                    }
                ],
                "Comments": [
                    {
                        "DateAdded""2016-05-14",
                        "Comment""Sent email",
                        "Firstname""Joseph",
                        "KnownAs""Jo",
                        "Lastname""Bloggs"
                    },
                    ...
                ]
                ...
            }

            When you POST a new Incident, the api will return a JSON object with the Incident's details.


            Meets

            Overview

            URLhttps://app.swimclubmanager.co.uk/api/Meets
            Methods SupportedGET
            DescriptionAllows you to get meets in an SCM account

            Elements For Meets

            GuidThe meet unique id in the system (read only)
            MeetNameThe name of the meet (max length = 50)
            FacilityThe location of the meet (optional max length = 50)
            TypeThe type of meet (Open Meet, Team Gala, Club Champs, Turn Up and Swim)
            StartDateThe start date of the meet (yyyy-mm-dd format)
            EndDateThe end date of the meet (yyyy-mm-dd format)
            AgeUpDateThe age up date of the meet (yyyy-mm-dd format)
            EligibilityDateThe eligibility date of the meet (yyyy-mm-dd format)
            EntryOpenDateThe entry open date of the meet (yyyy-mm-dd format)
            EntryDeadlineThe entry deadline date of the meet (yyyy-mm-dd format)
            StreetThe street address of the meet (optional max length = 50)
            Address2The address line 2 of the meet (optional max length = 50)
            CityThe city of the meet (optional max length = 50)
            CountyThe county of the meet (optional max length = 50)
            PostCodeThe post code of the meet (optional max length = 50)
            CountryThe country of the meet (optional max length = 50)
            SwimTimesAddedSwim times have been added (optional 1 or 0)
            SwimTimesVerifiedSwim times have been verified (optional 1 or 0)
            SwimTimesAny associated swim times for the meet (read only)

            GET Meet

            To get a Meet, use the following URL where {guid} is the Guid of the Meet:

            Data Returned

            When you GET a Meet, the following JSON will be returned:

            {
                "Guid""f6e21c87-1581-4aa6-a15a-791874b1eddf",
                "MeetName""Droitwich Champs",
                "Facility""Leisure Centre",
                "Type""Open Meet",
                "StartDate""2016-05-14",
                "EndDate""2016-05-14",
                ...
                "SwimTimes": [
                    {
                        "Time""00:28.65",
                        "Distance""50m",
                        ...
                    },
                    ...
                ]
                ...
            }

            Trial Requests

            Overview

            URLhttps://app.swimclubmanager.co.uk/api/TrialRequests
            Methods SupportedPOST, GET
            DescriptionAllows you to create or get trial requests in an SCM account

            Elements For Trial Requests

            GuidThe trial request unique id in the system (read only)
            DateAddedThe read only date the trial request was added (yyyy-mm-dd format)
            FirstName requiredThe first name of the trial requester (max length = 50)
            LastName requiredThe last name of the trial requester (max length = 50)
            Dob requiredThe date of birth of the trial requester (yyyy-mm-dd format)
            GenderThe trial requester's gender (M or F)
            EmailThe trial requester's email address (max length = 50)
            SwimmingExperienceThe swimming experience of the trial requester (max length = 4000)

            GET Trial Request

            To get a Trial Request, use the following URL where {guid} is the Guid of the Trial Request:

            Data Returned

            When you GET a Trial Request, the following JSON will be returned:

            {
                "Guid""f6e21c87-1581-4aa6-a15a-791874b1eddf",
                "Firstname""Jo",
                "Lastname""Bloggs",
                "Dob""1999-06-12",
                "Email""email@domain.com",
                ...
            }

            When you POST a new Trial Request, the api will return a JSON object with the Trial Request's details.


            Users (members)

            Overview

            URLhttps://app.swimclubmanager.co.uk/api/Users
            Methods SupportedPOST, GET, PUT, DELETE
            DescriptionAllows you to create (POST), get (GET), update (PUT) or archive (DELETE) users in an SCM account

            Elements For Users

            GuidThe user's unique id in the system (read only)
            MemberIDThe member ID of the user (max length = 50)
            Firstname requiredThe first name of the user (max length = 50)
            KnownAsThe name the user is known as if different from Firstname (max length = 50)
            Lastname requiredThe last name of the user (max length = 50)
            PrimaryContactNameThe primary contact for the user (max length = 50)
            RelationshipToMemberThe relationship to the user (max length = 50)
            HomePhoneThe user's home phone number (max length = 50)
            MobilePhoneThe user's mobile phone number (max length = 50)
            EmailThe user's email address (max length = 50)
            DOBThe user's date of birth (yyyy-mm-dd format)
            GenderThe user's gender (M or F)
            EthnicityThe user's ethnicity Use ASA Ethnicity codes
            Address1The user's address 1 (max length = 50)
            Address2The user's address 2(max length = 50)
            Address3The user's address 3 (max length = 50)
            TownThe user's town (max length = 50)
            CountyThe user's county (max length = 50)
            PostcodeThe user's postcode (max length = 50)
            EmergencyContactPerson1The user's emergency contact person 1 (max length = 50)
            EmergencyContactPhone1The user's emergency contact phone 1 (max length = 50)
            EmergencyContactPerson2The user's emergency contact person 2 (max length = 50)
            EmergencyContactPhone2The user's emergency contact phone 2 (max length = 50)
            DetailsConfirmedCorrectThe date the user confirmed their details were correct (yyyy-mm-dd format)
            LastModifiedDateThe date the user was last modified (yyyy-mm-dd format)
            ActiveThe user's active status (1 or 0)
            DateJoinedClubThe date the user joined your club (yyyy-mm-dd format)
            ASANumberThe user's asa number (max length = 50)
            AsaCategoryThe user's asa category (max length = 50)
            CountryOfRepresentationThe user's country of representation (max length = 50)
            IsASwimmerIf the user is a swimmer (1 or 0)
            IsAVolunteerIf the user is a volunteer (1 or 0)
            IsACoachIf the user is a coach (1 or 0)
            IsAParentIf the user is a parent (1 or 0)
            CommitteeMemberIf the user is on the committee (1 or 0)
            JobTitleThe user's job title at the club (max length = 50)
            CompetitiveDivingPassedThe date the user passed competitive diving (yyyy-mm-dd format)
            SwimsForOtherClubThe name of another club the user swims for (max length = 100)
            LocoParentisRightsThe date loco parentis rights were given (yyyy-mm-dd format)
            ConsentToTravelThe date consent to travel was given (yyyy-mm-dd format)
            ConsentImageUseThe date consent to image use was given (yyyy-mm-dd format)
            ConsentVideoUseThe date consent to video use was given (yyyy-mm-dd format)
            SchoolAttendedThe school the user attended (max length = 50)
            LastClubDisclaimerAcknowledgedThe date the user last acknowledged a club disclaimer (yyyy-mm-dd format)
            DateLeftThe date the user left the club (yyyy-mm-dd format)
            NotesAny notes pertaining to the user (max length = 4000)
            MedicalHistoryAny medical history pertaining to the user (max length = 4000)
            AllergiesAny allergies the user has (max length = 4000)
            DisabilityDetailsAny disabilities the user has (max length = 4000)
            DoctorThe user's doctor (max length = 50)
            DoctorAddressThe user's doctor's address (max length = 50)
            DoctorPhoneThe user's doctor's phone number (max length = 50)
            DBSDateThe user's DBS date (yyyy-mm-dd format)
            DBSRenewalDateThe user's DBS renewal date (yyyy-mm-dd format)
            DBSCertificateNumberThe user's DBS certificate number (max length = 50)
            SafeguardingDateThe user's Safeguarding date (yyyy-mm-dd format)
            SafeguardingRenewalDateThe user's Safeguarding renewal date (yyyy-mm-dd format)
            UsernameThe user's login username (max length = 50)
            PasswordThe user's login password (max length = 50)
            LastLoggedInThe date the user last logged in (yyyy-mm-dd format - Read Only)
            InvoiceDiscountPercentThe user's invoice discount if applicable number to 2 decimal places
            SessionRestrictionsA list of Session Guids that the user is restricted to
            ParentsA list of User Guids of the swimmer's parents
            SwimmersA list of User Guids of the parent's swimmers

            GET User

            To get a User, use the following URL where {guid} is the Guid of the User:

            Data Returned

            When you GET a User, the following JSON will be returned:

            {
                "Guid""85525b05-ef52-4997-9f50-6ed0539d37b0",
                "Firstname""Lakesha",
                "Lastname""Wilson",
                "KnownAs""",
                "Dob""2002-12-03",
                "Gender""F",
                "Address1""2 Scotsburn Rd",
                "Address2""",
                "Address3""",
                "Town""",
                "City""TALERDDIG",
                "Postcode""SY19 8FF",
                ...                        
            }

            When you POST a new User, the api will return a JSON object with the User's details.The password field will always be blank.


            Waiting List

            Overview

            URLhttps://app.swimclubmanager.co.uk/api/WaitingList
            Methods SupportedPOST, GET
            DescriptionAllows you to get (GET), create (POST) waiting list members in an SCM account

            Elements For Waiting List

            GuidThe person's unique id in the system (read only)
            DateAdded requiredThe first name of the person (yyyy-mm-dd format)
            Firstname requiredThe first name of the person (max length = 50)
            Lastname requiredThe last name of the person (max length = 50)
            DOBThe person's date of birth (yyyy-mm-dd format)
            GenderThe person's gender (M or F)
            EmailThe person's email address (max length = 50)
            Address1The person's address 1 (max length = 50)
            Address2The person's address 2(max length = 50)
            Address3The person's address 3 (max length = 50)
            TownThe person's town (max length = 50)
            CountyThe person's county (max length = 50)
            PostcodeThe person's postcode (max length = 50)
            HomePhoneThe person's home phone number (max length = 50)
            MobilePhoneThe person's mobile phone number (max length = 50)
            PreviousExperienceThe person's previous experience (max length = 4000)
            NotesAny relevant notes (max length = 4000)
            DateLastEmailedThe date the person was last emailed (read only)
            DateConvertedToMemberThe date the person was converted to a member (read only)

            GET Waiting List

            To get a Waiting List, use the following URL where {guid} is the Guid of the Waiting List person:

            Data Returned

            When you GET a Waiting List, the following JSON will be returned:

            {
                "Guid""85525b05-ef52-4997-9f50-6ed0539d37b0",
                "Firstname""Lakesha",
                "Lastname""Wilson",
                "DOB""2002-12-03",
                "Gender""F",
                "Email""jo@bloggs.com",
                "Address1""2 Scotsburn Rd",
                "Address2""",
                "Address3""",
                "Town""",
                "City""TALERDDIG",
                "Postcode""SY19 8FF",
                ...                        
            }

            When you POST a new Waiting List, the api will return a JSON object with the Waiting List details.


            Who's Who

            Overview

            URLhttps://app.swimclubmanager.co.uk/api/WhosWho
            Methods SupportedGET
            DescriptionAllows you to get who's who in an SCM account

            The "WhosWho" GET method returns a list of your Who's Who categories and Members assigned to those categories

            {
                "Categories": [
                {
                "Category""Club Officers",
                "Members": [
                {
                    "Firstname""Joseph",
                    "Lastname""Bloggs",
                    "KnownAs""Jo",
                    "Notes""Secretary"
                },
                ...
                },
                ...
            }

            Club Sessions

            Overview

            URLhttps://app.swimclubmanager.co.uk/api/ClubSessions
            Methods SupportedGET
            DescriptionAllows you to get (GET) club sessions in an SCM account

            Elements For Club Sessions

            GuidThe session's unique id in the system (read only)
            SessionNameThe name of the session
            WeekDayThe day of the week the session is on
            StartTimeThe time the session starts
            EndTimeThe time the session ends
            SessionFeeThe session fee
            NoSessionDatesAny dates or date ranges the session does not run on
            MaxMembersThe max number of members for the session
            SessionLocationThe location of the session
            ArchivedThe archived status of the session
            CoachesA list of member Guids of the session coaches
            MembersA list of member Guids of members assigned this session

            GET Club Session

            To get a Club Session, use the following URL where {guid} is the Guid of the club session:

            Data Returned

            When you GET a Club Session, the following JSON will be returned:

            {
                "Guid""bb835a18-1234-5678-a99f-3177572e40d7",
                "SessionName""Ben test",
                "WeekDay""Sunday",
                "StartTime""00:00",
                "EndTime""00:00",
                "SessionFee": 0,
                "NoSessionDates""",
                "MaxMembers": 0,
                "SessionLocation""",
                "Archived": 0,
                "Coaches": [
                {
                    "Guid""94d54adb-1234-5678-985d-a530e4457b51",
                        "LastAttended""2017-11-05"
                }
                ],
                "Members": [
                {
                    "Guid""90b11226-1234-5678-b38f-23984e58223f",
                    "LastAttended""2017-11-05"
                },
                {
                    "Guid""3993c5d5-1234-5678-b6bd-73e46b4abaa7",
                    "LastAttended""2017-11-05"
                },
                ]
            }

            Club Groups

            Overview

            URLhttps://app.swimclubmanager.co.uk/api/ClubGroups
            Methods SupportedGET
            DescriptionAllows you to get (GET) club groups in an SCM account

            Elements For Club Groups

            GuidThe group's unique id in the system (read only)
            GroupNameThe name of the group
            MaxMembersThe max number of members for the group
            GroupFeeThe group fee
            MembersA list of member Guids of members assigned this group

            GET Club Group

            To get a Club Group, use the following URL where {guid} is the Guid of the club group:

            Data Returned

            When you GET a Club Group, the following JSON will be returned:

            {
                "Guid""bb835a18-1234-5678-a99f-3177572e40d7",
                "GroupName""Development",
                "MaxMembers": 15,
                "GroupFee""10",
                "Members": [
                {
                    "Guid""90b11226-1234-5678-b38f-23984e58223f"
                },
                {
                    "Guid""3993c5d5-1234-5678-b6bd-73e46b4abaa7"
                },
                ]
            }

            Club Roles

            Overview

            URLhttps://app.swimclubmanager.co.uk/api/ClubRoles
            Methods SupportedGET
            DescriptionAllows you to get (GET) club roles in an SCM account

            Elements For Club Roles

            GuidThe role's unique id in the system (read only)
            RoleNameThe name of the role
            MembersA list of member Guids of members assigned this role

            GET Club Role

            To get a Club Role, use the following URL where {guid} is the Guid of the club role:

            Data Returned

            When you GET a Club Role, the following JSON will be returned:

            {
                "Guid""bb835a18-1234-5678-a99f-3177572e40d7",
                "RoleName""Coach",
                "Members": [
                {
                    "Guid""90b11226-1234-5678-b38f-23984e58223f"
                },
                {
                    "Guid""3993c5d5-1234-5678-b6bd-73e46b4abaa7"
                },
                ]
            }

            Email Lists

            Overview

            URLhttps://app.swimclubmanager.co.uk/api/EmailLists
            Methods SupportedPOST, GET, PUT
            DescriptionAllows you to get (GET), add (POST) and update (PUT) email lists in an SCM account

            Elements For Email Lists

            GuidThe list's unique id in the system (read only)
            ListNameThe name of the list
            MembersA list of member Guids of members in this list

            GET Email List

            To get an Email list, use the following URL where {guid} is the Guid of the email list:

            Data Returned

            When you GET an Email List, the following JSON will be returned:

            {
                "Guid""bb835a18-1234-5678-a99f-3177572e40d7",
                "ListName""Swim Club Challenge",
                "Members": [
                {
                    "Guid""90b11226-1234-5678-b38f-23984e58223f"
                },
                {
                    "Guid""3993c5d5-1234-5678-b6bd-73e46b4abaa7"
                },
                ]
            }

            When you POST or PUT a new EmailList, the api will return a JSON object with the List's details.


            Code Of Conduct

            Overview

            URLhttps://app.swimclubmanager.co.uk/api/CodeOfConduct
            Methods SupportedGET
            DescriptionAllows you to get (GET) code of conducts in an SCM account

            Elements For Code Of Conducts

            GuidThe code of conduct's unique id in the system (read only)
            TitleThe tile of the code of conduct
            DetailsThe details of the code of conduct
            FilenameThe file name of an attached file
            MembersA list of member Guids of members assigned to this code of conduct

            GET Code Of Conduct

            To get a Code of Conduct, use the following URL where {guid} is the Guid of the code of conduct:

            Data Returned

            When you GET a Code of Conduct, the following JSON will be returned:

            {
                "Guid""bb835a18-1234-5678-a99f-3177572e40d7",
                "Title""Coaches",
                "Details""Details goes here...",
                "Filename""",
                "Members": [
                {
                    "Guid""90b11226-1234-5678-b38f-23984e58223f",
                    "DateAgreed"""
                },
                {
                    "Guid""3993c5d5-1234-5678-b6bd-73e46b4abaa7",
                    "DateAgreed""2018-04-19"
                },
                ]
            }

            NoticeBoard

            Overview

            URLhttps://app.swimclubmanager.co.uk/api/NoticeBoard
            Methods SupportedGET
            DescriptionAllows you to get (GET) noticeboard in an SCM account

            Elements For NoticeBoard

            GuidThe noticeboard's unique id in the system (read only)
            NoticeDateThe date of the noticeboard item (yyyy-mm-dd format)
            NoticeTitleThe title of the noticeboard item

            NoticeDetails

            The noticeboard message
            DisplayUntilDateThe date the notice will display until (yyyy-mm-dd format)
            FirstNameThe first name of the member who created the noticeboard item
            KnownAsThe "known as" of the member who created the noticeboard item
            LastNameThe last name of the member who created the noticeboard item

            GET NoticeBoard

            To get a Notice Board, use the following URL where {guid} is the Guid of the noticeboard item:

            Data Returned

            When you GET a NoticeBoard, the following JSON will be returned:

            {
                "Guid""bb835a18-1234-5678-a99f-3177572e40d7",
                "NoticeDate""2018-09-19",
                "NoticeTitle""Title goes here...",
                "NoticeDetails""Details goes here...",
                "DisplayUntilDate""2018-09-22",
                "FirstName""Jo",
                "KnownAs""",
                "LastName""Bloggs",
            }

            Error Codes

            CodeExplanation
            400Bad request - something is wrong with your data i.e. missing required fields etc
            401Unauthorized - invalid authorization token
            403Forbidden - you have made too many api requests in the current 24 hour period
            404Not Found - you supplied an incorrect object id
            500Internal Server Error - something has gone wrong on our side

            A message detailing the exact error will also be sent along with the error code above

            Updated: 15 Jan 2019 09:30 PM
            Helpful?  
            Help us to make this article better
            0 0