Function: initiateProcess

Request for a url to initiate a browser session with prefilled data.

Usage: initiateProcess

Access to the API and the URLs provided through the API is subject to adequate security measures for authentication and authorization according to the guidelines given in the Security chapter. Note that the URL is a deeplink.
Any outcome of the browser session, for example a dataset and/or a pdf file, can be sent to the initiating party directly (submitMessage) or through a message exchange platform. This is however not part of the scope of this function.

If any problems are encountered, an error message is returned, see the error section below.

Technical specifications: initiateProcess

Input: initiateProcess

Name Variant Type Description
processStructure all Global structure to deliver party, policy and/or claim data in their respective structures.
commonFunctional all Entity for general information with regard to structure, handling and processing.
entityType all string Unique identification of an entity.
dataCatalogVersion all ADNAFM Version of the data catalog on which the message is based.
functionVariant all APIVAR The function variant is used to determine the additional set of required and optional input and output data.
process all
entityType all string Set to ‘transaction’
processParty all string The party hosting the process.
processName all string Identification of the process for which an URL is requested.
processParameters string Possible additional parameters to identify / specify the process. At the discretion of the process provider.
email all string E-mail of the logged-in user. This data can be used to initiate a browser session for a specific user.

Output: initiateProcess

The response header contains the URL and has no body section if no errors occurred.
Example: https://api.[host-domain]/process?processId=edcc3ac1-7329-490f-97da-d8293fccc00e


When a negative response is generated, it follows the general rules as described in the Error section of the Status codes and error handling chapter.

The Open Api Specification (3.0.0)


Thanks for your feedback.

Post your comment on this topic.

Post Comment