Initializing help system before first use

dmpiniturl

dmpiniturl

Purpose
Initialize a dmpresource with user-supplied URL and credentials
Synopsis
procedure dmpiniturl(res:dmpresource, url:text, authtokentype:text, authtoken:text)
procedure dmpiniturl(res:dmpresource, url:text, authheaders:array(set of string) of text)
Arguments
res 
The dmpresource value to initialize.
url 
The resource root URL. All dmphttp calls through this resource will be relative to this URL.
authtokentype 
The type of authorization token, expressed as one of the following constants:
DMP_TOKEN_TYPE_BEARER 
DMP_TOKEN_TYPE_JWT 
authtoken 
The authorization token to add to outgoing HTTP requests made through this resource.
authheaders 
A collection of HTTP Headers to add to outgoing HTTP requests made through this resource.
Example 
declarations
  res: dmpresource
  headers: dynamic array(set of string) of text
end-declarations
headers("Cookie") := "SESSIONID=8364825249"
headers("Authorization") := "Bearer 834692364jdnvdjfvb7t3jkd78"
dmpiniturl(res, "http://fakeresource.example.com/", headers)
if res.status<>DMP_OK then
  writeln('ERROR: ',res.lasterror)
end-if
Further information
1. This procedure is intended to assist users to write code interacting with DMP resources that will work both within Xpress DMP components and when executed locally.
2. If you pass an authtoken value, all HTTP requests made through this resource will be decorated with an appropriate Authorization: header.
3. If you pass an authheaders value, all HTTP requests made through this resource will be decorated with HTTP headers read from this array (indices are the header names).
4. You should check the status attribute of the dmpresource after calling this procedure.

Parent Topic Procedures and functions

© 2001-2019 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.