Releases: CSOIreland/Server-API-Library
Releases · CSOIreland/Server-API-Library
4.2.0
API.Utility static class fixed:
API.Utility.IpAddress
suppressed. Use the publicAPI.Utility.GetIP()
instead.API.Utility.UserAgent
suppressed. Use the publicAPI.Utility.GetUserAgent()
instead.API.Utility.HttpGET
suppressed. Use theJSONRPC_API
andRESTful_API
public memberhttpGET
.API.Utility.HttpPOST
suppressed. Use theJSONRPC_API
andRESTful_API
public memberhttpPOST
.
4.1.3
API Authentication mechanism fixed when AD (Active Directory) is down or unreachable
4.1.2
- New public method
API.MemCacheD.GetStats()
implemented
4.1.1
- New public method
Utility.HttpGet()
implemented to retrieve the HTTP(s) request for the GET verb - New public method
Utility.HttpPOST()
implemented to retrieve the HTTP(s) request for the POST verb
4.1.0
- RESTful implementation added
- Add the new
API.RESTful
handler to the Web.config
<add verb="GET,POST" path="api.restful" name="API.RESTful" type="API.RESTful" />
- Rename the following keys in the Web.*.config files under the
<appSettings>
section:API_JSONRPC_MAINTENANCE
>>API_MAINTENANCE
API_JSONRPC_AUTHENTICATION_TYPE
>>API_AUTHENTICATION_TYPE
API_JSONRPC_STATELESS
>>API_STATELESS
API_JSONRPC_SUCCESS
>>API_SUCCESS
4.0.1
- API.Utility.GetIP method fixed when
HttpContext.Current
isnull
and theIPHostEntry
is returned instead - API.Utility.GetUserAgent method fixed when
HttpContext.Current
is null and ablank
string is returned instead - Under maintenance flag implemented in order to disconnect the JSON-RPC listener when the system is under maintenance.
- Add the application setting API_JSONRPC_MAINTENANCE in the
Web.config
- Add the application setting API_JSONRPC_MAINTENANCE in the
<!-- JSONRPC - Maintenance flag [TRUE, FALSE] -->
<add key="API_JSONRPC_MAINTENANCE" value="FALSE" />
4.0.0
This Version is NOT backward compatible.
N.B. If you upgrade to this version then you must upgrade the Client API Library to implement the strict JSON-RPC specifications.
-
JSON-RPC response structure fixed to implement strict specifications: https://www.jsonrpc.org/specification
data
property renamed toresult
error.code
changed to typeinteger
error.message
changed to typestring
error.data
added as typedynamic
-
New Methods added
- API.Utility.GetUserAcceptLanguage()
- API.Utility.EncodeBase64FromUTF8()
- API.Utility.EncodeBase64FromByteArray()
-
Header
RESPONSE_Server
overridden andenableVersionHeader
set tofalse
following the OWASP security best practice.
3.0.6
- Methods fixed to handle an
empty
ornull
input:- API.Utility.GZipCompress
- API.Utility.GZipDecompress
3.0.5
- New Methods added:
- API.Utility.GZipCompress to compress a string with
GZip
- API.Utility.GZipDecompress to decompress a string with
GZip
- API.Utility.GZipCompress to compress a string with
- Class API.MemCacheD enhanced to compress/decompress cached data automatically
3.0.4
- Mime-Type
application/json
set for the Content Type JSON-RPC response - CacheControl
no-cache
set for the JSON-RPC response