Page History
Returns the API Root URL for the web site. It pulls this from SRP_HTTP_FRAMEWORK_SETUP <2>.
Syntax
| Code Block |
|---|
Response = HTTP_Services('RunHTTPServiceGetAPIRootURL', HTTPService, RemainingURLFullURL) |
Returns
N/AThe end point or full URL that defines where the API entry point begins.
Parameters
| Parameter | Description |
|---|---|
| HTTPService | The HTTP (or web) service to call.. Required. |
| 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.
| FullURL | Boolean flag indicating if the full URL or just the end point should be returned. Default is True. Optional. |
Remarks
It pulls this from SRP_HTTP_FRAMEWORK_SETUP <2>. A full URL will contains the Home URL appended with the end point API URLThe 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.
