 |
Manual: Settings-RestServer |
|
| Get Started |Calendar |Locations |
Feature=Rest
permits the data transfer of information to calling programs using the REST protocol. The characteristics of the RestServer can be configured via Setting=RestServer, as follows:
- ActionMessage
- When set to true (1), generates a recordable message when an Action is received and processed by the Rest Server (see Administrator: Operations-Activity for recorded messages).
Default is "".
- AddUsers
- When Logon=Sitename is in effect, IF the incoming REST request has been initiated by a User that is not identified in the Users table and AddUsers is set to true (1), a new Users entry is created (for Auditing purposes). If AddUsers is set to a non-numeric value, any Users added will have that Role activated (e.g. AddUsers=>Referee will cause NewUsers to have the Referee Role activated for them).
Default is "".
- APIKey
- For sites authorizing individual User access via direct calls to the Rest Server uitilzing the standard Rest Authorization Header, this value specifies the length of the APIKey that will be generated for use by the User to gain access to the system using the SiteName. The generated APIKey will be utilized as the standard Password paired appropriately with the correct Sitename.
Default is "16".
- Logon
Specifies the type of Site access permitted from sites listed in Setting=RestClients. REST callers not listed in the Setting (such as TouchLine or JavaNames) are subject to user identity processes associated with those specific implementations. Operand values associated with other Site access are:
- None (no login required)
- Sitename (assumes Sitename from Client site matches Rest Server's Sitename)
- UID (requires Universal ID for Washington State based Servers)
- MatchMethods
- When an Add arrives for the Matches table, this Setting controls how the Position Methods will be set. "Options" indicates that any Method specifications delivered from the Source site will be ignored and the appropriate Methods for the Match will be extracted from the Options table.
Default is "".
- MatchRanks
- When an Add arrives for the Matches table, this Setting controls how the Match Rank will be set. "Options" indicates that any Rank value delivered from the Source site will be ignored and the appropriate Rank for the Match will be extracted from the Options table. A numeric value directly sets the specified value.
Default is "".
- Names
- Specifies whether the individual User identity in database tables (e.g. Matches table) is available to Rest callers ("Public"). Specify "Private" if you want the Rest caller to be required to identify themselves prior to receiving User identity translation via the Rest Server.
Default is "Private".
- Requestors
- Specifies the acceptable identities for requesting programs/sites that can utilize the services of the Rest Server. "All" implies any Requestor (including unidentified requestors) will be accepted. Specific callers (e.g. calling Site acronyms) or App identities (e.g. "TouchLine") can be specified using the plus sign as a delimiter.
E.G. Requestors=>TouchLine+RidgeStar permits both the Sound Software Mobile app named TouchLine, as well as the website operating as "RidgeStar" to utilize the services of the Rest Server. Callers that are not listed will receive a HTTP Response 403 (Unidentified Caller is not Authorized).
RidgeStar supported callers are: TouchLine, RidgeStar, and JavaNames.
Default is "JavaNames".
- SSL
- Indicates if the Rest Server requires SSL Protocols for all requests ("1") or not ("0").
Default is "0".
| Copyright © 2024 by RidgeStar/webmaster@ridgestar.com |  |