GET api/ProtocolSearch?age={age}&diseasesite={diseasesite}&keyword={keyword}&drug={drug}&therapy={therapy}&excludetherapy={excludetherapy}&phase={phase}&cancerprevention={cancerprevention}&cancercontrol={cancercontrol}&protocolnumber={protocolnumber}&pi={pi}&studysite={studysite}&treatment={treatment}

Returns all SIP protocols matching query string filter parameters

Request Information

URI Parameters

NameDescriptionTypeAdditional information
age

e.g. adult, children

string

Default value is

diseasesite

e.g. breast, kidney, thyroid

string

Default value is

keyword

string

Default value is

drug

e.g. 06-benzylguanine, prednisone

string

Default value is

therapy

e.g. chemotherapy, immunotherapy

string

Default value is

excludetherapy

true or false

string

Default value is false

phase

e.g. I, II, III, IV

string

Default value is

cancerprevention

true or false

string

Default value is false

cancercontrol

true or false

string

Default value is false

protocolnumber

e.g. 12, 1234, 12-1234,

string

Default value is

pi

e.g. jones, smith

string

Default value is

studysite

e.g. UCD, UCHealth, Childrens Hospital

string

Default value is

treatment

e.g. Prevention, Screening, Diagnostic

string

Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of SIP_PROTOCOL
NameDescriptionTypeAdditional information
PROTOCOL_ID

decimal number

None.

PROTOCOL_NO

string

String length: inclusive between 0 and 35

TITLE

string

String length: inclusive between 0 and 4000

SUMMARY

string

String length: inclusive between 0 and 4000

STATUS

string

String length: inclusive between 0 and 30

PHASE_CODE

decimal number

None.

PHASE_DESC

string

String length: inclusive between 0 and 500

TREATMENT_TYPE_CODE

string

String length: inclusive between 0 and 12

TREATMENT_TYPE_DESC

string

String length: inclusive between 0 and 500

SCOPE_CODE

string

String length: inclusive between 0 and 12

SCOPE_DESC

string

String length: inclusive between 0 and 500

AGE

string

String length: inclusive between 0 and 1

CANCER_PREVENTION

string

String length: inclusive between 0 and 1

NCT_ID

string

String length: inclusive between 0 and 35

CANCER_CONTROL

string

String length: inclusive between 0 and 1

EXCLUDE_ON_WEB

string

String length: inclusive between 0 and 1

DESCRIPTION

string

String length: inclusive between 0 and 4000

SIP_CONFIG_STATUS

Collection of SIP_CONFIG_STATUS

None.

SIP_DISPLAYABLE_PROTOCOL

Collection of SIP_DISPLAYABLE_PROTOCOL

None.

SIP_EXCLUDED_PROTOCOL

Collection of SIP_EXCLUDED_PROTOCOL

None.

SIP_PCL_DETAIL

Collection of SIP_PCL_DETAIL

None.

SIP_PCL_DEVICE

Collection of SIP_PCL_DEVICE

None.

SIP_PCL_DISEASE_SITE

Collection of SIP_PCL_DISEASE_SITE

None.

SIP_PCL_DRUG

Collection of SIP_PCL_DRUG

None.

SIP_PCL_HISTOLOGY

Collection of SIP_PCL_HISTOLOGY

None.

SIP_PCL_ONCOLOGY_GROUP

Collection of SIP_PCL_ONCOLOGY_GROUP

None.

SIP_PCL_SPONSOR

Collection of SIP_PCL_SPONSOR

None.

SIP_PCL_STAFF

Collection of SIP_PCL_STAFF

None.

SIP_PCL_STUDY_SITE

Collection of SIP_PCL_STUDY_SITE

None.

SIP_PCL_THERAPY

Collection of SIP_PCL_THERAPY

None.

SIP_PCL_WEB_DISEASE_SITE

Collection of SIP_PCL_WEB_DISEASE_SITE

None.

SV_PCL_INST_CURR_STATUS

Collection of SV_PCL_INST_CURR_STATUS

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "PROTOCOL_ID": 1.0,
    "PROTOCOL_NO": "sample string 2",
    "TITLE": "sample string 3",
    "SUMMARY": "sample string 4",
    "STATUS": "sample string 5",
    "PHASE_CODE": 1.0,
    "PHASE_DESC": "sample string 6",
    "TREATMENT_TYPE_CODE": "sample string 7",
    "TREATMENT_TYPE_DESC": "sample string 8",
    "SCOPE_CODE": "sample string 9",
    "SCOPE_DESC": "sample string 10",
    "AGE": "sample string 11",
    "CANCER_PREVENTION": "sample string 12",
    "NCT_ID": "sample string 13",
    "CANCER_CONTROL": "sample string 14",
    "EXCLUDE_ON_WEB": "sample string 15",
    "DESCRIPTION": "sample string 16",
    "SIP_CONFIG_STATUS": [
      {
        "$id": "2",
        "Id": 1,
        "PROTOCOL_ID": 2.0,
        "PROTOCOL_NO": "sample string 3",
        "TITLE": "sample string 4",
        "PROTOCOL_STATUS": "sample string 5",
        "STATUS_DATE": "sample string 6",
        "CONFIGURATION_STATUS": "sample string 7",
        "SIP_PROTOCOL": {
          "$ref": "1"
        }
      },
      {
        "$ref": "2"
      }
    ],
    "SIP_DISPLAYABLE_PROTOCOL": [
      {
        "$id": "3",
        "Id": 1,
        "PROTOCOL_ID": 2.0,
        "PROTOCOL_NO": "sample string 3",
        "TITLE": "sample string 4",
        "SIP_PROTOCOL": {
          "$ref": "1"
        }
      },
      {
        "$ref": "3"
      }
    ],
    "SIP_EXCLUDED_PROTOCOL": [
      {
        "$id": "4",
        "Id": 1,
        "PROTOCOL_ID": 2.0,
        "PROTOCOL_NO": "sample string 3",
        "TITLE": "sample string 4",
        "STATUS": "sample string 5",
        "SIP_PROTOCOL": {
          "$ref": "1"
        }
      },
      {
        "$ref": "4"
      }
    ],
    "SIP_PCL_DETAIL": [
      {
        "$id": "5",
        "Id": 1,
        "PROTOCOL_ID": 2.0,
        "DETAIL": 3.0,
        "SIP_PROTOCOL": {
          "$ref": "1"
        }
      },
      {
        "$ref": "5"
      }
    ],
    "SIP_PCL_DEVICE": [
      {
        "$id": "6",
        "Id": 1,
        "PROTOCOL_ID": 2.0,
        "DEVICE_ID": 1.0,
        "DEVICE_CODE": "sample string 3",
        "DEVICE_NAME": "sample string 4",
        "DEVICE_PARENT": 1.0,
        "DEVICE_PARENT_CODE": "sample string 5",
        "DEVICE_PARENT_DESCRIPTION": "sample string 6",
        "SIP_PROTOCOL": {
          "$ref": "1"
        }
      },
      {
        "$ref": "6"
      }
    ],
    "SIP_PCL_DISEASE_SITE": [
      {
        "$id": "7",
        "Id": 1,
        "PROTOCOL_ID": 2.0,
        "DISEASE_SITE_DESC": "sample string 3",
        "SIP_PROTOCOL": {
          "$ref": "1"
        }
      },
      {
        "$ref": "7"
      }
    ],
    "SIP_PCL_DRUG": [
      {
        "$id": "8",
        "Id": 1,
        "PROTOCOL_ID": 2.0,
        "DRUG_ID": 1.0,
        "DRUG_CODE": "sample string 3",
        "DRUG_NAME": "sample string 4",
        "DRUG_PARENT": 1.0,
        "DRUG_PARENT_CODE": "sample string 5",
        "DRUG_PARENT_DESCRIPTION": "sample string 6",
        "SIP_PROTOCOL": {
          "$ref": "1"
        }
      },
      {
        "$ref": "8"
      }
    ],
    "SIP_PCL_HISTOLOGY": [
      {
        "$id": "9",
        "Id": 1,
        "PROTOCOL_ID": 2.0,
        "HISTOLOGY_CODE": "sample string 3",
        "HISTOLOGY_DESC": "sample string 4",
        "SIP_PROTOCOL": {
          "$ref": "1"
        }
      },
      {
        "$ref": "9"
      }
    ],
    "SIP_PCL_ONCOLOGY_GROUP": [
      {
        "$id": "10",
        "Id": 1,
        "PROTOCOL_ID": 2.0,
        "ONCOLOGY_GROUP_CODE": "sample string 3",
        "ONCOLOGY_GROUP_DESC": "sample string 4",
        "SIP_PROTOCOL": {
          "$ref": "1"
        }
      },
      {
        "$ref": "10"
      }
    ],
    "SIP_PCL_SPONSOR": [
      {
        "$id": "11",
        "Id": 1,
        "PROTOCOL_ID": 2.0,
        "PROTOCOL_NO": "sample string 3",
        "SPONSOR_TYPE": 1.0,
        "SPONSOR_TYPE_DESC": "sample string 4",
        "SPONSOR_PROTOCOL_NO": "sample string 5",
        "SIP_PROTOCOL": {
          "$ref": "1"
        }
      },
      {
        "$ref": "11"
      }
    ],
    "SIP_PCL_STAFF": [
      {
        "$id": "12",
        "Id": 1,
        "PROTOCOL_ID": 2.0,
        "FIRST_NAME": "sample string 3",
        "LAST_NAME": "sample string 4",
        "MID_INITIAL": "sample string 5",
        "ROLE_CODE": "sample string 6",
        "PHONE_NO": "sample string 7",
        "PHONE_EXT": 1.0,
        "FAX_NO": "sample string 8",
        "PAGER_NO": "sample string 9",
        "EMAIL": "sample string 10",
        "INSTITUTION": "sample string 11",
        "INSTITUTION_TYPE_CODE": "sample string 12",
        "INSTITUTION_TYPE": "sample string 13",
        "TITLE": "sample string 14",
        "CREDENTIALS": "sample string 15",
        "SIP_PROTOCOL": {
          "$ref": "1"
        }
      },
      {
        "$ref": "12"
      }
    ],
    "SIP_PCL_STUDY_SITE": [
      {
        "$id": "13",
        "Id": 1,
        "PROTOCOL_ID": 2.0,
        "STUDY_SITE_ID": 3.0,
        "STUDY_SITE_CODE": "sample string 4",
        "STUDY_SITE_NAME": "sample string 5",
        "INSTITUTION_CODE": 1.0,
        "STATUS": "sample string 6",
        "SIP_PROTOCOL": {
          "$ref": "1"
        }
      },
      {
        "$ref": "13"
      }
    ],
    "SIP_PCL_THERAPY": [
      {
        "$id": "14",
        "Id": 1,
        "PROTOCOL_ID": 2.0,
        "THERAPY_ID": 3.0,
        "THERAPY_CODE": "sample string 4",
        "THERAPY_NAME": "sample string 5",
        "SIP_PROTOCOL": {
          "$ref": "1"
        }
      },
      {
        "$ref": "14"
      }
    ],
    "SIP_PCL_WEB_DISEASE_SITE": [
      {
        "$id": "15",
        "Id": 1,
        "PROTOCOL_ID": 2.0,
        "WEB_DESCRIPTION_CODE": 1.0,
        "WEB_DESCRIPTION": "sample string 3",
        "SIP_PROTOCOL": {
          "$ref": "1"
        }
      },
      {
        "$ref": "15"
      }
    ],
    "SV_PCL_INST_CURR_STATUS": [
      {
        "$id": "16",
        "Id": 1,
        "PROTOCOL_ID": 2.0,
        "INSTITUTION_ID": 3.0,
        "STATUS": "sample string 4",
        "STATUS_DATE": "2018-04-20T12:10:40.2453234-06:00",
        "SIP_PROTOCOL": {
          "$ref": "1"
        }
      },
      {
        "$ref": "16"
      }
    ]
  },
  {
    "$ref": "1"
  }
]