Developers Area
  • Information for developers
  • About the APIs
  • Release Log
  • Level 1 Calls
    • User membership check
    • Club details
    • Club affiliation status
    • Counties
  • Level 2 Calls
    • Users
    • User clubs
    • Club members
Powered by GitBook
On this page
  1. Level 2 Calls

Users

/users (Level 1)

GET https://api.englandsquash.com/users

Requires Level 2 access. Returns a list of users and associated user details, filtered by optional parameters

Query Parameters

Name
Type
Description

FirstName

string

Use this parameter to filter by first name (like match)

LastName

string

Use this parameter to filter by last name (like match)

CountyID

integer

Use this parameter to filter by County - can be used to return a list of users linked to a specified county (exact match)

EnglandSquashID

string

Use the parameter to filter by EnglandSquashID (exact match)

memberID

integer

Use this parameter to filter by legacy member ID (exact match)

SPINID

integer

Use this parameter to filter by SPIN ID (exact match)

Headers

Name
Type
Description

APIToken

string

API key required to authenticate your request

[
 {
 "title": "Mr",
 "firstName": "John",
 "lastName": "Smith",
 "sex": null,
 "dateOfBirth": "1958-07-17T00:00:00",
 "countyID": null,
 "countyname": null
 "memberID": "",
 "englandSquashID": "ES1234567",
 "spinid": "123456"
 "membershipStatus": "Active",
 "membershipType": "Club",
 "membershipExpiresOn": "2016-09-01T00:00:00"
 }
 ]
{
    "message": "Authorization has been denied for this request."
}
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
        <title>404 - File or directory not found.</title>
        <style type="text/css">
            <!--
body{margin:0;font-size:.7em;font-family:Verdana, Arial, Helvetica, sans-serif;background:#EEEEEE;}
fieldset{padding:0 15px 10px 15px;} 
h1{font-size:2.4em;margin:0;color:#FFF;}
h2{font-size:1.7em;margin:0;color:#CC0000;} 
h3{font-size:1.2em;margin:10px 0 0 0;color:#000000;} 
#header{width:96%;margin:0 0 0 0;padding:6px 2% 6px 2%;font-family:"trebuchet MS", Verdana, sans-serif;color:#FFF;
background-color:#555555;}
#content{margin:0 0 0 2%;position:relative;}
.content-container{background:#FFF;width:96%;margin-top:8px;padding:10px;position:relative;}
-->

        </style>
    </head>
    <body>
        <div id="header">
            <h1>Server Error</h1>
        </div>
        <div id="content">
            <div class="content-container">
                <fieldset>
                    <h2>404 - File or directory not found.</h2>
                    <h3>The resource you are looking for might have been removed, had its name changed, or is temporarily unavailable.</h3>
                </fieldset>
            </div>
        </div>
    </body>
</html>

Following a succesful call, Membership Status, will return one of the following statuses:

  • Inactive (no current membership)

  • Club (active membership via a club – adult/junior)

  • Coach (active direct coach membership)

  • Adult (active direct adult membership)

  • Junior (active direct junior membership)

PreviousCountiesNextUser clubs

Last updated 6 years ago