Previous Topic

Next Topic

Book Contents

Input parameters—Issue

Takes an issueRequest XML element as a child element.

IssueRequest takes a list of InForm items, referenced by GUID, DBUID, or an InForm item type that allows the specification of data that is found in an LSID.

A request can be made for a single study. A request that contains multiple items is treated as an atomic transaction.

Hidden items

A hidden item is an item that is globally hidden.

A request to issue a discrepancy on a hidden item generates an error.

Issue

Parameter or child element

Description

authenticationTrialName

The study in which the discrepancies are issued or updated. If username/password authentication is enabled, the username and password that you specify in the SOAP header are authenticated against this study name.

transactionId

A GUID created by the caller.

TransactionID is not case sensitive. It must use one of the formats described in Transaction ID GUID format.

This parameter prevents a transaction from being submitted multiple times. If you specify a value that was previously submitted and resulted in a successful transaction, an error occurs.

transactionUserName

The user name of the InForm user to associate with this transaction. The user must belong to a query group in an InForm trial.

If using the InForm Adapter with InForm 6.0 or later studies that are configured to work with single sign-on, the OrgID value must be prepended to the trial username to match the tenant-qualified username that is used by the single sign-on application.

InFormItemIdentifier

A unique identifier of an InForm item:

  • GUID.
  • DBUID.
  • An InForm item type structure that contains the data found in an LSID.

InitialState

The state in which the query is to be opened.

Values: Candidate, Opened.

Reason

The reason for issuing the discrepancy.

ValidateOnly

Values: True, False.

If True, both of the following occur:

  • The request is validated, but no data is committed to the database.
  • The response contains an error list that includes any errors in validation. If all items in the request are validated successfully, the error list is empty.

Send Feedback