Reference: RidgeStar-Rest API

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 API

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.

Syntax

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

Get a list of all Chapter Officers

/officers/17

Get all default Properties for a specific individual

Sending: https://www.referees.biz/api/officers.html/17
Request Headers: rsr-Date: 2025-04-03T12:08:58-07:00
Content-Type: application/json;
rsr-Powered-By: RidgeStar/6.3.3
Response Headers: HTTP_Response: 200
Date: Thu, 03 Apr 2025 19:08:58 GMT
Server: Apache/2.4.63 (Fedora Linux) OpenSSL/3.2.4
X-Powered-By: PHP/8.3.19
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=1, first=1, last=1
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: rsr-Powered-By,rsr-Resource
Transfer-Encoding: chunked
Content-Type: text/html; charset=utf-8
Data returned: <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"><body><p><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"><body><h1>Users</h1><p><ol><ol><li>dusKey=17</li><li>dusFirstName=Joe</li><li>dusMiddleName=</li><li>dusLastName=Smith</li><li>dusBoardTitle=Webmaster</li><li>dusPrimaryPhone=Work</li><li>dusHome=</li><li>dusWork=3606765999</li><li>dusCellular=3605551234</li><li>dusPrimaryEmail=Email1</li><li>dusEmail1=webmaster@referees.biz</li><li>dusEmail2=</li></ol></ol></p></body></html></p></body></html>

/matches?dmaClient=LakeView&dmaLevel=U16&dmaDate[from]=2020-11-30

Retrieve Matches for a specific Client and Level of play between specific Dates

/matches?dmaLevel=U14,U15

Retrieve Matches for 2 different Levels of play

/matches?criteria={dmaLevel=U14},{dmaLeague=NFHS}

Retrieve Matches for a specific Level of Play OR in a specific League of play

/matches/1137?properties=dmaKey,dmaDate,dmaRef

Get 3 Property values for a specific Match

/matches/1137?properties=dmaKey,dmaDate,dmaRef&expand=dmaRef,Dates

Expand data fields to obtain translated values

/matches?properties=dmaKey,dmaDate,dmaRef,dmaAR1,dmaAR2&dmaPositions=17

Obtain assignments for a specific Referee

/matches?dmaLevel=U14&offset=4&limit=2

Starting with the fourth Match, list only 2

/doc

Retrieve information about the API and Site hosting it

/doc/resources/locations

Obtain a description of the Get options for the Resource named "locations"