Prerequisites

Get your IRT study deployed on Oracle cloud. Obtain the URL for the study APIs.

Step 1: Create Users

All REST API calls are stateless and therefore require authentication information for each request. Get the API user provisioned for your study provisioned. Use to application users is not allowed for API calls.

Step 2: Execute a Web Service

You may use any tool available to create the client to call the IRT REST API.

To execute an API, the following name-value pairs are mandatory in the Request header:

• Accept: application/json OR application/xml

• Content-Type: application/json or application/xml

• Authentication: username and password configured in Step 1

See the following examples of POST APIs.

Example Request

https://subdomain.domain.com:port/apps/studyname/api/sites/

Request Header:

Accept: application/json
Content-Type: application/json
Username: username

Request Body:

"sites": {
	"site": [ 
		"SiteId": 208,
		"InvestigatorId": 1289003,
		"InvestigatorFirstName": "Joe",
		"InvestigatorLastName": "Taylor",
		"Address1": "300 Barr harbor Dr",
		"Address2": "Five Towerbridge",
		"Address3": "Suite 400",
		"City": "Broomal",
		"State": "PA",
		"Zip": "18976",
		"CountryId": "USA",
		"ShipFax": "12398098111",
		"ShipName": "Marysya",
		"ShipEmail": "donotreply@oracle.com"0,
		"ShipNote": "note text",
		"TimeZone": "Eastern Standard Time",
		"ExternalId": 1233229,
		"DEARegistrationNumber": "ab1234568",
		"DEAExpiration": "2018-05-25T19:01:06.439617+01:00"
	]
}

Expected Response:

"HasExceptions": "false"
"Transaction": "47-09-031420-5146-17766"
"Records": {
	"Site": [
		"ErrorCount": "0"
		"ErrorMessages": ""
		"IsSuccessful": "true"
		"Key": "414931bb-0cb4-46c1-9b55-a61eaa764158"
		"SiteId": "208"
		"InvestigatorId": "1289003"
		"InvestigatorFirstName": "Joe"
		"InvestigatorLastName": "Taylor"
		"Address1": "300 Barr harbor Dr"
		"Address2": "Five Towerbridge"
		"Address3": "Suite 400"
		"City": "Broomal"
		"State": "PA"
		"Zip": "18976"
		"CountryId": "USA"
		"ShipFax": "12398098111"
		"ShipName": "Marysya"
		"ShipEmail": "donotreply@oracle.com"
		"ShipNote": "note text"
		"TimeZone": "Eastern Standard Time"
		"ExternalId": "1233229"
		"DEARegistrationNumber": "ab1234568"
		"DEAExpiration": "2018-05-25T19:01:06.439617+01:00"
	]
}

Response Details

In addition to the response code, the response payload contains the following:

• Common Exception – any errors that occurred while transforming the payload that fails the entire transaction

• Number of successful records

• Transaction ID

• Total records

• HasExceptions flag

• Record details

  • All elements of the record sent.

  • Success flag.

  • Error messages – one record can have more than one failure. Each error will have the following information:

    • Code

    • Description

    • Field name

    • Severity level - critical, fatal, or warning

Step 3: Troubleshooting

All business and technical errors are included in the response. For further diagnosis provide the transaction ID contained in the response.