Page History
Calls the indicated HTTP web service routineSets the indicated Response Header Field with the indicated value. This can then be retrieved with a GetRequestHeaderField service call so that server processing can operate accordingly.
Syntax
| Code Block |
|---|
Response = HTTP_Services('RunHTTPServiceSetResponseHeaderField', Name, HTTPServiceValue, RemainingURLAppend) |
Returns
N/A
Parameters
| Parameter | Description | ||
|---|---|---|---|
| Name | Header Field Name to set | HTTPService | The HTTP (or web) service to call.. Required. |
| Value | Value for the header field. This will be Trimmed to enforce proper formatting | RemainingURL | This is the remaining portion of the URL that has not yet been processed by previous services. Required. |
Remarks
The RunHTTPService service is the official way to call specific web service APIs. The HTTPService argument should contain the same name found in the URL segment that corresponds with the API resource. For instance, for the /customers URL, the HTTPService argument should contain the value of customers. This will call the HTTP_CUSTOMERS_SERVICES BASIC+ routine.
| Append | Flag that determines if values can be appended to a list. By default this is false and all values will replace existing values. Optional. |
Remarks
Any value can be entered for the Name argument, but there is a pre-defined list of standard HTTP response header field names which have been defined as metadata for this service to make it easier for the developer to select one. The current list is as follows:
| Access-Control-Allow-Headers |
| Access-Control-Allow-Methods |
| Access-Control-Allow-Origin |
| Allow |
| Content-Encoding |
| Content-Language |
| Content-Length |
| Content-Location |
| Content-Disposition |
| Content-Type |
| Date |
| Expires |
| Last-Modified |
| Link |
| Location |
| Retry-After |
| Server |
| Set-Cookie |
| Transfer-Encoding |
| Vary |
| WWW-Authenticate |
The Append argument is to be used for header fields that can store multiple values, such as different HTTP methods for the Allow header field or various properties in the Content-Types header fieldThe RemainingURL argument will contain the value of the remaining portion of the URL that follows the current URL segment. Examples of managing this are found in the HTTP_Entry_Point_Services routine.
