BPAPI Methods

BPAPI method HTTPStatus

HTTPStatus

Returns an HTTP / HTML-response with the specified HTTP {status_code} and the specified plain-text {message}

Authorization required: No

HTTP methods allowed: GET

Syntax: HTTPStatus  Details 

Syntax: HTTPStatus/{status_code}/  Details 

Syntax: HTTPStatus/{status_code}/{message}/  Details   Details 

Returns an HTTP / HTML-response with the specified HTTP {status_code} and the specified plain-text {message}

Not used by the API itself. Used for presentation of static HTML pages in order to have standardized error-pages

If {status_code} is not given or if {status_code} is an invalid HTTP status code then 404 is assumed.
If {message} is not given then string-value of .NET System.Net.HttpStatusCode will be returned.
if {status_code} starts with '3' and {message} starts with 'http' then the HTTP Location header in the returned response will be set to {message}
HTML is returned regardless of HTML being added at the end of the query-string or not.

Popularity: 289257 (number of times method has been accessed)

Documentation and tests automatically generated from source-code 2020-07-08 11:31