REST APIs for Oracle InForm User Management Tool

Add a site

post

/scim/{trialname}/2.0/groups

Adds a site to an InForm study.

Request

Supported Media Types

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded

Path Parameters

trialname(required): string

Name of the InForm study.

Root Schema : Site

Type: object

Show Source

displayName(required): string

Maximum Length: 255

Pattern: ([^~`!@#$%^&*()\+=\{\}\[\]\|\\"\<\>\?\/ ])+

A human-readable name for the site.
urn:umt:extension:schema:site(required): object UMTSite

{
    "type":"object",
    "required":[
        "displayName",
        "urn:umt:extension:schema:site"
    ],
    "properties":{
        "displayName":{
            "type":"string",
            "maxLength":"255",
            "pattern":" ([^~`!@#$%^&*()\\+=\\{\\}\\[\\]\\|\\\\\"\\<\\>\\?\\/\t])+",
            "description":"A human-readable name for the site."
        },
        "urn:umt:extension:schema:site":{
            "$ref":"#/definitions/UMTSite"
        }
    }
}

Nested Schema : UMTSite

Type: object

Show Source

active(required): boolean

Default value is true. Use PATCH with value true to re-instate. All other actions ignore this attribute.
addresses(required): addresses
DateFormat(required): DateFormat
email(required): string

Maximum Length: 255

Pattern: ^[A-Za-z0-9\._\#\!\$\&\'\*\/\=\?\^\`\{\}\~\|\%\+\-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,4}$

Email address for the site.
locale(required): locale
phoneNumbers(required): array phoneNumbers

Contact numbers for the site. Primary phone number is required. Pager type is not supported for site. The specific format for the contact number is user determined.
Reason(required): string

Maximum Length: 255

Reason for the change.
SignatureOrder(required): string

Allowed Values: [ "F,L", "L,F" ]

Study name signature order.
SiteMnemonic(required): string

Maximum Length: 20

Pattern: (\w|-|_| )+

Site Mnemonic. Also referred to as the site number.
timeZone(required): timeZone

{
    "type":"object",
    "required":[
        "SiteMnemonic",
        "email",
        "phoneNumbers",
        "addresses",
        "timeZone",
        "DateFormat",
        "locale",
        "active",
        "SignatureOrder",
        "Reason"
    ],
    "properties":{
        "SiteMnemonic":{
            "type":"string",
            "maxLength":"20",
            "pattern":"(\\w|-|_| )+",
            "description":"Site Mnemonic. Also referred to as the site number."
        },
        "email":{
            "type":"string",
            "maxLength":"255",
            "pattern":"^[A-Za-z0-9\\._\\#\\!\\$\\&\\'\\*\\/\\=\\?\\^\\`\\{\\}\\~\\|\\%\\+\\-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,4}$",
            "description":"Email address for the site."
        },
        "phoneNumbers":{
            "type":"array",
            "description":"Contact numbers for the site. Primary phone number is required. Pager type is not supported for site. The specific format for the contact number is user determined.",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ContactNumber"
                    }
                ]
            }
        },
        "addresses":{
            "allOf":[
                {
                    "$ref":"#/definitions/address"
                },
                {
                    "description":"Address for the site."
                }
            ]
        },
        "timeZone":{
            "allOf":[
                {
                    "$ref":"#/definitions/timeZone"
                },
                {
                    "description":"Timezone for the site. Please use one of the provided values."
                }
            ]
        },
        "DateFormat":{
            "allOf":[
                {
                    "$ref":"#/definitions/DateFormat"
                }
            ]
        },
        "locale":{
            "allOf":[
                {
                    "$ref":"#/definitions/locale"
                },
                {
                    "description":"Site Study Locale."
                }
            ]
        },
        "active":{
            "type":"boolean",
            "description":"Default value is true. Use PATCH with value true to re-instate. All other actions ignore this attribute."
        },
        "SignatureOrder":{
            "type":"string",
            "description":"Study name signature order.",
            "enum":[
                "F,L",
                "L,F"
            ]
        },
        "Reason":{
            "type":"string",
            "maxLength":"255",
            "description":"Reason for the change."
        }
    }
}

Nested Schema : addresses

Match All

Show Source

object address
Address for the site.

{
    "allOf":[
        {
            "$ref":"#/definitions/address"
        },
        {
            "description":"Address for the site."
        }
    ]
}

Nested Schema : DateFormat

Match All

Show Source

string

Allowed Values: [ "Day / Month / Year", "Month / Day / Year", "Year / Month / Day" ]

DateFormat to be used.

{
    "allOf":[
        {
            "$ref":"#/definitions/DateFormat"
        }
    ]
}

Nested Schema : locale

Match All

Show Source

string

Allowed Values: [ "English (United States)", "Japanese (Japan)" ]
Site Study Locale.

{
    "allOf":[
        {
            "$ref":"#/definitions/locale"
        },
        {
            "description":"Site Study Locale."
        }
    ]
}

Nested Schema : phoneNumbers

Type: array

Contact numbers for the site. Primary phone number is required. Pager type is not supported for site. The specific format for the contact number is user determined.

Show Source

Array of: items

{
    "type":"array",
    "description":"Contact numbers for the site. Primary phone number is required. Pager type is not supported for site. The specific format for the contact number is user determined.",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ContactNumber"
            }
        ]
    }
}

Nested Schema : timeZone

Match All

Show Source

string

Allowed Values: [ "(UTC-07:00) Chihuahua, La Paz, Mazatlan", "(UTC-07:00) Mountain Time(US & Canada)", "(UTC-08:00) Baja California", "(UTC-08:00) Pacific Time(US & Canada)", "(UTC-09:00) Alaska", "(UTC-10:00) Hawaii", "(UTC-11:00) Coordinated Universal Time-11", "(UTC-12:00) International Date Line West", "(UTC+02:00) Chisinau", "(UTC-05:00) Bogota, Lima, Quito, Rio Branco", "(UTC-05:00) Eastern Time(US & Canada)", "(UTC-05:00) Indiana(East)", "(UTC-06:00) Central America", "(UTC-06:00) Central Time(US & Canada)", "(UTC-06:00) Guadalajara, Mexico City, Monterrey", "(UTC-06:00) Saskatchewan", "(UTC-07:00) Arizona", "(UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi", "(UTC+02:00) Tripoli", "(UTC+03:00) Minsk", "(UTC+14:00) Kiritimati Island", "(UTC+11:00) Chokurdakh", "(UTC+12:00) Anadyr, Petropavlovsk-Kamchatsky", "(UTC+04:00) Izhevsk, Samara", "(UTC+01:00) Casablanca", "(UTC) Coordinated Universal Time", "(UTC+00:00) Dublin, Edinburgh, Lisbon, London", "(UTC+00:00) Monrovia, Reykjavik", "(UTC+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna", "(UTC+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague", "(UTC+01:00) Brussels, Copenhagen, Madrid, Paris", "(UTC+01:00) Sarajevo, Skopje, Warsaw, Zagreb", "(UTC+01:00) West Central Africa", "(UTC+02:00) Windhoek", "(UTC+02:00) Amman", "(UTC+02:00) Athens, Bucharest", "(UTC+02:00) Beirut", "(UTC+02:00) Cairo", "(UTC+02:00) Damascus", "(UTC+02:00) Harare, Pretoria", "(UTC+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius", "(UTC+03:00) Istanbul", "(UTC+02:00) Jerusalem", "(UTC+03:00) Baghdad", "(UTC+02:00) Kaliningrad", "(UTC+03:00) Kuwait, Riyadh", "(UTC+03:00) Nairobi", "(UTC+03:30) Tehran", "(UTC+04:00) Abu Dhabi, Muscat", "(UTC+04:00) Baku", "(UTC+03:00) Moscow, St. Petersburg", "(UTC+04:00) Port Louis", "(UTC+04:00) Tbilisi", "(UTC+04:00) Yerevan", "(UTC+04:30) Kabul", "(UTC+05:00) Islamabad, Karachi", "(UTC+05:00) Ashgabat, Tashkent", "(UTC+05:30) Sri Jayawardenepura", "(UTC+05:45) Kathmandu", "(UTC+06:00) Astana", "(UTC+06:00) Dhaka", "(UTC+05:00) Ekaterinburg", "(UTC+06:30) Yangon(Rangoon)", "(UTC+07:00) Bangkok, Hanoi, Jakarta", "(UTC+07:00) Novosibirsk", "(UTC+08:00) Beijing, Chongqing, Hong Kong, Urumqi", "(UTC+07:00) Krasnoyarsk", "(UTC+08:00) Kuala Lumpur, Singapore", "(UTC+08:00) Perth", "(UTC+08:00) Taipei", "(UTC+08:00) Ulaanbaatar", "(UTC+08:00) Irkutsk", "(UTC+09:00) Osaka, Sapporo, Tokyo", "(UTC+09:00) Seoul", "(UTC+09:30) Adelaide", "(UTC+09:30) Darwin", "(UTC+10:00) Brisbane", "(UTC+10:00) Canberra, Melbourne, Sydney", "(UTC+10:00) Guam, Port Moresby", "(UTC+10:00) Hobart", "(UTC+09:00) Yakutsk", "(UTC+11:00) Solomon Is., New Caledonia", "(UTC+10:00) Vladivostok", "(UTC+12:00) Auckland, Wellington", "(UTC+12:00) Coordinated Universal Time+12", "(UTC+12:00) Fiji", "(UTC+11:00) Magadan", "(UTC+12:00) Petropavlovsk - Kamchatsky - Old", "(UTC+13:00) Nuku'alofa", "(UTC+13:00) Samoa", "(UTC-01:00) Azores", "(UTC-01:00) Cabo Verde Is.", "(UTC-02:00) Coordinated Universal Time-02", "(UTC-03:00) Brasilia", "(UTC-03:00) City of Buenos Aires", "(UTC-03:00) Cayenne, Fortaleza", "(UTC-03:00) Greenland", "(UTC-03:00) Montevideo", "(UTC-03:00) Salvador", "(UTC-03:30) Newfoundland", "(UTC-04:00) Asuncion", "(UTC-04:00) Atlantic Time(Canada)", "(UTC-04:00) Cuiaba", "(UTC-04:00) Georgetown, La Paz, Manaus, San Juan", "(UTC-04:00) Santiago", "(UTC-04:00) Caracas", "(UTC-10:00) Aleutian Islands", "(UTC+07:00) Barnaul, Gorno-Altaysk", "(UTC+04:00) Astrakhan, Ulyanovsk", "(UTC+11:00) Bougainville Island", "(UTC+12:45) Chatham Islands", "(UTC-05:00) Havana", "(UTC-06:00) Easter Island", "(UTC-05:00) Chetumal", "(UTC-05:00) Haiti", "(UTC+10:30) Lord Howe Island", "(UTC-09:30) Marquesas Islands", "(UTC+11:00) Norfolk Island", "(UTC+09:00) Pyongyang", "(UTC+06:00) Omsk", "(UTC-03:00) Saint Pierre and Miquelon", "(UTC+11:00) Sakhalin", "(UTC-03:00) Araguaina", "(UTC+07:00) Tomsk", "(UTC+09:00) Chita", "(UTC-05:00) Turks and Caicos", "(UTC-08:00) Coordinated Universal Time-08", "(UTC-09:00) Coordinated Universal Time-09", "(UTC+07:00) Hovd", "(UTC+02:00) Gaza, Hebron", "(UTC+08:45) Eucla", "(UTC-03:00) Punta Arenas", "(UTC+04:00) Saratov", "(UTC+13:00) Coordinated Universal Time+13", "(UTC+04:00) Volgograd", "(UTC+00:00) Sao Tome", "(UTC+05:00) Qyzylorda" ]

Supported timezone values
Timezone for the site. Please use one of the provided values.

{
    "allOf":[
        {
            "$ref":"#/definitions/timeZone"
        },
        {
            "description":"Timezone for the site. Please use one of the provided values."
        }
    ]
}

Nested Schema : address

Type: object

Show Source

country(required): string

Maximum Length: 255

Pattern: ([a-zA-Z0-9]| | )+

The country name component.
formatted: string

Maximum Length: 255

Pattern: ([A-Z]|[a-z]|[0-9]|[,]|-|_|[.]| |)+

Any additional line for the address after 'streetAddress'. This is labeled as 'Address2' in the Oracle User Management Tool application.
locality: string

Maximum Length: 255

Pattern: ([a-zA-Z0-9]| | )+

The city or locality component of the address.
postalCode: string

Maximum Length: 16

The zip code or postal code component.
region: string

Maximum Length: 255

Pattern: ([A-Z]|[a-z]| | )*

The state or region component.
streetAddress(required): string

Maximum Length: 255

Pattern: ([A-Z]|[a-z]|[0-9]|[,]|-|_|[.]| |)+

The full street address component, which may include building number, street name, and P.O. box.

{
    "type":"object",
    "required":[
        "streetAddress",
        "country"
    ],
    "properties":{
        "streetAddress":{
            "type":"string",
            "maxLength":"255",
            "pattern":"([A-Z]|[a-z]|[0-9]|[,]|-|_|[.]| |)+",
            "description":"The full street address component, which may include building number, street name, and P.O. box."
        },
        "formatted":{
            "type":"string",
            "maxLength":"255",
            "pattern":"([A-Z]|[a-z]|[0-9]|[,]|-|_|[.]| |)+",
            "description":"Any additional line for the address after 'streetAddress'. This is labeled as 'Address2' in the Oracle User Management Tool application."
        },
        "locality":{
            "type":"string",
            "maxLength":"255",
            "pattern":"([a-zA-Z0-9]| | )+",
            "description":"The city or locality component of the address."
        },
        "region":{
            "type":"string",
            "maxLength":"255",
            "pattern":"([A-Z]|[a-z]| | )*",
            "description":"The state or region component."
        },
        "postalCode":{
            "type":"string",
            "maxLength":"16",
            "description":"The zip code or postal code component."
        },
        "country":{
            "type":"string",
            "maxLength":"255",
            "pattern":"([a-zA-Z0-9]| | )+",
            "description":"The country name component."
        }
    }
}

Nested Schema : items

Match All

Show Source

object ContactNumber

{
    "allOf":[
        {
            "$ref":"#/definitions/ContactNumber"
        }
    ]
}

Nested Schema : ContactNumber

Type: object

Show Source

type(required): string

Allowed Values: [ "primary", "fax", "alternate", "pager" ]
value(required): string

Maximum Length: 25

Pattern: ([A-Z]|[a-z]|[0-9]|[,]|-|_|[.]| |)+

{
    "type":"object",
    "required":[
        "type",
        "value"
    ],
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "primary",
                "fax",
                "alternate",
                "pager"
            ]
        },
        "value":{
            "type":"string",
            "maxLength":"25",
            "pattern":"([A-Z]|[a-z]|[0-9]|[,]|-|_|[.]| |)+"
        }
    }
}

Response

Supported Media Types

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

201 Response

Created

Root Schema : schema

Type: object

401 Response

Unauthorized. An invalid token or study name was provided

Root Schema : schema

Type: object

500 Response

Root Schema : schema

Type: object

Show Source

Message: Message

{
    "type":"object",
    "properties":{
        "Message":{
            "allOf":[
                {
                    "$ref":"#/definitions/siteerror"
                }
            ]
        }
    }
}

Nested Schema : Message

Match All

Show Source

string
Default Value: Error messages defined in the model.
- Site number not provided - Site number was not provided.
- Site name not provided - Site name was not provided.
- Site Address1 not found - StreetAddress was not provided.
- Country name not found - Country name was not provided.
- Invalid Characters found in site number - Invalid characters were found in the site number.
- Site number should have at least one number - The site number is missing at least one number.
- Invalid Characters found in Site name - Invalid characters were found in the site name.
- Invalid Characters found in Address1 - Invalid characters were found in StreetAddress.
- Invalid Characters found in Address2 - Invalid characters were found in formatted attribute.
- Invalid Characters found in City/Town name - Invalid characters were found in locality attribute.
- Invalid Characters found in Region/State name - Invalid characters were found in region attribute.
- Invalid Characters found in Postal/Zip Code - Invalid characters were found in postalcode attribute.
- Email ID is Invalid - The email ID was invalid.
- Time zone Not Found For The Trial - The time zone provided was not recognized by the system.
- Country Name is Invalid - The country name provided was not recognized by the system.
- Site Study Locale Not Found For The Trial - The specified locale has not been added or associated to the study.
- Site number exceeds maximum limit 20 characters - The site number exceeded the maximum character limit.
- Site name exceeds maximum limit 255 characters - The site name exceeded the maximum character limit.
- City/Town name exceeds maximum limit 127 characters - The city or town name exceeded the maximum character limit.
- Region/State name exceeds maximum limit 255 characters - The region or state name exceeded the maximum character limit.
- Postal Code exceeds maximum limit 16 characters - The postal code exceeded the maximum character limit.
- Phone number exceeds maximum limit 25 characters - The phone number exceeded the maximum character limit.
- Fax number exceeds maximum limit 25 characters - The fax number exceeded the maximum character limit.
- Alternate Phone Number exceeds maximum limit 25 characters - The alternate phone number exceeded the maximum character limit.
- Email ID exceeds maximum limit 255characters) - The email ID exceeded the maximum character limit.
- Address1 exceeds maximum limit 255 characters) - StreetAddress exceeded the maximum character limit.
- Address2 exceeds maximum limit 255 characters) - formatted attribute of address exceeded the maximum character limit.
- Country Not found for the Trial - The specified country has not been added or associated to the study.
- Subject Selection and Initial Subjects Not found for the Trial - This error message only applies for studies that are below version 6.3.
- Trial is locked - Cannot update site when trial is in locked status.
- Internal Error - Internal processing error. Please contact support.

{
    "allOf":[
        {
            "$ref":"#/definitions/siteerror"
        }
    ]
}