Jump to

• Request
• Response

Terminate or reinstate a site

patch

/scim/{trialname}/2.0/groups

Terminates or reinstates an InForm sutdy site.

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.

Body ()

Root Schema : schema

Match All

Show Source

• object SitePatch

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

Nested Schema : SitePatch

Type: object

Show Source

• urn:umt:extension:schema:site(required): urn:umt:extension:schema:site

{
    "type":"object",
    "required":[
        "urn:umt:extension:schema:site"
    ],
    "properties":{
        "urn:umt:extension:schema:site":{
            "allOf":[
                {
                    "$ref":"#/definitions/SitePatchAttr"
                }
            ]
        }
    }
}

Nested Schema : urn:umt:extension:schema:site

Match All

Show Source

• object SitePatchAttr

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

Nested Schema : SitePatchAttr

Type: object

Show Source

• active(required): boolean
  Use value true to re-instate, false to terminate.
• SiteMnemonic(required): string
  Maximum Length: 20

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

  Site Mnemonic. Also referred to as the site number.

{
    "type":"object",
    "required":[
        "SiteMnemonic",
        "active"
    ],
    "properties":{
        "SiteMnemonic":{
            "type":"string",
            "maxLength":"20",
            "pattern":"(\\w|-|_| )+",
            "description":"Site Mnemonic. Also referred to as the site number."
        },
        "active":{
            "type":"boolean",
            "description":"Use value true to re-instate, false to terminate."
        }
    }
}

Back to Top

Response

Supported Media Types

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

200 Response

OK

Body ()

Root Schema : schema

Type: object

500 Response

Body ()

Root Schema : schema

Type: object

Show Source

• Message: string
  Default Value: Error messages defined in the model.

  • Unauthorized - An invalid token or study name was provided.
  • Site number not provided - Site number was not provided.
  • Invalid Site - Invalid site number provided.
  • Unknown error - Internal processing error. Please contact support.

{
    "type":"object",
    "properties":{
        "Message":{
            "type":"string",
            "description":"<ul>\n<li><i>Unauthorized</i> - An invalid token or study name was provided.</li> \n<li><i>Site number not provided</i> - Site number was not provided.</li>\n<li><i>Invalid Site</i> -  Invalid site number provided.</li>\n<li><i>Unknown error</i> -  Internal processing error. Please contact support.</li>\n</ul>\n",
            "default":"Error messages defined in the model."
        }
    }
}

Back to Top