Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Services

Usage:
HTTP_Resource_Services('GetDatabaseItems', Filter, TableName, SelfURL, ColumnNames, ItemArrayLabelGets the resource items from a database table. The format will be HAL+JSON.

Returns:
Database rows in HAL+JSON format.

ServiceDescription
GetDatabaseItemSendHTTPRequest

Usage:
HTTP_ResourceHTTPClient_Services('GetDatabaseItemSendHTTPRequest', TableName, SelfURL, ItemID, ColumnNames, ItemArrayLabelMethod, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP)

Comments:
Gets the resource item from a database table. The format will be HAL+JSON.

Returns:
A database row in HAL+JSON format.

GetDatabaseItems

Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

SetRequestHeaderFields

Usage:
HTTPClient_Services('SetRequestHeaderFields', Method, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

SetRequestHeaderField

Usage:
HTTPClient_Services('SetRequestHeaderField', Method, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP)

Comments:

Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

GetRequestHeaderFields

Usage:
HTTPClient_Services('GetRequestHeaderFields', Method, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

GetRequestHeaderField

Usage:
HTTPClient_Services('GetRequestHeaderField', Method, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP

DeleteDatabaseItem

Usage:
HTTP_Resource_Services('DeleteDatabaseItem', TableName, ItemID)

Comments:
Deletes the resource item from a database tableCalls the indicated HTTP web service routine.

Returns:
N/AThe HTTP response body from the server.

SetResponseHeaderFieldPostDatabaseItem

Usage:
HTTP_ResourceHTTPClient_Services('PostDatabaseItem', TableName, SelfURL, ItemIDSetResponseHeaderField', Method, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP)

Comments:
Creates a new or updates a specific resource item in the database table. If a specific resource item is being updated then only the data columns specified will be updated. A PUT will replace the entire resource item.

Returns:
N/A

GetColumnNames

Usage:
HTTP_Resource_Services('GetColumnNames', TableName, ColumnNames)

Comments:
Gets the column names from the dictionary of the table provided that will be used to create the resource. If the ColumnNames argument is used then this service will validate the list as valid columns. In either case, the following rules will be applied:

  • Regardless of the case used to in the ColumnNames argument it will be upper cased to match against the dictionary names correctly.
  • All column names will be returned in lower case.
  • All column names bound to a Key ID of part 0 (i.e., the entire key) will be removed.
  • All non-master column names will be removed to avoid duplicates.
  • SRP FrameWorks audit column names (MODIFIED_BY, MODIFIED_DATE, and MODIFIED_TIME) will be removed.

Returns:
An @FM delimited list of database column names.

GetColumnValues

Usage:
HTTP_Resource_Services('GetColumnValues', TableName, ColumnNames, ItemID)

Comments:
Gets the column values from the database row from the provided table and ID that will be used to create the resource. This is returned as an @FM delimited list of values.

Returns:
An @FM delimited list of database column values for a specific Key ID.

Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

GetResponseHeaderFields

Usage:
HTTPClient_Services('GetResponseHeaderFields', Method, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

GetResponseHeaderField

Usage:
HTTPClient_Services('GetResponseHeaderField', Method, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server. 

SetResponseStatusCode

Usage:
HTTPClient_Services('SetResponseStatusCode', Method, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server. 

GetResponseStatusCode

Usage:
HTTPClient_Services('GetResponseStatusCode', Method, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server. 

SetResponseStatusPhrase

Usage:
HTTPClient_Services('SetResponseStatusPhrase', Method, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server. 

GetResponseStatusPhrase

Usage:
HTTPClient_Services('GetResponseStatusPhrase', Method, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server. 

SetResponseBody

Usage:
HTTPClient_Services('SetResponseBody', Method, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server. 

GetResponseBody

Usage:
HTTPClient_Services('GetResponseBody', Method, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

SetTimeoutDuration

Usage:
HTTPClient_Services('SetTimeoutDuration', Method, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server. 

GetTimeoutDuration

Usage:
HTTPClient_Services('GetTimeoutDuration', Method, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

ClearResponseSettings

Usage:
HTTPClient_Services('ClearResponseSettings', Method, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

ClearRequestSettings

Usage:
HTTPClient_Services('ClearRequestSettings', Method, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server

GetMVGroupNames

Usage:
HTTP_Resource_Services('GetMVGroupNames', TableName, ColumnNames)

Comments:
Gets the MV group names for the dictionary columns passed in. Note: the ColumnNames argument should be the same list that was returned from the GetColumnNames service. This will return an @FM delimited list of MV group names. Thus, for non-multivalue fields, the values will be empty. The MV group names will be returned in lower case. Gets the column values from the database row from the provided table and ID that will be used to create the resource. This is returned as an @FM delimited list of values.

Returns:
An @FM delimited list of MV group names.

Param1 - Param10

The proper use of the generic arguments are defined in the definition of each service above.