Websydian v6.1 online documentationOnline documentation - WebsydianExpress v3.5

API: SetHttpStatus

Scoped Name

APIWebServer.WebServices._Parameters.SetHttpStatus

Interface

Field Variable ...as Description
HttpStatus Input Input Specifies the http status the service handler wants the service processor to return to the client.

Description

The API writes the http status to the memory. This does not send the value to the client (use the SendHeader API if that is what you want to do).

The service processor sends default http status values to the client based on the *Returning status of the service handler (200 if *Successful, 500 if any errors are returned).

Call this API if you want to override this behavior. By calling the SetHttpStatus API, you determine the exact status that will be sent to the client.

Events

Universal events