a5DialogHelper_TransFormAPIQuery Function
Syntax
dim result as p = a5DialogHelper_TransFormAPIQuery(urlSuffix as c, postBody as c, apikey as c [, location as c])
Arguments
- urlSuffixCharacter
The TransForm API endpoint to call including any URL parameters to pass to the endpoint.
- postBodyCharacter
A JSON string that contains additional data to submit to the endpoint.
- apikeyCharacter
Your TransForm API key.
- locationCharacter
Default = "cloud". Whether the call should be made against TransForm Central or the TransForm test site.
- Location
- Description
- cloud
API call is made to transform.alphasoftware.com.
- cloudbeta
API call is made to the Alpha TransForm testing platform.
Returns
- resultPointer
Returns an object with the following properties:
- errorLogical
If .T., an error occurred when trying to make a CURL call to the API endpoint. If .F., call succeeded.
If error is .F., it does not mean no errors occurred calling the API endpoint. It simply indicates that the CURL call was successful and was not malformed in some way. result will contain additional details as to whether or not the TransForm API call succeeded, including any error messages from the API endpoint.
- errorTextCharacter
If error is .T., contains an error message.
- resultCharacter
If error is .F., contains the result of the call.
Description
Executes a TransForm API call.
Discussion
The a5DialogHelper_TransFormAPIQuery() function makes a call to the TransForm API.
See Also