REST API for Oracle Health Sciences IRT

Create or update one or more site.

post

/<irt_study>/api/sites

Request

Supported Media Types

application/json
text/json
application/xml
text/xml

Body Parameter

List of sites.

Root Schema : /paths/~1api~1sites/post/parameters/0/schema

Type: array

Items

Type: object SiteDto

Nested Schema : SiteDto

Type: object

Properties

Address1: Type: string

The address of the ship location: Street address. At least one of the three address fields must be provided.
Address2: Type: string

The address of the ship location: Suite or office number.
Address3: Type: string

Line 3 of the site address.
City: Type: string

The address of the ship location: City. REQUIRED.
CountryId: Type: string

The three digit ISO Code of country where the site is located. The country must already be configured for the study to allow sites in IRT. REQUIRED.
DEAExpiration: Type: string (date-time)

REQUIRED only if the study has a controlled substance.
DEARegistrationNumber: Type: string

REQUIRED only if the study has a controlled substance.
ErrorCount: Type: integer (int32)

The count of errors for this record.
ErrorMessages: Type: array ErrorMessages

Error list.
ExternalId: Type: string

The site identifier in the client system. OPTIONAL.
InvestigatorFirstName: Type: string

Last Name of the Site Investigator. REQUIRED
InvestigatorId: Type: string

The Investigator ID number. REQUIRED if configured for the study.
InvestigatorLastName: Type: string

First Name of the Site Investigator. REQUIRED
IsSuccessful: Type: boolean

Flag indicating if the record creation/update was successful.
Key: Type: string (uuid)

Generated GUID to identify the site record. Referenced by the error object to identify the corresponding record.
ShipEmail: Type: string

The email address of the contact at the ship location. REQUIRED
ShipFax: Type: string

The fax number of the ship location. OPTIONAL.
ShipName: Type: string

The name of the location where the drugs should be shipped. REQUIRED.
ShipNote: Type: string

A note for the ship location. OPTIONAL.
ShipPhone: Type: string

The phone number of the ship location. OPTIONAL.
SiteId: Type: string

The site ID number. REQUIRED to create the site.
State: Type: string

The address of the ship location: State. REQUIRED.
TimeZone: Type: string

The time zone in which the site is located. The Valid Time Zone Name as per https://support.microsoft.com/en-us/kb/973627. REQUIRED.
Zip: Type: string

The address of the ship location: Zip code. REQUIRED.

Nested Schema : ErrorMessages

Type: array

Error list.

Items

Type: object ErrorDto

Nested Schema : ErrorDto

Type: object

Properties

Code: Type: string

Numeric error code.
description: Type: string

Error description.
ExceptionField: Type: string

Allowed Values: [ "NULL", "SiteId", "CountryId", "InvestigatorId", "InvestigatorFirstName", "InvestigatorLastName", "ShipName", "Phone", "Fax", "Email", "Address", "Address1", "Address2", "Address3", "City", "State", "Zip", "TimeZone", "ExternalId", "ShipNote", "DeaRegistrationNumber", "DeaExpiration", "DrugResupplyTypeId", "Approved", "InitiallyApproved", "ReapprovedDate", "DeactivationDate", "RandOpen", "ScreeningOpen", "DrugOrderingOpen", "RandLimit", "LastScreeningNumber", "ScreeningLimit", "UserDepotId", "UserFirstName", "UserLastName", "UserInitial", "UserTitle", "UserCompany", "UserExternalId", "UserRoleId", "UserLanguage", "UserDateFormat", "SendUserId" ]

The field corresponding to the error. For example, if the error is for the zip code, its value will be Zip.
Key: Type: string (uuid)

The internal GUID to identify the corresponding site record.
SeverityLevel: Type: string

Allowed Values: [ "Warning", "Critical", "Fatal" ]

The severity level of the error.

Response

Supported Media Types

application/json
text/json
application/xml
text/xml

200 Response

The sites have been created/updated successfully.

Body

The class process Users/Sites and creates response to send back

Root Schema : ResponseModel[UserDto]

Type: object

The class process Users/Sites and creates response to send back

Properties

CommonExceptions: Type: array CommonExceptions

Read Only: true

The list of errors that occurred while transforming the payload that fails the entire transaction.
HasExceptions: Type: boolean

True, if there any errors.
Records: Type: array Records

The total number of records processed in the request.
SuccessfulRecords: Type: integer (int32)

The number of records processed successfully.
Transaction: Type: string

The internal transacation id captured in the logs.

Nested Schema : CommonExceptions

Type: array

Read Only: true

The list of errors that occurred while transforming the payload that fails the entire transaction.

Items

Type: object ErrorDto

Nested Schema : Records

Type: array

The total number of records processed in the request.

Items

Type: object UserDto

Nested Schema : ErrorDto

Type: object

Properties

Code: Type: string

Numeric error code.
description: Type: string

Error description.
ExceptionField: Type: string

Allowed Values: [ "NULL", "SiteId", "CountryId", "InvestigatorId", "InvestigatorFirstName", "InvestigatorLastName", "ShipName", "Phone", "Fax", "Email", "Address", "Address1", "Address2", "Address3", "City", "State", "Zip", "TimeZone", "ExternalId", "ShipNote", "DeaRegistrationNumber", "DeaExpiration", "DrugResupplyTypeId", "Approved", "InitiallyApproved", "ReapprovedDate", "DeactivationDate", "RandOpen", "ScreeningOpen", "DrugOrderingOpen", "RandLimit", "LastScreeningNumber", "ScreeningLimit", "UserDepotId", "UserFirstName", "UserLastName", "UserInitial", "UserTitle", "UserCompany", "UserExternalId", "UserRoleId", "UserLanguage", "UserDateFormat", "SendUserId" ]

The field corresponding to the error. For example, if the error is for the zip code, its value will be Zip.
Key: Type: string (uuid)

The internal GUID to identify the corresponding site record.
SeverityLevel: Type: string

Allowed Values: [ "Warning", "Critical", "Fatal" ]

The severity level of the error.

Nested Schema : UserDto

Type: object

Properties

Address: Type: string

The address of the user. OPTIONAL.
City: Type: string

The address of the user: City. OPTIONAL.
Company: Type: string

The company that the user works for. OPTIONAL.
Country: Type: string

The address of the user: Country. This must exist in the list of countries specified in the IRT Configuration Settings Document for the study. The value will be the three letter ISO Code for the Country. REQUIRED.
DateFormat: Type: string

The format for entering the date on the phone. OPTIONAL.
Depot: Type: string

The depot associated with the user. REQUIRED for the depot user role.
Email: Type: string

The email address of the user. Must be a valid email address. REQUIRED.
ErrorCount: Type: integer (int32)

The count of errors for this record.
ErrorMessages: Type: array ErrorMessages

The error details.
ExternalUserId: Type: string

The site identifier in the client system. OPTIONAL.
Fax: Type: string

The fax number of the user. Must be a valid fax number. OPTIONAL.
FirstName: Type: string

The first name of the user. REQUIRED.
InFormUserId: Type: string

Only for InForm integrated studies. User identifer in InForm for the user. OPTIONAL
Initial: Type: string

The middle initial of the user. OPTIONAL.
IsSuccessful: Type: boolean

A flag indicating if the record creation/update was successful.
Key: Type: string (uuid)

The generated GUID to identify the site record. Referenced by the error object to identify the corresponding record.
KeyId: Type: string

Response parameter. GUID of the record for internal reference. Not REQUIRED.
Language: Type: string

The preferred language of the user. OPTIONAL.
LastName: Type: string

The last name of the user. REQUIRED.
Phone: Type: string

The phone number of the user. Must be a valid phone number. OPTIONAL.
Role: Type: string

The user’s role in IRT. REQUIRED.
SendUserId: Type: boolean

A flag indicating whether to create a new user id. OPTIONAL.
Site: Type: string

The site associated with the user. REQUIRED for the site user role.
State: Type: string

The address of the user: State. OPTIONAL.
TimeZone: Type: string

The time zone of user's location. The Valid Time Zone Name as explained on https://support.microsoft.com/en-us/kb/973627. OPTIONAL.
Title: Type: string

The title of the user. OPTIONAL.
Zip: Type: string

The address of the user: Zip code. OPTIONAL.

Nested Schema : ErrorMessages

Type: array

The error details.

Items

Type: object ErrorDto

201 Response

The sites have been created successfully.

Body

The class process Users/Sites and creates response to send back

Root Schema : ResponseModel[UserDto]

Type: object

The class process Users/Sites and creates response to send back

Properties

CommonExceptions: Type: array CommonExceptions

Read Only: true

The list of errors that occurred while transforming the payload that fails the entire transaction.
HasExceptions: Type: boolean

True, if there any errors.
Records: Type: array Records

The total number of records processed in the request.
SuccessfulRecords: Type: integer (int32)

The number of records processed successfully.
Transaction: Type: string

The internal transacation id captured in the logs.

Nested Schema : CommonExceptions

Type: array

Read Only: true

The list of errors that occurred while transforming the payload that fails the entire transaction.

Items

Type: object ErrorDto

Nested Schema : Records

Type: array

The total number of records processed in the request.

Items

Type: object UserDto

Nested Schema : ErrorDto

Type: object

Properties

Code: Type: string

Numeric error code.
description: Type: string

Error description.
ExceptionField: Type: string

Allowed Values: [ "NULL", "SiteId", "CountryId", "InvestigatorId", "InvestigatorFirstName", "InvestigatorLastName", "ShipName", "Phone", "Fax", "Email", "Address", "Address1", "Address2", "Address3", "City", "State", "Zip", "TimeZone", "ExternalId", "ShipNote", "DeaRegistrationNumber", "DeaExpiration", "DrugResupplyTypeId", "Approved", "InitiallyApproved", "ReapprovedDate", "DeactivationDate", "RandOpen", "ScreeningOpen", "DrugOrderingOpen", "RandLimit", "LastScreeningNumber", "ScreeningLimit", "UserDepotId", "UserFirstName", "UserLastName", "UserInitial", "UserTitle", "UserCompany", "UserExternalId", "UserRoleId", "UserLanguage", "UserDateFormat", "SendUserId" ]

The field corresponding to the error. For example, if the error is for the zip code, its value will be Zip.
Key: Type: string (uuid)

The internal GUID to identify the corresponding site record.
SeverityLevel: Type: string

Allowed Values: [ "Warning", "Critical", "Fatal" ]

The severity level of the error.

Nested Schema : UserDto

Type: object

Properties

Address: Type: string

The address of the user. OPTIONAL.
City: Type: string

The address of the user: City. OPTIONAL.
Company: Type: string

The company that the user works for. OPTIONAL.
Country: Type: string

The address of the user: Country. This must exist in the list of countries specified in the IRT Configuration Settings Document for the study. The value will be the three letter ISO Code for the Country. REQUIRED.
DateFormat: Type: string

The format for entering the date on the phone. OPTIONAL.
Depot: Type: string

The depot associated with the user. REQUIRED for the depot user role.
Email: Type: string

The email address of the user. Must be a valid email address. REQUIRED.
ErrorCount: Type: integer (int32)

The count of errors for this record.
ErrorMessages: Type: array ErrorMessages

The error details.
ExternalUserId: Type: string

The site identifier in the client system. OPTIONAL.
Fax: Type: string

The fax number of the user. Must be a valid fax number. OPTIONAL.
FirstName: Type: string

The first name of the user. REQUIRED.
InFormUserId: Type: string

Only for InForm integrated studies. User identifer in InForm for the user. OPTIONAL
Initial: Type: string

The middle initial of the user. OPTIONAL.
IsSuccessful: Type: boolean

A flag indicating if the record creation/update was successful.
Key: Type: string (uuid)

The generated GUID to identify the site record. Referenced by the error object to identify the corresponding record.
KeyId: Type: string

Response parameter. GUID of the record for internal reference. Not REQUIRED.
Language: Type: string

The preferred language of the user. OPTIONAL.
LastName: Type: string

The last name of the user. REQUIRED.
Phone: Type: string

The phone number of the user. Must be a valid phone number. OPTIONAL.
Role: Type: string

The user’s role in IRT. REQUIRED.
SendUserId: Type: boolean

A flag indicating whether to create a new user id. OPTIONAL.
Site: Type: string

The site associated with the user. REQUIRED for the site user role.
State: Type: string

The address of the user: State. OPTIONAL.
TimeZone: Type: string

The time zone of user's location. The Valid Time Zone Name as explained on https://support.microsoft.com/en-us/kb/973627. OPTIONAL.
Title: Type: string

The title of the user. OPTIONAL.
Zip: Type: string

The address of the user: Zip code. OPTIONAL.

Nested Schema : ErrorMessages

Type: array

The error details.

Items

Type: object ErrorDto

204 Response

The response has no content.

Body

Root Schema : /paths/~1api~1sites/post/responses/204/schema

Type: string

207 Response

The request ran successfully, but some records had errors.

Body

The class process Users/Sites and creates response to send back

Root Schema : ResponseModel[UserDto]

Type: object

The class process Users/Sites and creates response to send back

Properties

CommonExceptions: Type: array CommonExceptions

Read Only: true

The list of errors that occurred while transforming the payload that fails the entire transaction.
HasExceptions: Type: boolean

True, if there any errors.
Records: Type: array Records

The total number of records processed in the request.
SuccessfulRecords: Type: integer (int32)

The number of records processed successfully.
Transaction: Type: string

The internal transacation id captured in the logs.

Nested Schema : CommonExceptions

Type: array

Read Only: true

The list of errors that occurred while transforming the payload that fails the entire transaction.

Items

Type: object ErrorDto

Nested Schema : Records

Type: array

The total number of records processed in the request.

Items

Type: object UserDto

Nested Schema : ErrorDto

Type: object

Properties

Code: Type: string

Numeric error code.
description: Type: string

Error description.
ExceptionField: Type: string

Allowed Values: [ "NULL", "SiteId", "CountryId", "InvestigatorId", "InvestigatorFirstName", "InvestigatorLastName", "ShipName", "Phone", "Fax", "Email", "Address", "Address1", "Address2", "Address3", "City", "State", "Zip", "TimeZone", "ExternalId", "ShipNote", "DeaRegistrationNumber", "DeaExpiration", "DrugResupplyTypeId", "Approved", "InitiallyApproved", "ReapprovedDate", "DeactivationDate", "RandOpen", "ScreeningOpen", "DrugOrderingOpen", "RandLimit", "LastScreeningNumber", "ScreeningLimit", "UserDepotId", "UserFirstName", "UserLastName", "UserInitial", "UserTitle", "UserCompany", "UserExternalId", "UserRoleId", "UserLanguage", "UserDateFormat", "SendUserId" ]

The field corresponding to the error. For example, if the error is for the zip code, its value will be Zip.
Key: Type: string (uuid)

The internal GUID to identify the corresponding site record.
SeverityLevel: Type: string

Allowed Values: [ "Warning", "Critical", "Fatal" ]

The severity level of the error.

Nested Schema : UserDto

Type: object

Properties

Address: Type: string

The address of the user. OPTIONAL.
City: Type: string

The address of the user: City. OPTIONAL.
Company: Type: string

The company that the user works for. OPTIONAL.
Country: Type: string

The address of the user: Country. This must exist in the list of countries specified in the IRT Configuration Settings Document for the study. The value will be the three letter ISO Code for the Country. REQUIRED.
DateFormat: Type: string

The format for entering the date on the phone. OPTIONAL.
Depot: Type: string

The depot associated with the user. REQUIRED for the depot user role.
Email: Type: string

The email address of the user. Must be a valid email address. REQUIRED.
ErrorCount: Type: integer (int32)

The count of errors for this record.
ErrorMessages: Type: array ErrorMessages

The error details.
ExternalUserId: Type: string

The site identifier in the client system. OPTIONAL.
Fax: Type: string

The fax number of the user. Must be a valid fax number. OPTIONAL.
FirstName: Type: string

The first name of the user. REQUIRED.
InFormUserId: Type: string

Only for InForm integrated studies. User identifer in InForm for the user. OPTIONAL
Initial: Type: string

The middle initial of the user. OPTIONAL.
IsSuccessful: Type: boolean

A flag indicating if the record creation/update was successful.
Key: Type: string (uuid)

The generated GUID to identify the site record. Referenced by the error object to identify the corresponding record.
KeyId: Type: string

Response parameter. GUID of the record for internal reference. Not REQUIRED.
Language: Type: string

The preferred language of the user. OPTIONAL.
LastName: Type: string

The last name of the user. REQUIRED.
Phone: Type: string

The phone number of the user. Must be a valid phone number. OPTIONAL.
Role: Type: string

The user’s role in IRT. REQUIRED.
SendUserId: Type: boolean

A flag indicating whether to create a new user id. OPTIONAL.
Site: Type: string

The site associated with the user. REQUIRED for the site user role.
State: Type: string

The address of the user: State. OPTIONAL.
TimeZone: Type: string

The time zone of user's location. The Valid Time Zone Name as explained on https://support.microsoft.com/en-us/kb/973627. OPTIONAL.
Title: Type: string

The title of the user. OPTIONAL.
Zip: Type: string

The address of the user: Zip code. OPTIONAL.

Nested Schema : ErrorMessages

Type: array

The error details.

Items

Type: object ErrorDto

400 Response

The request could not be understood by the server due to malformed syntax.

Body

Root Schema : /paths/~1api~1sites/post/responses/400/schema

Type: string

401 Response

User authentication or authorization failed.

Body

Root Schema : /paths/~1api~1sites/post/responses/401/schema

Type: string

404 Response

The requested resource was not found.

Body

Root Schema : /paths/~1api~1sites/post/responses/404/schema

Type: string

417 Response

User creation/update failed because the records have errors.

Body

The class process Users/Sites and creates response to send back

Root Schema : ResponseModel[SiteDto]

Type: object

The class process Users/Sites and creates response to send back

Properties

CommonExceptions: Type: array CommonExceptions

Read Only: true

The list of errors that occurred while transforming the payload that fails the entire transaction.
HasExceptions: Type: boolean

True, if there are any errors.
Records: Type: array Records

The total number of records processed in the request.
SuccessfulRecords: Type: integer (int32)

The number of records processed successfully.
Transaction: Type: string

The internal transacation id captured in the logs.

Nested Schema : CommonExceptions

Type: array

Read Only: true

The list of errors that occurred while transforming the payload that fails the entire transaction.

Items

Type: object ErrorDto

Nested Schema : Records

Type: array

The total number of records processed in the request.

Items

Type: object SiteDto

Nested Schema : ErrorDto

Type: object

Properties

Code: Type: string

Numeric error code.
description: Type: string

Error description.
ExceptionField: Type: string

Allowed Values: [ "NULL", "SiteId", "CountryId", "InvestigatorId", "InvestigatorFirstName", "InvestigatorLastName", "ShipName", "Phone", "Fax", "Email", "Address", "Address1", "Address2", "Address3", "City", "State", "Zip", "TimeZone", "ExternalId", "ShipNote", "DeaRegistrationNumber", "DeaExpiration", "DrugResupplyTypeId", "Approved", "InitiallyApproved", "ReapprovedDate", "DeactivationDate", "RandOpen", "ScreeningOpen", "DrugOrderingOpen", "RandLimit", "LastScreeningNumber", "ScreeningLimit", "UserDepotId", "UserFirstName", "UserLastName", "UserInitial", "UserTitle", "UserCompany", "UserExternalId", "UserRoleId", "UserLanguage", "UserDateFormat", "SendUserId" ]

The field corresponding to the error. For example, if the error is for the zip code, its value will be Zip.
Key: Type: string (uuid)

The internal GUID to identify the corresponding site record.
SeverityLevel: Type: string

Allowed Values: [ "Warning", "Critical", "Fatal" ]

The severity level of the error.

Nested Schema : SiteDto

Type: object

Properties

Address1: Type: string

The address of the ship location: Street address. At least one of the three address fields must be provided.
Address2: Type: string

The address of the ship location: Suite or office number.
Address3: Type: string

Line 3 of the site address.
City: Type: string

The address of the ship location: City. REQUIRED.
CountryId: Type: string

The three digit ISO Code of country where the site is located. The country must already be configured for the study to allow sites in IRT. REQUIRED.
DEAExpiration: Type: string (date-time)

REQUIRED only if the study has a controlled substance.
DEARegistrationNumber: Type: string

REQUIRED only if the study has a controlled substance.
ErrorCount: Type: integer (int32)

The count of errors for this record.
ErrorMessages: Type: array ErrorMessages

Error list.
ExternalId: Type: string

The site identifier in the client system. OPTIONAL.
InvestigatorFirstName: Type: string

Last Name of the Site Investigator. REQUIRED
InvestigatorId: Type: string

The Investigator ID number. REQUIRED if configured for the study.
InvestigatorLastName: Type: string

First Name of the Site Investigator. REQUIRED
IsSuccessful: Type: boolean

Flag indicating if the record creation/update was successful.
Key: Type: string (uuid)

Generated GUID to identify the site record. Referenced by the error object to identify the corresponding record.
ShipEmail: Type: string

The email address of the contact at the ship location. REQUIRED
ShipFax: Type: string

The fax number of the ship location. OPTIONAL.
ShipName: Type: string

The name of the location where the drugs should be shipped. REQUIRED.
ShipNote: Type: string

A note for the ship location. OPTIONAL.
ShipPhone: Type: string

The phone number of the ship location. OPTIONAL.
SiteId: Type: string

The site ID number. REQUIRED to create the site.
State: Type: string

The address of the ship location: State. REQUIRED.
TimeZone: Type: string

The time zone in which the site is located. The Valid Time Zone Name as per https://support.microsoft.com/en-us/kb/973627. REQUIRED.
Zip: Type: string

The address of the ship location: Zip code. REQUIRED.

Nested Schema : ErrorMessages

Type: array

Error list.

Items

Type: object ErrorDto

500 Response

The server encountered an unexpected error.

Body

Root Schema : /paths/~1api~1sites/post/responses/500/schema

Type: string

Examples

The following example submits a POST request.

API URL

http://localhost:65385/IrtStudy/api/sites/post

Example of Request Body

The following example shows the request sent in JSON format.

[
  {
    "SiteId": "208",
    "InvestigatorId": "1289003",
    "InvestigatorFirstName": "John",
    "InvestigatorLastName": "Doe",
    "Address1": "123 Main Street",
    "Address2": "456 Main Street",
    "Address3": "789 Main Street",
    "City": "Broomal",
    "State": "PA",
    "Zip": "18976",
    "CountryId": "USA",
    "ShipPhone": "1239809118",
    "ShipFax": "12398098111",
    "ShipName": "Marysya",
    "ShipEmail": "john.doe@oracle.com",
    "ShipNote": "just note",
    "TimeZone": "Eastern Standard Time",
    "ExternalId": "1233229",
    "DEARegistrationNumber": "ab1234568",
    "DEAExpiration": "2018-05-25T14:01:06.439617-04:00"
  }
]

Example of Response Body

The following example shows the response returned in JSON format.

{
  "Transaction": "4706050217164838947",
  "Records": [
    {
      "Key": "7ac180e6-d840-4d4e-91cc-e70a14839ef2",
      "ErrorCount": 0,
      "ErrorMessages": [],
      "IsSuccessful": true,
      "SiteId": "208",
      "InvestigatorId": "1289003",
      "InvestigatorFirstName": "John",
      "InvestigatorLastName": "Doe",
      "Address1": "123 Main Street",
      "Address2": "456 Main Street",
      "Address3": "789 Main Street",
      "City": "Broomal",
      "State": "PA",
      "Zip": "18976",
      "CountryId": "USA",
      "ShipPhone": "1239809118",
      "ShipFax": "12398098111",
      "ShipName": "Marysya",
      "ShipEmail": "john.doe@oracle.com",
      "ShipNote": "just note",
      "TimeZone": "Eastern Standard Time",
      "ExternalId": "1233229",
      "DEARegistrationNumber": "ab1234568",
      "DEAExpiration": "2018-05-25T14:01:06.439617-04:00"
    }
  ],
  "CommonExceptions": [],
  "SuccessfulRecords": 1,
  "HasExceptions": false
}