RidgeStar
About
Locations
Manual
Reference
Notices
Email
HTML
Internet
Passwords
Processes
Results Lists
RidgeStar
Copying Panels
Development
Documents
Environment
Monitor Activity
Production
Rest API
Site Structure
Site Outline
Soccer Referee
Symbols
Usage Policies
Wire Time
Your Environment
Tools
Service
Logon
RidgeStar

Reference: RidgeStar-Rest API

Logontranslate
Get Started |Calendar |Locations
Criteria is now using saved Site values

Sites with the RidgeStar REST (Representational State Transfer) API (Application Programming Interface) active will be capable of interacting with remote Clients (other websites and/or programs at other Internet end-points), as follows:

The APIHide

The API has been built to generally conform to commonly accepted standards associated with RESTful Servers. This is not to say that the API is 100% a REST implementation, but it has made efforts to adhere to the principles and concepts embodied by REST.

The API is built upon a few basic terms that should be clarified from the outset:

Resource
Identifies a logical set of information available from the API. In this context, a Resource might refer to a single database table, might be a subset or superset of one or more database tables, or might even be simple meta-data available to describe the available Resources.
Properties
Each Resource has one or more Properties that, in turn, have one or more values. Conceptually, when a Resource is the result of a data table, a Property is a data field within the data table and the Property's value is synonymous with the data field value.

SyntaxShow

Examples

All the following examples can be executed by clicking the desired symbol (for HTML, JSON, or XML) below and are sent to Referees.biz-> for processing.

/officers H J XML
Get a list of all Chapter Officers
Sending
https://www.referees.biz/api/officers.
Request Headers
rsr-Date: 2024-11-21T06:25:58-08:00
Content-Type: application/json;
rsr-Powered-By: RidgeStar/6.3.0
Response Headers
HTTP_Response: 200
Date: Thu, 21 Nov 2024 14:25:58 GMT
Server: Apache/2.4.62 (Fedora Linux) OpenSSL/3.2.2
X-Powered-By: PHP/8.3.13
Expires: Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control: no-store, no-cache, must-revalidate
Pragma: no-cache
rsr-Powered-By: server/6.2.6
rsr-Resource: officers total=7, first=1, last=7
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: rsr-Powered-By,rsr-Resource
Set-Cookie: PHPSESSID=5r0b5dicn5mqb7b57vtcumjumk; path=/; SameSite=Strict
Transfer-Encoding: chunked
Content-Type: application/json; charset=utf-8
Data returned
[{"dusKey":16,"dusFirstName":"Julia","dusMiddleName":"","dusLastName":"Assignor","dusBoardTitle":"Treasurer","dusPrimaryPhone":"Home","dusHome":"3606765999","dusWork":null,"dusCellular":null,"dusPrimaryEmail":"Email1","dusEmail1":"webmaster@referees.biz","dusEmail2":""},{"dusKey":5,"dusFirstName":"James","dusMiddleName":"","dusLastName":"Goal","dusBoardTitle":"President","dusPrimaryPhone":"Home","dusHome":"2061121111","dusWork":"2061121112","dusCellular":"2061121113","dusPrimaryEmail":"Email1","dusEmail1":"mick@ridgestar.com","dusEmail2":null},{"dusKey":47,"dusFirstName":"Hard","dusMiddleName":"","dusLastName":"Grader","dusBoardTitle":"Director of Assessment","dusPrimaryPhone":"Home","dusHome":"2135551234","dusWork":null,"dusCellular":null,"dusPrimaryEmail":"Email1","dusEmail1":"assessments@referees.biz","dusEmail2":""},{"dusKey":19,"dusFirstName":"Jan","dusMiddleName":"","dusLastName":"Smith","dusBoardTitle":"Secretary","dusPrimaryPhone":"Work","dusHome":null,"dusWork":"3606765999","dusCellular":null,"dusPrimaryEmail":"Email1","dusEmail1":"secretary@referees.biz","dusEmail2":""},{"dusKey":17,"dusFirstName":"Joe","dusMiddleName":"","dusLastName":"Smith","dusBoardTitle":"Webmaster","dusPrimaryPhone":"Work","dusHome":null,"dusWork":"3606765999","dusCellular":"3605551234","dusPrimaryEmail":"Email1","dusEmail1":"webmaster@referees.biz","dusEmail2":null},{"dusKey":129,"dusFirstName":"Joe","dusMiddleName":"","dusLastName":"Smith II","dusBoardTitle":"Webmaster","dusPrimaryPhone":"Work","dusHome":"(360) 733-5855","dusWork":"(360) 676-5999","dusCellular":null,"dusPrimaryEmail":"Email1","dusEmail1":"juventusblast@ymail.com","dusEmail2":""},{"dusKey":9,"dusFirstName":"Seth","dusMiddleName":"","dusLastName":"Sounder","dusBoardTitle":"Vice President","dusPrimaryPhone":null,"dusHome":"4251161111","dusWork":"2061161112","dusCellular":"4251161113","dusPrimaryEmail":"Email1","dusEmail1":"webmaster@referees.biz","dusEmail2":""}]
/officers/17 H J XML
Get all default Properties for a specific individual
/matches?dmaClient=LakeView&dmaLevel=U16&dmaDate[from]=2020-11-30 H J XML
Retrieve Matches for a specific Client and Level of play between specific Dates
/matches?dmaLevel=U14,U15 H J XML
Retrieve Matches for 2 different Levels of play
/matches?criteria={dmaLevel=U14},{dmaLeague=NFHS} H J XML
Retrieve Matches for a specific Level of Play OR in a specific League of play
/matches/1137?properties=dmaKey,dmaDate,dmaRef H J XML
Get 3 Property values for a specific Match
/matches/1137?properties=dmaKey,dmaDate,dmaRef&expand=dmaRef,Dates H J XML
Expand data fields to obtain translated values
/matches?properties=dmaKey,dmaDate,dmaRef,dmaAR1,dmaAR2&dmaPositions=17 H J XML
Obtain assignments for a specific Referee
/matches?dmaLevel=U14&offset=4&limit=2 H J XML
Starting with the fourth Match, list only 2
/doc H J XML
Retrieve information about the API and Site hosting it
/doc/resources/locations H J XML
Obtain a description of the Get options for the Resource named "locations"