API Documentation
Kuali Research REST APIs - IRB
Research Irb ¶
Committee Batch Correspondence Details ¶
Get Committee Batch Correspondence Details by KeyGET/irb/api/v1/committee-batch-correspondence-details/(key)
Example URI
GET /irb/api/v1/committee-batch-correspondence-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"committeeBatchCorrespondenceDetailId": "(val)",
"committeeBatchCorrespondenceId": "(val)",
"protocolActionId": "(val)",
"protocolCorrespondenceId": "(val)",
"_primaryKey": "(val)"
}Get All Committee Batch Correspondence DetailsGET/irb/api/v1/committee-batch-correspondence-details/
Example URI
GET /irb/api/v1/committee-batch-correspondence-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"committeeBatchCorrespondenceDetailId": "(val)",
"committeeBatchCorrespondenceId": "(val)",
"protocolActionId": "(val)",
"protocolCorrespondenceId": "(val)",
"_primaryKey": "(val)"
},
{
"committeeBatchCorrespondenceDetailId": "(val)",
"committeeBatchCorrespondenceId": "(val)",
"protocolActionId": "(val)",
"protocolCorrespondenceId": "(val)",
"_primaryKey": "(val)"
}
]Get All Committee Batch Correspondence Details with FilteringGET/irb/api/v1/committee-batch-correspondence-details/
Example URI
GET /irb/api/v1/committee-batch-correspondence-details/
URI Parameters
- committeeBatchCorrespondenceDetailId
string(optional)Committee Batch Corresponcence Detail Id. Maximum length is 12.
- committeeBatchCorrespondenceId
string(optional)Committee Batch Correspondence Id. Maximum length is 10.
- protocolActionId
string(optional)Protocol Action Id. Maximum length is 12.
- protocolCorrespondenceId
string(optional)Protocol Correspondence Id. Maximum length is 12.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"committeeBatchCorrespondenceDetailId": "(val)",
"committeeBatchCorrespondenceId": "(val)",
"protocolActionId": "(val)",
"protocolCorrespondenceId": "(val)",
"_primaryKey": "(val)"
},
{
"committeeBatchCorrespondenceDetailId": "(val)",
"committeeBatchCorrespondenceId": "(val)",
"protocolActionId": "(val)",
"protocolCorrespondenceId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Committee Batch Correspondence DetailsGET/irb/api/v1/committee-batch-correspondence-details/
Example URI
GET /irb/api/v1/committee-batch-correspondence-details/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"committeeBatchCorrespondenceDetailId",
"committeeBatchCorrespondenceId",
"protocolActionId",
"protocolCorrespondenceId"
],
"primaryKey": "committeeBatchCorrespondenceDetailId"
}Get Blueprint API specification for Committee Batch Correspondence DetailsGET/irb/api/v1/committee-batch-correspondence-details/
Example URI
GET /irb/api/v1/committee-batch-correspondence-details/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Committee Batch Correspondence Details.md"
transfer-encoding: chunkedUpdate Committee Batch Correspondence DetailsPUT/irb/api/v1/committee-batch-correspondence-details/(key)
Example URI
PUT /irb/api/v1/committee-batch-correspondence-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"committeeBatchCorrespondenceDetailId": "(val)",
"committeeBatchCorrespondenceId": "(val)",
"protocolActionId": "(val)",
"protocolCorrespondenceId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Committee Batch Correspondence DetailsPUT/irb/api/v1/committee-batch-correspondence-details/
Example URI
PUT /irb/api/v1/committee-batch-correspondence-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"committeeBatchCorrespondenceDetailId": "(val)",
"committeeBatchCorrespondenceId": "(val)",
"protocolActionId": "(val)",
"protocolCorrespondenceId": "(val)",
"_primaryKey": "(val)"
},
{
"committeeBatchCorrespondenceDetailId": "(val)",
"committeeBatchCorrespondenceId": "(val)",
"protocolActionId": "(val)",
"protocolCorrespondenceId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Committee Batch Correspondence DetailsPATCH/irb/api/v1/committee-batch-correspondence-details/(key)
Example URI
PATCH /irb/api/v1/committee-batch-correspondence-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"committeeBatchCorrespondenceDetailId": "(val)",
"committeeBatchCorrespondenceId": "(val)",
"protocolActionId": "(val)",
"protocolCorrespondenceId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"committeeBatchCorrespondenceDetailId": "(val)",
"committeeBatchCorrespondenceId": "(val)",
"protocolActionId": "(val)",
"protocolCorrespondenceId": "(val)",
"_primaryKey": "(val)"
}Insert Committee Batch Correspondence DetailsPOST/irb/api/v1/committee-batch-correspondence-details/
Example URI
POST /irb/api/v1/committee-batch-correspondence-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"committeeBatchCorrespondenceDetailId": "(val)",
"committeeBatchCorrespondenceId": "(val)",
"protocolActionId": "(val)",
"protocolCorrespondenceId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"committeeBatchCorrespondenceDetailId": "(val)",
"committeeBatchCorrespondenceId": "(val)",
"protocolActionId": "(val)",
"protocolCorrespondenceId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Committee Batch Correspondence DetailsPOST/irb/api/v1/committee-batch-correspondence-details/
Example URI
POST /irb/api/v1/committee-batch-correspondence-details/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"committeeBatchCorrespondenceDetailId": "(val)",
"committeeBatchCorrespondenceId": "(val)",
"protocolActionId": "(val)",
"protocolCorrespondenceId": "(val)",
"_primaryKey": "(val)"
},
{
"committeeBatchCorrespondenceDetailId": "(val)",
"committeeBatchCorrespondenceId": "(val)",
"protocolActionId": "(val)",
"protocolCorrespondenceId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"committeeBatchCorrespondenceDetailId": "(val)",
"committeeBatchCorrespondenceId": "(val)",
"protocolActionId": "(val)",
"protocolCorrespondenceId": "(val)",
"_primaryKey": "(val)"
},
{
"committeeBatchCorrespondenceDetailId": "(val)",
"committeeBatchCorrespondenceId": "(val)",
"protocolActionId": "(val)",
"protocolCorrespondenceId": "(val)",
"_primaryKey": "(val)"
}
]Delete Committee Batch Correspondence Details by KeyDELETE/irb/api/v1/committee-batch-correspondence-details/(key)
Example URI
DELETE /irb/api/v1/committee-batch-correspondence-details/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Batch Correspondence DetailsDELETE/irb/api/v1/committee-batch-correspondence-details/
Example URI
DELETE /irb/api/v1/committee-batch-correspondence-details/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Batch Correspondence Details with MatchingDELETE/irb/api/v1/committee-batch-correspondence-details/
Example URI
DELETE /irb/api/v1/committee-batch-correspondence-details/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- committeeBatchCorrespondenceDetailId
string(optional)Committee Batch Corresponcence Detail Id. Maximum length is 12.
- committeeBatchCorrespondenceId
string(optional)Committee Batch Correspondence Id. Maximum length is 10.
- protocolActionId
string(optional)Protocol Action Id. Maximum length is 12.
- protocolCorrespondenceId
string(optional)Protocol Correspondence Id. Maximum length is 12.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Committee Batch Correspondences ¶
Get Committee Batch Correspondences by KeyGET/irb/api/v1/committee-batch-correspondences/(key)
Example URI
GET /irb/api/v1/committee-batch-correspondences/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"committeeBatchCorrespondenceId": "(val)",
"committeeId": "(val)",
"batchCorrespondenceTypeCode": "(val)",
"batchRunDate": "(val)",
"timeWindowStart": "(val)",
"timeWindowEnd": "(val)",
"_primaryKey": "(val)"
}Get All Committee Batch CorrespondencesGET/irb/api/v1/committee-batch-correspondences/
Example URI
GET /irb/api/v1/committee-batch-correspondences/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"committeeBatchCorrespondenceId": "(val)",
"committeeId": "(val)",
"batchCorrespondenceTypeCode": "(val)",
"batchRunDate": "(val)",
"timeWindowStart": "(val)",
"timeWindowEnd": "(val)",
"_primaryKey": "(val)"
},
{
"committeeBatchCorrespondenceId": "(val)",
"committeeId": "(val)",
"batchCorrespondenceTypeCode": "(val)",
"batchRunDate": "(val)",
"timeWindowStart": "(val)",
"timeWindowEnd": "(val)",
"_primaryKey": "(val)"
}
]Get All Committee Batch Correspondences with FilteringGET/irb/api/v1/committee-batch-correspondences/
Example URI
GET /irb/api/v1/committee-batch-correspondences/
URI Parameters
- committeeBatchCorrespondenceId
string(optional)- committeeId
string(optional)- batchCorrespondenceTypeCode
string(optional)- batchRunDate
string(optional)- timeWindowStart
string(optional)- timeWindowEnd
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"committeeBatchCorrespondenceId": "(val)",
"committeeId": "(val)",
"batchCorrespondenceTypeCode": "(val)",
"batchRunDate": "(val)",
"timeWindowStart": "(val)",
"timeWindowEnd": "(val)",
"_primaryKey": "(val)"
},
{
"committeeBatchCorrespondenceId": "(val)",
"committeeId": "(val)",
"batchCorrespondenceTypeCode": "(val)",
"batchRunDate": "(val)",
"timeWindowStart": "(val)",
"timeWindowEnd": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Committee Batch CorrespondencesGET/irb/api/v1/committee-batch-correspondences/
Example URI
GET /irb/api/v1/committee-batch-correspondences/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"committeeBatchCorrespondenceId",
"committeeId",
"batchCorrespondenceTypeCode",
"batchRunDate",
"timeWindowStart",
"timeWindowEnd"
],
"primaryKey": "committeeBatchCorrespondenceId"
}Get Blueprint API specification for Committee Batch CorrespondencesGET/irb/api/v1/committee-batch-correspondences/
Example URI
GET /irb/api/v1/committee-batch-correspondences/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Committee Batch Correspondences.md"
transfer-encoding: chunkedUpdate Committee Batch CorrespondencesPUT/irb/api/v1/committee-batch-correspondences/(key)
Example URI
PUT /irb/api/v1/committee-batch-correspondences/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"committeeBatchCorrespondenceId": "(val)",
"committeeId": "(val)",
"batchCorrespondenceTypeCode": "(val)",
"batchRunDate": "(val)",
"timeWindowStart": "(val)",
"timeWindowEnd": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Committee Batch CorrespondencesPUT/irb/api/v1/committee-batch-correspondences/
Example URI
PUT /irb/api/v1/committee-batch-correspondences/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"committeeBatchCorrespondenceId": "(val)",
"committeeId": "(val)",
"batchCorrespondenceTypeCode": "(val)",
"batchRunDate": "(val)",
"timeWindowStart": "(val)",
"timeWindowEnd": "(val)",
"_primaryKey": "(val)"
},
{
"committeeBatchCorrespondenceId": "(val)",
"committeeId": "(val)",
"batchCorrespondenceTypeCode": "(val)",
"batchRunDate": "(val)",
"timeWindowStart": "(val)",
"timeWindowEnd": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Committee Batch CorrespondencesPATCH/irb/api/v1/committee-batch-correspondences/(key)
Example URI
PATCH /irb/api/v1/committee-batch-correspondences/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"committeeBatchCorrespondenceId": "(val)",
"committeeId": "(val)",
"batchCorrespondenceTypeCode": "(val)",
"batchRunDate": "(val)",
"timeWindowStart": "(val)",
"timeWindowEnd": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"committeeBatchCorrespondenceId": "(val)",
"committeeId": "(val)",
"batchCorrespondenceTypeCode": "(val)",
"batchRunDate": "(val)",
"timeWindowStart": "(val)",
"timeWindowEnd": "(val)",
"_primaryKey": "(val)"
}Insert Committee Batch CorrespondencesPOST/irb/api/v1/committee-batch-correspondences/
Example URI
POST /irb/api/v1/committee-batch-correspondences/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"committeeBatchCorrespondenceId": "(val)",
"committeeId": "(val)",
"batchCorrespondenceTypeCode": "(val)",
"batchRunDate": "(val)",
"timeWindowStart": "(val)",
"timeWindowEnd": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"committeeBatchCorrespondenceId": "(val)",
"committeeId": "(val)",
"batchCorrespondenceTypeCode": "(val)",
"batchRunDate": "(val)",
"timeWindowStart": "(val)",
"timeWindowEnd": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Committee Batch CorrespondencesPOST/irb/api/v1/committee-batch-correspondences/
Example URI
POST /irb/api/v1/committee-batch-correspondences/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"committeeBatchCorrespondenceId": "(val)",
"committeeId": "(val)",
"batchCorrespondenceTypeCode": "(val)",
"batchRunDate": "(val)",
"timeWindowStart": "(val)",
"timeWindowEnd": "(val)",
"_primaryKey": "(val)"
},
{
"committeeBatchCorrespondenceId": "(val)",
"committeeId": "(val)",
"batchCorrespondenceTypeCode": "(val)",
"batchRunDate": "(val)",
"timeWindowStart": "(val)",
"timeWindowEnd": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"committeeBatchCorrespondenceId": "(val)",
"committeeId": "(val)",
"batchCorrespondenceTypeCode": "(val)",
"batchRunDate": "(val)",
"timeWindowStart": "(val)",
"timeWindowEnd": "(val)",
"_primaryKey": "(val)"
},
{
"committeeBatchCorrespondenceId": "(val)",
"committeeId": "(val)",
"batchCorrespondenceTypeCode": "(val)",
"batchRunDate": "(val)",
"timeWindowStart": "(val)",
"timeWindowEnd": "(val)",
"_primaryKey": "(val)"
}
]Delete Committee Batch Correspondences by KeyDELETE/irb/api/v1/committee-batch-correspondences/(key)
Example URI
DELETE /irb/api/v1/committee-batch-correspondences/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Batch CorrespondencesDELETE/irb/api/v1/committee-batch-correspondences/
Example URI
DELETE /irb/api/v1/committee-batch-correspondences/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Batch Correspondences with MatchingDELETE/irb/api/v1/committee-batch-correspondences/
Example URI
DELETE /irb/api/v1/committee-batch-correspondences/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- committeeBatchCorrespondenceId
string(optional)- committeeId
string(optional)- batchCorrespondenceTypeCode
string(optional)- batchRunDate
string(optional)- timeWindowStart
string(optional)- timeWindowEnd
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Committee Membership Expertise Entries ¶
Get Committee Membership Expertise Entries by KeyGET/irb/api/v1/committee-membership-expertise-entries/(key)
Example URI
GET /irb/api/v1/committee-membership-expertise-entries/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"committeeMembershipExpertiseId": "(val)",
"committeeMembershipIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}Get All Committee Membership Expertise EntriesGET/irb/api/v1/committee-membership-expertise-entries/
Example URI
GET /irb/api/v1/committee-membership-expertise-entries/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"committeeMembershipExpertiseId": "(val)",
"committeeMembershipIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
},
{
"committeeMembershipExpertiseId": "(val)",
"committeeMembershipIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Committee Membership Expertise Entries with FilteringGET/irb/api/v1/committee-membership-expertise-entries/
Example URI
GET /irb/api/v1/committee-membership-expertise-entries/
URI Parameters
- committeeMembershipExpertiseId
string(optional)Committee Membership Expertise Id. Maximum length is 22.
- committeeMembershipIdFk
string(optional)Committee Membership Id Fk. Maximum length is 22.
- researchAreaCode
string(optional)Research Area Code. Maximum length is 8.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"committeeMembershipExpertiseId": "(val)",
"committeeMembershipIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
},
{
"committeeMembershipExpertiseId": "(val)",
"committeeMembershipIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Committee Membership Expertise EntriesGET/irb/api/v1/committee-membership-expertise-entries/
Example URI
GET /irb/api/v1/committee-membership-expertise-entries/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"committeeMembershipExpertiseId",
"committeeMembershipIdFk",
"researchAreaCode"
],
"primaryKey": "committeeMembershipExpertiseId"
}Get Blueprint API specification for Committee Membership Expertise EntriesGET/irb/api/v1/committee-membership-expertise-entries/
Example URI
GET /irb/api/v1/committee-membership-expertise-entries/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Committee Membership Expertise Entries.md"
transfer-encoding: chunkedUpdate Committee Membership Expertise EntriesPUT/irb/api/v1/committee-membership-expertise-entries/(key)
Example URI
PUT /irb/api/v1/committee-membership-expertise-entries/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"committeeMembershipExpertiseId": "(val)",
"committeeMembershipIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Committee Membership Expertise EntriesPUT/irb/api/v1/committee-membership-expertise-entries/
Example URI
PUT /irb/api/v1/committee-membership-expertise-entries/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"committeeMembershipExpertiseId": "(val)",
"committeeMembershipIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
},
{
"committeeMembershipExpertiseId": "(val)",
"committeeMembershipIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Committee Membership Expertise EntriesPATCH/irb/api/v1/committee-membership-expertise-entries/(key)
Example URI
PATCH /irb/api/v1/committee-membership-expertise-entries/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"committeeMembershipExpertiseId": "(val)",
"committeeMembershipIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"committeeMembershipExpertiseId": "(val)",
"committeeMembershipIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}Insert Committee Membership Expertise EntriesPOST/irb/api/v1/committee-membership-expertise-entries/
Example URI
POST /irb/api/v1/committee-membership-expertise-entries/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"committeeMembershipExpertiseId": "(val)",
"committeeMembershipIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"committeeMembershipExpertiseId": "(val)",
"committeeMembershipIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Committee Membership Expertise EntriesPOST/irb/api/v1/committee-membership-expertise-entries/
Example URI
POST /irb/api/v1/committee-membership-expertise-entries/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"committeeMembershipExpertiseId": "(val)",
"committeeMembershipIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
},
{
"committeeMembershipExpertiseId": "(val)",
"committeeMembershipIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"committeeMembershipExpertiseId": "(val)",
"committeeMembershipIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
},
{
"committeeMembershipExpertiseId": "(val)",
"committeeMembershipIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Committee Membership Expertise Entries by KeyDELETE/irb/api/v1/committee-membership-expertise-entries/(key)
Example URI
DELETE /irb/api/v1/committee-membership-expertise-entries/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Membership Expertise EntriesDELETE/irb/api/v1/committee-membership-expertise-entries/
Example URI
DELETE /irb/api/v1/committee-membership-expertise-entries/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Membership Expertise Entries with MatchingDELETE/irb/api/v1/committee-membership-expertise-entries/
Example URI
DELETE /irb/api/v1/committee-membership-expertise-entries/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- committeeMembershipExpertiseId
string(optional)Committee Membership Expertise Id. Maximum length is 22.
- committeeMembershipIdFk
string(optional)Committee Membership Id Fk. Maximum length is 22.
- researchAreaCode
string(optional)Research Area Code. Maximum length is 8.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Committee Memberships ¶
Get Committee Memberships by KeyGET/irb/api/v1/committee-memberships/(key)
Example URI
GET /irb/api/v1/committee-memberships/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"committeeMembershipId": "(val)",
"committeeIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"personName": "(val)",
"membershipId": "(val)",
"paidMember": "(val)",
"termStartDate": "(val)",
"termEndDate": "(val)",
"membershipTypeCode": "(val)",
"comments": "(val)",
"contactNotes": "(val)",
"trainingNotes": "(val)",
"_primaryKey": "(val)"
}Get All Committee MembershipsGET/irb/api/v1/committee-memberships/
Example URI
GET /irb/api/v1/committee-memberships/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"committeeMembershipId": "(val)",
"committeeIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"personName": "(val)",
"membershipId": "(val)",
"paidMember": "(val)",
"termStartDate": "(val)",
"termEndDate": "(val)",
"membershipTypeCode": "(val)",
"comments": "(val)",
"contactNotes": "(val)",
"trainingNotes": "(val)",
"_primaryKey": "(val)"
},
{
"committeeMembershipId": "(val)",
"committeeIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"personName": "(val)",
"membershipId": "(val)",
"paidMember": "(val)",
"termStartDate": "(val)",
"termEndDate": "(val)",
"membershipTypeCode": "(val)",
"comments": "(val)",
"contactNotes": "(val)",
"trainingNotes": "(val)",
"_primaryKey": "(val)"
}
]Get All Committee Memberships with FilteringGET/irb/api/v1/committee-memberships/
Example URI
GET /irb/api/v1/committee-memberships/
URI Parameters
- committeeMembershipId
string(optional)Committee Membership Id. Maximum length is 12.
- committeeIdFk
string(optional)Committee Id Fk. Maximum length is 12.
- personId
string(optional)Person Id. Maximum length is 40.
- rolodexId
string(optional)Rolodex Id. Maximum length is 12.
- personName
string(optional)Person Name. Maximum length is 90.
- membershipId
string(optional)Membership Id. Maximum length is 10.
- paidMember
string(optional)Paid Member. Maximum length is 1.
- termStartDate
string(optional)Term Start Date. Maximum length is 10.
- termEndDate
string(optional)Term End Date. Maximum length is 10.
- membershipTypeCode
string(optional)Membership Type Code. Maximum length is 3.
- comments
string(optional)Comments. Maximum length is 200.
- contactNotes
string(optional)Contact Notes. Maximum length is 200.
- trainingNotes
string(optional)Training Notes. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"committeeMembershipId": "(val)",
"committeeIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"personName": "(val)",
"membershipId": "(val)",
"paidMember": "(val)",
"termStartDate": "(val)",
"termEndDate": "(val)",
"membershipTypeCode": "(val)",
"comments": "(val)",
"contactNotes": "(val)",
"trainingNotes": "(val)",
"_primaryKey": "(val)"
},
{
"committeeMembershipId": "(val)",
"committeeIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"personName": "(val)",
"membershipId": "(val)",
"paidMember": "(val)",
"termStartDate": "(val)",
"termEndDate": "(val)",
"membershipTypeCode": "(val)",
"comments": "(val)",
"contactNotes": "(val)",
"trainingNotes": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Committee MembershipsGET/irb/api/v1/committee-memberships/
Example URI
GET /irb/api/v1/committee-memberships/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"committeeMembershipId",
"committeeIdFk",
"personId",
"rolodexId",
"personName",
"membershipId",
"paidMember",
"termStartDate",
"termEndDate",
"membershipTypeCode",
"comments",
"contactNotes",
"trainingNotes"
],
"primaryKey": "committeeMembershipId"
}Get Blueprint API specification for Committee MembershipsGET/irb/api/v1/committee-memberships/
Example URI
GET /irb/api/v1/committee-memberships/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Committee Memberships.md"
transfer-encoding: chunkedUpdate Committee MembershipsPUT/irb/api/v1/committee-memberships/(key)
Example URI
PUT /irb/api/v1/committee-memberships/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"committeeMembershipId": "(val)",
"committeeIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"personName": "(val)",
"membershipId": "(val)",
"paidMember": "(val)",
"termStartDate": "(val)",
"termEndDate": "(val)",
"membershipTypeCode": "(val)",
"comments": "(val)",
"contactNotes": "(val)",
"trainingNotes": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Committee MembershipsPUT/irb/api/v1/committee-memberships/
Example URI
PUT /irb/api/v1/committee-memberships/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"committeeMembershipId": "(val)",
"committeeIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"personName": "(val)",
"membershipId": "(val)",
"paidMember": "(val)",
"termStartDate": "(val)",
"termEndDate": "(val)",
"membershipTypeCode": "(val)",
"comments": "(val)",
"contactNotes": "(val)",
"trainingNotes": "(val)",
"_primaryKey": "(val)"
},
{
"committeeMembershipId": "(val)",
"committeeIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"personName": "(val)",
"membershipId": "(val)",
"paidMember": "(val)",
"termStartDate": "(val)",
"termEndDate": "(val)",
"membershipTypeCode": "(val)",
"comments": "(val)",
"contactNotes": "(val)",
"trainingNotes": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Committee MembershipsPATCH/irb/api/v1/committee-memberships/(key)
Example URI
PATCH /irb/api/v1/committee-memberships/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"committeeMembershipId": "(val)",
"committeeIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"personName": "(val)",
"membershipId": "(val)",
"paidMember": "(val)",
"termStartDate": "(val)",
"termEndDate": "(val)",
"membershipTypeCode": "(val)",
"comments": "(val)",
"contactNotes": "(val)",
"trainingNotes": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"committeeMembershipId": "(val)",
"committeeIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"personName": "(val)",
"membershipId": "(val)",
"paidMember": "(val)",
"termStartDate": "(val)",
"termEndDate": "(val)",
"membershipTypeCode": "(val)",
"comments": "(val)",
"contactNotes": "(val)",
"trainingNotes": "(val)",
"_primaryKey": "(val)"
}Insert Committee MembershipsPOST/irb/api/v1/committee-memberships/
Example URI
POST /irb/api/v1/committee-memberships/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"committeeMembershipId": "(val)",
"committeeIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"personName": "(val)",
"membershipId": "(val)",
"paidMember": "(val)",
"termStartDate": "(val)",
"termEndDate": "(val)",
"membershipTypeCode": "(val)",
"comments": "(val)",
"contactNotes": "(val)",
"trainingNotes": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"committeeMembershipId": "(val)",
"committeeIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"personName": "(val)",
"membershipId": "(val)",
"paidMember": "(val)",
"termStartDate": "(val)",
"termEndDate": "(val)",
"membershipTypeCode": "(val)",
"comments": "(val)",
"contactNotes": "(val)",
"trainingNotes": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Committee MembershipsPOST/irb/api/v1/committee-memberships/
Example URI
POST /irb/api/v1/committee-memberships/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"committeeMembershipId": "(val)",
"committeeIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"personName": "(val)",
"membershipId": "(val)",
"paidMember": "(val)",
"termStartDate": "(val)",
"termEndDate": "(val)",
"membershipTypeCode": "(val)",
"comments": "(val)",
"contactNotes": "(val)",
"trainingNotes": "(val)",
"_primaryKey": "(val)"
},
{
"committeeMembershipId": "(val)",
"committeeIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"personName": "(val)",
"membershipId": "(val)",
"paidMember": "(val)",
"termStartDate": "(val)",
"termEndDate": "(val)",
"membershipTypeCode": "(val)",
"comments": "(val)",
"contactNotes": "(val)",
"trainingNotes": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"committeeMembershipId": "(val)",
"committeeIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"personName": "(val)",
"membershipId": "(val)",
"paidMember": "(val)",
"termStartDate": "(val)",
"termEndDate": "(val)",
"membershipTypeCode": "(val)",
"comments": "(val)",
"contactNotes": "(val)",
"trainingNotes": "(val)",
"_primaryKey": "(val)"
},
{
"committeeMembershipId": "(val)",
"committeeIdFk": "(val)",
"personId": "(val)",
"rolodexId": "(val)",
"personName": "(val)",
"membershipId": "(val)",
"paidMember": "(val)",
"termStartDate": "(val)",
"termEndDate": "(val)",
"membershipTypeCode": "(val)",
"comments": "(val)",
"contactNotes": "(val)",
"trainingNotes": "(val)",
"_primaryKey": "(val)"
}
]Delete Committee Memberships by KeyDELETE/irb/api/v1/committee-memberships/(key)
Example URI
DELETE /irb/api/v1/committee-memberships/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee MembershipsDELETE/irb/api/v1/committee-memberships/
Example URI
DELETE /irb/api/v1/committee-memberships/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Memberships with MatchingDELETE/irb/api/v1/committee-memberships/
Example URI
DELETE /irb/api/v1/committee-memberships/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- committeeMembershipId
string(optional)Committee Membership Id. Maximum length is 12.
- committeeIdFk
string(optional)Committee Id Fk. Maximum length is 12.
- personId
string(optional)Person Id. Maximum length is 40.
- rolodexId
string(optional)Rolodex Id. Maximum length is 12.
- personName
string(optional)Person Name. Maximum length is 90.
- membershipId
string(optional)Membership Id. Maximum length is 10.
- paidMember
string(optional)Paid Member. Maximum length is 1.
- termStartDate
string(optional)Term Start Date. Maximum length is 10.
- termEndDate
string(optional)Term End Date. Maximum length is 10.
- membershipTypeCode
string(optional)Membership Type Code. Maximum length is 3.
- comments
string(optional)Comments. Maximum length is 200.
- contactNotes
string(optional)Contact Notes. Maximum length is 200.
- trainingNotes
string(optional)Training Notes. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Committee Research Areas ¶
Get Committee Research Areas by KeyGET/irb/api/v1/committee-research-areas/(key)
Example URI
GET /irb/api/v1/committee-research-areas/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"committeeIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}Get All Committee Research AreasGET/irb/api/v1/committee-research-areas/
Example URI
GET /irb/api/v1/committee-research-areas/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"committeeIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"committeeIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Committee Research Areas with FilteringGET/irb/api/v1/committee-research-areas/
Example URI
GET /irb/api/v1/committee-research-areas/
URI Parameters
- id
string(optional)Committee Research Area Id.
- committeeIdFk
string(optional)Committee Id Fk.
- researchAreaCode
string(optional)Research Area Code.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"committeeIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"committeeIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Committee Research AreasGET/irb/api/v1/committee-research-areas/
Example URI
GET /irb/api/v1/committee-research-areas/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"committeeIdFk",
"researchAreaCode"
],
"primaryKey": "id"
}Get Blueprint API specification for Committee Research AreasGET/irb/api/v1/committee-research-areas/
Example URI
GET /irb/api/v1/committee-research-areas/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Committee Research Areas.md"
transfer-encoding: chunkedUpdate Committee Research AreasPUT/irb/api/v1/committee-research-areas/(key)
Example URI
PUT /irb/api/v1/committee-research-areas/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"committeeIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Committee Research AreasPUT/irb/api/v1/committee-research-areas/
Example URI
PUT /irb/api/v1/committee-research-areas/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"committeeIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"committeeIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Committee Research AreasPATCH/irb/api/v1/committee-research-areas/(key)
Example URI
PATCH /irb/api/v1/committee-research-areas/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"committeeIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"committeeIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}Insert Committee Research AreasPOST/irb/api/v1/committee-research-areas/
Example URI
POST /irb/api/v1/committee-research-areas/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"committeeIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"committeeIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Committee Research AreasPOST/irb/api/v1/committee-research-areas/
Example URI
POST /irb/api/v1/committee-research-areas/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"committeeIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"committeeIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"committeeIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"committeeIdFk": "(val)",
"researchAreaCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Committee Research Areas by KeyDELETE/irb/api/v1/committee-research-areas/(key)
Example URI
DELETE /irb/api/v1/committee-research-areas/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Research AreasDELETE/irb/api/v1/committee-research-areas/
Example URI
DELETE /irb/api/v1/committee-research-areas/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Research Areas with MatchingDELETE/irb/api/v1/committee-research-areas/
Example URI
DELETE /irb/api/v1/committee-research-areas/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Committee Research Area Id.
- committeeIdFk
string(optional)Committee Id Fk.
- researchAreaCode
string(optional)Research Area Code.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Committee Schedule Action Items ¶
Get Committee Schedule Action Items by KeyGET/irb/api/v1/committee-schedule-action-items/(key)
Example URI
GET /irb/api/v1/committee-schedule-action-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"commScheduleActItemsId": "(val)",
"scheduleIdFk": "(val)",
"actionItemNumber": "(val)",
"scheduleActItemTypeCode": "(val)",
"itemDescription": "(val)",
"_primaryKey": "(val)"
}Get All Committee Schedule Action ItemsGET/irb/api/v1/committee-schedule-action-items/
Example URI
GET /irb/api/v1/committee-schedule-action-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"commScheduleActItemsId": "(val)",
"scheduleIdFk": "(val)",
"actionItemNumber": "(val)",
"scheduleActItemTypeCode": "(val)",
"itemDescription": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleActItemsId": "(val)",
"scheduleIdFk": "(val)",
"actionItemNumber": "(val)",
"scheduleActItemTypeCode": "(val)",
"itemDescription": "(val)",
"_primaryKey": "(val)"
}
]Get All Committee Schedule Action Items with FilteringGET/irb/api/v1/committee-schedule-action-items/
Example URI
GET /irb/api/v1/committee-schedule-action-items/
URI Parameters
- commScheduleActItemsId
string(optional)Comm Schedule Act Items Id. Maximum length is 12.
- scheduleIdFk
string(optional)Schedule Id. Maximum length is 12.
- actionItemNumber
string(optional)Action Item Number. Maximum length is 22.
- scheduleActItemTypeCode
string(optional)Schedule Act Item Type Code. Maximum length is 3.
- itemDescription
string(optional)Item Description. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"commScheduleActItemsId": "(val)",
"scheduleIdFk": "(val)",
"actionItemNumber": "(val)",
"scheduleActItemTypeCode": "(val)",
"itemDescription": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleActItemsId": "(val)",
"scheduleIdFk": "(val)",
"actionItemNumber": "(val)",
"scheduleActItemTypeCode": "(val)",
"itemDescription": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Committee Schedule Action ItemsGET/irb/api/v1/committee-schedule-action-items/
Example URI
GET /irb/api/v1/committee-schedule-action-items/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"commScheduleActItemsId",
"scheduleIdFk",
"actionItemNumber",
"scheduleActItemTypeCode",
"itemDescription"
],
"primaryKey": "commScheduleActItemsId"
}Get Blueprint API specification for Committee Schedule Action ItemsGET/irb/api/v1/committee-schedule-action-items/
Example URI
GET /irb/api/v1/committee-schedule-action-items/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Committee Schedule Action Items.md"
transfer-encoding: chunkedUpdate Committee Schedule Action ItemsPUT/irb/api/v1/committee-schedule-action-items/(key)
Example URI
PUT /irb/api/v1/committee-schedule-action-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"commScheduleActItemsId": "(val)",
"scheduleIdFk": "(val)",
"actionItemNumber": "(val)",
"scheduleActItemTypeCode": "(val)",
"itemDescription": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Committee Schedule Action ItemsPUT/irb/api/v1/committee-schedule-action-items/
Example URI
PUT /irb/api/v1/committee-schedule-action-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"commScheduleActItemsId": "(val)",
"scheduleIdFk": "(val)",
"actionItemNumber": "(val)",
"scheduleActItemTypeCode": "(val)",
"itemDescription": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleActItemsId": "(val)",
"scheduleIdFk": "(val)",
"actionItemNumber": "(val)",
"scheduleActItemTypeCode": "(val)",
"itemDescription": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Committee Schedule Action ItemsPATCH/irb/api/v1/committee-schedule-action-items/(key)
Example URI
PATCH /irb/api/v1/committee-schedule-action-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"commScheduleActItemsId": "(val)",
"scheduleIdFk": "(val)",
"actionItemNumber": "(val)",
"scheduleActItemTypeCode": "(val)",
"itemDescription": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"commScheduleActItemsId": "(val)",
"scheduleIdFk": "(val)",
"actionItemNumber": "(val)",
"scheduleActItemTypeCode": "(val)",
"itemDescription": "(val)",
"_primaryKey": "(val)"
}Insert Committee Schedule Action ItemsPOST/irb/api/v1/committee-schedule-action-items/
Example URI
POST /irb/api/v1/committee-schedule-action-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"commScheduleActItemsId": "(val)",
"scheduleIdFk": "(val)",
"actionItemNumber": "(val)",
"scheduleActItemTypeCode": "(val)",
"itemDescription": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"commScheduleActItemsId": "(val)",
"scheduleIdFk": "(val)",
"actionItemNumber": "(val)",
"scheduleActItemTypeCode": "(val)",
"itemDescription": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Committee Schedule Action ItemsPOST/irb/api/v1/committee-schedule-action-items/
Example URI
POST /irb/api/v1/committee-schedule-action-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"commScheduleActItemsId": "(val)",
"scheduleIdFk": "(val)",
"actionItemNumber": "(val)",
"scheduleActItemTypeCode": "(val)",
"itemDescription": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleActItemsId": "(val)",
"scheduleIdFk": "(val)",
"actionItemNumber": "(val)",
"scheduleActItemTypeCode": "(val)",
"itemDescription": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"commScheduleActItemsId": "(val)",
"scheduleIdFk": "(val)",
"actionItemNumber": "(val)",
"scheduleActItemTypeCode": "(val)",
"itemDescription": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleActItemsId": "(val)",
"scheduleIdFk": "(val)",
"actionItemNumber": "(val)",
"scheduleActItemTypeCode": "(val)",
"itemDescription": "(val)",
"_primaryKey": "(val)"
}
]Delete Committee Schedule Action Items by KeyDELETE/irb/api/v1/committee-schedule-action-items/(key)
Example URI
DELETE /irb/api/v1/committee-schedule-action-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Schedule Action ItemsDELETE/irb/api/v1/committee-schedule-action-items/
Example URI
DELETE /irb/api/v1/committee-schedule-action-items/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Schedule Action Items with MatchingDELETE/irb/api/v1/committee-schedule-action-items/
Example URI
DELETE /irb/api/v1/committee-schedule-action-items/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- commScheduleActItemsId
string(optional)Comm Schedule Act Items Id. Maximum length is 12.
- scheduleIdFk
string(optional)Schedule Id. Maximum length is 12.
- actionItemNumber
string(optional)Action Item Number. Maximum length is 22.
- scheduleActItemTypeCode
string(optional)Schedule Act Item Type Code. Maximum length is 3.
- itemDescription
string(optional)Item Description. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Committee Schedule Attachments ¶
Get Committee Schedule Attachments by KeyGET/irb/api/v1/committee-schedule-attachments/(key)
Example URI
GET /irb/api/v1/committee-schedule-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"scheduleId": "(val)",
"attachmentId": "(val)",
"attachmentsTypeCode": "(val)",
"description": "(val)",
"fileName": "(val)",
"document": "(val)",
"mimeType": "(val)",
"newUpdateTimestamp": "(val)",
"newUpdateUser": "(val)",
"_primaryKey": "(val)"
}Get All Committee Schedule AttachmentsGET/irb/api/v1/committee-schedule-attachments/
Example URI
GET /irb/api/v1/committee-schedule-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"scheduleId": "(val)",
"attachmentId": "(val)",
"attachmentsTypeCode": "(val)",
"description": "(val)",
"fileName": "(val)",
"document": "(val)",
"mimeType": "(val)",
"newUpdateTimestamp": "(val)",
"newUpdateUser": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleId": "(val)",
"attachmentId": "(val)",
"attachmentsTypeCode": "(val)",
"description": "(val)",
"fileName": "(val)",
"document": "(val)",
"mimeType": "(val)",
"newUpdateTimestamp": "(val)",
"newUpdateUser": "(val)",
"_primaryKey": "(val)"
}
]Get All Committee Schedule Attachments with FilteringGET/irb/api/v1/committee-schedule-attachments/
Example URI
GET /irb/api/v1/committee-schedule-attachments/
URI Parameters
- scheduleId
string(optional)- attachmentId
string(optional)- attachmentsTypeCode
string(optional)Attachment Type. Maximum length is 3.
- description
string(optional)Description. Maximum length is 4000.
- fileName
string(optional)File Name. Maximum length is 150.
- document
string(optional)- mimeType
string(optional)- newUpdateTimestamp
string(optional)- newUpdateUser
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"scheduleId": "(val)",
"attachmentId": "(val)",
"attachmentsTypeCode": "(val)",
"description": "(val)",
"fileName": "(val)",
"document": "(val)",
"mimeType": "(val)",
"newUpdateTimestamp": "(val)",
"newUpdateUser": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleId": "(val)",
"attachmentId": "(val)",
"attachmentsTypeCode": "(val)",
"description": "(val)",
"fileName": "(val)",
"document": "(val)",
"mimeType": "(val)",
"newUpdateTimestamp": "(val)",
"newUpdateUser": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Committee Schedule AttachmentsGET/irb/api/v1/committee-schedule-attachments/
Example URI
GET /irb/api/v1/committee-schedule-attachments/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"scheduleId",
"attachmentId",
"attachmentsTypeCode",
"description",
"fileName",
"document",
"mimeType",
"newUpdateTimestamp",
"newUpdateUser"
],
"primaryKey": "attachmentId"
}Get Blueprint API specification for Committee Schedule AttachmentsGET/irb/api/v1/committee-schedule-attachments/
Example URI
GET /irb/api/v1/committee-schedule-attachments/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Committee Schedule Attachments.md"
transfer-encoding: chunkedUpdate Committee Schedule AttachmentsPUT/irb/api/v1/committee-schedule-attachments/(key)
Example URI
PUT /irb/api/v1/committee-schedule-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"scheduleId": "(val)",
"attachmentId": "(val)",
"attachmentsTypeCode": "(val)",
"description": "(val)",
"fileName": "(val)",
"document": "(val)",
"mimeType": "(val)",
"newUpdateTimestamp": "(val)",
"newUpdateUser": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Committee Schedule AttachmentsPUT/irb/api/v1/committee-schedule-attachments/
Example URI
PUT /irb/api/v1/committee-schedule-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"scheduleId": "(val)",
"attachmentId": "(val)",
"attachmentsTypeCode": "(val)",
"description": "(val)",
"fileName": "(val)",
"document": "(val)",
"mimeType": "(val)",
"newUpdateTimestamp": "(val)",
"newUpdateUser": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleId": "(val)",
"attachmentId": "(val)",
"attachmentsTypeCode": "(val)",
"description": "(val)",
"fileName": "(val)",
"document": "(val)",
"mimeType": "(val)",
"newUpdateTimestamp": "(val)",
"newUpdateUser": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Committee Schedule AttachmentsPATCH/irb/api/v1/committee-schedule-attachments/(key)
Example URI
PATCH /irb/api/v1/committee-schedule-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"scheduleId": "(val)",
"attachmentId": "(val)",
"attachmentsTypeCode": "(val)",
"description": "(val)",
"fileName": "(val)",
"document": "(val)",
"mimeType": "(val)",
"newUpdateTimestamp": "(val)",
"newUpdateUser": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"scheduleId": "(val)",
"attachmentId": "(val)",
"attachmentsTypeCode": "(val)",
"description": "(val)",
"fileName": "(val)",
"document": "(val)",
"mimeType": "(val)",
"newUpdateTimestamp": "(val)",
"newUpdateUser": "(val)",
"_primaryKey": "(val)"
}Insert Committee Schedule AttachmentsPOST/irb/api/v1/committee-schedule-attachments/
Example URI
POST /irb/api/v1/committee-schedule-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"scheduleId": "(val)",
"attachmentId": "(val)",
"attachmentsTypeCode": "(val)",
"description": "(val)",
"fileName": "(val)",
"document": "(val)",
"mimeType": "(val)",
"newUpdateTimestamp": "(val)",
"newUpdateUser": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"scheduleId": "(val)",
"attachmentId": "(val)",
"attachmentsTypeCode": "(val)",
"description": "(val)",
"fileName": "(val)",
"document": "(val)",
"mimeType": "(val)",
"newUpdateTimestamp": "(val)",
"newUpdateUser": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Committee Schedule AttachmentsPOST/irb/api/v1/committee-schedule-attachments/
Example URI
POST /irb/api/v1/committee-schedule-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"scheduleId": "(val)",
"attachmentId": "(val)",
"attachmentsTypeCode": "(val)",
"description": "(val)",
"fileName": "(val)",
"document": "(val)",
"mimeType": "(val)",
"newUpdateTimestamp": "(val)",
"newUpdateUser": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleId": "(val)",
"attachmentId": "(val)",
"attachmentsTypeCode": "(val)",
"description": "(val)",
"fileName": "(val)",
"document": "(val)",
"mimeType": "(val)",
"newUpdateTimestamp": "(val)",
"newUpdateUser": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"scheduleId": "(val)",
"attachmentId": "(val)",
"attachmentsTypeCode": "(val)",
"description": "(val)",
"fileName": "(val)",
"document": "(val)",
"mimeType": "(val)",
"newUpdateTimestamp": "(val)",
"newUpdateUser": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleId": "(val)",
"attachmentId": "(val)",
"attachmentsTypeCode": "(val)",
"description": "(val)",
"fileName": "(val)",
"document": "(val)",
"mimeType": "(val)",
"newUpdateTimestamp": "(val)",
"newUpdateUser": "(val)",
"_primaryKey": "(val)"
}
]Delete Committee Schedule Attachments by KeyDELETE/irb/api/v1/committee-schedule-attachments/(key)
Example URI
DELETE /irb/api/v1/committee-schedule-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Schedule AttachmentsDELETE/irb/api/v1/committee-schedule-attachments/
Example URI
DELETE /irb/api/v1/committee-schedule-attachments/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Schedule Attachments with MatchingDELETE/irb/api/v1/committee-schedule-attachments/
Example URI
DELETE /irb/api/v1/committee-schedule-attachments/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- scheduleId
string(optional)- attachmentId
string(optional)- attachmentsTypeCode
string(optional)Attachment Type. Maximum length is 3.
- description
string(optional)Description. Maximum length is 4000.
- fileName
string(optional)File Name. Maximum length is 150.
- document
string(optional)- mimeType
string(optional)- newUpdateTimestamp
string(optional)- newUpdateUser
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Committee Schedule Attendances ¶
Get Committee Schedule Attendances by KeyGET/irb/api/v1/committee-schedule-attendances/(key)
Example URI
GET /irb/api/v1/committee-schedule-attendances/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"commScheduleAttendanceId": "(val)",
"scheduleIdFk": "(val)",
"personId": "(val)",
"personName": "(val)",
"guestFlag": "(val)",
"alternateFlag": "(val)",
"alternateFor": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}Get All Committee Schedule AttendancesGET/irb/api/v1/committee-schedule-attendances/
Example URI
GET /irb/api/v1/committee-schedule-attendances/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"commScheduleAttendanceId": "(val)",
"scheduleIdFk": "(val)",
"personId": "(val)",
"personName": "(val)",
"guestFlag": "(val)",
"alternateFlag": "(val)",
"alternateFor": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleAttendanceId": "(val)",
"scheduleIdFk": "(val)",
"personId": "(val)",
"personName": "(val)",
"guestFlag": "(val)",
"alternateFlag": "(val)",
"alternateFor": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}
]Get All Committee Schedule Attendances with FilteringGET/irb/api/v1/committee-schedule-attendances/
Example URI
GET /irb/api/v1/committee-schedule-attendances/
URI Parameters
- commScheduleAttendanceId
string(optional)Comm Schedule Attendance Id. Maximum length is 22.
- scheduleIdFk
string(optional)Schedule Id. Maximum length is 10.
- personId
string(optional)Person Id. Maximum length is 40.
- personName
string(optional)Person Name. Maximum length is 90.
- guestFlag
string(optional)Guest Flag. Maximum length is 1.
- alternateFlag
string(optional)Alternate Flag. Maximum length is 1.
- alternateFor
string(optional)Alternate For. Maximum length is 9.
- nonEmployeeFlag
string(optional)Non Employee Flag. Maximum length is 1.
- comments
string(optional)Comments. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"commScheduleAttendanceId": "(val)",
"scheduleIdFk": "(val)",
"personId": "(val)",
"personName": "(val)",
"guestFlag": "(val)",
"alternateFlag": "(val)",
"alternateFor": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleAttendanceId": "(val)",
"scheduleIdFk": "(val)",
"personId": "(val)",
"personName": "(val)",
"guestFlag": "(val)",
"alternateFlag": "(val)",
"alternateFor": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Committee Schedule AttendancesGET/irb/api/v1/committee-schedule-attendances/
Example URI
GET /irb/api/v1/committee-schedule-attendances/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"commScheduleAttendanceId",
"scheduleIdFk",
"personId",
"personName",
"guestFlag",
"alternateFlag",
"alternateFor",
"nonEmployeeFlag",
"comments"
],
"primaryKey": "commScheduleAttendanceId"
}Get Blueprint API specification for Committee Schedule AttendancesGET/irb/api/v1/committee-schedule-attendances/
Example URI
GET /irb/api/v1/committee-schedule-attendances/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Committee Schedule Attendances.md"
transfer-encoding: chunkedUpdate Committee Schedule AttendancesPUT/irb/api/v1/committee-schedule-attendances/(key)
Example URI
PUT /irb/api/v1/committee-schedule-attendances/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"commScheduleAttendanceId": "(val)",
"scheduleIdFk": "(val)",
"personId": "(val)",
"personName": "(val)",
"guestFlag": "(val)",
"alternateFlag": "(val)",
"alternateFor": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Committee Schedule AttendancesPUT/irb/api/v1/committee-schedule-attendances/
Example URI
PUT /irb/api/v1/committee-schedule-attendances/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"commScheduleAttendanceId": "(val)",
"scheduleIdFk": "(val)",
"personId": "(val)",
"personName": "(val)",
"guestFlag": "(val)",
"alternateFlag": "(val)",
"alternateFor": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleAttendanceId": "(val)",
"scheduleIdFk": "(val)",
"personId": "(val)",
"personName": "(val)",
"guestFlag": "(val)",
"alternateFlag": "(val)",
"alternateFor": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Committee Schedule AttendancesPATCH/irb/api/v1/committee-schedule-attendances/(key)
Example URI
PATCH /irb/api/v1/committee-schedule-attendances/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"commScheduleAttendanceId": "(val)",
"scheduleIdFk": "(val)",
"personId": "(val)",
"personName": "(val)",
"guestFlag": "(val)",
"alternateFlag": "(val)",
"alternateFor": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"commScheduleAttendanceId": "(val)",
"scheduleIdFk": "(val)",
"personId": "(val)",
"personName": "(val)",
"guestFlag": "(val)",
"alternateFlag": "(val)",
"alternateFor": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}Insert Committee Schedule AttendancesPOST/irb/api/v1/committee-schedule-attendances/
Example URI
POST /irb/api/v1/committee-schedule-attendances/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"commScheduleAttendanceId": "(val)",
"scheduleIdFk": "(val)",
"personId": "(val)",
"personName": "(val)",
"guestFlag": "(val)",
"alternateFlag": "(val)",
"alternateFor": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"commScheduleAttendanceId": "(val)",
"scheduleIdFk": "(val)",
"personId": "(val)",
"personName": "(val)",
"guestFlag": "(val)",
"alternateFlag": "(val)",
"alternateFor": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Committee Schedule AttendancesPOST/irb/api/v1/committee-schedule-attendances/
Example URI
POST /irb/api/v1/committee-schedule-attendances/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"commScheduleAttendanceId": "(val)",
"scheduleIdFk": "(val)",
"personId": "(val)",
"personName": "(val)",
"guestFlag": "(val)",
"alternateFlag": "(val)",
"alternateFor": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleAttendanceId": "(val)",
"scheduleIdFk": "(val)",
"personId": "(val)",
"personName": "(val)",
"guestFlag": "(val)",
"alternateFlag": "(val)",
"alternateFor": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"commScheduleAttendanceId": "(val)",
"scheduleIdFk": "(val)",
"personId": "(val)",
"personName": "(val)",
"guestFlag": "(val)",
"alternateFlag": "(val)",
"alternateFor": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleAttendanceId": "(val)",
"scheduleIdFk": "(val)",
"personId": "(val)",
"personName": "(val)",
"guestFlag": "(val)",
"alternateFlag": "(val)",
"alternateFor": "(val)",
"nonEmployeeFlag": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}
]Delete Committee Schedule Attendances by KeyDELETE/irb/api/v1/committee-schedule-attendances/(key)
Example URI
DELETE /irb/api/v1/committee-schedule-attendances/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Schedule AttendancesDELETE/irb/api/v1/committee-schedule-attendances/
Example URI
DELETE /irb/api/v1/committee-schedule-attendances/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Schedule Attendances with MatchingDELETE/irb/api/v1/committee-schedule-attendances/
Example URI
DELETE /irb/api/v1/committee-schedule-attendances/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- commScheduleAttendanceId
string(optional)Comm Schedule Attendance Id. Maximum length is 22.
- scheduleIdFk
string(optional)Schedule Id. Maximum length is 10.
- personId
string(optional)Person Id. Maximum length is 40.
- personName
string(optional)Person Name. Maximum length is 90.
- guestFlag
string(optional)Guest Flag. Maximum length is 1.
- alternateFlag
string(optional)Alternate Flag. Maximum length is 1.
- alternateFor
string(optional)Alternate For. Maximum length is 9.
- nonEmployeeFlag
string(optional)Non Employee Flag. Maximum length is 1.
- comments
string(optional)Comments. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Committee Schedule Minute Docs ¶
Get Committee Schedule Minute Docs by KeyGET/irb/api/v1/committee-schedule-minute-docs/(key)
Example URI
GET /irb/api/v1/committee-schedule-minute-docs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"commScheduleMinuteDocId": "(val)",
"scheduleIdFk": "(val)",
"minuteNumber": "(val)",
"minuteName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Get All Committee Schedule Minute DocsGET/irb/api/v1/committee-schedule-minute-docs/
Example URI
GET /irb/api/v1/committee-schedule-minute-docs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"commScheduleMinuteDocId": "(val)",
"scheduleIdFk": "(val)",
"minuteNumber": "(val)",
"minuteName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleMinuteDocId": "(val)",
"scheduleIdFk": "(val)",
"minuteNumber": "(val)",
"minuteName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}
]Get All Committee Schedule Minute Docs with FilteringGET/irb/api/v1/committee-schedule-minute-docs/
Example URI
GET /irb/api/v1/committee-schedule-minute-docs/
URI Parameters
- commScheduleMinuteDocId
string(optional)Comm Schedule Minute Doc Id. Maximum length is 12.
- scheduleIdFk
string(optional)Schedule Id. Maximum length is 12.
- minuteNumber
string(optional)Minute Number. Maximum length is 4.
- minuteName
string(optional)Minute Name. Maximum length is 200.
- pdfStore
string(optional)Pdf Store. Maximum length is 4000.
- createTimestamp
string(optional)- createUser
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"commScheduleMinuteDocId": "(val)",
"scheduleIdFk": "(val)",
"minuteNumber": "(val)",
"minuteName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleMinuteDocId": "(val)",
"scheduleIdFk": "(val)",
"minuteNumber": "(val)",
"minuteName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Committee Schedule Minute DocsGET/irb/api/v1/committee-schedule-minute-docs/
Example URI
GET /irb/api/v1/committee-schedule-minute-docs/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"commScheduleMinuteDocId",
"scheduleIdFk",
"minuteNumber",
"minuteName",
"pdfStore",
"createTimestamp",
"createUser"
],
"primaryKey": "commScheduleMinuteDocId"
}Get Blueprint API specification for Committee Schedule Minute DocsGET/irb/api/v1/committee-schedule-minute-docs/
Example URI
GET /irb/api/v1/committee-schedule-minute-docs/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Committee Schedule Minute Docs.md"
transfer-encoding: chunkedUpdate Committee Schedule Minute DocsPUT/irb/api/v1/committee-schedule-minute-docs/(key)
Example URI
PUT /irb/api/v1/committee-schedule-minute-docs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"commScheduleMinuteDocId": "(val)",
"scheduleIdFk": "(val)",
"minuteNumber": "(val)",
"minuteName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Committee Schedule Minute DocsPUT/irb/api/v1/committee-schedule-minute-docs/
Example URI
PUT /irb/api/v1/committee-schedule-minute-docs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"commScheduleMinuteDocId": "(val)",
"scheduleIdFk": "(val)",
"minuteNumber": "(val)",
"minuteName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleMinuteDocId": "(val)",
"scheduleIdFk": "(val)",
"minuteNumber": "(val)",
"minuteName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Committee Schedule Minute DocsPATCH/irb/api/v1/committee-schedule-minute-docs/(key)
Example URI
PATCH /irb/api/v1/committee-schedule-minute-docs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"commScheduleMinuteDocId": "(val)",
"scheduleIdFk": "(val)",
"minuteNumber": "(val)",
"minuteName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"commScheduleMinuteDocId": "(val)",
"scheduleIdFk": "(val)",
"minuteNumber": "(val)",
"minuteName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Insert Committee Schedule Minute DocsPOST/irb/api/v1/committee-schedule-minute-docs/
Example URI
POST /irb/api/v1/committee-schedule-minute-docs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"commScheduleMinuteDocId": "(val)",
"scheduleIdFk": "(val)",
"minuteNumber": "(val)",
"minuteName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"commScheduleMinuteDocId": "(val)",
"scheduleIdFk": "(val)",
"minuteNumber": "(val)",
"minuteName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Committee Schedule Minute DocsPOST/irb/api/v1/committee-schedule-minute-docs/
Example URI
POST /irb/api/v1/committee-schedule-minute-docs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"commScheduleMinuteDocId": "(val)",
"scheduleIdFk": "(val)",
"minuteNumber": "(val)",
"minuteName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleMinuteDocId": "(val)",
"scheduleIdFk": "(val)",
"minuteNumber": "(val)",
"minuteName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"commScheduleMinuteDocId": "(val)",
"scheduleIdFk": "(val)",
"minuteNumber": "(val)",
"minuteName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleMinuteDocId": "(val)",
"scheduleIdFk": "(val)",
"minuteNumber": "(val)",
"minuteName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}
]Delete Committee Schedule Minute Docs by KeyDELETE/irb/api/v1/committee-schedule-minute-docs/(key)
Example URI
DELETE /irb/api/v1/committee-schedule-minute-docs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Schedule Minute DocsDELETE/irb/api/v1/committee-schedule-minute-docs/
Example URI
DELETE /irb/api/v1/committee-schedule-minute-docs/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Schedule Minute Docs with MatchingDELETE/irb/api/v1/committee-schedule-minute-docs/
Example URI
DELETE /irb/api/v1/committee-schedule-minute-docs/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- commScheduleMinuteDocId
string(optional)Comm Schedule Minute Doc Id. Maximum length is 12.
- scheduleIdFk
string(optional)Schedule Id. Maximum length is 12.
- minuteNumber
string(optional)Minute Number. Maximum length is 4.
- minuteName
string(optional)Minute Name. Maximum length is 200.
- pdfStore
string(optional)Pdf Store. Maximum length is 4000.
- createTimestamp
string(optional)- createUser
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Committee Schedule Minutes ¶
Get Committee Schedule Minutes by KeyGET/irb/api/v1/committee-schedule-minutes/(key)
Example URI
GET /irb/api/v1/committee-schedule-minutes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"commScheduleMinutesId": "(val)",
"scheduleIdFk": "(val)",
"entryNumber": "(val)",
"minuteEntryTypeCode": "(val)",
"protocolIdFk": "(val)",
"protocolNumber": "(val)",
"submissionNumber": "(val)",
"commScheduleActItemsIdFk": "(val)",
"submissionIdFk": "(val)",
"privateCommentFlag": "(val)",
"protocolContingencyCode": "(val)",
"minuteEntry": "(val)",
"finalFlag": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolReviewerIdFk": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"_primaryKey": "(val)"
}Get All Committee Schedule MinutesGET/irb/api/v1/committee-schedule-minutes/
Example URI
GET /irb/api/v1/committee-schedule-minutes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"commScheduleMinutesId": "(val)",
"scheduleIdFk": "(val)",
"entryNumber": "(val)",
"minuteEntryTypeCode": "(val)",
"protocolIdFk": "(val)",
"protocolNumber": "(val)",
"submissionNumber": "(val)",
"commScheduleActItemsIdFk": "(val)",
"submissionIdFk": "(val)",
"privateCommentFlag": "(val)",
"protocolContingencyCode": "(val)",
"minuteEntry": "(val)",
"finalFlag": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolReviewerIdFk": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleMinutesId": "(val)",
"scheduleIdFk": "(val)",
"entryNumber": "(val)",
"minuteEntryTypeCode": "(val)",
"protocolIdFk": "(val)",
"protocolNumber": "(val)",
"submissionNumber": "(val)",
"commScheduleActItemsIdFk": "(val)",
"submissionIdFk": "(val)",
"privateCommentFlag": "(val)",
"protocolContingencyCode": "(val)",
"minuteEntry": "(val)",
"finalFlag": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolReviewerIdFk": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"_primaryKey": "(val)"
}
]Get All Committee Schedule Minutes with FilteringGET/irb/api/v1/committee-schedule-minutes/
Example URI
GET /irb/api/v1/committee-schedule-minutes/
URI Parameters
- commScheduleMinutesId
string(optional)Id. Maximum length is 12.
- scheduleIdFk
string(optional)Schedule Id Fk. Maximum length is 12.
- entryNumber
string(optional)Entry Number. Maximum length is 12.
- minuteEntryTypeCode
string(optional)Minute Entry Type Code. Maximum length is 3.
- protocolIdFk
string(optional)Protocol Id Fk. Maximum length is 12.
- protocolNumber
string(optional)- submissionNumber
string(optional)- commScheduleActItemsIdFk
string(optional)CommScheduleActItems Id Fk. Maximum length is 12.
- submissionIdFk
string(optional)Submission Id Fk. Maximum length is 12.
- privateCommentFlag
string(optional)Private Comment Flag. Maximum length is 1.
- protocolContingencyCode
string(optional)Protocol Contingency Code. Maximum length is 4.
- minuteEntry
string(optional)Minute Entry. Maximum length is 4000.
- finalFlag
string(optional)Final Flag. Maximum length is 1.
- createTimestamp
string(optional)Created Time. Maximum length is 21.
- createUser
string(optional)Create User. Maximum length is 80.
- protocolReviewerIdFk
string(optional)Reviewers. Maximum length is 1000.
- protocolOnlineReviewIdFk
string(optional)Protocol Online Review. Maximum length is 1000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"commScheduleMinutesId": "(val)",
"scheduleIdFk": "(val)",
"entryNumber": "(val)",
"minuteEntryTypeCode": "(val)",
"protocolIdFk": "(val)",
"protocolNumber": "(val)",
"submissionNumber": "(val)",
"commScheduleActItemsIdFk": "(val)",
"submissionIdFk": "(val)",
"privateCommentFlag": "(val)",
"protocolContingencyCode": "(val)",
"minuteEntry": "(val)",
"finalFlag": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolReviewerIdFk": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleMinutesId": "(val)",
"scheduleIdFk": "(val)",
"entryNumber": "(val)",
"minuteEntryTypeCode": "(val)",
"protocolIdFk": "(val)",
"protocolNumber": "(val)",
"submissionNumber": "(val)",
"commScheduleActItemsIdFk": "(val)",
"submissionIdFk": "(val)",
"privateCommentFlag": "(val)",
"protocolContingencyCode": "(val)",
"minuteEntry": "(val)",
"finalFlag": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolReviewerIdFk": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Committee Schedule MinutesGET/irb/api/v1/committee-schedule-minutes/
Example URI
GET /irb/api/v1/committee-schedule-minutes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"commScheduleMinutesId",
"scheduleIdFk",
"entryNumber",
"minuteEntryTypeCode",
"protocolIdFk",
"protocolNumber",
"submissionNumber",
"commScheduleActItemsIdFk",
"submissionIdFk",
"privateCommentFlag",
"protocolContingencyCode",
"minuteEntry",
"finalFlag",
"createTimestamp",
"createUser",
"protocolReviewerIdFk",
"protocolOnlineReviewIdFk"
],
"primaryKey": "commScheduleMinutesId"
}Get Blueprint API specification for Committee Schedule MinutesGET/irb/api/v1/committee-schedule-minutes/
Example URI
GET /irb/api/v1/committee-schedule-minutes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Committee Schedule Minutes.md"
transfer-encoding: chunkedUpdate Committee Schedule MinutesPUT/irb/api/v1/committee-schedule-minutes/(key)
Example URI
PUT /irb/api/v1/committee-schedule-minutes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"commScheduleMinutesId": "(val)",
"scheduleIdFk": "(val)",
"entryNumber": "(val)",
"minuteEntryTypeCode": "(val)",
"protocolIdFk": "(val)",
"protocolNumber": "(val)",
"submissionNumber": "(val)",
"commScheduleActItemsIdFk": "(val)",
"submissionIdFk": "(val)",
"privateCommentFlag": "(val)",
"protocolContingencyCode": "(val)",
"minuteEntry": "(val)",
"finalFlag": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolReviewerIdFk": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Committee Schedule MinutesPUT/irb/api/v1/committee-schedule-minutes/
Example URI
PUT /irb/api/v1/committee-schedule-minutes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"commScheduleMinutesId": "(val)",
"scheduleIdFk": "(val)",
"entryNumber": "(val)",
"minuteEntryTypeCode": "(val)",
"protocolIdFk": "(val)",
"protocolNumber": "(val)",
"submissionNumber": "(val)",
"commScheduleActItemsIdFk": "(val)",
"submissionIdFk": "(val)",
"privateCommentFlag": "(val)",
"protocolContingencyCode": "(val)",
"minuteEntry": "(val)",
"finalFlag": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolReviewerIdFk": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleMinutesId": "(val)",
"scheduleIdFk": "(val)",
"entryNumber": "(val)",
"minuteEntryTypeCode": "(val)",
"protocolIdFk": "(val)",
"protocolNumber": "(val)",
"submissionNumber": "(val)",
"commScheduleActItemsIdFk": "(val)",
"submissionIdFk": "(val)",
"privateCommentFlag": "(val)",
"protocolContingencyCode": "(val)",
"minuteEntry": "(val)",
"finalFlag": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolReviewerIdFk": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Committee Schedule MinutesPATCH/irb/api/v1/committee-schedule-minutes/(key)
Example URI
PATCH /irb/api/v1/committee-schedule-minutes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"commScheduleMinutesId": "(val)",
"scheduleIdFk": "(val)",
"entryNumber": "(val)",
"minuteEntryTypeCode": "(val)",
"protocolIdFk": "(val)",
"protocolNumber": "(val)",
"submissionNumber": "(val)",
"commScheduleActItemsIdFk": "(val)",
"submissionIdFk": "(val)",
"privateCommentFlag": "(val)",
"protocolContingencyCode": "(val)",
"minuteEntry": "(val)",
"finalFlag": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolReviewerIdFk": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"commScheduleMinutesId": "(val)",
"scheduleIdFk": "(val)",
"entryNumber": "(val)",
"minuteEntryTypeCode": "(val)",
"protocolIdFk": "(val)",
"protocolNumber": "(val)",
"submissionNumber": "(val)",
"commScheduleActItemsIdFk": "(val)",
"submissionIdFk": "(val)",
"privateCommentFlag": "(val)",
"protocolContingencyCode": "(val)",
"minuteEntry": "(val)",
"finalFlag": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolReviewerIdFk": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"_primaryKey": "(val)"
}Insert Committee Schedule MinutesPOST/irb/api/v1/committee-schedule-minutes/
Example URI
POST /irb/api/v1/committee-schedule-minutes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"commScheduleMinutesId": "(val)",
"scheduleIdFk": "(val)",
"entryNumber": "(val)",
"minuteEntryTypeCode": "(val)",
"protocolIdFk": "(val)",
"protocolNumber": "(val)",
"submissionNumber": "(val)",
"commScheduleActItemsIdFk": "(val)",
"submissionIdFk": "(val)",
"privateCommentFlag": "(val)",
"protocolContingencyCode": "(val)",
"minuteEntry": "(val)",
"finalFlag": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolReviewerIdFk": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"commScheduleMinutesId": "(val)",
"scheduleIdFk": "(val)",
"entryNumber": "(val)",
"minuteEntryTypeCode": "(val)",
"protocolIdFk": "(val)",
"protocolNumber": "(val)",
"submissionNumber": "(val)",
"commScheduleActItemsIdFk": "(val)",
"submissionIdFk": "(val)",
"privateCommentFlag": "(val)",
"protocolContingencyCode": "(val)",
"minuteEntry": "(val)",
"finalFlag": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolReviewerIdFk": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Committee Schedule MinutesPOST/irb/api/v1/committee-schedule-minutes/
Example URI
POST /irb/api/v1/committee-schedule-minutes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"commScheduleMinutesId": "(val)",
"scheduleIdFk": "(val)",
"entryNumber": "(val)",
"minuteEntryTypeCode": "(val)",
"protocolIdFk": "(val)",
"protocolNumber": "(val)",
"submissionNumber": "(val)",
"commScheduleActItemsIdFk": "(val)",
"submissionIdFk": "(val)",
"privateCommentFlag": "(val)",
"protocolContingencyCode": "(val)",
"minuteEntry": "(val)",
"finalFlag": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolReviewerIdFk": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleMinutesId": "(val)",
"scheduleIdFk": "(val)",
"entryNumber": "(val)",
"minuteEntryTypeCode": "(val)",
"protocolIdFk": "(val)",
"protocolNumber": "(val)",
"submissionNumber": "(val)",
"commScheduleActItemsIdFk": "(val)",
"submissionIdFk": "(val)",
"privateCommentFlag": "(val)",
"protocolContingencyCode": "(val)",
"minuteEntry": "(val)",
"finalFlag": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolReviewerIdFk": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"commScheduleMinutesId": "(val)",
"scheduleIdFk": "(val)",
"entryNumber": "(val)",
"minuteEntryTypeCode": "(val)",
"protocolIdFk": "(val)",
"protocolNumber": "(val)",
"submissionNumber": "(val)",
"commScheduleActItemsIdFk": "(val)",
"submissionIdFk": "(val)",
"privateCommentFlag": "(val)",
"protocolContingencyCode": "(val)",
"minuteEntry": "(val)",
"finalFlag": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolReviewerIdFk": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"_primaryKey": "(val)"
},
{
"commScheduleMinutesId": "(val)",
"scheduleIdFk": "(val)",
"entryNumber": "(val)",
"minuteEntryTypeCode": "(val)",
"protocolIdFk": "(val)",
"protocolNumber": "(val)",
"submissionNumber": "(val)",
"commScheduleActItemsIdFk": "(val)",
"submissionIdFk": "(val)",
"privateCommentFlag": "(val)",
"protocolContingencyCode": "(val)",
"minuteEntry": "(val)",
"finalFlag": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolReviewerIdFk": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"_primaryKey": "(val)"
}
]Delete Committee Schedule Minutes by KeyDELETE/irb/api/v1/committee-schedule-minutes/(key)
Example URI
DELETE /irb/api/v1/committee-schedule-minutes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Schedule MinutesDELETE/irb/api/v1/committee-schedule-minutes/
Example URI
DELETE /irb/api/v1/committee-schedule-minutes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Schedule Minutes with MatchingDELETE/irb/api/v1/committee-schedule-minutes/
Example URI
DELETE /irb/api/v1/committee-schedule-minutes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- commScheduleMinutesId
string(optional)Id. Maximum length is 12.
- scheduleIdFk
string(optional)Schedule Id Fk. Maximum length is 12.
- entryNumber
string(optional)Entry Number. Maximum length is 12.
- minuteEntryTypeCode
string(optional)Minute Entry Type Code. Maximum length is 3.
- protocolIdFk
string(optional)Protocol Id Fk. Maximum length is 12.
- protocolNumber
string(optional)- submissionNumber
string(optional)- commScheduleActItemsIdFk
string(optional)CommScheduleActItems Id Fk. Maximum length is 12.
- submissionIdFk
string(optional)Submission Id Fk. Maximum length is 12.
- privateCommentFlag
string(optional)Private Comment Flag. Maximum length is 1.
- protocolContingencyCode
string(optional)Protocol Contingency Code. Maximum length is 4.
- minuteEntry
string(optional)Minute Entry. Maximum length is 4000.
- finalFlag
string(optional)Final Flag. Maximum length is 1.
- createTimestamp
string(optional)Created Time. Maximum length is 21.
- createUser
string(optional)Create User. Maximum length is 80.
- protocolReviewerIdFk
string(optional)Reviewers. Maximum length is 1000.
- protocolOnlineReviewIdFk
string(optional)Protocol Online Review. Maximum length is 1000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Committee Schedules ¶
Get Committee Schedules by KeyGET/irb/api/v1/committee-schedules/(key)
Example URI
GET /irb/api/v1/committee-schedules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"scheduleId": "(val)",
"committeeIdFk": "(val)",
"scheduledDate": "(val)",
"place": "(val)",
"time": "(val)",
"protocolSubDeadline": "(val)",
"scheduleStatusCode": "(val)",
"meetingDate": "(val)",
"startTime": "(val)",
"endTime": "(val)",
"agendaProdRevDate": "(val)",
"maxProtocols": "(val)",
"comments": "(val)",
"availableToReviewers": "(val)",
"_primaryKey": "(val)"
}Get All Committee SchedulesGET/irb/api/v1/committee-schedules/
Example URI
GET /irb/api/v1/committee-schedules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"scheduleId": "(val)",
"committeeIdFk": "(val)",
"scheduledDate": "(val)",
"place": "(val)",
"time": "(val)",
"protocolSubDeadline": "(val)",
"scheduleStatusCode": "(val)",
"meetingDate": "(val)",
"startTime": "(val)",
"endTime": "(val)",
"agendaProdRevDate": "(val)",
"maxProtocols": "(val)",
"comments": "(val)",
"availableToReviewers": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"scheduleId": "(val)",
"committeeIdFk": "(val)",
"scheduledDate": "(val)",
"place": "(val)",
"time": "(val)",
"protocolSubDeadline": "(val)",
"scheduleStatusCode": "(val)",
"meetingDate": "(val)",
"startTime": "(val)",
"endTime": "(val)",
"agendaProdRevDate": "(val)",
"maxProtocols": "(val)",
"comments": "(val)",
"availableToReviewers": "(val)",
"_primaryKey": "(val)"
}
]Get All Committee Schedules with FilteringGET/irb/api/v1/committee-schedules/
Example URI
GET /irb/api/v1/committee-schedules/
URI Parameters
- id
string(optional)Id. Maximum length is 12.
- scheduleId
string(optional)Schedule Id. Maximum length is 10.
- committeeIdFk
string(optional)Committee Id. Maximum length is 12.
- scheduledDate
string(optional)Scheduled Date. Maximum length is 10.
- place
string(optional)Place. Maximum length is 200.
- time
string(optional)Time. Maximum length is 10.
- protocolSubDeadline
string(optional)Protocol Sub Deadline. Maximum length is 10.
- scheduleStatusCode
string(optional)Schedule Status Code. Maximum length is 3.
- meetingDate
string(optional)Meeting Date. Maximum length is 21.
- startTime
string(optional)Start Time. Maximum length is 10.
- endTime
string(optional)End Time. Maximum length is 10.
- agendaProdRevDate
string(optional)Agenda Prod Rev Date. Maximum length is 21.
- maxProtocols
string(optional)Max Protocols. Maximum length is 4.
- comments
string(optional)Comments. Maximum length is 2000.
- availableToReviewers
string(optional)Available to reviewers. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"scheduleId": "(val)",
"committeeIdFk": "(val)",
"scheduledDate": "(val)",
"place": "(val)",
"time": "(val)",
"protocolSubDeadline": "(val)",
"scheduleStatusCode": "(val)",
"meetingDate": "(val)",
"startTime": "(val)",
"endTime": "(val)",
"agendaProdRevDate": "(val)",
"maxProtocols": "(val)",
"comments": "(val)",
"availableToReviewers": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"scheduleId": "(val)",
"committeeIdFk": "(val)",
"scheduledDate": "(val)",
"place": "(val)",
"time": "(val)",
"protocolSubDeadline": "(val)",
"scheduleStatusCode": "(val)",
"meetingDate": "(val)",
"startTime": "(val)",
"endTime": "(val)",
"agendaProdRevDate": "(val)",
"maxProtocols": "(val)",
"comments": "(val)",
"availableToReviewers": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Committee SchedulesGET/irb/api/v1/committee-schedules/
Example URI
GET /irb/api/v1/committee-schedules/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"scheduleId",
"committeeIdFk",
"scheduledDate",
"place",
"time",
"protocolSubDeadline",
"scheduleStatusCode",
"meetingDate",
"startTime",
"endTime",
"agendaProdRevDate",
"maxProtocols",
"comments",
"availableToReviewers"
],
"primaryKey": "id"
}Get Blueprint API specification for Committee SchedulesGET/irb/api/v1/committee-schedules/
Example URI
GET /irb/api/v1/committee-schedules/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Committee Schedules.md"
transfer-encoding: chunkedUpdate Committee SchedulesPUT/irb/api/v1/committee-schedules/(key)
Example URI
PUT /irb/api/v1/committee-schedules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"scheduleId": "(val)",
"committeeIdFk": "(val)",
"scheduledDate": "(val)",
"place": "(val)",
"time": "(val)",
"protocolSubDeadline": "(val)",
"scheduleStatusCode": "(val)",
"meetingDate": "(val)",
"startTime": "(val)",
"endTime": "(val)",
"agendaProdRevDate": "(val)",
"maxProtocols": "(val)",
"comments": "(val)",
"availableToReviewers": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Committee SchedulesPUT/irb/api/v1/committee-schedules/
Example URI
PUT /irb/api/v1/committee-schedules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"scheduleId": "(val)",
"committeeIdFk": "(val)",
"scheduledDate": "(val)",
"place": "(val)",
"time": "(val)",
"protocolSubDeadline": "(val)",
"scheduleStatusCode": "(val)",
"meetingDate": "(val)",
"startTime": "(val)",
"endTime": "(val)",
"agendaProdRevDate": "(val)",
"maxProtocols": "(val)",
"comments": "(val)",
"availableToReviewers": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"scheduleId": "(val)",
"committeeIdFk": "(val)",
"scheduledDate": "(val)",
"place": "(val)",
"time": "(val)",
"protocolSubDeadline": "(val)",
"scheduleStatusCode": "(val)",
"meetingDate": "(val)",
"startTime": "(val)",
"endTime": "(val)",
"agendaProdRevDate": "(val)",
"maxProtocols": "(val)",
"comments": "(val)",
"availableToReviewers": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Committee SchedulesPATCH/irb/api/v1/committee-schedules/(key)
Example URI
PATCH /irb/api/v1/committee-schedules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"scheduleId": "(val)",
"committeeIdFk": "(val)",
"scheduledDate": "(val)",
"place": "(val)",
"time": "(val)",
"protocolSubDeadline": "(val)",
"scheduleStatusCode": "(val)",
"meetingDate": "(val)",
"startTime": "(val)",
"endTime": "(val)",
"agendaProdRevDate": "(val)",
"maxProtocols": "(val)",
"comments": "(val)",
"availableToReviewers": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"scheduleId": "(val)",
"committeeIdFk": "(val)",
"scheduledDate": "(val)",
"place": "(val)",
"time": "(val)",
"protocolSubDeadline": "(val)",
"scheduleStatusCode": "(val)",
"meetingDate": "(val)",
"startTime": "(val)",
"endTime": "(val)",
"agendaProdRevDate": "(val)",
"maxProtocols": "(val)",
"comments": "(val)",
"availableToReviewers": "(val)",
"_primaryKey": "(val)"
}Insert Committee SchedulesPOST/irb/api/v1/committee-schedules/
Example URI
POST /irb/api/v1/committee-schedules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"scheduleId": "(val)",
"committeeIdFk": "(val)",
"scheduledDate": "(val)",
"place": "(val)",
"time": "(val)",
"protocolSubDeadline": "(val)",
"scheduleStatusCode": "(val)",
"meetingDate": "(val)",
"startTime": "(val)",
"endTime": "(val)",
"agendaProdRevDate": "(val)",
"maxProtocols": "(val)",
"comments": "(val)",
"availableToReviewers": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"scheduleId": "(val)",
"committeeIdFk": "(val)",
"scheduledDate": "(val)",
"place": "(val)",
"time": "(val)",
"protocolSubDeadline": "(val)",
"scheduleStatusCode": "(val)",
"meetingDate": "(val)",
"startTime": "(val)",
"endTime": "(val)",
"agendaProdRevDate": "(val)",
"maxProtocols": "(val)",
"comments": "(val)",
"availableToReviewers": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Committee SchedulesPOST/irb/api/v1/committee-schedules/
Example URI
POST /irb/api/v1/committee-schedules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"scheduleId": "(val)",
"committeeIdFk": "(val)",
"scheduledDate": "(val)",
"place": "(val)",
"time": "(val)",
"protocolSubDeadline": "(val)",
"scheduleStatusCode": "(val)",
"meetingDate": "(val)",
"startTime": "(val)",
"endTime": "(val)",
"agendaProdRevDate": "(val)",
"maxProtocols": "(val)",
"comments": "(val)",
"availableToReviewers": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"scheduleId": "(val)",
"committeeIdFk": "(val)",
"scheduledDate": "(val)",
"place": "(val)",
"time": "(val)",
"protocolSubDeadline": "(val)",
"scheduleStatusCode": "(val)",
"meetingDate": "(val)",
"startTime": "(val)",
"endTime": "(val)",
"agendaProdRevDate": "(val)",
"maxProtocols": "(val)",
"comments": "(val)",
"availableToReviewers": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"scheduleId": "(val)",
"committeeIdFk": "(val)",
"scheduledDate": "(val)",
"place": "(val)",
"time": "(val)",
"protocolSubDeadline": "(val)",
"scheduleStatusCode": "(val)",
"meetingDate": "(val)",
"startTime": "(val)",
"endTime": "(val)",
"agendaProdRevDate": "(val)",
"maxProtocols": "(val)",
"comments": "(val)",
"availableToReviewers": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"scheduleId": "(val)",
"committeeIdFk": "(val)",
"scheduledDate": "(val)",
"place": "(val)",
"time": "(val)",
"protocolSubDeadline": "(val)",
"scheduleStatusCode": "(val)",
"meetingDate": "(val)",
"startTime": "(val)",
"endTime": "(val)",
"agendaProdRevDate": "(val)",
"maxProtocols": "(val)",
"comments": "(val)",
"availableToReviewers": "(val)",
"_primaryKey": "(val)"
}
]Delete Committee Schedules by KeyDELETE/irb/api/v1/committee-schedules/(key)
Example URI
DELETE /irb/api/v1/committee-schedules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee SchedulesDELETE/irb/api/v1/committee-schedules/
Example URI
DELETE /irb/api/v1/committee-schedules/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Committee Schedules with MatchingDELETE/irb/api/v1/committee-schedules/
Example URI
DELETE /irb/api/v1/committee-schedules/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Id. Maximum length is 12.
- scheduleId
string(optional)Schedule Id. Maximum length is 10.
- committeeIdFk
string(optional)Committee Id. Maximum length is 12.
- scheduledDate
string(optional)Scheduled Date. Maximum length is 10.
- place
string(optional)Place. Maximum length is 200.
- time
string(optional)Time. Maximum length is 10.
- protocolSubDeadline
string(optional)Protocol Sub Deadline. Maximum length is 10.
- scheduleStatusCode
string(optional)Schedule Status Code. Maximum length is 3.
- meetingDate
string(optional)Meeting Date. Maximum length is 21.
- startTime
string(optional)Start Time. Maximum length is 10.
- endTime
string(optional)End Time. Maximum length is 10.
- agendaProdRevDate
string(optional)Agenda Prod Rev Date. Maximum length is 21.
- maxProtocols
string(optional)Max Protocols. Maximum length is 4.
- comments
string(optional)Comments. Maximum length is 2000.
- availableToReviewers
string(optional)Available to reviewers. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Committees ¶
Get Committees by KeyGET/irb/api/v1/committees/(key)
Example URI
GET /irb/api/v1/committees/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"committeeId": "(val)",
"sequenceNumber": "(val)",
"committeeName": "(val)",
"homeUnitNumber": "(val)",
"committeeDescription": "(val)",
"scheduleDescription": "(val)",
"committeeTypeCode": "(val)",
"minimumMembersRequired": "(val)",
"maxProtocols": "(val)",
"advancedSubmissionDaysRequired": "(val)",
"reviewTypeCode": "(val)",
"committeeDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}Get All CommitteesGET/irb/api/v1/committees/
Example URI
GET /irb/api/v1/committees/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"committeeId": "(val)",
"sequenceNumber": "(val)",
"committeeName": "(val)",
"homeUnitNumber": "(val)",
"committeeDescription": "(val)",
"scheduleDescription": "(val)",
"committeeTypeCode": "(val)",
"minimumMembersRequired": "(val)",
"maxProtocols": "(val)",
"advancedSubmissionDaysRequired": "(val)",
"reviewTypeCode": "(val)",
"committeeDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"committeeId": "(val)",
"sequenceNumber": "(val)",
"committeeName": "(val)",
"homeUnitNumber": "(val)",
"committeeDescription": "(val)",
"scheduleDescription": "(val)",
"committeeTypeCode": "(val)",
"minimumMembersRequired": "(val)",
"maxProtocols": "(val)",
"advancedSubmissionDaysRequired": "(val)",
"reviewTypeCode": "(val)",
"committeeDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Committees with FilteringGET/irb/api/v1/committees/
Example URI
GET /irb/api/v1/committees/
URI Parameters
- id
string(optional)- committeeId
string(optional)Committee ID. Maximum length is 15.
- sequenceNumber
string(optional)- committeeName
string(optional)Committee Name. Maximum length is 60.
- homeUnitNumber
string(optional)Home Unit. Maximum length is 8.
- committeeDescription
string(optional)Committee Description. Maximum length is 2000.
- scheduleDescription
string(optional)Schedule Description. Maximum length is 2000.
- committeeTypeCode
string(optional)The type of committee. Maximum length is 3.
- minimumMembersRequired
string(optional)Min Members for Quorum. Maximum length is 3.
- maxProtocols
string(optional)Maximum Protocols. Maximum length is 4.
- advancedSubmissionDaysRequired
string(optional)Adv Submission Days. Maximum length is 3.
- reviewTypeCode
string(optional)The type of review. Maximum length is 3.
- coiReviewTypeCode
string(optional)The type of COI review. Maximum length is 3.
- committeeDocument.documentNumber
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"committeeId": "(val)",
"sequenceNumber": "(val)",
"committeeName": "(val)",
"homeUnitNumber": "(val)",
"committeeDescription": "(val)",
"scheduleDescription": "(val)",
"committeeTypeCode": "(val)",
"minimumMembersRequired": "(val)",
"maxProtocols": "(val)",
"advancedSubmissionDaysRequired": "(val)",
"reviewTypeCode": "(val)",
"committeeDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"committeeId": "(val)",
"sequenceNumber": "(val)",
"committeeName": "(val)",
"homeUnitNumber": "(val)",
"committeeDescription": "(val)",
"scheduleDescription": "(val)",
"committeeTypeCode": "(val)",
"minimumMembersRequired": "(val)",
"maxProtocols": "(val)",
"advancedSubmissionDaysRequired": "(val)",
"reviewTypeCode": "(val)",
"committeeDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for CommitteesGET/irb/api/v1/committees/
Example URI
GET /irb/api/v1/committees/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"committeeId",
"sequenceNumber",
"committeeName",
"homeUnitNumber",
"committeeDescription",
"scheduleDescription",
"committeeTypeCode",
"minimumMembersRequired",
"maxProtocols",
"advancedSubmissionDaysRequired",
"reviewTypeCode",
"committeeDocument.documentNumber"
],
"primaryKey": "id"
}Get Blueprint API specification for CommitteesGET/irb/api/v1/committees/
Example URI
GET /irb/api/v1/committees/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Committees.md"
transfer-encoding: chunkedCorrespondent Types ¶
Get Correspondent Types by KeyGET/irb/api/v1/correspondent-types/(key)
Example URI
GET /irb/api/v1/correspondent-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"correspondentTypeCode": "(val)",
"description": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}Get All Correspondent TypesGET/irb/api/v1/correspondent-types/
Example URI
GET /irb/api/v1/correspondent-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"correspondentTypeCode": "(val)",
"description": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
},
{
"correspondentTypeCode": "(val)",
"description": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}
]Get All Correspondent Types with FilteringGET/irb/api/v1/correspondent-types/
Example URI
GET /irb/api/v1/correspondent-types/
URI Parameters
- correspondentTypeCode
string(optional)Correspondent Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- qualifier
string(optional)Qualifier. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"correspondentTypeCode": "(val)",
"description": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
},
{
"correspondentTypeCode": "(val)",
"description": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Correspondent TypesGET/irb/api/v1/correspondent-types/
Example URI
GET /irb/api/v1/correspondent-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"correspondentTypeCode",
"description",
"qualifier"
],
"primaryKey": "correspondentTypeCode"
}Get Blueprint API specification for Correspondent TypesGET/irb/api/v1/correspondent-types/
Example URI
GET /irb/api/v1/correspondent-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Correspondent Types.md"
transfer-encoding: chunkedUpdate Correspondent TypesPUT/irb/api/v1/correspondent-types/(key)
Example URI
PUT /irb/api/v1/correspondent-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"correspondentTypeCode": "(val)",
"description": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Correspondent TypesPUT/irb/api/v1/correspondent-types/
Example URI
PUT /irb/api/v1/correspondent-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"correspondentTypeCode": "(val)",
"description": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
},
{
"correspondentTypeCode": "(val)",
"description": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Correspondent TypesPATCH/irb/api/v1/correspondent-types/(key)
Example URI
PATCH /irb/api/v1/correspondent-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"correspondentTypeCode": "(val)",
"description": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"correspondentTypeCode": "(val)",
"description": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}Insert Correspondent TypesPOST/irb/api/v1/correspondent-types/
Example URI
POST /irb/api/v1/correspondent-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"correspondentTypeCode": "(val)",
"description": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"correspondentTypeCode": "(val)",
"description": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Correspondent TypesPOST/irb/api/v1/correspondent-types/
Example URI
POST /irb/api/v1/correspondent-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"correspondentTypeCode": "(val)",
"description": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
},
{
"correspondentTypeCode": "(val)",
"description": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"correspondentTypeCode": "(val)",
"description": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
},
{
"correspondentTypeCode": "(val)",
"description": "(val)",
"qualifier": "(val)",
"_primaryKey": "(val)"
}
]Delete Correspondent Types by KeyDELETE/irb/api/v1/correspondent-types/(key)
Example URI
DELETE /irb/api/v1/correspondent-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Correspondent TypesDELETE/irb/api/v1/correspondent-types/
Example URI
DELETE /irb/api/v1/correspondent-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Correspondent Types with MatchingDELETE/irb/api/v1/correspondent-types/
Example URI
DELETE /irb/api/v1/correspondent-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- correspondentTypeCode
string(optional)Correspondent Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- qualifier
string(optional)Qualifier. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Exempt Studies Checklist Items ¶
Get Exempt Studies Checklist Items by KeyGET/irb/api/v1/exempt-studies-checklist-items/(key)
Example URI
GET /irb/api/v1/exempt-studies-checklist-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"exemptStudiesCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Exempt Studies Checklist ItemsGET/irb/api/v1/exempt-studies-checklist-items/
Example URI
GET /irb/api/v1/exempt-studies-checklist-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exemptStudiesCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exemptStudiesCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Exempt Studies Checklist Items with FilteringGET/irb/api/v1/exempt-studies-checklist-items/
Example URI
GET /irb/api/v1/exempt-studies-checklist-items/
URI Parameters
- exemptStudiesCheckListCode
string(optional)Exempt Studies CheckList Code. Maximum length is 4.
- description
string(optional)Description. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"exemptStudiesCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exemptStudiesCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Exempt Studies Checklist ItemsGET/irb/api/v1/exempt-studies-checklist-items/
Example URI
GET /irb/api/v1/exempt-studies-checklist-items/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"exemptStudiesCheckListCode",
"description"
],
"primaryKey": "exemptStudiesCheckListCode"
}Get Blueprint API specification for Exempt Studies Checklist ItemsGET/irb/api/v1/exempt-studies-checklist-items/
Example URI
GET /irb/api/v1/exempt-studies-checklist-items/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Exempt Studies Checklist Items.md"
transfer-encoding: chunkedUpdate Exempt Studies Checklist ItemsPUT/irb/api/v1/exempt-studies-checklist-items/(key)
Example URI
PUT /irb/api/v1/exempt-studies-checklist-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exemptStudiesCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Exempt Studies Checklist ItemsPUT/irb/api/v1/exempt-studies-checklist-items/
Example URI
PUT /irb/api/v1/exempt-studies-checklist-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exemptStudiesCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exemptStudiesCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Exempt Studies Checklist ItemsPATCH/irb/api/v1/exempt-studies-checklist-items/(key)
Example URI
PATCH /irb/api/v1/exempt-studies-checklist-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exemptStudiesCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"exemptStudiesCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Exempt Studies Checklist ItemsPOST/irb/api/v1/exempt-studies-checklist-items/
Example URI
POST /irb/api/v1/exempt-studies-checklist-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"exemptStudiesCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"exemptStudiesCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Exempt Studies Checklist ItemsPOST/irb/api/v1/exempt-studies-checklist-items/
Example URI
POST /irb/api/v1/exempt-studies-checklist-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"exemptStudiesCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exemptStudiesCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"exemptStudiesCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"exemptStudiesCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Exempt Studies Checklist Items by KeyDELETE/irb/api/v1/exempt-studies-checklist-items/(key)
Example URI
DELETE /irb/api/v1/exempt-studies-checklist-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Exempt Studies Checklist ItemsDELETE/irb/api/v1/exempt-studies-checklist-items/
Example URI
DELETE /irb/api/v1/exempt-studies-checklist-items/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Exempt Studies Checklist Items with MatchingDELETE/irb/api/v1/exempt-studies-checklist-items/
Example URI
DELETE /irb/api/v1/exempt-studies-checklist-items/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- exemptStudiesCheckListCode
string(optional)Exempt Studies CheckList Code. Maximum length is 4.
- description
string(optional)Description. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Expedited Review Checklist Items ¶
Get Expedited Review Checklist Items by KeyGET/irb/api/v1/expedited-review-checklist-items/(key)
Example URI
GET /irb/api/v1/expedited-review-checklist-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"expeditedReviewCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Expedited Review Checklist ItemsGET/irb/api/v1/expedited-review-checklist-items/
Example URI
GET /irb/api/v1/expedited-review-checklist-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"expeditedReviewCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"expeditedReviewCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Expedited Review Checklist Items with FilteringGET/irb/api/v1/expedited-review-checklist-items/
Example URI
GET /irb/api/v1/expedited-review-checklist-items/
URI Parameters
- expeditedReviewCheckListCode
string(optional)Expedited Review CheckList Code. Maximum length is 4.
- description
string(optional)Description. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"expeditedReviewCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"expeditedReviewCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Expedited Review Checklist ItemsGET/irb/api/v1/expedited-review-checklist-items/
Example URI
GET /irb/api/v1/expedited-review-checklist-items/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"expeditedReviewCheckListCode",
"description"
],
"primaryKey": "expeditedReviewCheckListCode"
}Get Blueprint API specification for Expedited Review Checklist ItemsGET/irb/api/v1/expedited-review-checklist-items/
Example URI
GET /irb/api/v1/expedited-review-checklist-items/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Expedited Review Checklist Items.md"
transfer-encoding: chunkedUpdate Expedited Review Checklist ItemsPUT/irb/api/v1/expedited-review-checklist-items/(key)
Example URI
PUT /irb/api/v1/expedited-review-checklist-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"expeditedReviewCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Expedited Review Checklist ItemsPUT/irb/api/v1/expedited-review-checklist-items/
Example URI
PUT /irb/api/v1/expedited-review-checklist-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"expeditedReviewCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"expeditedReviewCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Expedited Review Checklist ItemsPATCH/irb/api/v1/expedited-review-checklist-items/(key)
Example URI
PATCH /irb/api/v1/expedited-review-checklist-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"expeditedReviewCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"expeditedReviewCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Expedited Review Checklist ItemsPOST/irb/api/v1/expedited-review-checklist-items/
Example URI
POST /irb/api/v1/expedited-review-checklist-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"expeditedReviewCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"expeditedReviewCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Expedited Review Checklist ItemsPOST/irb/api/v1/expedited-review-checklist-items/
Example URI
POST /irb/api/v1/expedited-review-checklist-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"expeditedReviewCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"expeditedReviewCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"expeditedReviewCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"expeditedReviewCheckListCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Expedited Review Checklist Items by KeyDELETE/irb/api/v1/expedited-review-checklist-items/(key)
Example URI
DELETE /irb/api/v1/expedited-review-checklist-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Expedited Review Checklist ItemsDELETE/irb/api/v1/expedited-review-checklist-items/
Example URI
DELETE /irb/api/v1/expedited-review-checklist-items/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Expedited Review Checklist Items with MatchingDELETE/irb/api/v1/expedited-review-checklist-items/
Example URI
DELETE /irb/api/v1/expedited-review-checklist-items/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- expeditedReviewCheckListCode
string(optional)Expedited Review CheckList Code. Maximum length is 4.
- description
string(optional)Description. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Irb Protocol Notifications ¶
Get Irb Protocol Notifications by KeyGET/irb/api/v1/irb-protocol-notifications/(key)
Example URI
GET /irb/api/v1/irb-protocol-notifications/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"owningDocumentIdFk": "(val)",
"recipients": "(val)",
"subject": "(val)",
"message": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"_primaryKey": "(val)"
}Get All Irb Protocol NotificationsGET/irb/api/v1/irb-protocol-notifications/
Example URI
GET /irb/api/v1/irb-protocol-notifications/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"owningDocumentIdFk": "(val)",
"recipients": "(val)",
"subject": "(val)",
"message": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"_primaryKey": "(val)"
},
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"owningDocumentIdFk": "(val)",
"recipients": "(val)",
"subject": "(val)",
"message": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"_primaryKey": "(val)"
}
]Get All Irb Protocol Notifications with FilteringGET/irb/api/v1/irb-protocol-notifications/
Example URI
GET /irb/api/v1/irb-protocol-notifications/
URI Parameters
- notificationId
string(optional)- notificationTypeId
string(optional)- documentNumber
string(optional)- owningDocumentIdFk
string(optional)- recipients
string(optional)- subject
string(optional)- message
string(optional)- createUser
string(optional)- createTimestamp
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"owningDocumentIdFk": "(val)",
"recipients": "(val)",
"subject": "(val)",
"message": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"_primaryKey": "(val)"
},
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"owningDocumentIdFk": "(val)",
"recipients": "(val)",
"subject": "(val)",
"message": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Irb Protocol NotificationsGET/irb/api/v1/irb-protocol-notifications/
Example URI
GET /irb/api/v1/irb-protocol-notifications/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"notificationId",
"notificationTypeId",
"documentNumber",
"owningDocumentIdFk",
"recipients",
"subject",
"message",
"createUser",
"createTimestamp"
],
"primaryKey": "notificationId"
}Get Blueprint API specification for Irb Protocol NotificationsGET/irb/api/v1/irb-protocol-notifications/
Example URI
GET /irb/api/v1/irb-protocol-notifications/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Irb Protocol Notifications.md"
transfer-encoding: chunkedUpdate Irb Protocol NotificationsPUT/irb/api/v1/irb-protocol-notifications/(key)
Example URI
PUT /irb/api/v1/irb-protocol-notifications/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"owningDocumentIdFk": "(val)",
"recipients": "(val)",
"subject": "(val)",
"message": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Irb Protocol NotificationsPUT/irb/api/v1/irb-protocol-notifications/
Example URI
PUT /irb/api/v1/irb-protocol-notifications/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"owningDocumentIdFk": "(val)",
"recipients": "(val)",
"subject": "(val)",
"message": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"_primaryKey": "(val)"
},
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"owningDocumentIdFk": "(val)",
"recipients": "(val)",
"subject": "(val)",
"message": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Irb Protocol NotificationsPATCH/irb/api/v1/irb-protocol-notifications/(key)
Example URI
PATCH /irb/api/v1/irb-protocol-notifications/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"owningDocumentIdFk": "(val)",
"recipients": "(val)",
"subject": "(val)",
"message": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"owningDocumentIdFk": "(val)",
"recipients": "(val)",
"subject": "(val)",
"message": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"_primaryKey": "(val)"
}Insert Irb Protocol NotificationsPOST/irb/api/v1/irb-protocol-notifications/
Example URI
POST /irb/api/v1/irb-protocol-notifications/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"owningDocumentIdFk": "(val)",
"recipients": "(val)",
"subject": "(val)",
"message": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"owningDocumentIdFk": "(val)",
"recipients": "(val)",
"subject": "(val)",
"message": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Irb Protocol NotificationsPOST/irb/api/v1/irb-protocol-notifications/
Example URI
POST /irb/api/v1/irb-protocol-notifications/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"owningDocumentIdFk": "(val)",
"recipients": "(val)",
"subject": "(val)",
"message": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"_primaryKey": "(val)"
},
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"owningDocumentIdFk": "(val)",
"recipients": "(val)",
"subject": "(val)",
"message": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"owningDocumentIdFk": "(val)",
"recipients": "(val)",
"subject": "(val)",
"message": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"_primaryKey": "(val)"
},
{
"notificationId": "(val)",
"notificationTypeId": "(val)",
"documentNumber": "(val)",
"owningDocumentIdFk": "(val)",
"recipients": "(val)",
"subject": "(val)",
"message": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"_primaryKey": "(val)"
}
]Delete Irb Protocol Notifications by KeyDELETE/irb/api/v1/irb-protocol-notifications/(key)
Example URI
DELETE /irb/api/v1/irb-protocol-notifications/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Irb Protocol NotificationsDELETE/irb/api/v1/irb-protocol-notifications/
Example URI
DELETE /irb/api/v1/irb-protocol-notifications/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Irb Protocol Notifications with MatchingDELETE/irb/api/v1/irb-protocol-notifications/
Example URI
DELETE /irb/api/v1/irb-protocol-notifications/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- notificationId
string(optional)- notificationTypeId
string(optional)- documentNumber
string(optional)- owningDocumentIdFk
string(optional)- recipients
string(optional)- subject
string(optional)- message
string(optional)- createUser
string(optional)- createTimestamp
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Lite View Protocol Submissions ¶
Get Lite View Protocol Submissions by KeyGET/irb/api/v1/lite-view-protocol-submissions/(key)
Example URI
GET /irb/api/v1/lite-view-protocol-submissions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"protocolActive": "(val)",
"protocolStatusCode": "(val)",
"protocolTitle": "(val)",
"piPersonId": "(val)",
"piPersonName": "(val)",
"piRolodexId": "(val)",
"_primaryKey": "(val)"
}Get All Lite View Protocol SubmissionsGET/irb/api/v1/lite-view-protocol-submissions/
Example URI
GET /irb/api/v1/lite-view-protocol-submissions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"protocolActive": "(val)",
"protocolStatusCode": "(val)",
"protocolTitle": "(val)",
"piPersonId": "(val)",
"piPersonName": "(val)",
"piRolodexId": "(val)",
"_primaryKey": "(val)"
},
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"protocolActive": "(val)",
"protocolStatusCode": "(val)",
"protocolTitle": "(val)",
"piPersonId": "(val)",
"piPersonName": "(val)",
"piRolodexId": "(val)",
"_primaryKey": "(val)"
}
]Get All Lite View Protocol Submissions with FilteringGET/irb/api/v1/lite-view-protocol-submissions/
Example URI
GET /irb/api/v1/lite-view-protocol-submissions/
URI Parameters
- submissionId
string(optional)- submissionNumber
string(optional)Submission Number. Maximum length is 22.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 4.
- scheduleId
string(optional)Schedule Id. Maximum length is 10.
- committeeId
string(optional)Committee Id. Maximum length is 15.
- submissionTypeCode
string(optional)Submission Type Code. Maximum length is 3.
- submissionTypeQualifierCode
string(optional)Submission Type Qual Code. Maximum length is 3.
- submissionStatusCode
string(optional)Submission Status Code. Maximum length is 3.
- protocolId
string(optional)- scheduleIdFk
string(optional)- committeeIdFk
string(optional)Committee Id. Maximum length is 12.
- protocolReviewTypeCode
string(optional)Protocol Review Type Code. Maximum length is 3.
- submissionDate
string(optional)Submission Date. Maximum length is 10.
- comments
string(optional)Comments. Maximum length is 2000.
- committeeDecisionMotionTypeCode
string(optional)Committee Decision Motion Type. Maximum length is 3.
- yesVoteCount
string(optional)Yes Vote Count. Maximum length is 22.
- noVoteCount
string(optional)No Vote Count. Maximum length is 22.
- abstainerCount
string(optional)Abstainer Count. Maximum length is 22.
- recusedCount
string(optional)- votingComments
string(optional)Voting Comments. Maximum length is 2000.
- billable
string(optional)Is Billable. Maximum length is 1.
- protocolActive
string(optional)- protocolStatusCode
string(optional)- protocolTitle
string(optional)Title. Maximum length is 2000.
- piPersonId
string(optional)- piPersonName
string(optional)Person Name. Maximum length is 90.
- piRolodexId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"protocolActive": "(val)",
"protocolStatusCode": "(val)",
"protocolTitle": "(val)",
"piPersonId": "(val)",
"piPersonName": "(val)",
"piRolodexId": "(val)",
"_primaryKey": "(val)"
},
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"protocolActive": "(val)",
"protocolStatusCode": "(val)",
"protocolTitle": "(val)",
"piPersonId": "(val)",
"piPersonName": "(val)",
"piRolodexId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Lite View Protocol SubmissionsGET/irb/api/v1/lite-view-protocol-submissions/
Example URI
GET /irb/api/v1/lite-view-protocol-submissions/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"submissionId",
"submissionNumber",
"protocolNumber",
"sequenceNumber",
"scheduleId",
"committeeId",
"submissionTypeCode",
"submissionTypeQualifierCode",
"submissionStatusCode",
"protocolId",
"scheduleIdFk",
"committeeIdFk",
"protocolReviewTypeCode",
"submissionDate",
"comments",
"committeeDecisionMotionTypeCode",
"yesVoteCount",
"noVoteCount",
"abstainerCount",
"recusedCount",
"votingComments",
"billable",
"protocolActive",
"protocolStatusCode",
"protocolTitle",
"piPersonId",
"piPersonName",
"piRolodexId"
],
"primaryKey": "submissionId"
}Get Blueprint API specification for Lite View Protocol SubmissionsGET/irb/api/v1/lite-view-protocol-submissions/
Example URI
GET /irb/api/v1/lite-view-protocol-submissions/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Lite View Protocol Submissions.md"
transfer-encoding: chunkedUpdate Lite View Protocol SubmissionsPUT/irb/api/v1/lite-view-protocol-submissions/(key)
Example URI
PUT /irb/api/v1/lite-view-protocol-submissions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"protocolActive": "(val)",
"protocolStatusCode": "(val)",
"protocolTitle": "(val)",
"piPersonId": "(val)",
"piPersonName": "(val)",
"piRolodexId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Lite View Protocol SubmissionsPUT/irb/api/v1/lite-view-protocol-submissions/
Example URI
PUT /irb/api/v1/lite-view-protocol-submissions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"protocolActive": "(val)",
"protocolStatusCode": "(val)",
"protocolTitle": "(val)",
"piPersonId": "(val)",
"piPersonName": "(val)",
"piRolodexId": "(val)",
"_primaryKey": "(val)"
},
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"protocolActive": "(val)",
"protocolStatusCode": "(val)",
"protocolTitle": "(val)",
"piPersonId": "(val)",
"piPersonName": "(val)",
"piRolodexId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Lite View Protocol SubmissionsPATCH/irb/api/v1/lite-view-protocol-submissions/(key)
Example URI
PATCH /irb/api/v1/lite-view-protocol-submissions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"protocolActive": "(val)",
"protocolStatusCode": "(val)",
"protocolTitle": "(val)",
"piPersonId": "(val)",
"piPersonName": "(val)",
"piRolodexId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"protocolActive": "(val)",
"protocolStatusCode": "(val)",
"protocolTitle": "(val)",
"piPersonId": "(val)",
"piPersonName": "(val)",
"piRolodexId": "(val)",
"_primaryKey": "(val)"
}Insert Lite View Protocol SubmissionsPOST/irb/api/v1/lite-view-protocol-submissions/
Example URI
POST /irb/api/v1/lite-view-protocol-submissions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"protocolActive": "(val)",
"protocolStatusCode": "(val)",
"protocolTitle": "(val)",
"piPersonId": "(val)",
"piPersonName": "(val)",
"piRolodexId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"protocolActive": "(val)",
"protocolStatusCode": "(val)",
"protocolTitle": "(val)",
"piPersonId": "(val)",
"piPersonName": "(val)",
"piRolodexId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Lite View Protocol SubmissionsPOST/irb/api/v1/lite-view-protocol-submissions/
Example URI
POST /irb/api/v1/lite-view-protocol-submissions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"protocolActive": "(val)",
"protocolStatusCode": "(val)",
"protocolTitle": "(val)",
"piPersonId": "(val)",
"piPersonName": "(val)",
"piRolodexId": "(val)",
"_primaryKey": "(val)"
},
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"protocolActive": "(val)",
"protocolStatusCode": "(val)",
"protocolTitle": "(val)",
"piPersonId": "(val)",
"piPersonName": "(val)",
"piRolodexId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"protocolActive": "(val)",
"protocolStatusCode": "(val)",
"protocolTitle": "(val)",
"piPersonId": "(val)",
"piPersonName": "(val)",
"piRolodexId": "(val)",
"_primaryKey": "(val)"
},
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"protocolActive": "(val)",
"protocolStatusCode": "(val)",
"protocolTitle": "(val)",
"piPersonId": "(val)",
"piPersonName": "(val)",
"piRolodexId": "(val)",
"_primaryKey": "(val)"
}
]Delete Lite View Protocol Submissions by KeyDELETE/irb/api/v1/lite-view-protocol-submissions/(key)
Example URI
DELETE /irb/api/v1/lite-view-protocol-submissions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Lite View Protocol SubmissionsDELETE/irb/api/v1/lite-view-protocol-submissions/
Example URI
DELETE /irb/api/v1/lite-view-protocol-submissions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Lite View Protocol Submissions with MatchingDELETE/irb/api/v1/lite-view-protocol-submissions/
Example URI
DELETE /irb/api/v1/lite-view-protocol-submissions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- submissionId
string(optional)- submissionNumber
string(optional)Submission Number. Maximum length is 22.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 4.
- scheduleId
string(optional)Schedule Id. Maximum length is 10.
- committeeId
string(optional)Committee Id. Maximum length is 15.
- submissionTypeCode
string(optional)Submission Type Code. Maximum length is 3.
- submissionTypeQualifierCode
string(optional)Submission Type Qual Code. Maximum length is 3.
- submissionStatusCode
string(optional)Submission Status Code. Maximum length is 3.
- protocolId
string(optional)- scheduleIdFk
string(optional)- committeeIdFk
string(optional)Committee Id. Maximum length is 12.
- protocolReviewTypeCode
string(optional)Protocol Review Type Code. Maximum length is 3.
- submissionDate
string(optional)Submission Date. Maximum length is 10.
- comments
string(optional)Comments. Maximum length is 2000.
- committeeDecisionMotionTypeCode
string(optional)Committee Decision Motion Type. Maximum length is 3.
- yesVoteCount
string(optional)Yes Vote Count. Maximum length is 22.
- noVoteCount
string(optional)No Vote Count. Maximum length is 22.
- abstainerCount
string(optional)Abstainer Count. Maximum length is 22.
- recusedCount
string(optional)- votingComments
string(optional)Voting Comments. Maximum length is 2000.
- billable
string(optional)Is Billable. Maximum length is 1.
- protocolActive
string(optional)- protocolStatusCode
string(optional)- protocolTitle
string(optional)Title. Maximum length is 2000.
- piPersonId
string(optional)- piPersonName
string(optional)Person Name. Maximum length is 90.
- piRolodexId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Participant Types ¶
Get Participant Types by KeyGET/irb/api/v1/participant-types/(key)
Example URI
GET /irb/api/v1/participant-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"participantTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Participant TypesGET/irb/api/v1/participant-types/
Example URI
GET /irb/api/v1/participant-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"participantTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"participantTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Participant Types with FilteringGET/irb/api/v1/participant-types/
Example URI
GET /irb/api/v1/participant-types/
URI Parameters
- participantTypeCode
string(optional)Participant Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"participantTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"participantTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Participant TypesGET/irb/api/v1/participant-types/
Example URI
GET /irb/api/v1/participant-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"participantTypeCode",
"description"
],
"primaryKey": "participantTypeCode"
}Get Blueprint API specification for Participant TypesGET/irb/api/v1/participant-types/
Example URI
GET /irb/api/v1/participant-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Participant Types.md"
transfer-encoding: chunkedUpdate Participant TypesPUT/irb/api/v1/participant-types/(key)
Example URI
PUT /irb/api/v1/participant-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"participantTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Participant TypesPUT/irb/api/v1/participant-types/
Example URI
PUT /irb/api/v1/participant-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"participantTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"participantTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Participant TypesPATCH/irb/api/v1/participant-types/(key)
Example URI
PATCH /irb/api/v1/participant-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"participantTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"participantTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Participant TypesPOST/irb/api/v1/participant-types/
Example URI
POST /irb/api/v1/participant-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"participantTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"participantTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Participant TypesPOST/irb/api/v1/participant-types/
Example URI
POST /irb/api/v1/participant-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"participantTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"participantTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"participantTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"participantTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Participant Types by KeyDELETE/irb/api/v1/participant-types/(key)
Example URI
DELETE /irb/api/v1/participant-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Participant TypesDELETE/irb/api/v1/participant-types/
Example URI
DELETE /irb/api/v1/participant-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Participant Types with MatchingDELETE/irb/api/v1/participant-types/
Example URI
DELETE /irb/api/v1/participant-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- participantTypeCode
string(optional)Participant Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Action Types ¶
Get Protocol Action Types by KeyGET/irb/api/v1/protocol-action-types/(key)
Example URI
GET /irb/api/v1/protocol-action-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolActionTypeCode": "(val)",
"description": "(val)",
"triggerSubmission": "(val)",
"triggerCorrespondence": "(val)",
"finalActionForBatchCorrespondence": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Action TypesGET/irb/api/v1/protocol-action-types/
Example URI
GET /irb/api/v1/protocol-action-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolActionTypeCode": "(val)",
"description": "(val)",
"triggerSubmission": "(val)",
"triggerCorrespondence": "(val)",
"finalActionForBatchCorrespondence": "(val)",
"_primaryKey": "(val)"
},
{
"protocolActionTypeCode": "(val)",
"description": "(val)",
"triggerSubmission": "(val)",
"triggerCorrespondence": "(val)",
"finalActionForBatchCorrespondence": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Action Types with FilteringGET/irb/api/v1/protocol-action-types/
Example URI
GET /irb/api/v1/protocol-action-types/
URI Parameters
- protocolActionTypeCode
string(optional)Protocol Action Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- triggerSubmission
string(optional)Trigger Submission. Maximum length is 1.
- triggerCorrespondence
string(optional)Trigger Correspondence. Maximum length is 1.
- finalActionForBatchCorrespondence
string(optional)Final Action for Batch Correspondence. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolActionTypeCode": "(val)",
"description": "(val)",
"triggerSubmission": "(val)",
"triggerCorrespondence": "(val)",
"finalActionForBatchCorrespondence": "(val)",
"_primaryKey": "(val)"
},
{
"protocolActionTypeCode": "(val)",
"description": "(val)",
"triggerSubmission": "(val)",
"triggerCorrespondence": "(val)",
"finalActionForBatchCorrespondence": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Action TypesGET/irb/api/v1/protocol-action-types/
Example URI
GET /irb/api/v1/protocol-action-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolActionTypeCode",
"description",
"triggerSubmission",
"triggerCorrespondence",
"finalActionForBatchCorrespondence"
],
"primaryKey": "protocolActionTypeCode"
}Get Blueprint API specification for Protocol Action TypesGET/irb/api/v1/protocol-action-types/
Example URI
GET /irb/api/v1/protocol-action-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Action Types.md"
transfer-encoding: chunkedUpdate Protocol Action TypesPUT/irb/api/v1/protocol-action-types/(key)
Example URI
PUT /irb/api/v1/protocol-action-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolActionTypeCode": "(val)",
"description": "(val)",
"triggerSubmission": "(val)",
"triggerCorrespondence": "(val)",
"finalActionForBatchCorrespondence": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Action TypesPUT/irb/api/v1/protocol-action-types/
Example URI
PUT /irb/api/v1/protocol-action-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolActionTypeCode": "(val)",
"description": "(val)",
"triggerSubmission": "(val)",
"triggerCorrespondence": "(val)",
"finalActionForBatchCorrespondence": "(val)",
"_primaryKey": "(val)"
},
{
"protocolActionTypeCode": "(val)",
"description": "(val)",
"triggerSubmission": "(val)",
"triggerCorrespondence": "(val)",
"finalActionForBatchCorrespondence": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Action TypesPATCH/irb/api/v1/protocol-action-types/(key)
Example URI
PATCH /irb/api/v1/protocol-action-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolActionTypeCode": "(val)",
"description": "(val)",
"triggerSubmission": "(val)",
"triggerCorrespondence": "(val)",
"finalActionForBatchCorrespondence": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolActionTypeCode": "(val)",
"description": "(val)",
"triggerSubmission": "(val)",
"triggerCorrespondence": "(val)",
"finalActionForBatchCorrespondence": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Action TypesPOST/irb/api/v1/protocol-action-types/
Example URI
POST /irb/api/v1/protocol-action-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolActionTypeCode": "(val)",
"description": "(val)",
"triggerSubmission": "(val)",
"triggerCorrespondence": "(val)",
"finalActionForBatchCorrespondence": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolActionTypeCode": "(val)",
"description": "(val)",
"triggerSubmission": "(val)",
"triggerCorrespondence": "(val)",
"finalActionForBatchCorrespondence": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Action TypesPOST/irb/api/v1/protocol-action-types/
Example URI
POST /irb/api/v1/protocol-action-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolActionTypeCode": "(val)",
"description": "(val)",
"triggerSubmission": "(val)",
"triggerCorrespondence": "(val)",
"finalActionForBatchCorrespondence": "(val)",
"_primaryKey": "(val)"
},
{
"protocolActionTypeCode": "(val)",
"description": "(val)",
"triggerSubmission": "(val)",
"triggerCorrespondence": "(val)",
"finalActionForBatchCorrespondence": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolActionTypeCode": "(val)",
"description": "(val)",
"triggerSubmission": "(val)",
"triggerCorrespondence": "(val)",
"finalActionForBatchCorrespondence": "(val)",
"_primaryKey": "(val)"
},
{
"protocolActionTypeCode": "(val)",
"description": "(val)",
"triggerSubmission": "(val)",
"triggerCorrespondence": "(val)",
"finalActionForBatchCorrespondence": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Action Types by KeyDELETE/irb/api/v1/protocol-action-types/(key)
Example URI
DELETE /irb/api/v1/protocol-action-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Action TypesDELETE/irb/api/v1/protocol-action-types/
Example URI
DELETE /irb/api/v1/protocol-action-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Action Types with MatchingDELETE/irb/api/v1/protocol-action-types/
Example URI
DELETE /irb/api/v1/protocol-action-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolActionTypeCode
string(optional)Protocol Action Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- triggerSubmission
string(optional)Trigger Submission. Maximum length is 1.
- triggerCorrespondence
string(optional)Trigger Correspondence. Maximum length is 1.
- finalActionForBatchCorrespondence
string(optional)Final Action for Batch Correspondence. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Actions ¶
Get Protocol Actions by KeyGET/irb/api/v1/protocol-actions/(key)
Example URI
GET /irb/api/v1/protocol-actions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolActionId": "(val)",
"actionId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"submissionIdFk": "(val)",
"protocolActionTypeCode": "(val)",
"comments": "(val)",
"prevSubmissionStatusCode": "(val)",
"submissionTypeCode": "(val)",
"prevProtocolStatusCode": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"actionDate": "(val)",
"actualActionDate": "(val)",
"followupActionCode": "(val)",
"_primaryKey": "(val)"
}Get All Protocol ActionsGET/irb/api/v1/protocol-actions/
Example URI
GET /irb/api/v1/protocol-actions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolActionId": "(val)",
"actionId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"submissionIdFk": "(val)",
"protocolActionTypeCode": "(val)",
"comments": "(val)",
"prevSubmissionStatusCode": "(val)",
"submissionTypeCode": "(val)",
"prevProtocolStatusCode": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"actionDate": "(val)",
"actualActionDate": "(val)",
"followupActionCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolActionId": "(val)",
"actionId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"submissionIdFk": "(val)",
"protocolActionTypeCode": "(val)",
"comments": "(val)",
"prevSubmissionStatusCode": "(val)",
"submissionTypeCode": "(val)",
"prevProtocolStatusCode": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"actionDate": "(val)",
"actualActionDate": "(val)",
"followupActionCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Actions with FilteringGET/irb/api/v1/protocol-actions/
Example URI
GET /irb/api/v1/protocol-actions/
URI Parameters
- protocolActionId
string(optional)- actionId
string(optional)Action Id. Maximum length is 22.
- protocolId
string(optional)- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22.
- submissionNumber
string(optional)- submissionIdFk
string(optional)- protocolActionTypeCode
string(optional)- comments
string(optional)Comments. Maximum length is 2000.
- prevSubmissionStatusCode
string(optional)- submissionTypeCode
string(optional)- prevProtocolStatusCode
string(optional)- createTimestamp
string(optional)Create Timestamp. Maximum length is 10.
- createUser
string(optional)Create User. Maximum length is 60.
- actionDate
string(optional)Action Date. Maximum length is 10.
- actualActionDate
string(optional)- followupActionCode
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolActionId": "(val)",
"actionId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"submissionIdFk": "(val)",
"protocolActionTypeCode": "(val)",
"comments": "(val)",
"prevSubmissionStatusCode": "(val)",
"submissionTypeCode": "(val)",
"prevProtocolStatusCode": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"actionDate": "(val)",
"actualActionDate": "(val)",
"followupActionCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolActionId": "(val)",
"actionId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"submissionIdFk": "(val)",
"protocolActionTypeCode": "(val)",
"comments": "(val)",
"prevSubmissionStatusCode": "(val)",
"submissionTypeCode": "(val)",
"prevProtocolStatusCode": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"actionDate": "(val)",
"actualActionDate": "(val)",
"followupActionCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol ActionsGET/irb/api/v1/protocol-actions/
Example URI
GET /irb/api/v1/protocol-actions/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolActionId",
"actionId",
"protocolId",
"protocolNumber",
"sequenceNumber",
"submissionNumber",
"submissionIdFk",
"protocolActionTypeCode",
"comments",
"prevSubmissionStatusCode",
"submissionTypeCode",
"prevProtocolStatusCode",
"createTimestamp",
"createUser",
"actionDate",
"actualActionDate",
"followupActionCode"
],
"primaryKey": "protocolActionId"
}Get Blueprint API specification for Protocol ActionsGET/irb/api/v1/protocol-actions/
Example URI
GET /irb/api/v1/protocol-actions/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Actions.md"
transfer-encoding: chunkedUpdate Protocol ActionsPUT/irb/api/v1/protocol-actions/(key)
Example URI
PUT /irb/api/v1/protocol-actions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolActionId": "(val)",
"actionId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"submissionIdFk": "(val)",
"protocolActionTypeCode": "(val)",
"comments": "(val)",
"prevSubmissionStatusCode": "(val)",
"submissionTypeCode": "(val)",
"prevProtocolStatusCode": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"actionDate": "(val)",
"actualActionDate": "(val)",
"followupActionCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol ActionsPUT/irb/api/v1/protocol-actions/
Example URI
PUT /irb/api/v1/protocol-actions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolActionId": "(val)",
"actionId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"submissionIdFk": "(val)",
"protocolActionTypeCode": "(val)",
"comments": "(val)",
"prevSubmissionStatusCode": "(val)",
"submissionTypeCode": "(val)",
"prevProtocolStatusCode": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"actionDate": "(val)",
"actualActionDate": "(val)",
"followupActionCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolActionId": "(val)",
"actionId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"submissionIdFk": "(val)",
"protocolActionTypeCode": "(val)",
"comments": "(val)",
"prevSubmissionStatusCode": "(val)",
"submissionTypeCode": "(val)",
"prevProtocolStatusCode": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"actionDate": "(val)",
"actualActionDate": "(val)",
"followupActionCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol ActionsPATCH/irb/api/v1/protocol-actions/(key)
Example URI
PATCH /irb/api/v1/protocol-actions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolActionId": "(val)",
"actionId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"submissionIdFk": "(val)",
"protocolActionTypeCode": "(val)",
"comments": "(val)",
"prevSubmissionStatusCode": "(val)",
"submissionTypeCode": "(val)",
"prevProtocolStatusCode": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"actionDate": "(val)",
"actualActionDate": "(val)",
"followupActionCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolActionId": "(val)",
"actionId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"submissionIdFk": "(val)",
"protocolActionTypeCode": "(val)",
"comments": "(val)",
"prevSubmissionStatusCode": "(val)",
"submissionTypeCode": "(val)",
"prevProtocolStatusCode": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"actionDate": "(val)",
"actualActionDate": "(val)",
"followupActionCode": "(val)",
"_primaryKey": "(val)"
}Insert Protocol ActionsPOST/irb/api/v1/protocol-actions/
Example URI
POST /irb/api/v1/protocol-actions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolActionId": "(val)",
"actionId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"submissionIdFk": "(val)",
"protocolActionTypeCode": "(val)",
"comments": "(val)",
"prevSubmissionStatusCode": "(val)",
"submissionTypeCode": "(val)",
"prevProtocolStatusCode": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"actionDate": "(val)",
"actualActionDate": "(val)",
"followupActionCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolActionId": "(val)",
"actionId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"submissionIdFk": "(val)",
"protocolActionTypeCode": "(val)",
"comments": "(val)",
"prevSubmissionStatusCode": "(val)",
"submissionTypeCode": "(val)",
"prevProtocolStatusCode": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"actionDate": "(val)",
"actualActionDate": "(val)",
"followupActionCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol ActionsPOST/irb/api/v1/protocol-actions/
Example URI
POST /irb/api/v1/protocol-actions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolActionId": "(val)",
"actionId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"submissionIdFk": "(val)",
"protocolActionTypeCode": "(val)",
"comments": "(val)",
"prevSubmissionStatusCode": "(val)",
"submissionTypeCode": "(val)",
"prevProtocolStatusCode": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"actionDate": "(val)",
"actualActionDate": "(val)",
"followupActionCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolActionId": "(val)",
"actionId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"submissionIdFk": "(val)",
"protocolActionTypeCode": "(val)",
"comments": "(val)",
"prevSubmissionStatusCode": "(val)",
"submissionTypeCode": "(val)",
"prevProtocolStatusCode": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"actionDate": "(val)",
"actualActionDate": "(val)",
"followupActionCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolActionId": "(val)",
"actionId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"submissionIdFk": "(val)",
"protocolActionTypeCode": "(val)",
"comments": "(val)",
"prevSubmissionStatusCode": "(val)",
"submissionTypeCode": "(val)",
"prevProtocolStatusCode": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"actionDate": "(val)",
"actualActionDate": "(val)",
"followupActionCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolActionId": "(val)",
"actionId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"submissionIdFk": "(val)",
"protocolActionTypeCode": "(val)",
"comments": "(val)",
"prevSubmissionStatusCode": "(val)",
"submissionTypeCode": "(val)",
"prevProtocolStatusCode": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"actionDate": "(val)",
"actualActionDate": "(val)",
"followupActionCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Actions by KeyDELETE/irb/api/v1/protocol-actions/(key)
Example URI
DELETE /irb/api/v1/protocol-actions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol ActionsDELETE/irb/api/v1/protocol-actions/
Example URI
DELETE /irb/api/v1/protocol-actions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Actions with MatchingDELETE/irb/api/v1/protocol-actions/
Example URI
DELETE /irb/api/v1/protocol-actions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolActionId
string(optional)- actionId
string(optional)Action Id. Maximum length is 22.
- protocolId
string(optional)- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22.
- submissionNumber
string(optional)- submissionIdFk
string(optional)- protocolActionTypeCode
string(optional)- comments
string(optional)Comments. Maximum length is 2000.
- prevSubmissionStatusCode
string(optional)- submissionTypeCode
string(optional)- prevProtocolStatusCode
string(optional)- createTimestamp
string(optional)Create Timestamp. Maximum length is 10.
- createUser
string(optional)Create User. Maximum length is 60.
- actionDate
string(optional)Action Date. Maximum length is 10.
- actualActionDate
string(optional)- followupActionCode
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Affiliation Types ¶
Get Protocol Affiliation Types by KeyGET/irb/api/v1/protocol-affiliation-types/(key)
Example URI
GET /irb/api/v1/protocol-affiliation-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"affiliationTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Affiliation TypesGET/irb/api/v1/protocol-affiliation-types/
Example URI
GET /irb/api/v1/protocol-affiliation-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"affiliationTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"affiliationTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Affiliation Types with FilteringGET/irb/api/v1/protocol-affiliation-types/
Example URI
GET /irb/api/v1/protocol-affiliation-types/
URI Parameters
- affiliationTypeCode
string(optional)Affiliation Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"affiliationTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"affiliationTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Affiliation TypesGET/irb/api/v1/protocol-affiliation-types/
Example URI
GET /irb/api/v1/protocol-affiliation-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"affiliationTypeCode",
"description",
"active"
],
"primaryKey": "affiliationTypeCode"
}Get Blueprint API specification for Protocol Affiliation TypesGET/irb/api/v1/protocol-affiliation-types/
Example URI
GET /irb/api/v1/protocol-affiliation-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Affiliation Types.md"
transfer-encoding: chunkedUpdate Protocol Affiliation TypesPUT/irb/api/v1/protocol-affiliation-types/(key)
Example URI
PUT /irb/api/v1/protocol-affiliation-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"affiliationTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Affiliation TypesPUT/irb/api/v1/protocol-affiliation-types/
Example URI
PUT /irb/api/v1/protocol-affiliation-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"affiliationTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"affiliationTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Affiliation TypesPATCH/irb/api/v1/protocol-affiliation-types/(key)
Example URI
PATCH /irb/api/v1/protocol-affiliation-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"affiliationTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"affiliationTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Affiliation TypesPOST/irb/api/v1/protocol-affiliation-types/
Example URI
POST /irb/api/v1/protocol-affiliation-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"affiliationTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"affiliationTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Affiliation TypesPOST/irb/api/v1/protocol-affiliation-types/
Example URI
POST /irb/api/v1/protocol-affiliation-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"affiliationTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"affiliationTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"affiliationTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"affiliationTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Affiliation Types by KeyDELETE/irb/api/v1/protocol-affiliation-types/(key)
Example URI
DELETE /irb/api/v1/protocol-affiliation-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Affiliation TypesDELETE/irb/api/v1/protocol-affiliation-types/
Example URI
DELETE /irb/api/v1/protocol-affiliation-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Affiliation Types with MatchingDELETE/irb/api/v1/protocol-affiliation-types/
Example URI
DELETE /irb/api/v1/protocol-affiliation-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- affiliationTypeCode
string(optional)Affiliation Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Amend Renew Modules ¶
Get Protocol Amend Renew Modules by KeyGET/irb/api/v1/protocol-amend-renew-modules/(key)
Example URI
GET /irb/api/v1/protocol-amend-renew-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolAmendRenewModuleId": "(val)",
"protocolAmendRenewalNumber": "(val)",
"protocolAmendRenewalId": "(val)",
"protocolNumber": "(val)",
"protocolModuleTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Amend Renew ModulesGET/irb/api/v1/protocol-amend-renew-modules/
Example URI
GET /irb/api/v1/protocol-amend-renew-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolAmendRenewModuleId": "(val)",
"protocolAmendRenewalNumber": "(val)",
"protocolAmendRenewalId": "(val)",
"protocolNumber": "(val)",
"protocolModuleTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolAmendRenewModuleId": "(val)",
"protocolAmendRenewalNumber": "(val)",
"protocolAmendRenewalId": "(val)",
"protocolNumber": "(val)",
"protocolModuleTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Amend Renew Modules with FilteringGET/irb/api/v1/protocol-amend-renew-modules/
Example URI
GET /irb/api/v1/protocol-amend-renew-modules/
URI Parameters
- protocolAmendRenewModuleId
string(optional)- protocolAmendRenewalNumber
string(optional)- protocolAmendRenewalId
string(optional)- protocolNumber
string(optional)- protocolModuleTypeCode
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolAmendRenewModuleId": "(val)",
"protocolAmendRenewalNumber": "(val)",
"protocolAmendRenewalId": "(val)",
"protocolNumber": "(val)",
"protocolModuleTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolAmendRenewModuleId": "(val)",
"protocolAmendRenewalNumber": "(val)",
"protocolAmendRenewalId": "(val)",
"protocolNumber": "(val)",
"protocolModuleTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Amend Renew ModulesGET/irb/api/v1/protocol-amend-renew-modules/
Example URI
GET /irb/api/v1/protocol-amend-renew-modules/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolAmendRenewModuleId",
"protocolAmendRenewalNumber",
"protocolAmendRenewalId",
"protocolNumber",
"protocolModuleTypeCode"
],
"primaryKey": "protocolAmendRenewModuleId"
}Get Blueprint API specification for Protocol Amend Renew ModulesGET/irb/api/v1/protocol-amend-renew-modules/
Example URI
GET /irb/api/v1/protocol-amend-renew-modules/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Amend Renew Modules.md"
transfer-encoding: chunkedUpdate Protocol Amend Renew ModulesPUT/irb/api/v1/protocol-amend-renew-modules/(key)
Example URI
PUT /irb/api/v1/protocol-amend-renew-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolAmendRenewModuleId": "(val)",
"protocolAmendRenewalNumber": "(val)",
"protocolAmendRenewalId": "(val)",
"protocolNumber": "(val)",
"protocolModuleTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Amend Renew ModulesPUT/irb/api/v1/protocol-amend-renew-modules/
Example URI
PUT /irb/api/v1/protocol-amend-renew-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolAmendRenewModuleId": "(val)",
"protocolAmendRenewalNumber": "(val)",
"protocolAmendRenewalId": "(val)",
"protocolNumber": "(val)",
"protocolModuleTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolAmendRenewModuleId": "(val)",
"protocolAmendRenewalNumber": "(val)",
"protocolAmendRenewalId": "(val)",
"protocolNumber": "(val)",
"protocolModuleTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Amend Renew ModulesPATCH/irb/api/v1/protocol-amend-renew-modules/(key)
Example URI
PATCH /irb/api/v1/protocol-amend-renew-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolAmendRenewModuleId": "(val)",
"protocolAmendRenewalNumber": "(val)",
"protocolAmendRenewalId": "(val)",
"protocolNumber": "(val)",
"protocolModuleTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolAmendRenewModuleId": "(val)",
"protocolAmendRenewalNumber": "(val)",
"protocolAmendRenewalId": "(val)",
"protocolNumber": "(val)",
"protocolModuleTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Amend Renew ModulesPOST/irb/api/v1/protocol-amend-renew-modules/
Example URI
POST /irb/api/v1/protocol-amend-renew-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolAmendRenewModuleId": "(val)",
"protocolAmendRenewalNumber": "(val)",
"protocolAmendRenewalId": "(val)",
"protocolNumber": "(val)",
"protocolModuleTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolAmendRenewModuleId": "(val)",
"protocolAmendRenewalNumber": "(val)",
"protocolAmendRenewalId": "(val)",
"protocolNumber": "(val)",
"protocolModuleTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Amend Renew ModulesPOST/irb/api/v1/protocol-amend-renew-modules/
Example URI
POST /irb/api/v1/protocol-amend-renew-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolAmendRenewModuleId": "(val)",
"protocolAmendRenewalNumber": "(val)",
"protocolAmendRenewalId": "(val)",
"protocolNumber": "(val)",
"protocolModuleTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolAmendRenewModuleId": "(val)",
"protocolAmendRenewalNumber": "(val)",
"protocolAmendRenewalId": "(val)",
"protocolNumber": "(val)",
"protocolModuleTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolAmendRenewModuleId": "(val)",
"protocolAmendRenewalNumber": "(val)",
"protocolAmendRenewalId": "(val)",
"protocolNumber": "(val)",
"protocolModuleTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolAmendRenewModuleId": "(val)",
"protocolAmendRenewalNumber": "(val)",
"protocolAmendRenewalId": "(val)",
"protocolNumber": "(val)",
"protocolModuleTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Amend Renew Modules by KeyDELETE/irb/api/v1/protocol-amend-renew-modules/(key)
Example URI
DELETE /irb/api/v1/protocol-amend-renew-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Amend Renew ModulesDELETE/irb/api/v1/protocol-amend-renew-modules/
Example URI
DELETE /irb/api/v1/protocol-amend-renew-modules/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Amend Renew Modules with MatchingDELETE/irb/api/v1/protocol-amend-renew-modules/
Example URI
DELETE /irb/api/v1/protocol-amend-renew-modules/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolAmendRenewModuleId
string(optional)- protocolAmendRenewalNumber
string(optional)- protocolAmendRenewalId
string(optional)- protocolNumber
string(optional)- protocolModuleTypeCode
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Amend Renewals ¶
Get Protocol Amend Renewals by KeyGET/irb/api/v1/protocol-amend-renewals/(key)
Example URI
GET /irb/api/v1/protocol-amend-renewals/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"protoAmendRenNumber": "(val)",
"dateCreated": "(val)",
"summary": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Amend RenewalsGET/irb/api/v1/protocol-amend-renewals/
Example URI
GET /irb/api/v1/protocol-amend-renewals/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"protoAmendRenNumber": "(val)",
"dateCreated": "(val)",
"summary": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protoAmendRenNumber": "(val)",
"dateCreated": "(val)",
"summary": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Amend Renewals with FilteringGET/irb/api/v1/protocol-amend-renewals/
Example URI
GET /irb/api/v1/protocol-amend-renewals/
URI Parameters
- id
string(optional)Id. Maximum length is 10.
- protoAmendRenNumber
string(optional)Proto Amend Ren Number. Maximum length is 20.
- dateCreated
string(optional)Date Created. Maximum length is 10.
- summary
string(optional)Summary. Maximum length is 4000.
- protocolId
string(optional)Protocol Id. Maximum length is 22.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"protoAmendRenNumber": "(val)",
"dateCreated": "(val)",
"summary": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protoAmendRenNumber": "(val)",
"dateCreated": "(val)",
"summary": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Amend RenewalsGET/irb/api/v1/protocol-amend-renewals/
Example URI
GET /irb/api/v1/protocol-amend-renewals/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"protoAmendRenNumber",
"dateCreated",
"summary",
"protocolId",
"protocolNumber",
"sequenceNumber"
],
"primaryKey": "id"
}Get Blueprint API specification for Protocol Amend RenewalsGET/irb/api/v1/protocol-amend-renewals/
Example URI
GET /irb/api/v1/protocol-amend-renewals/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Amend Renewals.md"
transfer-encoding: chunkedUpdate Protocol Amend RenewalsPUT/irb/api/v1/protocol-amend-renewals/(key)
Example URI
PUT /irb/api/v1/protocol-amend-renewals/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"protoAmendRenNumber": "(val)",
"dateCreated": "(val)",
"summary": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Amend RenewalsPUT/irb/api/v1/protocol-amend-renewals/
Example URI
PUT /irb/api/v1/protocol-amend-renewals/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"protoAmendRenNumber": "(val)",
"dateCreated": "(val)",
"summary": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protoAmendRenNumber": "(val)",
"dateCreated": "(val)",
"summary": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Amend RenewalsPATCH/irb/api/v1/protocol-amend-renewals/(key)
Example URI
PATCH /irb/api/v1/protocol-amend-renewals/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"protoAmendRenNumber": "(val)",
"dateCreated": "(val)",
"summary": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"protoAmendRenNumber": "(val)",
"dateCreated": "(val)",
"summary": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Amend RenewalsPOST/irb/api/v1/protocol-amend-renewals/
Example URI
POST /irb/api/v1/protocol-amend-renewals/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"protoAmendRenNumber": "(val)",
"dateCreated": "(val)",
"summary": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"protoAmendRenNumber": "(val)",
"dateCreated": "(val)",
"summary": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Amend RenewalsPOST/irb/api/v1/protocol-amend-renewals/
Example URI
POST /irb/api/v1/protocol-amend-renewals/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"protoAmendRenNumber": "(val)",
"dateCreated": "(val)",
"summary": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protoAmendRenNumber": "(val)",
"dateCreated": "(val)",
"summary": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"protoAmendRenNumber": "(val)",
"dateCreated": "(val)",
"summary": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protoAmendRenNumber": "(val)",
"dateCreated": "(val)",
"summary": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Amend Renewals by KeyDELETE/irb/api/v1/protocol-amend-renewals/(key)
Example URI
DELETE /irb/api/v1/protocol-amend-renewals/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Amend RenewalsDELETE/irb/api/v1/protocol-amend-renewals/
Example URI
DELETE /irb/api/v1/protocol-amend-renewals/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Amend Renewals with MatchingDELETE/irb/api/v1/protocol-amend-renewals/
Example URI
DELETE /irb/api/v1/protocol-amend-renewals/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Id. Maximum length is 10.
- protoAmendRenNumber
string(optional)Proto Amend Ren Number. Maximum length is 20.
- dateCreated
string(optional)Date Created. Maximum length is 10.
- summary
string(optional)Summary. Maximum length is 4000.
- protocolId
string(optional)Protocol Id. Maximum length is 22.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Attachment Groups ¶
Get Protocol Attachment Groups by KeyGET/irb/api/v1/protocol-attachment-groups/(key)
Example URI
GET /irb/api/v1/protocol-attachment-groups/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Attachment GroupsGET/irb/api/v1/protocol-attachment-groups/
Example URI
GET /irb/api/v1/protocol-attachment-groups/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Attachment Groups with FilteringGET/irb/api/v1/protocol-attachment-groups/
Example URI
GET /irb/api/v1/protocol-attachment-groups/
URI Parameters
- code
string(optional)Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Attachment GroupsGET/irb/api/v1/protocol-attachment-groups/
Example URI
GET /irb/api/v1/protocol-attachment-groups/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description"
],
"primaryKey": "code"
}Get Blueprint API specification for Protocol Attachment GroupsGET/irb/api/v1/protocol-attachment-groups/
Example URI
GET /irb/api/v1/protocol-attachment-groups/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Attachment Groups.md"
transfer-encoding: chunkedUpdate Protocol Attachment GroupsPUT/irb/api/v1/protocol-attachment-groups/(key)
Example URI
PUT /irb/api/v1/protocol-attachment-groups/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Attachment GroupsPUT/irb/api/v1/protocol-attachment-groups/
Example URI
PUT /irb/api/v1/protocol-attachment-groups/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Attachment GroupsPATCH/irb/api/v1/protocol-attachment-groups/(key)
Example URI
PATCH /irb/api/v1/protocol-attachment-groups/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Attachment GroupsPOST/irb/api/v1/protocol-attachment-groups/
Example URI
POST /irb/api/v1/protocol-attachment-groups/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Attachment GroupsPOST/irb/api/v1/protocol-attachment-groups/
Example URI
POST /irb/api/v1/protocol-attachment-groups/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Attachment Groups by KeyDELETE/irb/api/v1/protocol-attachment-groups/(key)
Example URI
DELETE /irb/api/v1/protocol-attachment-groups/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Attachment GroupsDELETE/irb/api/v1/protocol-attachment-groups/
Example URI
DELETE /irb/api/v1/protocol-attachment-groups/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Attachment Groups with MatchingDELETE/irb/api/v1/protocol-attachment-groups/
Example URI
DELETE /irb/api/v1/protocol-attachment-groups/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Attachment Statuses ¶
Get Protocol Attachment Statuses by KeyGET/irb/api/v1/protocol-attachment-statuses/(key)
Example URI
GET /irb/api/v1/protocol-attachment-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Attachment StatusesGET/irb/api/v1/protocol-attachment-statuses/
Example URI
GET /irb/api/v1/protocol-attachment-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Attachment Statuses with FilteringGET/irb/api/v1/protocol-attachment-statuses/
Example URI
GET /irb/api/v1/protocol-attachment-statuses/
URI Parameters
- code
string(optional)Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Attachment StatusesGET/irb/api/v1/protocol-attachment-statuses/
Example URI
GET /irb/api/v1/protocol-attachment-statuses/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description"
],
"primaryKey": "code"
}Get Blueprint API specification for Protocol Attachment StatusesGET/irb/api/v1/protocol-attachment-statuses/
Example URI
GET /irb/api/v1/protocol-attachment-statuses/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Attachment Statuses.md"
transfer-encoding: chunkedUpdate Protocol Attachment StatusesPUT/irb/api/v1/protocol-attachment-statuses/(key)
Example URI
PUT /irb/api/v1/protocol-attachment-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Attachment StatusesPUT/irb/api/v1/protocol-attachment-statuses/
Example URI
PUT /irb/api/v1/protocol-attachment-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Attachment StatusesPATCH/irb/api/v1/protocol-attachment-statuses/(key)
Example URI
PATCH /irb/api/v1/protocol-attachment-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Attachment StatusesPOST/irb/api/v1/protocol-attachment-statuses/
Example URI
POST /irb/api/v1/protocol-attachment-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Attachment StatusesPOST/irb/api/v1/protocol-attachment-statuses/
Example URI
POST /irb/api/v1/protocol-attachment-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Attachment Statuses by KeyDELETE/irb/api/v1/protocol-attachment-statuses/(key)
Example URI
DELETE /irb/api/v1/protocol-attachment-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Attachment StatusesDELETE/irb/api/v1/protocol-attachment-statuses/
Example URI
DELETE /irb/api/v1/protocol-attachment-statuses/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Attachment Statuses with MatchingDELETE/irb/api/v1/protocol-attachment-statuses/
Example URI
DELETE /irb/api/v1/protocol-attachment-statuses/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Attachment Type Groups ¶
Get Protocol Attachment Type Groups by KeyGET/irb/api/v1/protocol-attachment-type-groups/(key)
Example URI
GET /irb/api/v1/protocol-attachment-type-groups/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"typeCode": "(val)",
"groupCode": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Attachment Type GroupsGET/irb/api/v1/protocol-attachment-type-groups/
Example URI
GET /irb/api/v1/protocol-attachment-type-groups/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"typeCode": "(val)",
"groupCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"typeCode": "(val)",
"groupCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Attachment Type Groups with FilteringGET/irb/api/v1/protocol-attachment-type-groups/
Example URI
GET /irb/api/v1/protocol-attachment-type-groups/
URI Parameters
- id
string(optional)id. Maximum length is 12.
- typeCode
string(optional)Type Code. Maximum length is 3.
- groupCode
string(optional)Group Code. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"typeCode": "(val)",
"groupCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"typeCode": "(val)",
"groupCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Attachment Type GroupsGET/irb/api/v1/protocol-attachment-type-groups/
Example URI
GET /irb/api/v1/protocol-attachment-type-groups/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"typeCode",
"groupCode"
],
"primaryKey": "id"
}Get Blueprint API specification for Protocol Attachment Type GroupsGET/irb/api/v1/protocol-attachment-type-groups/
Example URI
GET /irb/api/v1/protocol-attachment-type-groups/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Attachment Type Groups.md"
transfer-encoding: chunkedUpdate Protocol Attachment Type GroupsPUT/irb/api/v1/protocol-attachment-type-groups/(key)
Example URI
PUT /irb/api/v1/protocol-attachment-type-groups/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"typeCode": "(val)",
"groupCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Attachment Type GroupsPUT/irb/api/v1/protocol-attachment-type-groups/
Example URI
PUT /irb/api/v1/protocol-attachment-type-groups/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"typeCode": "(val)",
"groupCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"typeCode": "(val)",
"groupCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Attachment Type GroupsPATCH/irb/api/v1/protocol-attachment-type-groups/(key)
Example URI
PATCH /irb/api/v1/protocol-attachment-type-groups/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"typeCode": "(val)",
"groupCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"typeCode": "(val)",
"groupCode": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Attachment Type GroupsPOST/irb/api/v1/protocol-attachment-type-groups/
Example URI
POST /irb/api/v1/protocol-attachment-type-groups/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"typeCode": "(val)",
"groupCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"typeCode": "(val)",
"groupCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Attachment Type GroupsPOST/irb/api/v1/protocol-attachment-type-groups/
Example URI
POST /irb/api/v1/protocol-attachment-type-groups/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"typeCode": "(val)",
"groupCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"typeCode": "(val)",
"groupCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"typeCode": "(val)",
"groupCode": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"typeCode": "(val)",
"groupCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Attachment Type Groups by KeyDELETE/irb/api/v1/protocol-attachment-type-groups/(key)
Example URI
DELETE /irb/api/v1/protocol-attachment-type-groups/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Attachment Type GroupsDELETE/irb/api/v1/protocol-attachment-type-groups/
Example URI
DELETE /irb/api/v1/protocol-attachment-type-groups/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Attachment Type Groups with MatchingDELETE/irb/api/v1/protocol-attachment-type-groups/
Example URI
DELETE /irb/api/v1/protocol-attachment-type-groups/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)id. Maximum length is 12.
- typeCode
string(optional)Type Code. Maximum length is 3.
- groupCode
string(optional)Group Code. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Attachment Types ¶
Get Protocol Attachment Types by KeyGET/irb/api/v1/protocol-attachment-types/(key)
Example URI
GET /irb/api/v1/protocol-attachment-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Attachment TypesGET/irb/api/v1/protocol-attachment-types/
Example URI
GET /irb/api/v1/protocol-attachment-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Attachment Types with FilteringGET/irb/api/v1/protocol-attachment-types/
Example URI
GET /irb/api/v1/protocol-attachment-types/
URI Parameters
- code
string(optional)Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Attachment TypesGET/irb/api/v1/protocol-attachment-types/
Example URI
GET /irb/api/v1/protocol-attachment-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"code",
"description"
],
"primaryKey": "code"
}Get Blueprint API specification for Protocol Attachment TypesGET/irb/api/v1/protocol-attachment-types/
Example URI
GET /irb/api/v1/protocol-attachment-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Attachment Types.md"
transfer-encoding: chunkedUpdate Protocol Attachment TypesPUT/irb/api/v1/protocol-attachment-types/(key)
Example URI
PUT /irb/api/v1/protocol-attachment-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Attachment TypesPUT/irb/api/v1/protocol-attachment-types/
Example URI
PUT /irb/api/v1/protocol-attachment-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Attachment TypesPATCH/irb/api/v1/protocol-attachment-types/(key)
Example URI
PATCH /irb/api/v1/protocol-attachment-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Attachment TypesPOST/irb/api/v1/protocol-attachment-types/
Example URI
POST /irb/api/v1/protocol-attachment-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Attachment TypesPOST/irb/api/v1/protocol-attachment-types/
Example URI
POST /irb/api/v1/protocol-attachment-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"code": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Attachment Types by KeyDELETE/irb/api/v1/protocol-attachment-types/(key)
Example URI
DELETE /irb/api/v1/protocol-attachment-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Attachment TypesDELETE/irb/api/v1/protocol-attachment-types/
Example URI
DELETE /irb/api/v1/protocol-attachment-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Attachment Types with MatchingDELETE/irb/api/v1/protocol-attachment-types/
Example URI
DELETE /irb/api/v1/protocol-attachment-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- code
string(optional)Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Contingencies ¶
Get Protocol Contingencies by KeyGET/irb/api/v1/protocol-contingencies/(key)
Example URI
GET /irb/api/v1/protocol-contingencies/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolContingencyCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Protocol ContingenciesGET/irb/api/v1/protocol-contingencies/
Example URI
GET /irb/api/v1/protocol-contingencies/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolContingencyCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolContingencyCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Contingencies with FilteringGET/irb/api/v1/protocol-contingencies/
Example URI
GET /irb/api/v1/protocol-contingencies/
URI Parameters
- protocolContingencyCode
string(optional)Protocol Contingency Code. Maximum length is 4.
- description
string(optional)Description. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolContingencyCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolContingencyCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol ContingenciesGET/irb/api/v1/protocol-contingencies/
Example URI
GET /irb/api/v1/protocol-contingencies/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolContingencyCode",
"description"
],
"primaryKey": "protocolContingencyCode"
}Get Blueprint API specification for Protocol ContingenciesGET/irb/api/v1/protocol-contingencies/
Example URI
GET /irb/api/v1/protocol-contingencies/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Contingencies.md"
transfer-encoding: chunkedUpdate Protocol ContingenciesPUT/irb/api/v1/protocol-contingencies/(key)
Example URI
PUT /irb/api/v1/protocol-contingencies/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolContingencyCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol ContingenciesPUT/irb/api/v1/protocol-contingencies/
Example URI
PUT /irb/api/v1/protocol-contingencies/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolContingencyCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolContingencyCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol ContingenciesPATCH/irb/api/v1/protocol-contingencies/(key)
Example URI
PATCH /irb/api/v1/protocol-contingencies/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolContingencyCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolContingencyCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Protocol ContingenciesPOST/irb/api/v1/protocol-contingencies/
Example URI
POST /irb/api/v1/protocol-contingencies/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolContingencyCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolContingencyCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol ContingenciesPOST/irb/api/v1/protocol-contingencies/
Example URI
POST /irb/api/v1/protocol-contingencies/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolContingencyCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolContingencyCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolContingencyCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolContingencyCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Contingencies by KeyDELETE/irb/api/v1/protocol-contingencies/(key)
Example URI
DELETE /irb/api/v1/protocol-contingencies/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol ContingenciesDELETE/irb/api/v1/protocol-contingencies/
Example URI
DELETE /irb/api/v1/protocol-contingencies/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Contingencies with MatchingDELETE/irb/api/v1/protocol-contingencies/
Example URI
DELETE /irb/api/v1/protocol-contingencies/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolContingencyCode
string(optional)Protocol Contingency Code. Maximum length is 4.
- description
string(optional)Description. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Correspondence Templates ¶
Get Protocol Correspondence Templates by KeyGET/irb/api/v1/protocol-correspondence-templates/(key)
Example URI
GET /irb/api/v1/protocol-correspondence-templates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protoCorrespTemplId": "(val)",
"protoCorrespTypeCode": "(val)",
"committeeId": "(val)",
"fileName": "(val)",
"correspondenceTemplate": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Correspondence TemplatesGET/irb/api/v1/protocol-correspondence-templates/
Example URI
GET /irb/api/v1/protocol-correspondence-templates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protoCorrespTemplId": "(val)",
"protoCorrespTypeCode": "(val)",
"committeeId": "(val)",
"fileName": "(val)",
"correspondenceTemplate": "(val)",
"_primaryKey": "(val)"
},
{
"protoCorrespTemplId": "(val)",
"protoCorrespTypeCode": "(val)",
"committeeId": "(val)",
"fileName": "(val)",
"correspondenceTemplate": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Correspondence Templates with FilteringGET/irb/api/v1/protocol-correspondence-templates/
Example URI
GET /irb/api/v1/protocol-correspondence-templates/
URI Parameters
- protoCorrespTemplId
string(optional)Proto Corresp Templ Id. Maximum length is 12.
- protoCorrespTypeCode
string(optional)Proto Corresp Type Code. Maximum length is 3.
- committeeId
string(optional)Committee. Maximum length is 15.
- fileName
string(optional)File. Maximum length is 150.
- correspondenceTemplate
string(optional)Correspondence Template. Maximum length is 4000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protoCorrespTemplId": "(val)",
"protoCorrespTypeCode": "(val)",
"committeeId": "(val)",
"fileName": "(val)",
"correspondenceTemplate": "(val)",
"_primaryKey": "(val)"
},
{
"protoCorrespTemplId": "(val)",
"protoCorrespTypeCode": "(val)",
"committeeId": "(val)",
"fileName": "(val)",
"correspondenceTemplate": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Correspondence TemplatesGET/irb/api/v1/protocol-correspondence-templates/
Example URI
GET /irb/api/v1/protocol-correspondence-templates/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protoCorrespTemplId",
"protoCorrespTypeCode",
"committeeId",
"fileName",
"correspondenceTemplate"
],
"primaryKey": "protoCorrespTemplId"
}Get Blueprint API specification for Protocol Correspondence TemplatesGET/irb/api/v1/protocol-correspondence-templates/
Example URI
GET /irb/api/v1/protocol-correspondence-templates/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Correspondence Templates.md"
transfer-encoding: chunkedUpdate Protocol Correspondence TemplatesPUT/irb/api/v1/protocol-correspondence-templates/(key)
Example URI
PUT /irb/api/v1/protocol-correspondence-templates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protoCorrespTemplId": "(val)",
"protoCorrespTypeCode": "(val)",
"committeeId": "(val)",
"fileName": "(val)",
"correspondenceTemplate": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Correspondence TemplatesPUT/irb/api/v1/protocol-correspondence-templates/
Example URI
PUT /irb/api/v1/protocol-correspondence-templates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protoCorrespTemplId": "(val)",
"protoCorrespTypeCode": "(val)",
"committeeId": "(val)",
"fileName": "(val)",
"correspondenceTemplate": "(val)",
"_primaryKey": "(val)"
},
{
"protoCorrespTemplId": "(val)",
"protoCorrespTypeCode": "(val)",
"committeeId": "(val)",
"fileName": "(val)",
"correspondenceTemplate": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Correspondence TemplatesPATCH/irb/api/v1/protocol-correspondence-templates/(key)
Example URI
PATCH /irb/api/v1/protocol-correspondence-templates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protoCorrespTemplId": "(val)",
"protoCorrespTypeCode": "(val)",
"committeeId": "(val)",
"fileName": "(val)",
"correspondenceTemplate": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protoCorrespTemplId": "(val)",
"protoCorrespTypeCode": "(val)",
"committeeId": "(val)",
"fileName": "(val)",
"correspondenceTemplate": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Correspondence TemplatesPOST/irb/api/v1/protocol-correspondence-templates/
Example URI
POST /irb/api/v1/protocol-correspondence-templates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protoCorrespTemplId": "(val)",
"protoCorrespTypeCode": "(val)",
"committeeId": "(val)",
"fileName": "(val)",
"correspondenceTemplate": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protoCorrespTemplId": "(val)",
"protoCorrespTypeCode": "(val)",
"committeeId": "(val)",
"fileName": "(val)",
"correspondenceTemplate": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Correspondence TemplatesPOST/irb/api/v1/protocol-correspondence-templates/
Example URI
POST /irb/api/v1/protocol-correspondence-templates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protoCorrespTemplId": "(val)",
"protoCorrespTypeCode": "(val)",
"committeeId": "(val)",
"fileName": "(val)",
"correspondenceTemplate": "(val)",
"_primaryKey": "(val)"
},
{
"protoCorrespTemplId": "(val)",
"protoCorrespTypeCode": "(val)",
"committeeId": "(val)",
"fileName": "(val)",
"correspondenceTemplate": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protoCorrespTemplId": "(val)",
"protoCorrespTypeCode": "(val)",
"committeeId": "(val)",
"fileName": "(val)",
"correspondenceTemplate": "(val)",
"_primaryKey": "(val)"
},
{
"protoCorrespTemplId": "(val)",
"protoCorrespTypeCode": "(val)",
"committeeId": "(val)",
"fileName": "(val)",
"correspondenceTemplate": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Correspondence Templates by KeyDELETE/irb/api/v1/protocol-correspondence-templates/(key)
Example URI
DELETE /irb/api/v1/protocol-correspondence-templates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Correspondence TemplatesDELETE/irb/api/v1/protocol-correspondence-templates/
Example URI
DELETE /irb/api/v1/protocol-correspondence-templates/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Correspondence Templates with MatchingDELETE/irb/api/v1/protocol-correspondence-templates/
Example URI
DELETE /irb/api/v1/protocol-correspondence-templates/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protoCorrespTemplId
string(optional)Proto Corresp Templ Id. Maximum length is 12.
- protoCorrespTypeCode
string(optional)Proto Corresp Type Code. Maximum length is 3.
- committeeId
string(optional)Committee. Maximum length is 15.
- fileName
string(optional)File. Maximum length is 150.
- correspondenceTemplate
string(optional)Correspondence Template. Maximum length is 4000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Correspondence Types ¶
Get Protocol Correspondence Types by KeyGET/irb/api/v1/protocol-correspondence-types/(key)
Example URI
GET /irb/api/v1/protocol-correspondence-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protoCorrespTypeCode": "(val)",
"description": "(val)",
"moduleId": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Correspondence TypesGET/irb/api/v1/protocol-correspondence-types/
Example URI
GET /irb/api/v1/protocol-correspondence-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protoCorrespTypeCode": "(val)",
"description": "(val)",
"moduleId": "(val)",
"_primaryKey": "(val)"
},
{
"protoCorrespTypeCode": "(val)",
"description": "(val)",
"moduleId": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Correspondence Types with FilteringGET/irb/api/v1/protocol-correspondence-types/
Example URI
GET /irb/api/v1/protocol-correspondence-types/
URI Parameters
- protoCorrespTypeCode
string(optional)Proto Corresp Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- moduleId
string(optional)Module Id. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protoCorrespTypeCode": "(val)",
"description": "(val)",
"moduleId": "(val)",
"_primaryKey": "(val)"
},
{
"protoCorrespTypeCode": "(val)",
"description": "(val)",
"moduleId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Correspondence TypesGET/irb/api/v1/protocol-correspondence-types/
Example URI
GET /irb/api/v1/protocol-correspondence-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protoCorrespTypeCode",
"description",
"moduleId"
],
"primaryKey": "protoCorrespTypeCode"
}Get Blueprint API specification for Protocol Correspondence TypesGET/irb/api/v1/protocol-correspondence-types/
Example URI
GET /irb/api/v1/protocol-correspondence-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Correspondence Types.md"
transfer-encoding: chunkedUpdate Protocol Correspondence TypesPUT/irb/api/v1/protocol-correspondence-types/(key)
Example URI
PUT /irb/api/v1/protocol-correspondence-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protoCorrespTypeCode": "(val)",
"description": "(val)",
"moduleId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Correspondence TypesPUT/irb/api/v1/protocol-correspondence-types/
Example URI
PUT /irb/api/v1/protocol-correspondence-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protoCorrespTypeCode": "(val)",
"description": "(val)",
"moduleId": "(val)",
"_primaryKey": "(val)"
},
{
"protoCorrespTypeCode": "(val)",
"description": "(val)",
"moduleId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Correspondence TypesPATCH/irb/api/v1/protocol-correspondence-types/(key)
Example URI
PATCH /irb/api/v1/protocol-correspondence-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protoCorrespTypeCode": "(val)",
"description": "(val)",
"moduleId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protoCorrespTypeCode": "(val)",
"description": "(val)",
"moduleId": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Correspondence TypesPOST/irb/api/v1/protocol-correspondence-types/
Example URI
POST /irb/api/v1/protocol-correspondence-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protoCorrespTypeCode": "(val)",
"description": "(val)",
"moduleId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protoCorrespTypeCode": "(val)",
"description": "(val)",
"moduleId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Correspondence TypesPOST/irb/api/v1/protocol-correspondence-types/
Example URI
POST /irb/api/v1/protocol-correspondence-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protoCorrespTypeCode": "(val)",
"description": "(val)",
"moduleId": "(val)",
"_primaryKey": "(val)"
},
{
"protoCorrespTypeCode": "(val)",
"description": "(val)",
"moduleId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protoCorrespTypeCode": "(val)",
"description": "(val)",
"moduleId": "(val)",
"_primaryKey": "(val)"
},
{
"protoCorrespTypeCode": "(val)",
"description": "(val)",
"moduleId": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Correspondence Types by KeyDELETE/irb/api/v1/protocol-correspondence-types/(key)
Example URI
DELETE /irb/api/v1/protocol-correspondence-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Correspondence TypesDELETE/irb/api/v1/protocol-correspondence-types/
Example URI
DELETE /irb/api/v1/protocol-correspondence-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Correspondence Types with MatchingDELETE/irb/api/v1/protocol-correspondence-types/
Example URI
DELETE /irb/api/v1/protocol-correspondence-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protoCorrespTypeCode
string(optional)Proto Corresp Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- moduleId
string(optional)Module Id. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Correspondences ¶
Get Protocol Correspondences by KeyGET/irb/api/v1/protocol-correspondences/(key)
Example URI
GET /irb/api/v1/protocol-correspondences/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"actionId": "(val)",
"actionIdFk": "(val)",
"protoCorrespTypeCode": "(val)",
"correspondence": "(val)",
"finalFlag": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"finalFlagTimestamp": "(val)",
"_primaryKey": "(val)"
}Get All Protocol CorrespondencesGET/irb/api/v1/protocol-correspondences/
Example URI
GET /irb/api/v1/protocol-correspondences/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"actionId": "(val)",
"actionIdFk": "(val)",
"protoCorrespTypeCode": "(val)",
"correspondence": "(val)",
"finalFlag": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"finalFlagTimestamp": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"actionId": "(val)",
"actionIdFk": "(val)",
"protoCorrespTypeCode": "(val)",
"correspondence": "(val)",
"finalFlag": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"finalFlagTimestamp": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Correspondences with FilteringGET/irb/api/v1/protocol-correspondences/
Example URI
GET /irb/api/v1/protocol-correspondences/
URI Parameters
- id
string(optional)Id. Maximum length is 22.
- protocolId
string(optional)- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22.
- actionId
string(optional)- actionIdFk
string(optional)- protoCorrespTypeCode
string(optional)- correspondence
string(optional)Correspondence. Maximum length is 4000.
- finalFlag
string(optional)Is Final. Maximum length is 1.
- createUser
string(optional)Create User. Maximum length is 80.
- createTimestamp
string(optional)Created Time. Maximum length is 21.
- finalFlagTimestamp
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"actionId": "(val)",
"actionIdFk": "(val)",
"protoCorrespTypeCode": "(val)",
"correspondence": "(val)",
"finalFlag": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"finalFlagTimestamp": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"actionId": "(val)",
"actionIdFk": "(val)",
"protoCorrespTypeCode": "(val)",
"correspondence": "(val)",
"finalFlag": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"finalFlagTimestamp": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol CorrespondencesGET/irb/api/v1/protocol-correspondences/
Example URI
GET /irb/api/v1/protocol-correspondences/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"protocolId",
"protocolNumber",
"sequenceNumber",
"actionId",
"actionIdFk",
"protoCorrespTypeCode",
"correspondence",
"finalFlag",
"createUser",
"createTimestamp",
"finalFlagTimestamp"
],
"primaryKey": "id"
}Get Blueprint API specification for Protocol CorrespondencesGET/irb/api/v1/protocol-correspondences/
Example URI
GET /irb/api/v1/protocol-correspondences/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Correspondences.md"
transfer-encoding: chunkedUpdate Protocol CorrespondencesPUT/irb/api/v1/protocol-correspondences/(key)
Example URI
PUT /irb/api/v1/protocol-correspondences/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"actionId": "(val)",
"actionIdFk": "(val)",
"protoCorrespTypeCode": "(val)",
"correspondence": "(val)",
"finalFlag": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"finalFlagTimestamp": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol CorrespondencesPUT/irb/api/v1/protocol-correspondences/
Example URI
PUT /irb/api/v1/protocol-correspondences/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"actionId": "(val)",
"actionIdFk": "(val)",
"protoCorrespTypeCode": "(val)",
"correspondence": "(val)",
"finalFlag": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"finalFlagTimestamp": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"actionId": "(val)",
"actionIdFk": "(val)",
"protoCorrespTypeCode": "(val)",
"correspondence": "(val)",
"finalFlag": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"finalFlagTimestamp": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol CorrespondencesPATCH/irb/api/v1/protocol-correspondences/(key)
Example URI
PATCH /irb/api/v1/protocol-correspondences/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"actionId": "(val)",
"actionIdFk": "(val)",
"protoCorrespTypeCode": "(val)",
"correspondence": "(val)",
"finalFlag": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"finalFlagTimestamp": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"actionId": "(val)",
"actionIdFk": "(val)",
"protoCorrespTypeCode": "(val)",
"correspondence": "(val)",
"finalFlag": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"finalFlagTimestamp": "(val)",
"_primaryKey": "(val)"
}Insert Protocol CorrespondencesPOST/irb/api/v1/protocol-correspondences/
Example URI
POST /irb/api/v1/protocol-correspondences/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"actionId": "(val)",
"actionIdFk": "(val)",
"protoCorrespTypeCode": "(val)",
"correspondence": "(val)",
"finalFlag": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"finalFlagTimestamp": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"actionId": "(val)",
"actionIdFk": "(val)",
"protoCorrespTypeCode": "(val)",
"correspondence": "(val)",
"finalFlag": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"finalFlagTimestamp": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol CorrespondencesPOST/irb/api/v1/protocol-correspondences/
Example URI
POST /irb/api/v1/protocol-correspondences/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"actionId": "(val)",
"actionIdFk": "(val)",
"protoCorrespTypeCode": "(val)",
"correspondence": "(val)",
"finalFlag": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"finalFlagTimestamp": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"actionId": "(val)",
"actionIdFk": "(val)",
"protoCorrespTypeCode": "(val)",
"correspondence": "(val)",
"finalFlag": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"finalFlagTimestamp": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"actionId": "(val)",
"actionIdFk": "(val)",
"protoCorrespTypeCode": "(val)",
"correspondence": "(val)",
"finalFlag": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"finalFlagTimestamp": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"actionId": "(val)",
"actionIdFk": "(val)",
"protoCorrespTypeCode": "(val)",
"correspondence": "(val)",
"finalFlag": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"finalFlagTimestamp": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Correspondences by KeyDELETE/irb/api/v1/protocol-correspondences/(key)
Example URI
DELETE /irb/api/v1/protocol-correspondences/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol CorrespondencesDELETE/irb/api/v1/protocol-correspondences/
Example URI
DELETE /irb/api/v1/protocol-correspondences/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Correspondences with MatchingDELETE/irb/api/v1/protocol-correspondences/
Example URI
DELETE /irb/api/v1/protocol-correspondences/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Id. Maximum length is 22.
- protocolId
string(optional)- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22.
- actionId
string(optional)- actionIdFk
string(optional)- protoCorrespTypeCode
string(optional)- correspondence
string(optional)Correspondence. Maximum length is 4000.
- finalFlag
string(optional)Is Final. Maximum length is 1.
- createUser
string(optional)Create User. Maximum length is 80.
- createTimestamp
string(optional)Created Time. Maximum length is 21.
- finalFlagTimestamp
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Exempt Studies Checklist Items ¶
Get Protocol Exempt Studies Checklist Items by KeyGET/irb/api/v1/protocol-exempt-studies-checklist-items/(key)
Example URI
GET /irb/api/v1/protocol-exempt-studies-checklist-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolExemptCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"exemptStudiesCheckListCode": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Exempt Studies Checklist ItemsGET/irb/api/v1/protocol-exempt-studies-checklist-items/
Example URI
GET /irb/api/v1/protocol-exempt-studies-checklist-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolExemptCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"exemptStudiesCheckListCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolExemptCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"exemptStudiesCheckListCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Exempt Studies Checklist Items with FilteringGET/irb/api/v1/protocol-exempt-studies-checklist-items/
Example URI
GET /irb/api/v1/protocol-exempt-studies-checklist-items/
URI Parameters
- protocolExemptCheckListId
string(optional)- protocolId
string(optional)- submissionIdFk
string(optional)- protocolNumber
string(optional)- sequenceNumber
string(optional)- submissionNumber
string(optional)- exemptStudiesCheckListCode
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolExemptCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"exemptStudiesCheckListCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolExemptCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"exemptStudiesCheckListCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Exempt Studies Checklist ItemsGET/irb/api/v1/protocol-exempt-studies-checklist-items/
Example URI
GET /irb/api/v1/protocol-exempt-studies-checklist-items/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolExemptCheckListId",
"protocolId",
"submissionIdFk",
"protocolNumber",
"sequenceNumber",
"submissionNumber",
"exemptStudiesCheckListCode"
],
"primaryKey": "protocolExemptCheckListId"
}Get Blueprint API specification for Protocol Exempt Studies Checklist ItemsGET/irb/api/v1/protocol-exempt-studies-checklist-items/
Example URI
GET /irb/api/v1/protocol-exempt-studies-checklist-items/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Exempt Studies Checklist Items.md"
transfer-encoding: chunkedUpdate Protocol Exempt Studies Checklist ItemsPUT/irb/api/v1/protocol-exempt-studies-checklist-items/(key)
Example URI
PUT /irb/api/v1/protocol-exempt-studies-checklist-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolExemptCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"exemptStudiesCheckListCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Exempt Studies Checklist ItemsPUT/irb/api/v1/protocol-exempt-studies-checklist-items/
Example URI
PUT /irb/api/v1/protocol-exempt-studies-checklist-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolExemptCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"exemptStudiesCheckListCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolExemptCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"exemptStudiesCheckListCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Exempt Studies Checklist ItemsPATCH/irb/api/v1/protocol-exempt-studies-checklist-items/(key)
Example URI
PATCH /irb/api/v1/protocol-exempt-studies-checklist-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolExemptCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"exemptStudiesCheckListCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolExemptCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"exemptStudiesCheckListCode": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Exempt Studies Checklist ItemsPOST/irb/api/v1/protocol-exempt-studies-checklist-items/
Example URI
POST /irb/api/v1/protocol-exempt-studies-checklist-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolExemptCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"exemptStudiesCheckListCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolExemptCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"exemptStudiesCheckListCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Exempt Studies Checklist ItemsPOST/irb/api/v1/protocol-exempt-studies-checklist-items/
Example URI
POST /irb/api/v1/protocol-exempt-studies-checklist-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolExemptCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"exemptStudiesCheckListCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolExemptCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"exemptStudiesCheckListCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolExemptCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"exemptStudiesCheckListCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolExemptCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"exemptStudiesCheckListCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Exempt Studies Checklist Items by KeyDELETE/irb/api/v1/protocol-exempt-studies-checklist-items/(key)
Example URI
DELETE /irb/api/v1/protocol-exempt-studies-checklist-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Exempt Studies Checklist ItemsDELETE/irb/api/v1/protocol-exempt-studies-checklist-items/
Example URI
DELETE /irb/api/v1/protocol-exempt-studies-checklist-items/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Exempt Studies Checklist Items with MatchingDELETE/irb/api/v1/protocol-exempt-studies-checklist-items/
Example URI
DELETE /irb/api/v1/protocol-exempt-studies-checklist-items/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolExemptCheckListId
string(optional)- protocolId
string(optional)- submissionIdFk
string(optional)- protocolNumber
string(optional)- sequenceNumber
string(optional)- submissionNumber
string(optional)- exemptStudiesCheckListCode
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Expedited Review Checklist Items ¶
Get Protocol Expedited Review Checklist Items by KeyGET/irb/api/v1/protocol-expedited-review-checklist-items/(key)
Example URI
GET /irb/api/v1/protocol-expedited-review-checklist-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolExpeditedCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"expeditedReviewCheckListCode": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Expedited Review Checklist ItemsGET/irb/api/v1/protocol-expedited-review-checklist-items/
Example URI
GET /irb/api/v1/protocol-expedited-review-checklist-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolExpeditedCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"expeditedReviewCheckListCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolExpeditedCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"expeditedReviewCheckListCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Expedited Review Checklist Items with FilteringGET/irb/api/v1/protocol-expedited-review-checklist-items/
Example URI
GET /irb/api/v1/protocol-expedited-review-checklist-items/
URI Parameters
- protocolExpeditedCheckListId
string(optional)- protocolId
string(optional)- submissionIdFk
string(optional)- protocolNumber
string(optional)- sequenceNumber
string(optional)- submissionNumber
string(optional)- expeditedReviewCheckListCode
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolExpeditedCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"expeditedReviewCheckListCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolExpeditedCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"expeditedReviewCheckListCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Expedited Review Checklist ItemsGET/irb/api/v1/protocol-expedited-review-checklist-items/
Example URI
GET /irb/api/v1/protocol-expedited-review-checklist-items/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolExpeditedCheckListId",
"protocolId",
"submissionIdFk",
"protocolNumber",
"sequenceNumber",
"submissionNumber",
"expeditedReviewCheckListCode"
],
"primaryKey": "protocolExpeditedCheckListId"
}Get Blueprint API specification for Protocol Expedited Review Checklist ItemsGET/irb/api/v1/protocol-expedited-review-checklist-items/
Example URI
GET /irb/api/v1/protocol-expedited-review-checklist-items/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Expedited Review Checklist Items.md"
transfer-encoding: chunkedUpdate Protocol Expedited Review Checklist ItemsPUT/irb/api/v1/protocol-expedited-review-checklist-items/(key)
Example URI
PUT /irb/api/v1/protocol-expedited-review-checklist-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolExpeditedCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"expeditedReviewCheckListCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Expedited Review Checklist ItemsPUT/irb/api/v1/protocol-expedited-review-checklist-items/
Example URI
PUT /irb/api/v1/protocol-expedited-review-checklist-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolExpeditedCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"expeditedReviewCheckListCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolExpeditedCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"expeditedReviewCheckListCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Expedited Review Checklist ItemsPATCH/irb/api/v1/protocol-expedited-review-checklist-items/(key)
Example URI
PATCH /irb/api/v1/protocol-expedited-review-checklist-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolExpeditedCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"expeditedReviewCheckListCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolExpeditedCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"expeditedReviewCheckListCode": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Expedited Review Checklist ItemsPOST/irb/api/v1/protocol-expedited-review-checklist-items/
Example URI
POST /irb/api/v1/protocol-expedited-review-checklist-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolExpeditedCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"expeditedReviewCheckListCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolExpeditedCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"expeditedReviewCheckListCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Expedited Review Checklist ItemsPOST/irb/api/v1/protocol-expedited-review-checklist-items/
Example URI
POST /irb/api/v1/protocol-expedited-review-checklist-items/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolExpeditedCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"expeditedReviewCheckListCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolExpeditedCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"expeditedReviewCheckListCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolExpeditedCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"expeditedReviewCheckListCode": "(val)",
"_primaryKey": "(val)"
},
{
"protocolExpeditedCheckListId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"expeditedReviewCheckListCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Expedited Review Checklist Items by KeyDELETE/irb/api/v1/protocol-expedited-review-checklist-items/(key)
Example URI
DELETE /irb/api/v1/protocol-expedited-review-checklist-items/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Expedited Review Checklist ItemsDELETE/irb/api/v1/protocol-expedited-review-checklist-items/
Example URI
DELETE /irb/api/v1/protocol-expedited-review-checklist-items/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Expedited Review Checklist Items with MatchingDELETE/irb/api/v1/protocol-expedited-review-checklist-items/
Example URI
DELETE /irb/api/v1/protocol-expedited-review-checklist-items/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolExpeditedCheckListId
string(optional)- protocolId
string(optional)- submissionIdFk
string(optional)- protocolNumber
string(optional)- sequenceNumber
string(optional)- submissionNumber
string(optional)- expeditedReviewCheckListCode
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Funding Sources ¶
Get Protocol Funding Sources by KeyGET/irb/api/v1/protocol-funding-sources/(key)
Example URI
GET /irb/api/v1/protocol-funding-sources/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolFundingSourceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"fundingSourceTypeCode": "(val)",
"fundingSourceNumber": "(val)",
"fundingSourceName": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Funding SourcesGET/irb/api/v1/protocol-funding-sources/
Example URI
GET /irb/api/v1/protocol-funding-sources/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolFundingSourceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"fundingSourceTypeCode": "(val)",
"fundingSourceNumber": "(val)",
"fundingSourceName": "(val)",
"_primaryKey": "(val)"
},
{
"protocolFundingSourceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"fundingSourceTypeCode": "(val)",
"fundingSourceNumber": "(val)",
"fundingSourceName": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Funding Sources with FilteringGET/irb/api/v1/protocol-funding-sources/
Example URI
GET /irb/api/v1/protocol-funding-sources/
URI Parameters
- protocolFundingSourceId
string(optional)Protocol Funding Source Id. Maximum length is 12.
- protocolId
string(optional)Protocol Id. Maximum length is 12.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 4.
- fundingSourceTypeCode
string(optional)Funding Source Type Code. Maximum length is 22.
- fundingSourceNumber
string(optional)Funding Source Number. Maximum length is 200.
- fundingSourceName
string(optional)Funding Source Name. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolFundingSourceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"fundingSourceTypeCode": "(val)",
"fundingSourceNumber": "(val)",
"fundingSourceName": "(val)",
"_primaryKey": "(val)"
},
{
"protocolFundingSourceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"fundingSourceTypeCode": "(val)",
"fundingSourceNumber": "(val)",
"fundingSourceName": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Funding SourcesGET/irb/api/v1/protocol-funding-sources/
Example URI
GET /irb/api/v1/protocol-funding-sources/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolFundingSourceId",
"protocolId",
"protocolNumber",
"sequenceNumber",
"fundingSourceTypeCode",
"fundingSourceNumber",
"fundingSourceName"
],
"primaryKey": "protocolFundingSourceId"
}Get Blueprint API specification for Protocol Funding SourcesGET/irb/api/v1/protocol-funding-sources/
Example URI
GET /irb/api/v1/protocol-funding-sources/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Funding Sources.md"
transfer-encoding: chunkedUpdate Protocol Funding SourcesPUT/irb/api/v1/protocol-funding-sources/(key)
Example URI
PUT /irb/api/v1/protocol-funding-sources/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolFundingSourceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"fundingSourceTypeCode": "(val)",
"fundingSourceNumber": "(val)",
"fundingSourceName": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Funding SourcesPUT/irb/api/v1/protocol-funding-sources/
Example URI
PUT /irb/api/v1/protocol-funding-sources/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolFundingSourceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"fundingSourceTypeCode": "(val)",
"fundingSourceNumber": "(val)",
"fundingSourceName": "(val)",
"_primaryKey": "(val)"
},
{
"protocolFundingSourceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"fundingSourceTypeCode": "(val)",
"fundingSourceNumber": "(val)",
"fundingSourceName": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Funding SourcesPATCH/irb/api/v1/protocol-funding-sources/(key)
Example URI
PATCH /irb/api/v1/protocol-funding-sources/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolFundingSourceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"fundingSourceTypeCode": "(val)",
"fundingSourceNumber": "(val)",
"fundingSourceName": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolFundingSourceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"fundingSourceTypeCode": "(val)",
"fundingSourceNumber": "(val)",
"fundingSourceName": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Funding SourcesPOST/irb/api/v1/protocol-funding-sources/
Example URI
POST /irb/api/v1/protocol-funding-sources/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolFundingSourceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"fundingSourceTypeCode": "(val)",
"fundingSourceNumber": "(val)",
"fundingSourceName": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolFundingSourceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"fundingSourceTypeCode": "(val)",
"fundingSourceNumber": "(val)",
"fundingSourceName": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Funding SourcesPOST/irb/api/v1/protocol-funding-sources/
Example URI
POST /irb/api/v1/protocol-funding-sources/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolFundingSourceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"fundingSourceTypeCode": "(val)",
"fundingSourceNumber": "(val)",
"fundingSourceName": "(val)",
"_primaryKey": "(val)"
},
{
"protocolFundingSourceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"fundingSourceTypeCode": "(val)",
"fundingSourceNumber": "(val)",
"fundingSourceName": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolFundingSourceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"fundingSourceTypeCode": "(val)",
"fundingSourceNumber": "(val)",
"fundingSourceName": "(val)",
"_primaryKey": "(val)"
},
{
"protocolFundingSourceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"fundingSourceTypeCode": "(val)",
"fundingSourceNumber": "(val)",
"fundingSourceName": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Funding Sources by KeyDELETE/irb/api/v1/protocol-funding-sources/(key)
Example URI
DELETE /irb/api/v1/protocol-funding-sources/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Funding SourcesDELETE/irb/api/v1/protocol-funding-sources/
Example URI
DELETE /irb/api/v1/protocol-funding-sources/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Funding Sources with MatchingDELETE/irb/api/v1/protocol-funding-sources/
Example URI
DELETE /irb/api/v1/protocol-funding-sources/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolFundingSourceId
string(optional)Protocol Funding Source Id. Maximum length is 12.
- protocolId
string(optional)Protocol Id. Maximum length is 12.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 4.
- fundingSourceTypeCode
string(optional)Funding Source Type Code. Maximum length is 22.
- fundingSourceNumber
string(optional)Funding Source Number. Maximum length is 200.
- fundingSourceName
string(optional)Funding Source Name. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Locations ¶
Get Protocol Locations by KeyGET/irb/api/v1/protocol-locations/(key)
Example URI
GET /irb/api/v1/protocol-locations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolLocationId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolOrganizationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}Get All Protocol LocationsGET/irb/api/v1/protocol-locations/
Example URI
GET /irb/api/v1/protocol-locations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolLocationId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolOrganizationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
},
{
"protocolLocationId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolOrganizationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Locations with FilteringGET/irb/api/v1/protocol-locations/
Example URI
GET /irb/api/v1/protocol-locations/
URI Parameters
- protocolLocationId
string(optional)Protocol Location Id. Maximum length is 22.
- protocolId
string(optional)- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22.
- protocolOrganizationTypeCode
string(optional)Protocol Organization Type Code. Maximum length is 22.
- organizationId
string(optional)Organization Id. Maximum length is 8.
- rolodexId
string(optional)Contact - Rolodex Id. Maximum length is 22.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolLocationId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolOrganizationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
},
{
"protocolLocationId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolOrganizationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol LocationsGET/irb/api/v1/protocol-locations/
Example URI
GET /irb/api/v1/protocol-locations/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolLocationId",
"protocolId",
"protocolNumber",
"sequenceNumber",
"protocolOrganizationTypeCode",
"organizationId",
"rolodexId"
],
"primaryKey": "protocolLocationId"
}Get Blueprint API specification for Protocol LocationsGET/irb/api/v1/protocol-locations/
Example URI
GET /irb/api/v1/protocol-locations/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Locations.md"
transfer-encoding: chunkedUpdate Protocol LocationsPUT/irb/api/v1/protocol-locations/(key)
Example URI
PUT /irb/api/v1/protocol-locations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolLocationId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolOrganizationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol LocationsPUT/irb/api/v1/protocol-locations/
Example URI
PUT /irb/api/v1/protocol-locations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolLocationId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolOrganizationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
},
{
"protocolLocationId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolOrganizationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol LocationsPATCH/irb/api/v1/protocol-locations/(key)
Example URI
PATCH /irb/api/v1/protocol-locations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolLocationId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolOrganizationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolLocationId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolOrganizationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}Insert Protocol LocationsPOST/irb/api/v1/protocol-locations/
Example URI
POST /irb/api/v1/protocol-locations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolLocationId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolOrganizationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolLocationId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolOrganizationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol LocationsPOST/irb/api/v1/protocol-locations/
Example URI
POST /irb/api/v1/protocol-locations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolLocationId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolOrganizationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
},
{
"protocolLocationId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolOrganizationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolLocationId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolOrganizationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
},
{
"protocolLocationId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolOrganizationTypeCode": "(val)",
"organizationId": "(val)",
"rolodexId": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Locations by KeyDELETE/irb/api/v1/protocol-locations/(key)
Example URI
DELETE /irb/api/v1/protocol-locations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol LocationsDELETE/irb/api/v1/protocol-locations/
Example URI
DELETE /irb/api/v1/protocol-locations/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Locations with MatchingDELETE/irb/api/v1/protocol-locations/
Example URI
DELETE /irb/api/v1/protocol-locations/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolLocationId
string(optional)Protocol Location Id. Maximum length is 22.
- protocolId
string(optional)- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22.
- protocolOrganizationTypeCode
string(optional)Protocol Organization Type Code. Maximum length is 22.
- organizationId
string(optional)Organization Id. Maximum length is 8.
- rolodexId
string(optional)Contact - Rolodex Id. Maximum length is 22.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Modules ¶
Get Protocol Modules by KeyGET/irb/api/v1/protocol-modules/(key)
Example URI
GET /irb/api/v1/protocol-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolModuleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Protocol ModulesGET/irb/api/v1/protocol-modules/
Example URI
GET /irb/api/v1/protocol-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolModuleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolModuleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Modules with FilteringGET/irb/api/v1/protocol-modules/
Example URI
GET /irb/api/v1/protocol-modules/
URI Parameters
- protocolModuleCode
string(optional)- description
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolModuleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolModuleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol ModulesGET/irb/api/v1/protocol-modules/
Example URI
GET /irb/api/v1/protocol-modules/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolModuleCode",
"description"
],
"primaryKey": "protocolModuleCode"
}Get Blueprint API specification for Protocol ModulesGET/irb/api/v1/protocol-modules/
Example URI
GET /irb/api/v1/protocol-modules/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Modules.md"
transfer-encoding: chunkedUpdate Protocol ModulesPUT/irb/api/v1/protocol-modules/(key)
Example URI
PUT /irb/api/v1/protocol-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolModuleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol ModulesPUT/irb/api/v1/protocol-modules/
Example URI
PUT /irb/api/v1/protocol-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolModuleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolModuleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol ModulesPATCH/irb/api/v1/protocol-modules/(key)
Example URI
PATCH /irb/api/v1/protocol-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolModuleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolModuleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Protocol ModulesPOST/irb/api/v1/protocol-modules/
Example URI
POST /irb/api/v1/protocol-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolModuleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolModuleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol ModulesPOST/irb/api/v1/protocol-modules/
Example URI
POST /irb/api/v1/protocol-modules/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolModuleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolModuleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolModuleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolModuleCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Modules by KeyDELETE/irb/api/v1/protocol-modules/(key)
Example URI
DELETE /irb/api/v1/protocol-modules/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol ModulesDELETE/irb/api/v1/protocol-modules/
Example URI
DELETE /irb/api/v1/protocol-modules/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Modules with MatchingDELETE/irb/api/v1/protocol-modules/
Example URI
DELETE /irb/api/v1/protocol-modules/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolModuleCode
string(optional)- description
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Notepads ¶
Get Protocol Notepads by KeyGET/irb/api/v1/protocol-notepads/(key)
Example URI
GET /irb/api/v1/protocol-notepads/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"entryNumber": "(val)",
"comments": "(val)",
"restrictedView": "(val)",
"noteTopic": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Get All Protocol NotepadsGET/irb/api/v1/protocol-notepads/
Example URI
GET /irb/api/v1/protocol-notepads/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"entryNumber": "(val)",
"comments": "(val)",
"restrictedView": "(val)",
"noteTopic": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"entryNumber": "(val)",
"comments": "(val)",
"restrictedView": "(val)",
"noteTopic": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Notepads with FilteringGET/irb/api/v1/protocol-notepads/
Example URI
GET /irb/api/v1/protocol-notepads/
URI Parameters
- id
string(optional)Protocol Notepad Id. Maximum length is 22.
- protocolId
string(optional)- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)- entryNumber
string(optional)Entry Number. Maximum length is 22.
- comments
string(optional)Comments. Maximum length is 4000.
- restrictedView
string(optional)Restricted View. Maximum length is 1.
- noteTopic
string(optional)Comments. Maximum length is 60.
- createTimestamp
string(optional)The creation or last modification timestamp. Maximum length is 21.
- createUser
string(optional)The user who created or last modified the object. Maximum length is 60.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"entryNumber": "(val)",
"comments": "(val)",
"restrictedView": "(val)",
"noteTopic": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"entryNumber": "(val)",
"comments": "(val)",
"restrictedView": "(val)",
"noteTopic": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol NotepadsGET/irb/api/v1/protocol-notepads/
Example URI
GET /irb/api/v1/protocol-notepads/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"protocolId",
"protocolNumber",
"sequenceNumber",
"entryNumber",
"comments",
"restrictedView",
"noteTopic",
"createTimestamp",
"createUser"
],
"primaryKey": "id"
}Get Blueprint API specification for Protocol NotepadsGET/irb/api/v1/protocol-notepads/
Example URI
GET /irb/api/v1/protocol-notepads/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Notepads.md"
transfer-encoding: chunkedUpdate Protocol NotepadsPUT/irb/api/v1/protocol-notepads/(key)
Example URI
PUT /irb/api/v1/protocol-notepads/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"entryNumber": "(val)",
"comments": "(val)",
"restrictedView": "(val)",
"noteTopic": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol NotepadsPUT/irb/api/v1/protocol-notepads/
Example URI
PUT /irb/api/v1/protocol-notepads/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"entryNumber": "(val)",
"comments": "(val)",
"restrictedView": "(val)",
"noteTopic": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"entryNumber": "(val)",
"comments": "(val)",
"restrictedView": "(val)",
"noteTopic": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol NotepadsPATCH/irb/api/v1/protocol-notepads/(key)
Example URI
PATCH /irb/api/v1/protocol-notepads/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"entryNumber": "(val)",
"comments": "(val)",
"restrictedView": "(val)",
"noteTopic": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"entryNumber": "(val)",
"comments": "(val)",
"restrictedView": "(val)",
"noteTopic": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Insert Protocol NotepadsPOST/irb/api/v1/protocol-notepads/
Example URI
POST /irb/api/v1/protocol-notepads/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"entryNumber": "(val)",
"comments": "(val)",
"restrictedView": "(val)",
"noteTopic": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"entryNumber": "(val)",
"comments": "(val)",
"restrictedView": "(val)",
"noteTopic": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol NotepadsPOST/irb/api/v1/protocol-notepads/
Example URI
POST /irb/api/v1/protocol-notepads/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"entryNumber": "(val)",
"comments": "(val)",
"restrictedView": "(val)",
"noteTopic": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"entryNumber": "(val)",
"comments": "(val)",
"restrictedView": "(val)",
"noteTopic": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"entryNumber": "(val)",
"comments": "(val)",
"restrictedView": "(val)",
"noteTopic": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"entryNumber": "(val)",
"comments": "(val)",
"restrictedView": "(val)",
"noteTopic": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Notepads by KeyDELETE/irb/api/v1/protocol-notepads/(key)
Example URI
DELETE /irb/api/v1/protocol-notepads/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol NotepadsDELETE/irb/api/v1/protocol-notepads/
Example URI
DELETE /irb/api/v1/protocol-notepads/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Notepads with MatchingDELETE/irb/api/v1/protocol-notepads/
Example URI
DELETE /irb/api/v1/protocol-notepads/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Protocol Notepad Id. Maximum length is 22.
- protocolId
string(optional)- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)- entryNumber
string(optional)Entry Number. Maximum length is 22.
- comments
string(optional)Comments. Maximum length is 4000.
- restrictedView
string(optional)Restricted View. Maximum length is 1.
- noteTopic
string(optional)Comments. Maximum length is 60.
- createTimestamp
string(optional)The creation or last modification timestamp. Maximum length is 21.
- createUser
string(optional)The user who created or last modified the object. Maximum length is 60.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Notification Templates ¶
Get Protocol Notification Templates by KeyGET/irb/api/v1/protocol-notification-templates/(key)
Example URI
GET /irb/api/v1/protocol-notification-templates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"notificationTemplateId": "(val)",
"actionTypeCode": "(val)",
"fileName": "(val)",
"notificationTemplate": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Notification TemplatesGET/irb/api/v1/protocol-notification-templates/
Example URI
GET /irb/api/v1/protocol-notification-templates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"notificationTemplateId": "(val)",
"actionTypeCode": "(val)",
"fileName": "(val)",
"notificationTemplate": "(val)",
"_primaryKey": "(val)"
},
{
"notificationTemplateId": "(val)",
"actionTypeCode": "(val)",
"fileName": "(val)",
"notificationTemplate": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Notification Templates with FilteringGET/irb/api/v1/protocol-notification-templates/
Example URI
GET /irb/api/v1/protocol-notification-templates/
URI Parameters
- notificationTemplateId
string(optional)Proto Notification Templ Id. Maximum length is 12.
- actionTypeCode
string(optional)Protocol Action Type Code. Maximum length is 3.
- fileName
string(optional)File. Maximum length is 150.
- notificationTemplate
string(optional)Notification Template. Maximum length is 4000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"notificationTemplateId": "(val)",
"actionTypeCode": "(val)",
"fileName": "(val)",
"notificationTemplate": "(val)",
"_primaryKey": "(val)"
},
{
"notificationTemplateId": "(val)",
"actionTypeCode": "(val)",
"fileName": "(val)",
"notificationTemplate": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Notification TemplatesGET/irb/api/v1/protocol-notification-templates/
Example URI
GET /irb/api/v1/protocol-notification-templates/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"notificationTemplateId",
"actionTypeCode",
"fileName",
"notificationTemplate"
],
"primaryKey": "notificationTemplateId"
}Get Blueprint API specification for Protocol Notification TemplatesGET/irb/api/v1/protocol-notification-templates/
Example URI
GET /irb/api/v1/protocol-notification-templates/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Notification Templates.md"
transfer-encoding: chunkedUpdate Protocol Notification TemplatesPUT/irb/api/v1/protocol-notification-templates/(key)
Example URI
PUT /irb/api/v1/protocol-notification-templates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationTemplateId": "(val)",
"actionTypeCode": "(val)",
"fileName": "(val)",
"notificationTemplate": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Notification TemplatesPUT/irb/api/v1/protocol-notification-templates/
Example URI
PUT /irb/api/v1/protocol-notification-templates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"notificationTemplateId": "(val)",
"actionTypeCode": "(val)",
"fileName": "(val)",
"notificationTemplate": "(val)",
"_primaryKey": "(val)"
},
{
"notificationTemplateId": "(val)",
"actionTypeCode": "(val)",
"fileName": "(val)",
"notificationTemplate": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Notification TemplatesPATCH/irb/api/v1/protocol-notification-templates/(key)
Example URI
PATCH /irb/api/v1/protocol-notification-templates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationTemplateId": "(val)",
"actionTypeCode": "(val)",
"fileName": "(val)",
"notificationTemplate": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"notificationTemplateId": "(val)",
"actionTypeCode": "(val)",
"fileName": "(val)",
"notificationTemplate": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Notification TemplatesPOST/irb/api/v1/protocol-notification-templates/
Example URI
POST /irb/api/v1/protocol-notification-templates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"notificationTemplateId": "(val)",
"actionTypeCode": "(val)",
"fileName": "(val)",
"notificationTemplate": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"notificationTemplateId": "(val)",
"actionTypeCode": "(val)",
"fileName": "(val)",
"notificationTemplate": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Notification TemplatesPOST/irb/api/v1/protocol-notification-templates/
Example URI
POST /irb/api/v1/protocol-notification-templates/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"notificationTemplateId": "(val)",
"actionTypeCode": "(val)",
"fileName": "(val)",
"notificationTemplate": "(val)",
"_primaryKey": "(val)"
},
{
"notificationTemplateId": "(val)",
"actionTypeCode": "(val)",
"fileName": "(val)",
"notificationTemplate": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"notificationTemplateId": "(val)",
"actionTypeCode": "(val)",
"fileName": "(val)",
"notificationTemplate": "(val)",
"_primaryKey": "(val)"
},
{
"notificationTemplateId": "(val)",
"actionTypeCode": "(val)",
"fileName": "(val)",
"notificationTemplate": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Notification Templates by KeyDELETE/irb/api/v1/protocol-notification-templates/(key)
Example URI
DELETE /irb/api/v1/protocol-notification-templates/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Notification TemplatesDELETE/irb/api/v1/protocol-notification-templates/
Example URI
DELETE /irb/api/v1/protocol-notification-templates/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Notification Templates with MatchingDELETE/irb/api/v1/protocol-notification-templates/
Example URI
DELETE /irb/api/v1/protocol-notification-templates/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- notificationTemplateId
string(optional)Proto Notification Templ Id. Maximum length is 12.
- actionTypeCode
string(optional)Protocol Action Type Code. Maximum length is 3.
- fileName
string(optional)File. Maximum length is 150.
- notificationTemplate
string(optional)Notification Template. Maximum length is 4000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Online Review Determination Recommendations ¶
Get Protocol Online Review Determination Recommendations by KeyGET/irb/api/v1/protocol-online-review-determination-recommendations/(key)
Example URI
GET /irb/api/v1/protocol-online-review-determination-recommendations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Online Review Determination RecommendationsGET/irb/api/v1/protocol-online-review-determination-recommendations/
Example URI
GET /irb/api/v1/protocol-online-review-determination-recommendations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Online Review Determination Recommendations with FilteringGET/irb/api/v1/protocol-online-review-determination-recommendations/
Example URI
GET /irb/api/v1/protocol-online-review-determination-recommendations/
URI Parameters
- protocolOnlineReviewDeterminationRecommendationCode
string(optional)Status Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Online Review Determination RecommendationsGET/irb/api/v1/protocol-online-review-determination-recommendations/
Example URI
GET /irb/api/v1/protocol-online-review-determination-recommendations/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolOnlineReviewDeterminationRecommendationCode",
"description"
],
"primaryKey": "protocolOnlineReviewDeterminationRecommendationCode"
}Get Blueprint API specification for Protocol Online Review Determination RecommendationsGET/irb/api/v1/protocol-online-review-determination-recommendations/
Example URI
GET /irb/api/v1/protocol-online-review-determination-recommendations/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Online Review Determination Recommendations.md"
transfer-encoding: chunkedUpdate Protocol Online Review Determination RecommendationsPUT/irb/api/v1/protocol-online-review-determination-recommendations/(key)
Example URI
PUT /irb/api/v1/protocol-online-review-determination-recommendations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Online Review Determination RecommendationsPUT/irb/api/v1/protocol-online-review-determination-recommendations/
Example URI
PUT /irb/api/v1/protocol-online-review-determination-recommendations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Online Review Determination RecommendationsPATCH/irb/api/v1/protocol-online-review-determination-recommendations/(key)
Example URI
PATCH /irb/api/v1/protocol-online-review-determination-recommendations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Online Review Determination RecommendationsPOST/irb/api/v1/protocol-online-review-determination-recommendations/
Example URI
POST /irb/api/v1/protocol-online-review-determination-recommendations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Online Review Determination RecommendationsPOST/irb/api/v1/protocol-online-review-determination-recommendations/
Example URI
POST /irb/api/v1/protocol-online-review-determination-recommendations/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Online Review Determination Recommendations by KeyDELETE/irb/api/v1/protocol-online-review-determination-recommendations/(key)
Example URI
DELETE /irb/api/v1/protocol-online-review-determination-recommendations/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Online Review Determination RecommendationsDELETE/irb/api/v1/protocol-online-review-determination-recommendations/
Example URI
DELETE /irb/api/v1/protocol-online-review-determination-recommendations/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Online Review Determination Recommendations with MatchingDELETE/irb/api/v1/protocol-online-review-determination-recommendations/
Example URI
DELETE /irb/api/v1/protocol-online-review-determination-recommendations/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolOnlineReviewDeterminationRecommendationCode
string(optional)Status Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Online Review Statuses ¶
Get Protocol Online Review Statuses by KeyGET/irb/api/v1/protocol-online-review-statuses/(key)
Example URI
GET /irb/api/v1/protocol-online-review-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"statusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Online Review StatusesGET/irb/api/v1/protocol-online-review-statuses/
Example URI
GET /irb/api/v1/protocol-online-review-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"statusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"statusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Online Review Statuses with FilteringGET/irb/api/v1/protocol-online-review-statuses/
Example URI
GET /irb/api/v1/protocol-online-review-statuses/
URI Parameters
- statusCode
string(optional)Status Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"statusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"statusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Online Review StatusesGET/irb/api/v1/protocol-online-review-statuses/
Example URI
GET /irb/api/v1/protocol-online-review-statuses/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"statusCode",
"description"
],
"primaryKey": "statusCode"
}Get Blueprint API specification for Protocol Online Review StatusesGET/irb/api/v1/protocol-online-review-statuses/
Example URI
GET /irb/api/v1/protocol-online-review-statuses/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Online Review Statuses.md"
transfer-encoding: chunkedUpdate Protocol Online Review StatusesPUT/irb/api/v1/protocol-online-review-statuses/(key)
Example URI
PUT /irb/api/v1/protocol-online-review-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"statusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Online Review StatusesPUT/irb/api/v1/protocol-online-review-statuses/
Example URI
PUT /irb/api/v1/protocol-online-review-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"statusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"statusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Online Review StatusesPATCH/irb/api/v1/protocol-online-review-statuses/(key)
Example URI
PATCH /irb/api/v1/protocol-online-review-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"statusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"statusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Online Review StatusesPOST/irb/api/v1/protocol-online-review-statuses/
Example URI
POST /irb/api/v1/protocol-online-review-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"statusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"statusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Online Review StatusesPOST/irb/api/v1/protocol-online-review-statuses/
Example URI
POST /irb/api/v1/protocol-online-review-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"statusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"statusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"statusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"statusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Online Review Statuses by KeyDELETE/irb/api/v1/protocol-online-review-statuses/(key)
Example URI
DELETE /irb/api/v1/protocol-online-review-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Online Review StatusesDELETE/irb/api/v1/protocol-online-review-statuses/
Example URI
DELETE /irb/api/v1/protocol-online-review-statuses/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Online Review Statuses with MatchingDELETE/irb/api/v1/protocol-online-review-statuses/
Example URI
DELETE /irb/api/v1/protocol-online-review-statuses/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- statusCode
string(optional)Status Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Online Reviews ¶
Get Protocol Online Reviews by KeyGET/irb/api/v1/protocol-online-reviews/(key)
Example URI
GET /irb/api/v1/protocol-online-reviews/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolOnlineReviewId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolReviewerId": "(val)",
"protocolOnlineReviewStatusCode": "(val)",
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"dateDue": "(val)",
"dateRequested": "(val)",
"actionsPerformed": "(val)",
"reviewerApproved": "(val)",
"adminAccepted": "(val)",
"protocolOnlineReviewDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Online ReviewsGET/irb/api/v1/protocol-online-reviews/
Example URI
GET /irb/api/v1/protocol-online-reviews/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolOnlineReviewId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolReviewerId": "(val)",
"protocolOnlineReviewStatusCode": "(val)",
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"dateDue": "(val)",
"dateRequested": "(val)",
"actionsPerformed": "(val)",
"reviewerApproved": "(val)",
"adminAccepted": "(val)",
"protocolOnlineReviewDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"protocolOnlineReviewId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolReviewerId": "(val)",
"protocolOnlineReviewStatusCode": "(val)",
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"dateDue": "(val)",
"dateRequested": "(val)",
"actionsPerformed": "(val)",
"reviewerApproved": "(val)",
"adminAccepted": "(val)",
"protocolOnlineReviewDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Online Reviews with FilteringGET/irb/api/v1/protocol-online-reviews/
Example URI
GET /irb/api/v1/protocol-online-reviews/
URI Parameters
- protocolOnlineReviewId
string(optional)Id. Maximum length is 10.
- protocolId
string(optional)Protocol Id. Maximum length is 10.
- submissionIdFk
string(optional)Submission Id. Maximum length is 10.
- protocolReviewerId
string(optional)Protocol Reviewer Id. Maximum length is 10.
- protocolOnlineReviewStatusCode
string(optional)The status of the protocol review. Maximum length is 3.
- protocolOnlineReviewDeterminationRecommendationCode
string(optional)Determination Recommendation. Maximum length is 3.
- dateDue
string(optional)The date the online review is to be completed by. Maximum length is 10.
- dateRequested
string(optional)The date the online review was requested. Maximum length is 10.
- actionsPerformed
string(optional)- reviewerApproved
string(optional)- adminAccepted
string(optional)- protocolOnlineReviewDocument.documentNumber
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolOnlineReviewId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolReviewerId": "(val)",
"protocolOnlineReviewStatusCode": "(val)",
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"dateDue": "(val)",
"dateRequested": "(val)",
"actionsPerformed": "(val)",
"reviewerApproved": "(val)",
"adminAccepted": "(val)",
"protocolOnlineReviewDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"protocolOnlineReviewId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolReviewerId": "(val)",
"protocolOnlineReviewStatusCode": "(val)",
"protocolOnlineReviewDeterminationRecommendationCode": "(val)",
"dateDue": "(val)",
"dateRequested": "(val)",
"actionsPerformed": "(val)",
"reviewerApproved": "(val)",
"adminAccepted": "(val)",
"protocolOnlineReviewDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Online ReviewsGET/irb/api/v1/protocol-online-reviews/
Example URI
GET /irb/api/v1/protocol-online-reviews/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolOnlineReviewId",
"protocolId",
"submissionIdFk",
"protocolReviewerId",
"protocolOnlineReviewStatusCode",
"protocolOnlineReviewDeterminationRecommendationCode",
"dateDue",
"dateRequested",
"actionsPerformed",
"reviewerApproved",
"adminAccepted",
"protocolOnlineReviewDocument.documentNumber"
],
"primaryKey": "protocolOnlineReviewId"
}Get Blueprint API specification for Protocol Online ReviewsGET/irb/api/v1/protocol-online-reviews/
Example URI
GET /irb/api/v1/protocol-online-reviews/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Online Reviews.md"
transfer-encoding: chunkedProtocol Organization Types ¶
Get Protocol Organization Types by KeyGET/irb/api/v1/protocol-organization-types/(key)
Example URI
GET /irb/api/v1/protocol-organization-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolOrganizationTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Organization TypesGET/irb/api/v1/protocol-organization-types/
Example URI
GET /irb/api/v1/protocol-organization-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolOrganizationTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolOrganizationTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Organization Types with FilteringGET/irb/api/v1/protocol-organization-types/
Example URI
GET /irb/api/v1/protocol-organization-types/
URI Parameters
- protocolOrganizationTypeCode
string(optional)Protocol Organization Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolOrganizationTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolOrganizationTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Organization TypesGET/irb/api/v1/protocol-organization-types/
Example URI
GET /irb/api/v1/protocol-organization-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolOrganizationTypeCode",
"description"
],
"primaryKey": "protocolOrganizationTypeCode"
}Get Blueprint API specification for Protocol Organization TypesGET/irb/api/v1/protocol-organization-types/
Example URI
GET /irb/api/v1/protocol-organization-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Organization Types.md"
transfer-encoding: chunkedUpdate Protocol Organization TypesPUT/irb/api/v1/protocol-organization-types/(key)
Example URI
PUT /irb/api/v1/protocol-organization-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolOrganizationTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Organization TypesPUT/irb/api/v1/protocol-organization-types/
Example URI
PUT /irb/api/v1/protocol-organization-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolOrganizationTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolOrganizationTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Organization TypesPATCH/irb/api/v1/protocol-organization-types/(key)
Example URI
PATCH /irb/api/v1/protocol-organization-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolOrganizationTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolOrganizationTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Organization TypesPOST/irb/api/v1/protocol-organization-types/
Example URI
POST /irb/api/v1/protocol-organization-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolOrganizationTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolOrganizationTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Organization TypesPOST/irb/api/v1/protocol-organization-types/
Example URI
POST /irb/api/v1/protocol-organization-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolOrganizationTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolOrganizationTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolOrganizationTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolOrganizationTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Organization Types by KeyDELETE/irb/api/v1/protocol-organization-types/(key)
Example URI
DELETE /irb/api/v1/protocol-organization-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Organization TypesDELETE/irb/api/v1/protocol-organization-types/
Example URI
DELETE /irb/api/v1/protocol-organization-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Organization Types with MatchingDELETE/irb/api/v1/protocol-organization-types/
Example URI
DELETE /irb/api/v1/protocol-organization-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolOrganizationTypeCode
string(optional)Protocol Organization Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Participants ¶
Get Protocol Participants by KeyGET/irb/api/v1/protocol-participants/(key)
Example URI
GET /irb/api/v1/protocol-participants/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolParticipantId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"participantTypeCode": "(val)",
"participantCount": "(val)",
"_primaryKey": "(val)"
}Get All Protocol ParticipantsGET/irb/api/v1/protocol-participants/
Example URI
GET /irb/api/v1/protocol-participants/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolParticipantId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"participantTypeCode": "(val)",
"participantCount": "(val)",
"_primaryKey": "(val)"
},
{
"protocolParticipantId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"participantTypeCode": "(val)",
"participantCount": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Participants with FilteringGET/irb/api/v1/protocol-participants/
Example URI
GET /irb/api/v1/protocol-participants/
URI Parameters
- protocolParticipantId
string(optional)Protocol Participant Id. Maximum length is 22.
- protocolId
string(optional)Protocol Id. Maximum length is 22.
- protocolNumber
string(optional)- sequenceNumber
string(optional)- participantTypeCode
string(optional)Participant Type Code. Maximum length is 3.
- participantCount
string(optional)Participant Count. Maximum length is 6.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolParticipantId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"participantTypeCode": "(val)",
"participantCount": "(val)",
"_primaryKey": "(val)"
},
{
"protocolParticipantId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"participantTypeCode": "(val)",
"participantCount": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol ParticipantsGET/irb/api/v1/protocol-participants/
Example URI
GET /irb/api/v1/protocol-participants/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolParticipantId",
"protocolId",
"protocolNumber",
"sequenceNumber",
"participantTypeCode",
"participantCount"
],
"primaryKey": "protocolParticipantId"
}Get Blueprint API specification for Protocol ParticipantsGET/irb/api/v1/protocol-participants/
Example URI
GET /irb/api/v1/protocol-participants/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Participants.md"
transfer-encoding: chunkedUpdate Protocol ParticipantsPUT/irb/api/v1/protocol-participants/(key)
Example URI
PUT /irb/api/v1/protocol-participants/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolParticipantId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"participantTypeCode": "(val)",
"participantCount": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol ParticipantsPUT/irb/api/v1/protocol-participants/
Example URI
PUT /irb/api/v1/protocol-participants/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolParticipantId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"participantTypeCode": "(val)",
"participantCount": "(val)",
"_primaryKey": "(val)"
},
{
"protocolParticipantId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"participantTypeCode": "(val)",
"participantCount": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol ParticipantsPATCH/irb/api/v1/protocol-participants/(key)
Example URI
PATCH /irb/api/v1/protocol-participants/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolParticipantId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"participantTypeCode": "(val)",
"participantCount": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolParticipantId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"participantTypeCode": "(val)",
"participantCount": "(val)",
"_primaryKey": "(val)"
}Insert Protocol ParticipantsPOST/irb/api/v1/protocol-participants/
Example URI
POST /irb/api/v1/protocol-participants/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolParticipantId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"participantTypeCode": "(val)",
"participantCount": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolParticipantId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"participantTypeCode": "(val)",
"participantCount": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol ParticipantsPOST/irb/api/v1/protocol-participants/
Example URI
POST /irb/api/v1/protocol-participants/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolParticipantId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"participantTypeCode": "(val)",
"participantCount": "(val)",
"_primaryKey": "(val)"
},
{
"protocolParticipantId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"participantTypeCode": "(val)",
"participantCount": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolParticipantId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"participantTypeCode": "(val)",
"participantCount": "(val)",
"_primaryKey": "(val)"
},
{
"protocolParticipantId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"participantTypeCode": "(val)",
"participantCount": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Participants by KeyDELETE/irb/api/v1/protocol-participants/(key)
Example URI
DELETE /irb/api/v1/protocol-participants/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol ParticipantsDELETE/irb/api/v1/protocol-participants/
Example URI
DELETE /irb/api/v1/protocol-participants/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Participants with MatchingDELETE/irb/api/v1/protocol-participants/
Example URI
DELETE /irb/api/v1/protocol-participants/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolParticipantId
string(optional)Protocol Participant Id. Maximum length is 22.
- protocolId
string(optional)Protocol Id. Maximum length is 22.
- protocolNumber
string(optional)- sequenceNumber
string(optional)- participantTypeCode
string(optional)Participant Type Code. Maximum length is 3.
- participantCount
string(optional)Participant Count. Maximum length is 6.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Person Mass Changes ¶
Get Protocol Person Mass Changes by KeyGET/irb/api/v1/protocol-person-mass-changes/(key)
Example URI
GET /irb/api/v1/protocol-person-mass-changes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"keyStudyPerson": "(val)",
"correspondents": "(val)",
"reviewer": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Person Mass ChangesGET/irb/api/v1/protocol-person-mass-changes/
Example URI
GET /irb/api/v1/protocol-person-mass-changes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"keyStudyPerson": "(val)",
"correspondents": "(val)",
"reviewer": "(val)",
"_primaryKey": "(val)"
},
{
"protocolPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"keyStudyPerson": "(val)",
"correspondents": "(val)",
"reviewer": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Person Mass Changes with FilteringGET/irb/api/v1/protocol-person-mass-changes/
Example URI
GET /irb/api/v1/protocol-person-mass-changes/
URI Parameters
- protocolPersonMassChangeId
string(optional)Protocol Person Mass Change Id. Maximum length is 12.
- personMassChangeId
string(optional)Person Mass Change Id. Maximum length is 12.
- investigator
string(optional)Investigator. Maximum length is 1.
- keyStudyPerson
string(optional)Key Study Person. Maximum length is 1.
- correspondents
string(optional)Correspondents. Maximum length is 1.
- reviewer
string(optional)Reviewer. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"keyStudyPerson": "(val)",
"correspondents": "(val)",
"reviewer": "(val)",
"_primaryKey": "(val)"
},
{
"protocolPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"keyStudyPerson": "(val)",
"correspondents": "(val)",
"reviewer": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Person Mass ChangesGET/irb/api/v1/protocol-person-mass-changes/
Example URI
GET /irb/api/v1/protocol-person-mass-changes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolPersonMassChangeId",
"personMassChangeId",
"investigator",
"keyStudyPerson",
"correspondents",
"reviewer"
],
"primaryKey": "protocolPersonMassChangeId"
}Get Blueprint API specification for Protocol Person Mass ChangesGET/irb/api/v1/protocol-person-mass-changes/
Example URI
GET /irb/api/v1/protocol-person-mass-changes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Person Mass Changes.md"
transfer-encoding: chunkedUpdate Protocol Person Mass ChangesPUT/irb/api/v1/protocol-person-mass-changes/(key)
Example URI
PUT /irb/api/v1/protocol-person-mass-changes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"keyStudyPerson": "(val)",
"correspondents": "(val)",
"reviewer": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Person Mass ChangesPUT/irb/api/v1/protocol-person-mass-changes/
Example URI
PUT /irb/api/v1/protocol-person-mass-changes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"keyStudyPerson": "(val)",
"correspondents": "(val)",
"reviewer": "(val)",
"_primaryKey": "(val)"
},
{
"protocolPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"keyStudyPerson": "(val)",
"correspondents": "(val)",
"reviewer": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Person Mass ChangesPATCH/irb/api/v1/protocol-person-mass-changes/(key)
Example URI
PATCH /irb/api/v1/protocol-person-mass-changes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"keyStudyPerson": "(val)",
"correspondents": "(val)",
"reviewer": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"keyStudyPerson": "(val)",
"correspondents": "(val)",
"reviewer": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Person Mass ChangesPOST/irb/api/v1/protocol-person-mass-changes/
Example URI
POST /irb/api/v1/protocol-person-mass-changes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"keyStudyPerson": "(val)",
"correspondents": "(val)",
"reviewer": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"keyStudyPerson": "(val)",
"correspondents": "(val)",
"reviewer": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Person Mass ChangesPOST/irb/api/v1/protocol-person-mass-changes/
Example URI
POST /irb/api/v1/protocol-person-mass-changes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"keyStudyPerson": "(val)",
"correspondents": "(val)",
"reviewer": "(val)",
"_primaryKey": "(val)"
},
{
"protocolPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"keyStudyPerson": "(val)",
"correspondents": "(val)",
"reviewer": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"keyStudyPerson": "(val)",
"correspondents": "(val)",
"reviewer": "(val)",
"_primaryKey": "(val)"
},
{
"protocolPersonMassChangeId": "(val)",
"personMassChangeId": "(val)",
"investigator": "(val)",
"keyStudyPerson": "(val)",
"correspondents": "(val)",
"reviewer": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Person Mass Changes by KeyDELETE/irb/api/v1/protocol-person-mass-changes/(key)
Example URI
DELETE /irb/api/v1/protocol-person-mass-changes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Person Mass ChangesDELETE/irb/api/v1/protocol-person-mass-changes/
Example URI
DELETE /irb/api/v1/protocol-person-mass-changes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Person Mass Changes with MatchingDELETE/irb/api/v1/protocol-person-mass-changes/
Example URI
DELETE /irb/api/v1/protocol-person-mass-changes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolPersonMassChangeId
string(optional)Protocol Person Mass Change Id. Maximum length is 12.
- personMassChangeId
string(optional)Person Mass Change Id. Maximum length is 12.
- investigator
string(optional)Investigator. Maximum length is 1.
- keyStudyPerson
string(optional)Key Study Person. Maximum length is 1.
- correspondents
string(optional)Correspondents. Maximum length is 1.
- reviewer
string(optional)Reviewer. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Person Role Mappings ¶
Get Protocol Person Role Mappings by KeyGET/irb/api/v1/protocol-person-role-mappings/(key)
Example URI
GET /irb/api/v1/protocol-person-role-mappings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"roleMappingId": "(val)",
"sourceRoleId": "(val)",
"targetRoleId": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Person Role MappingsGET/irb/api/v1/protocol-person-role-mappings/
Example URI
GET /irb/api/v1/protocol-person-role-mappings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"roleMappingId": "(val)",
"sourceRoleId": "(val)",
"targetRoleId": "(val)",
"_primaryKey": "(val)"
},
{
"roleMappingId": "(val)",
"sourceRoleId": "(val)",
"targetRoleId": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Person Role Mappings with FilteringGET/irb/api/v1/protocol-person-role-mappings/
Example URI
GET /irb/api/v1/protocol-person-role-mappings/
URI Parameters
- roleMappingId
string(optional)- sourceRoleId
string(optional)- targetRoleId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"roleMappingId": "(val)",
"sourceRoleId": "(val)",
"targetRoleId": "(val)",
"_primaryKey": "(val)"
},
{
"roleMappingId": "(val)",
"sourceRoleId": "(val)",
"targetRoleId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Person Role MappingsGET/irb/api/v1/protocol-person-role-mappings/
Example URI
GET /irb/api/v1/protocol-person-role-mappings/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"roleMappingId",
"sourceRoleId",
"targetRoleId"
],
"primaryKey": "roleMappingId"
}Get Blueprint API specification for Protocol Person Role MappingsGET/irb/api/v1/protocol-person-role-mappings/
Example URI
GET /irb/api/v1/protocol-person-role-mappings/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Person Role Mappings.md"
transfer-encoding: chunkedUpdate Protocol Person Role MappingsPUT/irb/api/v1/protocol-person-role-mappings/(key)
Example URI
PUT /irb/api/v1/protocol-person-role-mappings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"roleMappingId": "(val)",
"sourceRoleId": "(val)",
"targetRoleId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Person Role MappingsPUT/irb/api/v1/protocol-person-role-mappings/
Example URI
PUT /irb/api/v1/protocol-person-role-mappings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"roleMappingId": "(val)",
"sourceRoleId": "(val)",
"targetRoleId": "(val)",
"_primaryKey": "(val)"
},
{
"roleMappingId": "(val)",
"sourceRoleId": "(val)",
"targetRoleId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Person Role MappingsPATCH/irb/api/v1/protocol-person-role-mappings/(key)
Example URI
PATCH /irb/api/v1/protocol-person-role-mappings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"roleMappingId": "(val)",
"sourceRoleId": "(val)",
"targetRoleId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"roleMappingId": "(val)",
"sourceRoleId": "(val)",
"targetRoleId": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Person Role MappingsPOST/irb/api/v1/protocol-person-role-mappings/
Example URI
POST /irb/api/v1/protocol-person-role-mappings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"roleMappingId": "(val)",
"sourceRoleId": "(val)",
"targetRoleId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"roleMappingId": "(val)",
"sourceRoleId": "(val)",
"targetRoleId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Person Role MappingsPOST/irb/api/v1/protocol-person-role-mappings/
Example URI
POST /irb/api/v1/protocol-person-role-mappings/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"roleMappingId": "(val)",
"sourceRoleId": "(val)",
"targetRoleId": "(val)",
"_primaryKey": "(val)"
},
{
"roleMappingId": "(val)",
"sourceRoleId": "(val)",
"targetRoleId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"roleMappingId": "(val)",
"sourceRoleId": "(val)",
"targetRoleId": "(val)",
"_primaryKey": "(val)"
},
{
"roleMappingId": "(val)",
"sourceRoleId": "(val)",
"targetRoleId": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Person Role Mappings by KeyDELETE/irb/api/v1/protocol-person-role-mappings/(key)
Example URI
DELETE /irb/api/v1/protocol-person-role-mappings/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Person Role MappingsDELETE/irb/api/v1/protocol-person-role-mappings/
Example URI
DELETE /irb/api/v1/protocol-person-role-mappings/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Person Role Mappings with MatchingDELETE/irb/api/v1/protocol-person-role-mappings/
Example URI
DELETE /irb/api/v1/protocol-person-role-mappings/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- roleMappingId
string(optional)- sourceRoleId
string(optional)- targetRoleId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Person Roles ¶
Get Protocol Person Roles by KeyGET/irb/api/v1/protocol-person-roles/(key)
Example URI
GET /irb/api/v1/protocol-person-roles/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolPersonRoleId": "(val)",
"description": "(val)",
"unitDetailsRequired": "(val)",
"affiliationDetailsRequired": "(val)",
"trainingDetailsRequired": "(val)",
"commentsDetailsRequired": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Person RolesGET/irb/api/v1/protocol-person-roles/
Example URI
GET /irb/api/v1/protocol-person-roles/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolPersonRoleId": "(val)",
"description": "(val)",
"unitDetailsRequired": "(val)",
"affiliationDetailsRequired": "(val)",
"trainingDetailsRequired": "(val)",
"commentsDetailsRequired": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"protocolPersonRoleId": "(val)",
"description": "(val)",
"unitDetailsRequired": "(val)",
"affiliationDetailsRequired": "(val)",
"trainingDetailsRequired": "(val)",
"commentsDetailsRequired": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Person Roles with FilteringGET/irb/api/v1/protocol-person-roles/
Example URI
GET /irb/api/v1/protocol-person-roles/
URI Parameters
- protocolPersonRoleId
string(optional)Protocol Person Role Id. Maximum length is 12.
- description
string(optional)Description. Maximum length is 250.
- unitDetailsRequired
string(optional)Unit Details Required. Maximum length is 1.
- affiliationDetailsRequired
string(optional)Affiliation Details Required. Maximum length is 1.
- trainingDetailsRequired
string(optional)Training Details Required. Maximum length is 1.
- commentsDetailsRequired
string(optional)Comments Details Required. Maximum length is 1.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolPersonRoleId": "(val)",
"description": "(val)",
"unitDetailsRequired": "(val)",
"affiliationDetailsRequired": "(val)",
"trainingDetailsRequired": "(val)",
"commentsDetailsRequired": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"protocolPersonRoleId": "(val)",
"description": "(val)",
"unitDetailsRequired": "(val)",
"affiliationDetailsRequired": "(val)",
"trainingDetailsRequired": "(val)",
"commentsDetailsRequired": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Person RolesGET/irb/api/v1/protocol-person-roles/
Example URI
GET /irb/api/v1/protocol-person-roles/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolPersonRoleId",
"description",
"unitDetailsRequired",
"affiliationDetailsRequired",
"trainingDetailsRequired",
"commentsDetailsRequired",
"active"
],
"primaryKey": "protocolPersonRoleId"
}Get Blueprint API specification for Protocol Person RolesGET/irb/api/v1/protocol-person-roles/
Example URI
GET /irb/api/v1/protocol-person-roles/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Person Roles.md"
transfer-encoding: chunkedUpdate Protocol Person RolesPUT/irb/api/v1/protocol-person-roles/(key)
Example URI
PUT /irb/api/v1/protocol-person-roles/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolPersonRoleId": "(val)",
"description": "(val)",
"unitDetailsRequired": "(val)",
"affiliationDetailsRequired": "(val)",
"trainingDetailsRequired": "(val)",
"commentsDetailsRequired": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Person RolesPUT/irb/api/v1/protocol-person-roles/
Example URI
PUT /irb/api/v1/protocol-person-roles/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolPersonRoleId": "(val)",
"description": "(val)",
"unitDetailsRequired": "(val)",
"affiliationDetailsRequired": "(val)",
"trainingDetailsRequired": "(val)",
"commentsDetailsRequired": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"protocolPersonRoleId": "(val)",
"description": "(val)",
"unitDetailsRequired": "(val)",
"affiliationDetailsRequired": "(val)",
"trainingDetailsRequired": "(val)",
"commentsDetailsRequired": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Person RolesPATCH/irb/api/v1/protocol-person-roles/(key)
Example URI
PATCH /irb/api/v1/protocol-person-roles/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolPersonRoleId": "(val)",
"description": "(val)",
"unitDetailsRequired": "(val)",
"affiliationDetailsRequired": "(val)",
"trainingDetailsRequired": "(val)",
"commentsDetailsRequired": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolPersonRoleId": "(val)",
"description": "(val)",
"unitDetailsRequired": "(val)",
"affiliationDetailsRequired": "(val)",
"trainingDetailsRequired": "(val)",
"commentsDetailsRequired": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Person RolesPOST/irb/api/v1/protocol-person-roles/
Example URI
POST /irb/api/v1/protocol-person-roles/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolPersonRoleId": "(val)",
"description": "(val)",
"unitDetailsRequired": "(val)",
"affiliationDetailsRequired": "(val)",
"trainingDetailsRequired": "(val)",
"commentsDetailsRequired": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolPersonRoleId": "(val)",
"description": "(val)",
"unitDetailsRequired": "(val)",
"affiliationDetailsRequired": "(val)",
"trainingDetailsRequired": "(val)",
"commentsDetailsRequired": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Person RolesPOST/irb/api/v1/protocol-person-roles/
Example URI
POST /irb/api/v1/protocol-person-roles/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolPersonRoleId": "(val)",
"description": "(val)",
"unitDetailsRequired": "(val)",
"affiliationDetailsRequired": "(val)",
"trainingDetailsRequired": "(val)",
"commentsDetailsRequired": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"protocolPersonRoleId": "(val)",
"description": "(val)",
"unitDetailsRequired": "(val)",
"affiliationDetailsRequired": "(val)",
"trainingDetailsRequired": "(val)",
"commentsDetailsRequired": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolPersonRoleId": "(val)",
"description": "(val)",
"unitDetailsRequired": "(val)",
"affiliationDetailsRequired": "(val)",
"trainingDetailsRequired": "(val)",
"commentsDetailsRequired": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"protocolPersonRoleId": "(val)",
"description": "(val)",
"unitDetailsRequired": "(val)",
"affiliationDetailsRequired": "(val)",
"trainingDetailsRequired": "(val)",
"commentsDetailsRequired": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Person Roles by KeyDELETE/irb/api/v1/protocol-person-roles/(key)
Example URI
DELETE /irb/api/v1/protocol-person-roles/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Person RolesDELETE/irb/api/v1/protocol-person-roles/
Example URI
DELETE /irb/api/v1/protocol-person-roles/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Person Roles with MatchingDELETE/irb/api/v1/protocol-person-roles/
Example URI
DELETE /irb/api/v1/protocol-person-roles/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolPersonRoleId
string(optional)Protocol Person Role Id. Maximum length is 12.
- description
string(optional)Description. Maximum length is 250.
- unitDetailsRequired
string(optional)Unit Details Required. Maximum length is 1.
- affiliationDetailsRequired
string(optional)Affiliation Details Required. Maximum length is 1.
- trainingDetailsRequired
string(optional)Training Details Required. Maximum length is 1.
- commentsDetailsRequired
string(optional)Comments Details Required. Maximum length is 1.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Person Rolodexes ¶
Get Protocol Person Rolodexes by KeyGET/irb/api/v1/protocol-person-rolodexes/(key)
Example URI
GET /irb/api/v1/protocol-person-rolodexes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Person RolodexesGET/irb/api/v1/protocol-person-rolodexes/
Example URI
GET /irb/api/v1/protocol-person-rolodexes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
},
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Person Rolodexes with FilteringGET/irb/api/v1/protocol-person-rolodexes/
Example URI
GET /irb/api/v1/protocol-person-rolodexes/
URI Parameters
- rolodexId
string(optional)- addressLine1
string(optional)- addressLine2
string(optional)- addressLine3
string(optional)- city
string(optional)- comments
string(optional)- countryCode
string(optional)- county
string(optional)- createUser
string(optional)- deleteFlag
string(optional)- emailAddress
string(optional)- faxNumber
string(optional)- firstName
string(optional)- lastName
string(optional)- middleName
string(optional)- organization
string(optional)- ownedByUnit
string(optional)- phoneNumber
string(optional)- postalCode
string(optional)- prefix
string(optional)- sponsorAddressFlag
string(optional)- sponsorCode
string(optional)- state
string(optional)- suffix
string(optional)- title
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
},
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Person RolodexesGET/irb/api/v1/protocol-person-rolodexes/
Example URI
GET /irb/api/v1/protocol-person-rolodexes/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"rolodexId",
"addressLine1",
"addressLine2",
"addressLine3",
"city",
"comments",
"countryCode",
"county",
"createUser",
"deleteFlag",
"emailAddress",
"faxNumber",
"firstName",
"lastName",
"middleName",
"organization",
"ownedByUnit",
"phoneNumber",
"postalCode",
"prefix",
"sponsorAddressFlag",
"sponsorCode",
"state",
"suffix",
"title"
],
"primaryKey": "rolodexId"
}Get Blueprint API specification for Protocol Person RolodexesGET/irb/api/v1/protocol-person-rolodexes/
Example URI
GET /irb/api/v1/protocol-person-rolodexes/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Person Rolodexes.md"
transfer-encoding: chunkedUpdate Protocol Person RolodexesPUT/irb/api/v1/protocol-person-rolodexes/(key)
Example URI
PUT /irb/api/v1/protocol-person-rolodexes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Person RolodexesPUT/irb/api/v1/protocol-person-rolodexes/
Example URI
PUT /irb/api/v1/protocol-person-rolodexes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
},
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Person RolodexesPATCH/irb/api/v1/protocol-person-rolodexes/(key)
Example URI
PATCH /irb/api/v1/protocol-person-rolodexes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Person RolodexesPOST/irb/api/v1/protocol-person-rolodexes/
Example URI
POST /irb/api/v1/protocol-person-rolodexes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Person RolodexesPOST/irb/api/v1/protocol-person-rolodexes/
Example URI
POST /irb/api/v1/protocol-person-rolodexes/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
},
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
},
{
"rolodexId": "(val)",
"addressLine1": "(val)",
"addressLine2": "(val)",
"addressLine3": "(val)",
"city": "(val)",
"comments": "(val)",
"countryCode": "(val)",
"county": "(val)",
"createUser": "(val)",
"deleteFlag": "(val)",
"emailAddress": "(val)",
"faxNumber": "(val)",
"firstName": "(val)",
"lastName": "(val)",
"middleName": "(val)",
"organization": "(val)",
"ownedByUnit": "(val)",
"phoneNumber": "(val)",
"postalCode": "(val)",
"prefix": "(val)",
"sponsorAddressFlag": "(val)",
"sponsorCode": "(val)",
"state": "(val)",
"suffix": "(val)",
"title": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Person Rolodexes by KeyDELETE/irb/api/v1/protocol-person-rolodexes/(key)
Example URI
DELETE /irb/api/v1/protocol-person-rolodexes/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Person RolodexesDELETE/irb/api/v1/protocol-person-rolodexes/
Example URI
DELETE /irb/api/v1/protocol-person-rolodexes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Person Rolodexes with MatchingDELETE/irb/api/v1/protocol-person-rolodexes/
Example URI
DELETE /irb/api/v1/protocol-person-rolodexes/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- rolodexId
string(optional)- addressLine1
string(optional)- addressLine2
string(optional)- addressLine3
string(optional)- city
string(optional)- comments
string(optional)- countryCode
string(optional)- county
string(optional)- createUser
string(optional)- deleteFlag
string(optional)- emailAddress
string(optional)- faxNumber
string(optional)- firstName
string(optional)- lastName
string(optional)- middleName
string(optional)- organization
string(optional)- ownedByUnit
string(optional)- phoneNumber
string(optional)- postalCode
string(optional)- prefix
string(optional)- sponsorAddressFlag
string(optional)- sponsorCode
string(optional)- state
string(optional)- suffix
string(optional)- title
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Personnel Attachments ¶
Get Protocol Personnel Attachments by KeyGET/irb/api/v1/protocol-personnel-attachments/(key)
Example URI
GET /irb/api/v1/protocol-personnel-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Personnel AttachmentsGET/irb/api/v1/protocol-personnel-attachments/
Example URI
GET /irb/api/v1/protocol-personnel-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Personnel Attachments with FilteringGET/irb/api/v1/protocol-personnel-attachments/
Example URI
GET /irb/api/v1/protocol-personnel-attachments/
URI Parameters
- id
string(optional)Attachment Id. Maximum length is 12.
- protocolId
string(optional)- protocolNumber
string(optional)- sequenceNumber
string(optional)Sequence Number. Maximum length is 4.
- typeCode
string(optional)Attachment Type. Maximum length is 3.
- documentId
string(optional)Document Id. Maximum length is 4.
- fileId
string(optional)File Name. Maximum length is 12.
- description
string(optional)Description. Maximum length is 200.
- personId
string(optional)Person. Maximum length is 12.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Personnel AttachmentsGET/irb/api/v1/protocol-personnel-attachments/
Example URI
GET /irb/api/v1/protocol-personnel-attachments/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"id",
"protocolId",
"protocolNumber",
"sequenceNumber",
"typeCode",
"documentId",
"fileId",
"description",
"personId"
],
"primaryKey": "id"
}Get Blueprint API specification for Protocol Personnel AttachmentsGET/irb/api/v1/protocol-personnel-attachments/
Example URI
GET /irb/api/v1/protocol-personnel-attachments/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Personnel Attachments.md"
transfer-encoding: chunkedUpdate Protocol Personnel AttachmentsPUT/irb/api/v1/protocol-personnel-attachments/(key)
Example URI
PUT /irb/api/v1/protocol-personnel-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Personnel AttachmentsPUT/irb/api/v1/protocol-personnel-attachments/
Example URI
PUT /irb/api/v1/protocol-personnel-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Personnel AttachmentsPATCH/irb/api/v1/protocol-personnel-attachments/(key)
Example URI
PATCH /irb/api/v1/protocol-personnel-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Personnel AttachmentsPOST/irb/api/v1/protocol-personnel-attachments/
Example URI
POST /irb/api/v1/protocol-personnel-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Personnel AttachmentsPOST/irb/api/v1/protocol-personnel-attachments/
Example URI
POST /irb/api/v1/protocol-personnel-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
},
{
"id": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"typeCode": "(val)",
"documentId": "(val)",
"fileId": "(val)",
"description": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Personnel Attachments by KeyDELETE/irb/api/v1/protocol-personnel-attachments/(key)
Example URI
DELETE /irb/api/v1/protocol-personnel-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Personnel AttachmentsDELETE/irb/api/v1/protocol-personnel-attachments/
Example URI
DELETE /irb/api/v1/protocol-personnel-attachments/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Personnel Attachments with MatchingDELETE/irb/api/v1/protocol-personnel-attachments/
Example URI
DELETE /irb/api/v1/protocol-personnel-attachments/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- id
string(optional)Attachment Id. Maximum length is 12.
- protocolId
string(optional)- protocolNumber
string(optional)- sequenceNumber
string(optional)Sequence Number. Maximum length is 4.
- typeCode
string(optional)Attachment Type. Maximum length is 3.
- documentId
string(optional)Document Id. Maximum length is 4.
- fileId
string(optional)File Name. Maximum length is 12.
- description
string(optional)Description. Maximum length is 200.
- personId
string(optional)Person. Maximum length is 12.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Reference Types ¶
Get Protocol Reference Types by KeyGET/irb/api/v1/protocol-reference-types/(key)
Example URI
GET /irb/api/v1/protocol-reference-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolReferenceTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Reference TypesGET/irb/api/v1/protocol-reference-types/
Example URI
GET /irb/api/v1/protocol-reference-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolReferenceTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"protocolReferenceTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Reference Types with FilteringGET/irb/api/v1/protocol-reference-types/
Example URI
GET /irb/api/v1/protocol-reference-types/
URI Parameters
- protocolReferenceTypeCode
string(optional)Protocol Reference Type Code. Maximum length is 22.
- description
string(optional)Description. Maximum length is 300.
- active
string(optional)Is Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolReferenceTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"protocolReferenceTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Reference TypesGET/irb/api/v1/protocol-reference-types/
Example URI
GET /irb/api/v1/protocol-reference-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolReferenceTypeCode",
"description",
"active"
],
"primaryKey": "protocolReferenceTypeCode"
}Get Blueprint API specification for Protocol Reference TypesGET/irb/api/v1/protocol-reference-types/
Example URI
GET /irb/api/v1/protocol-reference-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Reference Types.md"
transfer-encoding: chunkedUpdate Protocol Reference TypesPUT/irb/api/v1/protocol-reference-types/(key)
Example URI
PUT /irb/api/v1/protocol-reference-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolReferenceTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Reference TypesPUT/irb/api/v1/protocol-reference-types/
Example URI
PUT /irb/api/v1/protocol-reference-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolReferenceTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"protocolReferenceTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Reference TypesPATCH/irb/api/v1/protocol-reference-types/(key)
Example URI
PATCH /irb/api/v1/protocol-reference-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolReferenceTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolReferenceTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Reference TypesPOST/irb/api/v1/protocol-reference-types/
Example URI
POST /irb/api/v1/protocol-reference-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolReferenceTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolReferenceTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Reference TypesPOST/irb/api/v1/protocol-reference-types/
Example URI
POST /irb/api/v1/protocol-reference-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolReferenceTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"protocolReferenceTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolReferenceTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"protocolReferenceTypeCode": "(val)",
"description": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Reference Types by KeyDELETE/irb/api/v1/protocol-reference-types/(key)
Example URI
DELETE /irb/api/v1/protocol-reference-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Reference TypesDELETE/irb/api/v1/protocol-reference-types/
Example URI
DELETE /irb/api/v1/protocol-reference-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Reference Types with MatchingDELETE/irb/api/v1/protocol-reference-types/
Example URI
DELETE /irb/api/v1/protocol-reference-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolReferenceTypeCode
string(optional)Protocol Reference Type Code. Maximum length is 22.
- description
string(optional)Description. Maximum length is 300.
- active
string(optional)Is Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol References ¶
Get Protocol References by KeyGET/irb/api/v1/protocol-references/(key)
Example URI
GET /irb/api/v1/protocol-references/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolReferenceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolReferenceNumber": "(val)",
"protocolReferenceTypeCode": "(val)",
"referenceKey": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}Get All Protocol ReferencesGET/irb/api/v1/protocol-references/
Example URI
GET /irb/api/v1/protocol-references/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolReferenceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolReferenceNumber": "(val)",
"protocolReferenceTypeCode": "(val)",
"referenceKey": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
},
{
"protocolReferenceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolReferenceNumber": "(val)",
"protocolReferenceTypeCode": "(val)",
"referenceKey": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol References with FilteringGET/irb/api/v1/protocol-references/
Example URI
GET /irb/api/v1/protocol-references/
URI Parameters
- protocolReferenceId
string(optional)Protocol Reference Id. Maximum length is 22.
- protocolId
string(optional)Protocol Id. Maximum length is 22.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22.
- protocolReferenceNumber
string(optional)Protocol Reference Number. Maximum length is 22.
- protocolReferenceTypeCode
string(optional)Protocol Reference Type Code. Maximum length is 3.
- referenceKey
string(optional)Reference Key. Maximum length is 50.
- applicationDate
string(optional)Application Date. Maximum length is 10.
- approvalDate
string(optional)Approval Date. Maximum length is 10.
- comments
string(optional)Comments. Maximum length is 400.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolReferenceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolReferenceNumber": "(val)",
"protocolReferenceTypeCode": "(val)",
"referenceKey": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
},
{
"protocolReferenceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolReferenceNumber": "(val)",
"protocolReferenceTypeCode": "(val)",
"referenceKey": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol ReferencesGET/irb/api/v1/protocol-references/
Example URI
GET /irb/api/v1/protocol-references/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolReferenceId",
"protocolId",
"protocolNumber",
"sequenceNumber",
"protocolReferenceNumber",
"protocolReferenceTypeCode",
"referenceKey",
"applicationDate",
"approvalDate",
"comments"
],
"primaryKey": "protocolReferenceId"
}Get Blueprint API specification for Protocol ReferencesGET/irb/api/v1/protocol-references/
Example URI
GET /irb/api/v1/protocol-references/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol References.md"
transfer-encoding: chunkedUpdate Protocol ReferencesPUT/irb/api/v1/protocol-references/(key)
Example URI
PUT /irb/api/v1/protocol-references/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolReferenceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolReferenceNumber": "(val)",
"protocolReferenceTypeCode": "(val)",
"referenceKey": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol ReferencesPUT/irb/api/v1/protocol-references/
Example URI
PUT /irb/api/v1/protocol-references/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolReferenceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolReferenceNumber": "(val)",
"protocolReferenceTypeCode": "(val)",
"referenceKey": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
},
{
"protocolReferenceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolReferenceNumber": "(val)",
"protocolReferenceTypeCode": "(val)",
"referenceKey": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol ReferencesPATCH/irb/api/v1/protocol-references/(key)
Example URI
PATCH /irb/api/v1/protocol-references/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolReferenceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolReferenceNumber": "(val)",
"protocolReferenceTypeCode": "(val)",
"referenceKey": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolReferenceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolReferenceNumber": "(val)",
"protocolReferenceTypeCode": "(val)",
"referenceKey": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}Insert Protocol ReferencesPOST/irb/api/v1/protocol-references/
Example URI
POST /irb/api/v1/protocol-references/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolReferenceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolReferenceNumber": "(val)",
"protocolReferenceTypeCode": "(val)",
"referenceKey": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolReferenceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolReferenceNumber": "(val)",
"protocolReferenceTypeCode": "(val)",
"referenceKey": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol ReferencesPOST/irb/api/v1/protocol-references/
Example URI
POST /irb/api/v1/protocol-references/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolReferenceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolReferenceNumber": "(val)",
"protocolReferenceTypeCode": "(val)",
"referenceKey": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
},
{
"protocolReferenceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolReferenceNumber": "(val)",
"protocolReferenceTypeCode": "(val)",
"referenceKey": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolReferenceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolReferenceNumber": "(val)",
"protocolReferenceTypeCode": "(val)",
"referenceKey": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
},
{
"protocolReferenceId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"protocolReferenceNumber": "(val)",
"protocolReferenceTypeCode": "(val)",
"referenceKey": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"comments": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol References by KeyDELETE/irb/api/v1/protocol-references/(key)
Example URI
DELETE /irb/api/v1/protocol-references/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol ReferencesDELETE/irb/api/v1/protocol-references/
Example URI
DELETE /irb/api/v1/protocol-references/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol References with MatchingDELETE/irb/api/v1/protocol-references/
Example URI
DELETE /irb/api/v1/protocol-references/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolReferenceId
string(optional)Protocol Reference Id. Maximum length is 22.
- protocolId
string(optional)Protocol Id. Maximum length is 22.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22.
- protocolReferenceNumber
string(optional)Protocol Reference Number. Maximum length is 22.
- protocolReferenceTypeCode
string(optional)Protocol Reference Type Code. Maximum length is 3.
- referenceKey
string(optional)Reference Key. Maximum length is 50.
- applicationDate
string(optional)Application Date. Maximum length is 10.
- approvalDate
string(optional)Approval Date. Maximum length is 10.
- comments
string(optional)Comments. Maximum length is 400.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Review Attachments ¶
Get Protocol Review Attachments by KeyGET/irb/api/v1/protocol-review-attachments/(key)
Example URI
GET /irb/api/v1/protocol-review-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"reviewerAttachmentId": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"attachmentId": "(val)",
"description": "(val)",
"fileId": "(val)",
"personId": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"privateFlag": "(val)",
"protocolPersonCanView": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Review AttachmentsGET/irb/api/v1/protocol-review-attachments/
Example URI
GET /irb/api/v1/protocol-review-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"reviewerAttachmentId": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"attachmentId": "(val)",
"description": "(val)",
"fileId": "(val)",
"personId": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"privateFlag": "(val)",
"protocolPersonCanView": "(val)",
"_primaryKey": "(val)"
},
{
"reviewerAttachmentId": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"attachmentId": "(val)",
"description": "(val)",
"fileId": "(val)",
"personId": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"privateFlag": "(val)",
"protocolPersonCanView": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Review Attachments with FilteringGET/irb/api/v1/protocol-review-attachments/
Example URI
GET /irb/api/v1/protocol-review-attachments/
URI Parameters
- reviewerAttachmentId
string(optional)Id. Maximum length is 10.
- protocolOnlineReviewIdFk
string(optional)Id. Maximum length is 10.
- protocolIdFk
string(optional)Protocol Id Fk. Maximum length is 12.
- submissionIdFk
string(optional)Submission Id Fk. Maximum length is 12.
- attachmentId
string(optional)- description
string(optional)Description. Maximum length is 200.
- fileId
string(optional)File Name. Maximum length is 12.
- personId
string(optional)Person Id. Maximum length is 40.
- createUser
string(optional)Create User. Maximum length is 80.
- createTimestamp
string(optional)Created Time. Maximum length is 21.
- privateFlag
string(optional)Private Attachment Flag. Maximum length is 1.
- protocolPersonCanView
string(optional)Protocol personnel can view Flag. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"reviewerAttachmentId": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"attachmentId": "(val)",
"description": "(val)",
"fileId": "(val)",
"personId": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"privateFlag": "(val)",
"protocolPersonCanView": "(val)",
"_primaryKey": "(val)"
},
{
"reviewerAttachmentId": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"attachmentId": "(val)",
"description": "(val)",
"fileId": "(val)",
"personId": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"privateFlag": "(val)",
"protocolPersonCanView": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Review AttachmentsGET/irb/api/v1/protocol-review-attachments/
Example URI
GET /irb/api/v1/protocol-review-attachments/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"reviewerAttachmentId",
"protocolOnlineReviewIdFk",
"protocolIdFk",
"submissionIdFk",
"attachmentId",
"description",
"fileId",
"personId",
"createUser",
"createTimestamp",
"privateFlag",
"protocolPersonCanView"
],
"primaryKey": "reviewerAttachmentId"
}Get Blueprint API specification for Protocol Review AttachmentsGET/irb/api/v1/protocol-review-attachments/
Example URI
GET /irb/api/v1/protocol-review-attachments/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Review Attachments.md"
transfer-encoding: chunkedUpdate Protocol Review AttachmentsPUT/irb/api/v1/protocol-review-attachments/(key)
Example URI
PUT /irb/api/v1/protocol-review-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"reviewerAttachmentId": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"attachmentId": "(val)",
"description": "(val)",
"fileId": "(val)",
"personId": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"privateFlag": "(val)",
"protocolPersonCanView": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Review AttachmentsPUT/irb/api/v1/protocol-review-attachments/
Example URI
PUT /irb/api/v1/protocol-review-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"reviewerAttachmentId": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"attachmentId": "(val)",
"description": "(val)",
"fileId": "(val)",
"personId": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"privateFlag": "(val)",
"protocolPersonCanView": "(val)",
"_primaryKey": "(val)"
},
{
"reviewerAttachmentId": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"attachmentId": "(val)",
"description": "(val)",
"fileId": "(val)",
"personId": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"privateFlag": "(val)",
"protocolPersonCanView": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Review AttachmentsPATCH/irb/api/v1/protocol-review-attachments/(key)
Example URI
PATCH /irb/api/v1/protocol-review-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"reviewerAttachmentId": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"attachmentId": "(val)",
"description": "(val)",
"fileId": "(val)",
"personId": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"privateFlag": "(val)",
"protocolPersonCanView": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"reviewerAttachmentId": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"attachmentId": "(val)",
"description": "(val)",
"fileId": "(val)",
"personId": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"privateFlag": "(val)",
"protocolPersonCanView": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Review AttachmentsPOST/irb/api/v1/protocol-review-attachments/
Example URI
POST /irb/api/v1/protocol-review-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"reviewerAttachmentId": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"attachmentId": "(val)",
"description": "(val)",
"fileId": "(val)",
"personId": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"privateFlag": "(val)",
"protocolPersonCanView": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"reviewerAttachmentId": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"attachmentId": "(val)",
"description": "(val)",
"fileId": "(val)",
"personId": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"privateFlag": "(val)",
"protocolPersonCanView": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Review AttachmentsPOST/irb/api/v1/protocol-review-attachments/
Example URI
POST /irb/api/v1/protocol-review-attachments/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"reviewerAttachmentId": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"attachmentId": "(val)",
"description": "(val)",
"fileId": "(val)",
"personId": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"privateFlag": "(val)",
"protocolPersonCanView": "(val)",
"_primaryKey": "(val)"
},
{
"reviewerAttachmentId": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"attachmentId": "(val)",
"description": "(val)",
"fileId": "(val)",
"personId": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"privateFlag": "(val)",
"protocolPersonCanView": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"reviewerAttachmentId": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"attachmentId": "(val)",
"description": "(val)",
"fileId": "(val)",
"personId": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"privateFlag": "(val)",
"protocolPersonCanView": "(val)",
"_primaryKey": "(val)"
},
{
"reviewerAttachmentId": "(val)",
"protocolOnlineReviewIdFk": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"attachmentId": "(val)",
"description": "(val)",
"fileId": "(val)",
"personId": "(val)",
"createUser": "(val)",
"createTimestamp": "(val)",
"privateFlag": "(val)",
"protocolPersonCanView": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Review Attachments by KeyDELETE/irb/api/v1/protocol-review-attachments/(key)
Example URI
DELETE /irb/api/v1/protocol-review-attachments/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Review AttachmentsDELETE/irb/api/v1/protocol-review-attachments/
Example URI
DELETE /irb/api/v1/protocol-review-attachments/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Review Attachments with MatchingDELETE/irb/api/v1/protocol-review-attachments/
Example URI
DELETE /irb/api/v1/protocol-review-attachments/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- reviewerAttachmentId
string(optional)Id. Maximum length is 10.
- protocolOnlineReviewIdFk
string(optional)Id. Maximum length is 10.
- protocolIdFk
string(optional)Protocol Id Fk. Maximum length is 12.
- submissionIdFk
string(optional)Submission Id Fk. Maximum length is 12.
- attachmentId
string(optional)- description
string(optional)Description. Maximum length is 200.
- fileId
string(optional)File Name. Maximum length is 12.
- personId
string(optional)Person Id. Maximum length is 40.
- createUser
string(optional)Create User. Maximum length is 80.
- createTimestamp
string(optional)Created Time. Maximum length is 21.
- privateFlag
string(optional)Private Attachment Flag. Maximum length is 1.
- protocolPersonCanView
string(optional)Protocol personnel can view Flag. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Review Types ¶
Get Protocol Review Types by KeyGET/irb/api/v1/protocol-review-types/(key)
Example URI
GET /irb/api/v1/protocol-review-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"reviewTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Review TypesGET/irb/api/v1/protocol-review-types/
Example URI
GET /irb/api/v1/protocol-review-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"reviewTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
},
{
"reviewTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Review Types with FilteringGET/irb/api/v1/protocol-review-types/
Example URI
GET /irb/api/v1/protocol-review-types/
URI Parameters
- reviewTypeCode
string(optional)Protocol Review Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- globalFlag
string(optional)Global Flag. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"reviewTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
},
{
"reviewTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Review TypesGET/irb/api/v1/protocol-review-types/
Example URI
GET /irb/api/v1/protocol-review-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"reviewTypeCode",
"description",
"globalFlag"
],
"primaryKey": "reviewTypeCode"
}Get Blueprint API specification for Protocol Review TypesGET/irb/api/v1/protocol-review-types/
Example URI
GET /irb/api/v1/protocol-review-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Review Types.md"
transfer-encoding: chunkedUpdate Protocol Review TypesPUT/irb/api/v1/protocol-review-types/(key)
Example URI
PUT /irb/api/v1/protocol-review-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"reviewTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Review TypesPUT/irb/api/v1/protocol-review-types/
Example URI
PUT /irb/api/v1/protocol-review-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"reviewTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
},
{
"reviewTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Review TypesPATCH/irb/api/v1/protocol-review-types/(key)
Example URI
PATCH /irb/api/v1/protocol-review-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"reviewTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"reviewTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Review TypesPOST/irb/api/v1/protocol-review-types/
Example URI
POST /irb/api/v1/protocol-review-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"reviewTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"reviewTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Review TypesPOST/irb/api/v1/protocol-review-types/
Example URI
POST /irb/api/v1/protocol-review-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"reviewTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
},
{
"reviewTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"reviewTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
},
{
"reviewTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Review Types by KeyDELETE/irb/api/v1/protocol-review-types/(key)
Example URI
DELETE /irb/api/v1/protocol-review-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Review TypesDELETE/irb/api/v1/protocol-review-types/
Example URI
DELETE /irb/api/v1/protocol-review-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Review Types with MatchingDELETE/irb/api/v1/protocol-review-types/
Example URI
DELETE /irb/api/v1/protocol-review-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- reviewTypeCode
string(optional)Protocol Review Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
- globalFlag
string(optional)Global Flag. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Reviewer Types ¶
Get Protocol Reviewer Types by KeyGET/irb/api/v1/protocol-reviewer-types/(key)
Example URI
GET /irb/api/v1/protocol-reviewer-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"reviewerTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Reviewer TypesGET/irb/api/v1/protocol-reviewer-types/
Example URI
GET /irb/api/v1/protocol-reviewer-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"reviewerTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"reviewerTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Reviewer Types with FilteringGET/irb/api/v1/protocol-reviewer-types/
Example URI
GET /irb/api/v1/protocol-reviewer-types/
URI Parameters
- reviewerTypeCode
string(optional)Reviewer Type. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"reviewerTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"reviewerTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Reviewer TypesGET/irb/api/v1/protocol-reviewer-types/
Example URI
GET /irb/api/v1/protocol-reviewer-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"reviewerTypeCode",
"description"
],
"primaryKey": "reviewerTypeCode"
}Get Blueprint API specification for Protocol Reviewer TypesGET/irb/api/v1/protocol-reviewer-types/
Example URI
GET /irb/api/v1/protocol-reviewer-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Reviewer Types.md"
transfer-encoding: chunkedUpdate Protocol Reviewer TypesPUT/irb/api/v1/protocol-reviewer-types/(key)
Example URI
PUT /irb/api/v1/protocol-reviewer-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"reviewerTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Reviewer TypesPUT/irb/api/v1/protocol-reviewer-types/
Example URI
PUT /irb/api/v1/protocol-reviewer-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"reviewerTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"reviewerTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Reviewer TypesPATCH/irb/api/v1/protocol-reviewer-types/(key)
Example URI
PATCH /irb/api/v1/protocol-reviewer-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"reviewerTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"reviewerTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Reviewer TypesPOST/irb/api/v1/protocol-reviewer-types/
Example URI
POST /irb/api/v1/protocol-reviewer-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"reviewerTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"reviewerTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Reviewer TypesPOST/irb/api/v1/protocol-reviewer-types/
Example URI
POST /irb/api/v1/protocol-reviewer-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"reviewerTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"reviewerTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"reviewerTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"reviewerTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Reviewer Types by KeyDELETE/irb/api/v1/protocol-reviewer-types/(key)
Example URI
DELETE /irb/api/v1/protocol-reviewer-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Reviewer TypesDELETE/irb/api/v1/protocol-reviewer-types/
Example URI
DELETE /irb/api/v1/protocol-reviewer-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Reviewer Types with MatchingDELETE/irb/api/v1/protocol-reviewer-types/
Example URI
DELETE /irb/api/v1/protocol-reviewer-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- reviewerTypeCode
string(optional)Reviewer Type. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Reviewers ¶
Get Protocol Reviewers by KeyGET/irb/api/v1/protocol-reviewers/(key)
Example URI
GET /irb/api/v1/protocol-reviewers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolReviewerId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"submissionNumber": "(val)",
"reviewerTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"_primaryKey": "(val)"
}Get All Protocol ReviewersGET/irb/api/v1/protocol-reviewers/
Example URI
GET /irb/api/v1/protocol-reviewers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolReviewerId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"submissionNumber": "(val)",
"reviewerTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"_primaryKey": "(val)"
},
{
"protocolReviewerId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"submissionNumber": "(val)",
"reviewerTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Reviewers with FilteringGET/irb/api/v1/protocol-reviewers/
Example URI
GET /irb/api/v1/protocol-reviewers/
URI Parameters
- protocolReviewerId
string(optional)- protocolIdFk
string(optional)- submissionIdFk
string(optional)- protocolNumber
string(optional)- sequenceNumber
string(optional)- rolodexId
string(optional)- submissionNumber
string(optional)- reviewerTypeCode
string(optional)- personId
string(optional)- nonEmployeeFlag
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolReviewerId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"submissionNumber": "(val)",
"reviewerTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"_primaryKey": "(val)"
},
{
"protocolReviewerId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"submissionNumber": "(val)",
"reviewerTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol ReviewersGET/irb/api/v1/protocol-reviewers/
Example URI
GET /irb/api/v1/protocol-reviewers/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolReviewerId",
"protocolIdFk",
"submissionIdFk",
"protocolNumber",
"sequenceNumber",
"rolodexId",
"submissionNumber",
"reviewerTypeCode",
"personId",
"nonEmployeeFlag"
],
"primaryKey": "protocolReviewerId"
}Get Blueprint API specification for Protocol ReviewersGET/irb/api/v1/protocol-reviewers/
Example URI
GET /irb/api/v1/protocol-reviewers/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Reviewers.md"
transfer-encoding: chunkedUpdate Protocol ReviewersPUT/irb/api/v1/protocol-reviewers/(key)
Example URI
PUT /irb/api/v1/protocol-reviewers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolReviewerId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"submissionNumber": "(val)",
"reviewerTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol ReviewersPUT/irb/api/v1/protocol-reviewers/
Example URI
PUT /irb/api/v1/protocol-reviewers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolReviewerId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"submissionNumber": "(val)",
"reviewerTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"_primaryKey": "(val)"
},
{
"protocolReviewerId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"submissionNumber": "(val)",
"reviewerTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol ReviewersPATCH/irb/api/v1/protocol-reviewers/(key)
Example URI
PATCH /irb/api/v1/protocol-reviewers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolReviewerId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"submissionNumber": "(val)",
"reviewerTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolReviewerId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"submissionNumber": "(val)",
"reviewerTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"_primaryKey": "(val)"
}Insert Protocol ReviewersPOST/irb/api/v1/protocol-reviewers/
Example URI
POST /irb/api/v1/protocol-reviewers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolReviewerId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"submissionNumber": "(val)",
"reviewerTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolReviewerId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"submissionNumber": "(val)",
"reviewerTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol ReviewersPOST/irb/api/v1/protocol-reviewers/
Example URI
POST /irb/api/v1/protocol-reviewers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolReviewerId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"submissionNumber": "(val)",
"reviewerTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"_primaryKey": "(val)"
},
{
"protocolReviewerId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"submissionNumber": "(val)",
"reviewerTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolReviewerId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"submissionNumber": "(val)",
"reviewerTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"_primaryKey": "(val)"
},
{
"protocolReviewerId": "(val)",
"protocolIdFk": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"rolodexId": "(val)",
"submissionNumber": "(val)",
"reviewerTypeCode": "(val)",
"personId": "(val)",
"nonEmployeeFlag": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Reviewers by KeyDELETE/irb/api/v1/protocol-reviewers/(key)
Example URI
DELETE /irb/api/v1/protocol-reviewers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol ReviewersDELETE/irb/api/v1/protocol-reviewers/
Example URI
DELETE /irb/api/v1/protocol-reviewers/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Reviewers with MatchingDELETE/irb/api/v1/protocol-reviewers/
Example URI
DELETE /irb/api/v1/protocol-reviewers/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolReviewerId
string(optional)- protocolIdFk
string(optional)- submissionIdFk
string(optional)- protocolNumber
string(optional)- sequenceNumber
string(optional)- rolodexId
string(optional)- submissionNumber
string(optional)- reviewerTypeCode
string(optional)- personId
string(optional)- nonEmployeeFlag
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Risk Levels ¶
Get Protocol Risk Levels by KeyGET/irb/api/v1/protocol-risk-levels/(key)
Example URI
GET /irb/api/v1/protocol-risk-levels/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolRiskLevelId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"riskLevelCode": "(val)",
"comments": "(val)",
"dateAssigned": "(val)",
"dateInactivated": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Risk LevelsGET/irb/api/v1/protocol-risk-levels/
Example URI
GET /irb/api/v1/protocol-risk-levels/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolRiskLevelId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"riskLevelCode": "(val)",
"comments": "(val)",
"dateAssigned": "(val)",
"dateInactivated": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
},
{
"protocolRiskLevelId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"riskLevelCode": "(val)",
"comments": "(val)",
"dateAssigned": "(val)",
"dateInactivated": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Risk Levels with FilteringGET/irb/api/v1/protocol-risk-levels/
Example URI
GET /irb/api/v1/protocol-risk-levels/
URI Parameters
- protocolRiskLevelId
string(optional)Protocol Risk Levels Id. Maximum length is 22.
- protocolId
string(optional)Protocol Id. Maximum length is 22.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22.
- riskLevelCode
string(optional)Risk Level Code. Maximum length is 3.
- comments
string(optional)Comments. Maximum length is 2000.
- dateAssigned
string(optional)Date Assigned. Maximum length is 10.
- dateInactivated
string(optional)Date Inactivated. Maximum length is 10.
- status
string(optional)Status. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolRiskLevelId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"riskLevelCode": "(val)",
"comments": "(val)",
"dateAssigned": "(val)",
"dateInactivated": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
},
{
"protocolRiskLevelId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"riskLevelCode": "(val)",
"comments": "(val)",
"dateAssigned": "(val)",
"dateInactivated": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Risk LevelsGET/irb/api/v1/protocol-risk-levels/
Example URI
GET /irb/api/v1/protocol-risk-levels/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolRiskLevelId",
"protocolId",
"protocolNumber",
"sequenceNumber",
"riskLevelCode",
"comments",
"dateAssigned",
"dateInactivated",
"status"
],
"primaryKey": "protocolRiskLevelId"
}Get Blueprint API specification for Protocol Risk LevelsGET/irb/api/v1/protocol-risk-levels/
Example URI
GET /irb/api/v1/protocol-risk-levels/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Risk Levels.md"
transfer-encoding: chunkedUpdate Protocol Risk LevelsPUT/irb/api/v1/protocol-risk-levels/(key)
Example URI
PUT /irb/api/v1/protocol-risk-levels/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolRiskLevelId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"riskLevelCode": "(val)",
"comments": "(val)",
"dateAssigned": "(val)",
"dateInactivated": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Risk LevelsPUT/irb/api/v1/protocol-risk-levels/
Example URI
PUT /irb/api/v1/protocol-risk-levels/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolRiskLevelId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"riskLevelCode": "(val)",
"comments": "(val)",
"dateAssigned": "(val)",
"dateInactivated": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
},
{
"protocolRiskLevelId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"riskLevelCode": "(val)",
"comments": "(val)",
"dateAssigned": "(val)",
"dateInactivated": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Risk LevelsPATCH/irb/api/v1/protocol-risk-levels/(key)
Example URI
PATCH /irb/api/v1/protocol-risk-levels/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolRiskLevelId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"riskLevelCode": "(val)",
"comments": "(val)",
"dateAssigned": "(val)",
"dateInactivated": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolRiskLevelId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"riskLevelCode": "(val)",
"comments": "(val)",
"dateAssigned": "(val)",
"dateInactivated": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Risk LevelsPOST/irb/api/v1/protocol-risk-levels/
Example URI
POST /irb/api/v1/protocol-risk-levels/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolRiskLevelId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"riskLevelCode": "(val)",
"comments": "(val)",
"dateAssigned": "(val)",
"dateInactivated": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolRiskLevelId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"riskLevelCode": "(val)",
"comments": "(val)",
"dateAssigned": "(val)",
"dateInactivated": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Risk LevelsPOST/irb/api/v1/protocol-risk-levels/
Example URI
POST /irb/api/v1/protocol-risk-levels/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolRiskLevelId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"riskLevelCode": "(val)",
"comments": "(val)",
"dateAssigned": "(val)",
"dateInactivated": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
},
{
"protocolRiskLevelId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"riskLevelCode": "(val)",
"comments": "(val)",
"dateAssigned": "(val)",
"dateInactivated": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolRiskLevelId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"riskLevelCode": "(val)",
"comments": "(val)",
"dateAssigned": "(val)",
"dateInactivated": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
},
{
"protocolRiskLevelId": "(val)",
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"riskLevelCode": "(val)",
"comments": "(val)",
"dateAssigned": "(val)",
"dateInactivated": "(val)",
"status": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Risk Levels by KeyDELETE/irb/api/v1/protocol-risk-levels/(key)
Example URI
DELETE /irb/api/v1/protocol-risk-levels/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Risk LevelsDELETE/irb/api/v1/protocol-risk-levels/
Example URI
DELETE /irb/api/v1/protocol-risk-levels/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Risk Levels with MatchingDELETE/irb/api/v1/protocol-risk-levels/
Example URI
DELETE /irb/api/v1/protocol-risk-levels/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolRiskLevelId
string(optional)Protocol Risk Levels Id. Maximum length is 22.
- protocolId
string(optional)Protocol Id. Maximum length is 22.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22.
- riskLevelCode
string(optional)Risk Level Code. Maximum length is 3.
- comments
string(optional)Comments. Maximum length is 2000.
- dateAssigned
string(optional)Date Assigned. Maximum length is 10.
- dateInactivated
string(optional)Date Inactivated. Maximum length is 10.
- status
string(optional)Status. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Special Review Exemptions ¶
Get Protocol Special Review Exemptions by KeyGET/irb/api/v1/protocol-special-review-exemptions/(key)
Example URI
GET /irb/api/v1/protocol-special-review-exemptions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolSpecialReviewExemptionId": "(val)",
"exemptionTypeCode": "(val)",
"protocolSpecialReview.protocolSpecialReviewId": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Special Review ExemptionsGET/irb/api/v1/protocol-special-review-exemptions/
Example URI
GET /irb/api/v1/protocol-special-review-exemptions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolSpecialReviewExemptionId": "(val)",
"exemptionTypeCode": "(val)",
"protocolSpecialReview.protocolSpecialReviewId": "(val)",
"_primaryKey": "(val)"
},
{
"protocolSpecialReviewExemptionId": "(val)",
"exemptionTypeCode": "(val)",
"protocolSpecialReview.protocolSpecialReviewId": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Special Review Exemptions with FilteringGET/irb/api/v1/protocol-special-review-exemptions/
Example URI
GET /irb/api/v1/protocol-special-review-exemptions/
URI Parameters
- protocolSpecialReviewExemptionId
string(optional)Protocol Special Review Exemption Id. Maximum length is 22.
- exemptionTypeCode
string(optional)Exemption #. Maximum length is 3.
- protocolSpecialReview.protocolSpecialReviewId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolSpecialReviewExemptionId": "(val)",
"exemptionTypeCode": "(val)",
"protocolSpecialReview.protocolSpecialReviewId": "(val)",
"_primaryKey": "(val)"
},
{
"protocolSpecialReviewExemptionId": "(val)",
"exemptionTypeCode": "(val)",
"protocolSpecialReview.protocolSpecialReviewId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Special Review ExemptionsGET/irb/api/v1/protocol-special-review-exemptions/
Example URI
GET /irb/api/v1/protocol-special-review-exemptions/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolSpecialReviewExemptionId",
"exemptionTypeCode",
"protocolSpecialReview.protocolSpecialReviewId"
],
"primaryKey": "protocolSpecialReviewExemptionId"
}Get Blueprint API specification for Protocol Special Review ExemptionsGET/irb/api/v1/protocol-special-review-exemptions/
Example URI
GET /irb/api/v1/protocol-special-review-exemptions/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Special Review Exemptions.md"
transfer-encoding: chunkedProtocol Special Reviews ¶
Get Protocol Special Reviews by KeyGET/irb/api/v1/protocol-special-reviews/(key)
Example URI
GET /irb/api/v1/protocol-special-reviews/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolSpecialReviewId": "(val)",
"specialReviewNumber": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"protocolNumber": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"expirationDate": "(val)",
"comments": "(val)",
"sequenceOwner.protocolId": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Special ReviewsGET/irb/api/v1/protocol-special-reviews/
Example URI
GET /irb/api/v1/protocol-special-reviews/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolSpecialReviewId": "(val)",
"specialReviewNumber": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"protocolNumber": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"expirationDate": "(val)",
"comments": "(val)",
"sequenceOwner.protocolId": "(val)",
"_primaryKey": "(val)"
},
{
"protocolSpecialReviewId": "(val)",
"specialReviewNumber": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"protocolNumber": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"expirationDate": "(val)",
"comments": "(val)",
"sequenceOwner.protocolId": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Special Reviews with FilteringGET/irb/api/v1/protocol-special-reviews/
Example URI
GET /irb/api/v1/protocol-special-reviews/
URI Parameters
- protocolSpecialReviewId
string(optional)Protocol Special Review Id. Maximum length is 22.
- specialReviewNumber
string(optional)Special Review Number. Maximum length is 22.
- specialReviewTypeCode
string(optional)Special Review Type Code. Maximum length is 3.
- approvalTypeCode
string(optional)Approval Status Type Code. Maximum length is 3.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- applicationDate
string(optional)Application Date. Maximum length is 10.
- approvalDate
string(optional)Approval Date. Maximum length is 10.
- expirationDate
string(optional)Expiration Date. Maximum length is 10.
- comments
string(optional)Comments. Maximum length is 2000.
- sequenceOwner.protocolId
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolSpecialReviewId": "(val)",
"specialReviewNumber": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"protocolNumber": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"expirationDate": "(val)",
"comments": "(val)",
"sequenceOwner.protocolId": "(val)",
"_primaryKey": "(val)"
},
{
"protocolSpecialReviewId": "(val)",
"specialReviewNumber": "(val)",
"specialReviewTypeCode": "(val)",
"approvalTypeCode": "(val)",
"protocolNumber": "(val)",
"applicationDate": "(val)",
"approvalDate": "(val)",
"expirationDate": "(val)",
"comments": "(val)",
"sequenceOwner.protocolId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Special ReviewsGET/irb/api/v1/protocol-special-reviews/
Example URI
GET /irb/api/v1/protocol-special-reviews/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolSpecialReviewId",
"specialReviewNumber",
"specialReviewTypeCode",
"approvalTypeCode",
"protocolNumber",
"applicationDate",
"approvalDate",
"expirationDate",
"comments",
"sequenceOwner.protocolId"
],
"primaryKey": "protocolSpecialReviewId"
}Get Blueprint API specification for Protocol Special ReviewsGET/irb/api/v1/protocol-special-reviews/
Example URI
GET /irb/api/v1/protocol-special-reviews/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Special Reviews.md"
transfer-encoding: chunkedProtocol Statuses ¶
Get Protocol Statuses by KeyGET/irb/api/v1/protocol-statuses/(key)
Example URI
GET /irb/api/v1/protocol-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Protocol StatusesGET/irb/api/v1/protocol-statuses/
Example URI
GET /irb/api/v1/protocol-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Statuses with FilteringGET/irb/api/v1/protocol-statuses/
Example URI
GET /irb/api/v1/protocol-statuses/
URI Parameters
- protocolStatusCode
string(optional)Protocol Status Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol StatusesGET/irb/api/v1/protocol-statuses/
Example URI
GET /irb/api/v1/protocol-statuses/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolStatusCode",
"description"
],
"primaryKey": "protocolStatusCode"
}Get Blueprint API specification for Protocol StatusesGET/irb/api/v1/protocol-statuses/
Example URI
GET /irb/api/v1/protocol-statuses/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Statuses.md"
transfer-encoding: chunkedUpdate Protocol StatusesPUT/irb/api/v1/protocol-statuses/(key)
Example URI
PUT /irb/api/v1/protocol-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol StatusesPUT/irb/api/v1/protocol-statuses/
Example URI
PUT /irb/api/v1/protocol-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol StatusesPATCH/irb/api/v1/protocol-statuses/(key)
Example URI
PATCH /irb/api/v1/protocol-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Protocol StatusesPOST/irb/api/v1/protocol-statuses/
Example URI
POST /irb/api/v1/protocol-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol StatusesPOST/irb/api/v1/protocol-statuses/
Example URI
POST /irb/api/v1/protocol-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Statuses by KeyDELETE/irb/api/v1/protocol-statuses/(key)
Example URI
DELETE /irb/api/v1/protocol-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol StatusesDELETE/irb/api/v1/protocol-statuses/
Example URI
DELETE /irb/api/v1/protocol-statuses/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Statuses with MatchingDELETE/irb/api/v1/protocol-statuses/
Example URI
DELETE /irb/api/v1/protocol-statuses/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolStatusCode
string(optional)Protocol Status Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 300.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Submission Docs ¶
Get Protocol Submission Docs by KeyGET/irb/api/v1/protocol-submission-docs/(key)
Example URI
GET /irb/api/v1/protocol-submission-docs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"submissionDocId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"documentId": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"description": "(val)",
"document": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Submission DocsGET/irb/api/v1/protocol-submission-docs/
Example URI
GET /irb/api/v1/protocol-submission-docs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"submissionDocId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"documentId": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"description": "(val)",
"document": "(val)",
"_primaryKey": "(val)"
},
{
"submissionDocId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"documentId": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"description": "(val)",
"document": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Submission Docs with FilteringGET/irb/api/v1/protocol-submission-docs/
Example URI
GET /irb/api/v1/protocol-submission-docs/
URI Parameters
- submissionDocId
string(optional)Protocol Submission Doc Id. Maximum length is 22.
- protocolId
string(optional)- submissionIdFk
string(optional)Protocol Submission Id. Maximum length is 22.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22.
- submissionNumber
string(optional)Submission Number. Maximum length is 22.
- documentId
string(optional)Document Id. Maximum length is 22.
- fileName
string(optional)File Name. Maximum length is 300.
- contentType
string(optional)- description
string(optional)Description. Maximum length is 200.
- document
string(optional)Document. Maximum length is 4000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"submissionDocId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"documentId": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"description": "(val)",
"document": "(val)",
"_primaryKey": "(val)"
},
{
"submissionDocId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"documentId": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"description": "(val)",
"document": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Submission DocsGET/irb/api/v1/protocol-submission-docs/
Example URI
GET /irb/api/v1/protocol-submission-docs/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"submissionDocId",
"protocolId",
"submissionIdFk",
"protocolNumber",
"sequenceNumber",
"submissionNumber",
"documentId",
"fileName",
"contentType",
"description",
"document"
],
"primaryKey": "submissionDocId"
}Get Blueprint API specification for Protocol Submission DocsGET/irb/api/v1/protocol-submission-docs/
Example URI
GET /irb/api/v1/protocol-submission-docs/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Submission Docs.md"
transfer-encoding: chunkedUpdate Protocol Submission DocsPUT/irb/api/v1/protocol-submission-docs/(key)
Example URI
PUT /irb/api/v1/protocol-submission-docs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"submissionDocId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"documentId": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"description": "(val)",
"document": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Submission DocsPUT/irb/api/v1/protocol-submission-docs/
Example URI
PUT /irb/api/v1/protocol-submission-docs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"submissionDocId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"documentId": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"description": "(val)",
"document": "(val)",
"_primaryKey": "(val)"
},
{
"submissionDocId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"documentId": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"description": "(val)",
"document": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Submission DocsPATCH/irb/api/v1/protocol-submission-docs/(key)
Example URI
PATCH /irb/api/v1/protocol-submission-docs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"submissionDocId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"documentId": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"description": "(val)",
"document": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"submissionDocId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"documentId": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"description": "(val)",
"document": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Submission DocsPOST/irb/api/v1/protocol-submission-docs/
Example URI
POST /irb/api/v1/protocol-submission-docs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"submissionDocId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"documentId": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"description": "(val)",
"document": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"submissionDocId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"documentId": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"description": "(val)",
"document": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Submission DocsPOST/irb/api/v1/protocol-submission-docs/
Example URI
POST /irb/api/v1/protocol-submission-docs/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"submissionDocId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"documentId": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"description": "(val)",
"document": "(val)",
"_primaryKey": "(val)"
},
{
"submissionDocId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"documentId": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"description": "(val)",
"document": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"submissionDocId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"documentId": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"description": "(val)",
"document": "(val)",
"_primaryKey": "(val)"
},
{
"submissionDocId": "(val)",
"protocolId": "(val)",
"submissionIdFk": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"submissionNumber": "(val)",
"documentId": "(val)",
"fileName": "(val)",
"contentType": "(val)",
"description": "(val)",
"document": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Submission Docs by KeyDELETE/irb/api/v1/protocol-submission-docs/(key)
Example URI
DELETE /irb/api/v1/protocol-submission-docs/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Submission DocsDELETE/irb/api/v1/protocol-submission-docs/
Example URI
DELETE /irb/api/v1/protocol-submission-docs/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Submission Docs with MatchingDELETE/irb/api/v1/protocol-submission-docs/
Example URI
DELETE /irb/api/v1/protocol-submission-docs/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- submissionDocId
string(optional)Protocol Submission Doc Id. Maximum length is 22.
- protocolId
string(optional)- submissionIdFk
string(optional)Protocol Submission Id. Maximum length is 22.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 22.
- submissionNumber
string(optional)Submission Number. Maximum length is 22.
- documentId
string(optional)Document Id. Maximum length is 22.
- fileName
string(optional)File Name. Maximum length is 300.
- contentType
string(optional)- description
string(optional)Description. Maximum length is 200.
- document
string(optional)Document. Maximum length is 4000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Submission Qualifier Types ¶
Get Protocol Submission Qualifier Types by KeyGET/irb/api/v1/protocol-submission-qualifier-types/(key)
Example URI
GET /irb/api/v1/protocol-submission-qualifier-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"submissionQualifierTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Submission Qualifier TypesGET/irb/api/v1/protocol-submission-qualifier-types/
Example URI
GET /irb/api/v1/protocol-submission-qualifier-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"submissionQualifierTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"submissionQualifierTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Submission Qualifier Types with FilteringGET/irb/api/v1/protocol-submission-qualifier-types/
Example URI
GET /irb/api/v1/protocol-submission-qualifier-types/
URI Parameters
- submissionQualifierTypeCode
string(optional)Submission Qualifier Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"submissionQualifierTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"submissionQualifierTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Submission Qualifier TypesGET/irb/api/v1/protocol-submission-qualifier-types/
Example URI
GET /irb/api/v1/protocol-submission-qualifier-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"submissionQualifierTypeCode",
"description"
],
"primaryKey": "submissionQualifierTypeCode"
}Get Blueprint API specification for Protocol Submission Qualifier TypesGET/irb/api/v1/protocol-submission-qualifier-types/
Example URI
GET /irb/api/v1/protocol-submission-qualifier-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Submission Qualifier Types.md"
transfer-encoding: chunkedUpdate Protocol Submission Qualifier TypesPUT/irb/api/v1/protocol-submission-qualifier-types/(key)
Example URI
PUT /irb/api/v1/protocol-submission-qualifier-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"submissionQualifierTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Submission Qualifier TypesPUT/irb/api/v1/protocol-submission-qualifier-types/
Example URI
PUT /irb/api/v1/protocol-submission-qualifier-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"submissionQualifierTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"submissionQualifierTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Submission Qualifier TypesPATCH/irb/api/v1/protocol-submission-qualifier-types/(key)
Example URI
PATCH /irb/api/v1/protocol-submission-qualifier-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"submissionQualifierTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"submissionQualifierTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Submission Qualifier TypesPOST/irb/api/v1/protocol-submission-qualifier-types/
Example URI
POST /irb/api/v1/protocol-submission-qualifier-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"submissionQualifierTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"submissionQualifierTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Submission Qualifier TypesPOST/irb/api/v1/protocol-submission-qualifier-types/
Example URI
POST /irb/api/v1/protocol-submission-qualifier-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"submissionQualifierTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"submissionQualifierTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"submissionQualifierTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"submissionQualifierTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Submission Qualifier Types by KeyDELETE/irb/api/v1/protocol-submission-qualifier-types/(key)
Example URI
DELETE /irb/api/v1/protocol-submission-qualifier-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Submission Qualifier TypesDELETE/irb/api/v1/protocol-submission-qualifier-types/
Example URI
DELETE /irb/api/v1/protocol-submission-qualifier-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Submission Qualifier Types with MatchingDELETE/irb/api/v1/protocol-submission-qualifier-types/
Example URI
DELETE /irb/api/v1/protocol-submission-qualifier-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- submissionQualifierTypeCode
string(optional)Submission Qualifier Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Submission Statuses ¶
Get Protocol Submission Statuses by KeyGET/irb/api/v1/protocol-submission-statuses/(key)
Example URI
GET /irb/api/v1/protocol-submission-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolSubmissionStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Submission StatusesGET/irb/api/v1/protocol-submission-statuses/
Example URI
GET /irb/api/v1/protocol-submission-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolSubmissionStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolSubmissionStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Submission Statuses with FilteringGET/irb/api/v1/protocol-submission-statuses/
Example URI
GET /irb/api/v1/protocol-submission-statuses/
URI Parameters
- protocolSubmissionStatusCode
string(optional)Submission Status Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolSubmissionStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolSubmissionStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Submission StatusesGET/irb/api/v1/protocol-submission-statuses/
Example URI
GET /irb/api/v1/protocol-submission-statuses/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolSubmissionStatusCode",
"description"
],
"primaryKey": "protocolSubmissionStatusCode"
}Get Blueprint API specification for Protocol Submission StatusesGET/irb/api/v1/protocol-submission-statuses/
Example URI
GET /irb/api/v1/protocol-submission-statuses/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Submission Statuses.md"
transfer-encoding: chunkedUpdate Protocol Submission StatusesPUT/irb/api/v1/protocol-submission-statuses/(key)
Example URI
PUT /irb/api/v1/protocol-submission-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolSubmissionStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Submission StatusesPUT/irb/api/v1/protocol-submission-statuses/
Example URI
PUT /irb/api/v1/protocol-submission-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolSubmissionStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolSubmissionStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Submission StatusesPATCH/irb/api/v1/protocol-submission-statuses/(key)
Example URI
PATCH /irb/api/v1/protocol-submission-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolSubmissionStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolSubmissionStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Submission StatusesPOST/irb/api/v1/protocol-submission-statuses/
Example URI
POST /irb/api/v1/protocol-submission-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolSubmissionStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolSubmissionStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Submission StatusesPOST/irb/api/v1/protocol-submission-statuses/
Example URI
POST /irb/api/v1/protocol-submission-statuses/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolSubmissionStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolSubmissionStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolSubmissionStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"protocolSubmissionStatusCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Submission Statuses by KeyDELETE/irb/api/v1/protocol-submission-statuses/(key)
Example URI
DELETE /irb/api/v1/protocol-submission-statuses/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Submission StatusesDELETE/irb/api/v1/protocol-submission-statuses/
Example URI
DELETE /irb/api/v1/protocol-submission-statuses/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Submission Statuses with MatchingDELETE/irb/api/v1/protocol-submission-statuses/
Example URI
DELETE /irb/api/v1/protocol-submission-statuses/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolSubmissionStatusCode
string(optional)Submission Status Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Submission Types ¶
Get Protocol Submission Types by KeyGET/irb/api/v1/protocol-submission-types/(key)
Example URI
GET /irb/api/v1/protocol-submission-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"submissionTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Get All Protocol Submission TypesGET/irb/api/v1/protocol-submission-types/
Example URI
GET /irb/api/v1/protocol-submission-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"submissionTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"submissionTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Submission Types with FilteringGET/irb/api/v1/protocol-submission-types/
Example URI
GET /irb/api/v1/protocol-submission-types/
URI Parameters
- submissionTypeCode
string(optional)Submission Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"submissionTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"submissionTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol Submission TypesGET/irb/api/v1/protocol-submission-types/
Example URI
GET /irb/api/v1/protocol-submission-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"submissionTypeCode",
"description"
],
"primaryKey": "submissionTypeCode"
}Get Blueprint API specification for Protocol Submission TypesGET/irb/api/v1/protocol-submission-types/
Example URI
GET /irb/api/v1/protocol-submission-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Submission Types.md"
transfer-encoding: chunkedUpdate Protocol Submission TypesPUT/irb/api/v1/protocol-submission-types/(key)
Example URI
PUT /irb/api/v1/protocol-submission-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"submissionTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol Submission TypesPUT/irb/api/v1/protocol-submission-types/
Example URI
PUT /irb/api/v1/protocol-submission-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"submissionTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"submissionTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol Submission TypesPATCH/irb/api/v1/protocol-submission-types/(key)
Example URI
PATCH /irb/api/v1/protocol-submission-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"submissionTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"submissionTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Protocol Submission TypesPOST/irb/api/v1/protocol-submission-types/
Example URI
POST /irb/api/v1/protocol-submission-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"submissionTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"submissionTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol Submission TypesPOST/irb/api/v1/protocol-submission-types/
Example URI
POST /irb/api/v1/protocol-submission-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"submissionTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"submissionTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"submissionTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
},
{
"submissionTypeCode": "(val)",
"description": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Submission Types by KeyDELETE/irb/api/v1/protocol-submission-types/(key)
Example URI
DELETE /irb/api/v1/protocol-submission-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Submission TypesDELETE/irb/api/v1/protocol-submission-types/
Example URI
DELETE /irb/api/v1/protocol-submission-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Submission Types with MatchingDELETE/irb/api/v1/protocol-submission-types/
Example URI
DELETE /irb/api/v1/protocol-submission-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- submissionTypeCode
string(optional)Submission Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 200.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Submissions ¶
Get Protocol Submissions by KeyGET/irb/api/v1/protocol-submissions/(key)
Example URI
GET /irb/api/v1/protocol-submissions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"_primaryKey": "(val)"
}Get All Protocol SubmissionsGET/irb/api/v1/protocol-submissions/
Example URI
GET /irb/api/v1/protocol-submissions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"_primaryKey": "(val)"
},
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Submissions with FilteringGET/irb/api/v1/protocol-submissions/
Example URI
GET /irb/api/v1/protocol-submissions/
URI Parameters
- submissionId
string(optional)- submissionNumber
string(optional)Submission Number. Maximum length is 22.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 4.
- scheduleId
string(optional)Schedule Id. Maximum length is 10.
- committeeId
string(optional)Committee Id. Maximum length is 15.
- submissionTypeCode
string(optional)Submission Type Code. Maximum length is 3.
- submissionTypeQualifierCode
string(optional)Submission Type Qual Code. Maximum length is 3.
- submissionStatusCode
string(optional)Submission Status Code. Maximum length is 3.
- protocolId
string(optional)- scheduleIdFk
string(optional)- committeeIdFk
string(optional)Committee Id. Maximum length is 12.
- protocolReviewTypeCode
string(optional)Protocol Review Type Code. Maximum length is 3.
- submissionDate
string(optional)Submission Date. Maximum length is 10.
- comments
string(optional)Comments. Maximum length is 2000.
- committeeDecisionMotionTypeCode
string(optional)Committee Decision Motion Type. Maximum length is 3.
- yesVoteCount
string(optional)Yes Vote Count. Maximum length is 22.
- noVoteCount
string(optional)No Vote Count. Maximum length is 22.
- abstainerCount
string(optional)Abstainer Count. Maximum length is 22.
- recusedCount
string(optional)- votingComments
string(optional)Voting Comments. Maximum length is 2000.
- billable
string(optional)Is Billable. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"_primaryKey": "(val)"
},
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol SubmissionsGET/irb/api/v1/protocol-submissions/
Example URI
GET /irb/api/v1/protocol-submissions/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"submissionId",
"submissionNumber",
"protocolNumber",
"sequenceNumber",
"scheduleId",
"committeeId",
"submissionTypeCode",
"submissionTypeQualifierCode",
"submissionStatusCode",
"protocolId",
"scheduleIdFk",
"committeeIdFk",
"protocolReviewTypeCode",
"submissionDate",
"comments",
"committeeDecisionMotionTypeCode",
"yesVoteCount",
"noVoteCount",
"abstainerCount",
"recusedCount",
"votingComments",
"billable"
],
"primaryKey": "submissionId"
}Get Blueprint API specification for Protocol SubmissionsGET/irb/api/v1/protocol-submissions/
Example URI
GET /irb/api/v1/protocol-submissions/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Submissions.md"
transfer-encoding: chunkedUpdate Protocol SubmissionsPUT/irb/api/v1/protocol-submissions/(key)
Example URI
PUT /irb/api/v1/protocol-submissions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol SubmissionsPUT/irb/api/v1/protocol-submissions/
Example URI
PUT /irb/api/v1/protocol-submissions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"_primaryKey": "(val)"
},
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol SubmissionsPATCH/irb/api/v1/protocol-submissions/(key)
Example URI
PATCH /irb/api/v1/protocol-submissions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"_primaryKey": "(val)"
}Insert Protocol SubmissionsPOST/irb/api/v1/protocol-submissions/
Example URI
POST /irb/api/v1/protocol-submissions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol SubmissionsPOST/irb/api/v1/protocol-submissions/
Example URI
POST /irb/api/v1/protocol-submissions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"_primaryKey": "(val)"
},
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"_primaryKey": "(val)"
},
{
"submissionId": "(val)",
"submissionNumber": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"scheduleId": "(val)",
"committeeId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualifierCode": "(val)",
"submissionStatusCode": "(val)",
"protocolId": "(val)",
"scheduleIdFk": "(val)",
"committeeIdFk": "(val)",
"protocolReviewTypeCode": "(val)",
"submissionDate": "(val)",
"comments": "(val)",
"committeeDecisionMotionTypeCode": "(val)",
"yesVoteCount": "(val)",
"noVoteCount": "(val)",
"abstainerCount": "(val)",
"recusedCount": "(val)",
"votingComments": "(val)",
"billable": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Submissions by KeyDELETE/irb/api/v1/protocol-submissions/(key)
Example URI
DELETE /irb/api/v1/protocol-submissions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol SubmissionsDELETE/irb/api/v1/protocol-submissions/
Example URI
DELETE /irb/api/v1/protocol-submissions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Submissions with MatchingDELETE/irb/api/v1/protocol-submissions/
Example URI
DELETE /irb/api/v1/protocol-submissions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- submissionId
string(optional)- submissionNumber
string(optional)Submission Number. Maximum length is 22.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 4.
- scheduleId
string(optional)Schedule Id. Maximum length is 10.
- committeeId
string(optional)Committee Id. Maximum length is 15.
- submissionTypeCode
string(optional)Submission Type Code. Maximum length is 3.
- submissionTypeQualifierCode
string(optional)Submission Type Qual Code. Maximum length is 3.
- submissionStatusCode
string(optional)Submission Status Code. Maximum length is 3.
- protocolId
string(optional)- scheduleIdFk
string(optional)- committeeIdFk
string(optional)Committee Id. Maximum length is 12.
- protocolReviewTypeCode
string(optional)Protocol Review Type Code. Maximum length is 3.
- submissionDate
string(optional)Submission Date. Maximum length is 10.
- comments
string(optional)Comments. Maximum length is 2000.
- committeeDecisionMotionTypeCode
string(optional)Committee Decision Motion Type. Maximum length is 3.
- yesVoteCount
string(optional)Yes Vote Count. Maximum length is 22.
- noVoteCount
string(optional)No Vote Count. Maximum length is 22.
- abstainerCount
string(optional)Abstainer Count. Maximum length is 22.
- recusedCount
string(optional)- votingComments
string(optional)Voting Comments. Maximum length is 2000.
- billable
string(optional)Is Billable. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Types ¶
Get Protocol Types by KeyGET/irb/api/v1/protocol-types/(key)
Example URI
GET /irb/api/v1/protocol-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}Get All Protocol TypesGET/irb/api/v1/protocol-types/
Example URI
GET /irb/api/v1/protocol-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
},
{
"protocolTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Types with FilteringGET/irb/api/v1/protocol-types/
Example URI
GET /irb/api/v1/protocol-types/
URI Parameters
- protocolTypeCode
string(optional)Protocol Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 300.
- globalFlag
string(optional)Global Flag. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
},
{
"protocolTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol TypesGET/irb/api/v1/protocol-types/
Example URI
GET /irb/api/v1/protocol-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolTypeCode",
"description",
"globalFlag"
],
"primaryKey": "protocolTypeCode"
}Get Blueprint API specification for Protocol TypesGET/irb/api/v1/protocol-types/
Example URI
GET /irb/api/v1/protocol-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Types.md"
transfer-encoding: chunkedUpdate Protocol TypesPUT/irb/api/v1/protocol-types/(key)
Example URI
PUT /irb/api/v1/protocol-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol TypesPUT/irb/api/v1/protocol-types/
Example URI
PUT /irb/api/v1/protocol-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
},
{
"protocolTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol TypesPATCH/irb/api/v1/protocol-types/(key)
Example URI
PATCH /irb/api/v1/protocol-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}Insert Protocol TypesPOST/irb/api/v1/protocol-types/
Example URI
POST /irb/api/v1/protocol-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol TypesPOST/irb/api/v1/protocol-types/
Example URI
POST /irb/api/v1/protocol-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
},
{
"protocolTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
},
{
"protocolTypeCode": "(val)",
"description": "(val)",
"globalFlag": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Types by KeyDELETE/irb/api/v1/protocol-types/(key)
Example URI
DELETE /irb/api/v1/protocol-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol TypesDELETE/irb/api/v1/protocol-types/
Example URI
DELETE /irb/api/v1/protocol-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Types with MatchingDELETE/irb/api/v1/protocol-types/
Example URI
DELETE /irb/api/v1/protocol-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolTypeCode
string(optional)Protocol Type Code. Maximum length is 3.
- description
string(optional)Description. Maximum length is 300.
- globalFlag
string(optional)Global Flag. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocol Units ¶
Get Protocol Units by KeyGET/irb/api/v1/protocol-units/(key)
Example URI
GET /irb/api/v1/protocol-units/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolUnitsId": "(val)",
"protocolPersonId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"unitNumber": "(val)",
"leadUnitFlag": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}Get All Protocol UnitsGET/irb/api/v1/protocol-units/
Example URI
GET /irb/api/v1/protocol-units/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolUnitsId": "(val)",
"protocolPersonId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"unitNumber": "(val)",
"leadUnitFlag": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
},
{
"protocolUnitsId": "(val)",
"protocolPersonId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"unitNumber": "(val)",
"leadUnitFlag": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocol Units with FilteringGET/irb/api/v1/protocol-units/
Example URI
GET /irb/api/v1/protocol-units/
URI Parameters
- protocolUnitsId
string(optional)Protocol Units Id. Maximum length is 12.
- protocolPersonId
string(optional)Protocol Person Id. Maximum length is 9.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 4.
- unitNumber
string(optional)Unit Number. Maximum length is 8.
- leadUnitFlag
string(optional)Lead Unit Flag. Maximum length is 1.
- personId
string(optional)Person Id. Maximum length is 40.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolUnitsId": "(val)",
"protocolPersonId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"unitNumber": "(val)",
"leadUnitFlag": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
},
{
"protocolUnitsId": "(val)",
"protocolPersonId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"unitNumber": "(val)",
"leadUnitFlag": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Protocol UnitsGET/irb/api/v1/protocol-units/
Example URI
GET /irb/api/v1/protocol-units/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolUnitsId",
"protocolPersonId",
"protocolNumber",
"sequenceNumber",
"unitNumber",
"leadUnitFlag",
"personId"
],
"primaryKey": "protocolUnitsId"
}Get Blueprint API specification for Protocol UnitsGET/irb/api/v1/protocol-units/
Example URI
GET /irb/api/v1/protocol-units/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocol Units.md"
transfer-encoding: chunkedUpdate Protocol UnitsPUT/irb/api/v1/protocol-units/(key)
Example URI
PUT /irb/api/v1/protocol-units/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolUnitsId": "(val)",
"protocolPersonId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"unitNumber": "(val)",
"leadUnitFlag": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Protocol UnitsPUT/irb/api/v1/protocol-units/
Example URI
PUT /irb/api/v1/protocol-units/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolUnitsId": "(val)",
"protocolPersonId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"unitNumber": "(val)",
"leadUnitFlag": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
},
{
"protocolUnitsId": "(val)",
"protocolPersonId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"unitNumber": "(val)",
"leadUnitFlag": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Protocol UnitsPATCH/irb/api/v1/protocol-units/(key)
Example URI
PATCH /irb/api/v1/protocol-units/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolUnitsId": "(val)",
"protocolPersonId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"unitNumber": "(val)",
"leadUnitFlag": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"protocolUnitsId": "(val)",
"protocolPersonId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"unitNumber": "(val)",
"leadUnitFlag": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}Insert Protocol UnitsPOST/irb/api/v1/protocol-units/
Example URI
POST /irb/api/v1/protocol-units/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"protocolUnitsId": "(val)",
"protocolPersonId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"unitNumber": "(val)",
"leadUnitFlag": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"protocolUnitsId": "(val)",
"protocolPersonId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"unitNumber": "(val)",
"leadUnitFlag": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Protocol UnitsPOST/irb/api/v1/protocol-units/
Example URI
POST /irb/api/v1/protocol-units/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"protocolUnitsId": "(val)",
"protocolPersonId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"unitNumber": "(val)",
"leadUnitFlag": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
},
{
"protocolUnitsId": "(val)",
"protocolPersonId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"unitNumber": "(val)",
"leadUnitFlag": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"protocolUnitsId": "(val)",
"protocolPersonId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"unitNumber": "(val)",
"leadUnitFlag": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
},
{
"protocolUnitsId": "(val)",
"protocolPersonId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"unitNumber": "(val)",
"leadUnitFlag": "(val)",
"personId": "(val)",
"_primaryKey": "(val)"
}
]Delete Protocol Units by KeyDELETE/irb/api/v1/protocol-units/(key)
Example URI
DELETE /irb/api/v1/protocol-units/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol UnitsDELETE/irb/api/v1/protocol-units/
Example URI
DELETE /irb/api/v1/protocol-units/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Protocol Units with MatchingDELETE/irb/api/v1/protocol-units/
Example URI
DELETE /irb/api/v1/protocol-units/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- protocolUnitsId
string(optional)Protocol Units Id. Maximum length is 12.
- protocolPersonId
string(optional)Protocol Person Id. Maximum length is 9.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 4.
- unitNumber
string(optional)Unit Number. Maximum length is 8.
- leadUnitFlag
string(optional)Lead Unit Flag. Maximum length is 1.
- personId
string(optional)Person Id. Maximum length is 40.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Protocols ¶
Get Protocols by KeyGET/irb/api/v1/protocols/(key)
Example URI
GET /irb/api/v1/protocols/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"active": "(val)",
"protocolTypeCode": "(val)",
"protocolStatusCode": "(val)",
"title": "(val)",
"description": "(val)",
"initialSubmissionDate": "(val)",
"approvalDate": "(val)",
"expirationDate": "(val)",
"lastApprovalDate": "(val)",
"fdaApplicationNumber": "(val)",
"referenceNumber1": "(val)",
"referenceNumber2": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}Get All ProtocolsGET/irb/api/v1/protocols/
Example URI
GET /irb/api/v1/protocols/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"active": "(val)",
"protocolTypeCode": "(val)",
"protocolStatusCode": "(val)",
"title": "(val)",
"description": "(val)",
"initialSubmissionDate": "(val)",
"approvalDate": "(val)",
"expirationDate": "(val)",
"lastApprovalDate": "(val)",
"fdaApplicationNumber": "(val)",
"referenceNumber1": "(val)",
"referenceNumber2": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"active": "(val)",
"protocolTypeCode": "(val)",
"protocolStatusCode": "(val)",
"title": "(val)",
"description": "(val)",
"initialSubmissionDate": "(val)",
"approvalDate": "(val)",
"expirationDate": "(val)",
"lastApprovalDate": "(val)",
"fdaApplicationNumber": "(val)",
"referenceNumber1": "(val)",
"referenceNumber2": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Get All Protocols with FilteringGET/irb/api/v1/protocols/
Example URI
GET /irb/api/v1/protocols/
URI Parameters
- protocolId
string(optional)Protocol Id. Maximum length is 12.
- protocolNumber
string(optional)Protocol Number. Maximum length is 20.
- sequenceNumber
string(optional)Sequence Number. Maximum length is 4.
- active
string(optional)Active. Maximum length is 1.
- protocolTypeCode
string(optional)Protocol Type Code. Maximum length is 3.
- protocolStatusCode
string(optional)Protocol Status Code. Maximum length is 3.
- title
string(optional)Title. Maximum length is 2000.
- description
string(optional)Description. Maximum length is 2000.
- initialSubmissionDate
string(optional)Initial Submission Date. Maximum length is 10.
- approvalDate
string(optional)Approval Date. Maximum length is 10.
- expirationDate
string(optional)Expiration Date. Maximum length is 10.
- lastApprovalDate
string(optional)Last Approval Date. Maximum length is 10.
- fdaApplicationNumber
string(optional)Fda Application Number. Maximum length is 15.
- referenceNumber1
string(optional)Reference Number 1. Maximum length is 50.
- referenceNumber2
string(optional)Reference Number 2. Maximum length is 50.
- createTimestamp
string(optional)Protocol Create Date. Maximum length is 21.
- createUser
string(optional)- protocolDocument.documentNumber
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"active": "(val)",
"protocolTypeCode": "(val)",
"protocolStatusCode": "(val)",
"title": "(val)",
"description": "(val)",
"initialSubmissionDate": "(val)",
"approvalDate": "(val)",
"expirationDate": "(val)",
"lastApprovalDate": "(val)",
"fdaApplicationNumber": "(val)",
"referenceNumber1": "(val)",
"referenceNumber2": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
},
{
"protocolId": "(val)",
"protocolNumber": "(val)",
"sequenceNumber": "(val)",
"active": "(val)",
"protocolTypeCode": "(val)",
"protocolStatusCode": "(val)",
"title": "(val)",
"description": "(val)",
"initialSubmissionDate": "(val)",
"approvalDate": "(val)",
"expirationDate": "(val)",
"lastApprovalDate": "(val)",
"fdaApplicationNumber": "(val)",
"referenceNumber1": "(val)",
"referenceNumber2": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"protocolDocument.documentNumber": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for ProtocolsGET/irb/api/v1/protocols/
Example URI
GET /irb/api/v1/protocols/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"protocolId",
"protocolNumber",
"sequenceNumber",
"active",
"protocolTypeCode",
"protocolStatusCode",
"title",
"description",
"initialSubmissionDate",
"approvalDate",
"expirationDate",
"lastApprovalDate",
"fdaApplicationNumber",
"referenceNumber1",
"referenceNumber2",
"createTimestamp",
"createUser",
"protocolDocument.documentNumber"
],
"primaryKey": "protocolId"
}Get Blueprint API specification for ProtocolsGET/irb/api/v1/protocols/
Example URI
GET /irb/api/v1/protocols/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Protocols.md"
transfer-encoding: chunkedResearch Areas ¶
Get Research Areas by KeyGET/irb/api/v1/research-areas/(key)
Example URI
GET /irb/api/v1/research-areas/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"researchAreaCode": "(val)",
"description": "(val)",
"hasChildrenFlag": "(val)",
"parentResearchAreaCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Get All Research AreasGET/irb/api/v1/research-areas/
Example URI
GET /irb/api/v1/research-areas/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"researchAreaCode": "(val)",
"description": "(val)",
"hasChildrenFlag": "(val)",
"parentResearchAreaCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"researchAreaCode": "(val)",
"description": "(val)",
"hasChildrenFlag": "(val)",
"parentResearchAreaCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get All Research Areas with FilteringGET/irb/api/v1/research-areas/
Example URI
GET /irb/api/v1/research-areas/
URI Parameters
- researchAreaCode
string(optional)Research Area Code. Maximum length is 8.
- description
string(optional)Description. Maximum length is 200.
- hasChildrenFlag
string(optional)Has Children Flag. Maximum length is 1.
- parentResearchAreaCode
string(optional)Parent Research Area Code. Maximum length is 8.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"researchAreaCode": "(val)",
"description": "(val)",
"hasChildrenFlag": "(val)",
"parentResearchAreaCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"researchAreaCode": "(val)",
"description": "(val)",
"hasChildrenFlag": "(val)",
"parentResearchAreaCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Research AreasGET/irb/api/v1/research-areas/
Example URI
GET /irb/api/v1/research-areas/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"researchAreaCode",
"description",
"hasChildrenFlag",
"parentResearchAreaCode",
"active"
],
"primaryKey": "researchAreaCode"
}Get Blueprint API specification for Research AreasGET/irb/api/v1/research-areas/
Example URI
GET /irb/api/v1/research-areas/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Research Areas.md"
transfer-encoding: chunkedUpdate Research AreasPUT/irb/api/v1/research-areas/(key)
Example URI
PUT /irb/api/v1/research-areas/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"researchAreaCode": "(val)",
"description": "(val)",
"hasChildrenFlag": "(val)",
"parentResearchAreaCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Research AreasPUT/irb/api/v1/research-areas/
Example URI
PUT /irb/api/v1/research-areas/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"researchAreaCode": "(val)",
"description": "(val)",
"hasChildrenFlag": "(val)",
"parentResearchAreaCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"researchAreaCode": "(val)",
"description": "(val)",
"hasChildrenFlag": "(val)",
"parentResearchAreaCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Research AreasPATCH/irb/api/v1/research-areas/(key)
Example URI
PATCH /irb/api/v1/research-areas/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"researchAreaCode": "(val)",
"description": "(val)",
"hasChildrenFlag": "(val)",
"parentResearchAreaCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"researchAreaCode": "(val)",
"description": "(val)",
"hasChildrenFlag": "(val)",
"parentResearchAreaCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Research AreasPOST/irb/api/v1/research-areas/
Example URI
POST /irb/api/v1/research-areas/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"researchAreaCode": "(val)",
"description": "(val)",
"hasChildrenFlag": "(val)",
"parentResearchAreaCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"researchAreaCode": "(val)",
"description": "(val)",
"hasChildrenFlag": "(val)",
"parentResearchAreaCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Research AreasPOST/irb/api/v1/research-areas/
Example URI
POST /irb/api/v1/research-areas/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"researchAreaCode": "(val)",
"description": "(val)",
"hasChildrenFlag": "(val)",
"parentResearchAreaCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"researchAreaCode": "(val)",
"description": "(val)",
"hasChildrenFlag": "(val)",
"parentResearchAreaCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"researchAreaCode": "(val)",
"description": "(val)",
"hasChildrenFlag": "(val)",
"parentResearchAreaCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
},
{
"researchAreaCode": "(val)",
"description": "(val)",
"hasChildrenFlag": "(val)",
"parentResearchAreaCode": "(val)",
"active": "(val)",
"_primaryKey": "(val)"
}
]Delete Research Areas by KeyDELETE/irb/api/v1/research-areas/(key)
Example URI
DELETE /irb/api/v1/research-areas/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Research AreasDELETE/irb/api/v1/research-areas/
Example URI
DELETE /irb/api/v1/research-areas/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Research Areas with MatchingDELETE/irb/api/v1/research-areas/
Example URI
DELETE /irb/api/v1/research-areas/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- researchAreaCode
string(optional)Research Area Code. Maximum length is 8.
- description
string(optional)Description. Maximum length is 200.
- hasChildrenFlag
string(optional)Has Children Flag. Maximum length is 1.
- parentResearchAreaCode
string(optional)Parent Research Area Code. Maximum length is 8.
- active
string(optional)Active. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Schedule Agendas ¶
Get Schedule Agendas by KeyGET/irb/api/v1/schedule-agendas/(key)
Example URI
GET /irb/api/v1/schedule-agendas/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"scheduleAgendaId": "(val)",
"scheduleIdFk": "(val)",
"agendaNumber": "(val)",
"agendaName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Get All Schedule AgendasGET/irb/api/v1/schedule-agendas/
Example URI
GET /irb/api/v1/schedule-agendas/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"scheduleAgendaId": "(val)",
"scheduleIdFk": "(val)",
"agendaNumber": "(val)",
"agendaName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleAgendaId": "(val)",
"scheduleIdFk": "(val)",
"agendaNumber": "(val)",
"agendaName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}
]Get All Schedule Agendas with FilteringGET/irb/api/v1/schedule-agendas/
Example URI
GET /irb/api/v1/schedule-agendas/
URI Parameters
- scheduleAgendaId
string(optional)Schedule Agenda Id. Maximum length is 12.
- scheduleIdFk
string(optional)Schedule Id. Maximum length is 12.
- agendaNumber
string(optional)Agenda Number. Maximum length is 22.
- agendaName
string(optional)Agenda Name. Maximum length is 200.
- pdfStore
string(optional)Pdf Store. Maximum length is 4000.
- createTimestamp
string(optional)- createUser
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"scheduleAgendaId": "(val)",
"scheduleIdFk": "(val)",
"agendaNumber": "(val)",
"agendaName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleAgendaId": "(val)",
"scheduleIdFk": "(val)",
"agendaNumber": "(val)",
"agendaName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Schedule AgendasGET/irb/api/v1/schedule-agendas/
Example URI
GET /irb/api/v1/schedule-agendas/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"scheduleAgendaId",
"scheduleIdFk",
"agendaNumber",
"agendaName",
"pdfStore",
"createTimestamp",
"createUser"
],
"primaryKey": "scheduleAgendaId"
}Get Blueprint API specification for Schedule AgendasGET/irb/api/v1/schedule-agendas/
Example URI
GET /irb/api/v1/schedule-agendas/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Schedule Agendas.md"
transfer-encoding: chunkedUpdate Schedule AgendasPUT/irb/api/v1/schedule-agendas/(key)
Example URI
PUT /irb/api/v1/schedule-agendas/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"scheduleAgendaId": "(val)",
"scheduleIdFk": "(val)",
"agendaNumber": "(val)",
"agendaName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Schedule AgendasPUT/irb/api/v1/schedule-agendas/
Example URI
PUT /irb/api/v1/schedule-agendas/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"scheduleAgendaId": "(val)",
"scheduleIdFk": "(val)",
"agendaNumber": "(val)",
"agendaName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleAgendaId": "(val)",
"scheduleIdFk": "(val)",
"agendaNumber": "(val)",
"agendaName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Schedule AgendasPATCH/irb/api/v1/schedule-agendas/(key)
Example URI
PATCH /irb/api/v1/schedule-agendas/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"scheduleAgendaId": "(val)",
"scheduleIdFk": "(val)",
"agendaNumber": "(val)",
"agendaName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"scheduleAgendaId": "(val)",
"scheduleIdFk": "(val)",
"agendaNumber": "(val)",
"agendaName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Insert Schedule AgendasPOST/irb/api/v1/schedule-agendas/
Example URI
POST /irb/api/v1/schedule-agendas/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"scheduleAgendaId": "(val)",
"scheduleIdFk": "(val)",
"agendaNumber": "(val)",
"agendaName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"scheduleAgendaId": "(val)",
"scheduleIdFk": "(val)",
"agendaNumber": "(val)",
"agendaName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Schedule AgendasPOST/irb/api/v1/schedule-agendas/
Example URI
POST /irb/api/v1/schedule-agendas/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"scheduleAgendaId": "(val)",
"scheduleIdFk": "(val)",
"agendaNumber": "(val)",
"agendaName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleAgendaId": "(val)",
"scheduleIdFk": "(val)",
"agendaNumber": "(val)",
"agendaName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"scheduleAgendaId": "(val)",
"scheduleIdFk": "(val)",
"agendaNumber": "(val)",
"agendaName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
},
{
"scheduleAgendaId": "(val)",
"scheduleIdFk": "(val)",
"agendaNumber": "(val)",
"agendaName": "(val)",
"pdfStore": "(val)",
"createTimestamp": "(val)",
"createUser": "(val)",
"_primaryKey": "(val)"
}
]Delete Schedule Agendas by KeyDELETE/irb/api/v1/schedule-agendas/(key)
Example URI
DELETE /irb/api/v1/schedule-agendas/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Schedule AgendasDELETE/irb/api/v1/schedule-agendas/
Example URI
DELETE /irb/api/v1/schedule-agendas/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Schedule Agendas with MatchingDELETE/irb/api/v1/schedule-agendas/
Example URI
DELETE /irb/api/v1/schedule-agendas/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- scheduleAgendaId
string(optional)Schedule Agenda Id. Maximum length is 12.
- scheduleIdFk
string(optional)Schedule Id. Maximum length is 12.
- agendaNumber
string(optional)Agenda Number. Maximum length is 22.
- agendaName
string(optional)Agenda Name. Maximum length is 200.
- pdfStore
string(optional)Pdf Store. Maximum length is 4000.
- createTimestamp
string(optional)- createUser
string(optional)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Valid Protocol Action Actions ¶
Get Valid Protocol Action Actions by KeyGET/irb/api/v1/valid-protocol-action-actions/(key)
Example URI
GET /irb/api/v1/valid-protocol-action-actions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"validProtocolActionActionId": "(val)",
"protocolActionTypeCode": "(val)",
"motionTypeCode": "(val)",
"actionNumber": "(val)",
"followupActionCode": "(val)",
"userPromptFlag": "(val)",
"userPrompt": "(val)",
"_primaryKey": "(val)"
}Get All Valid Protocol Action ActionsGET/irb/api/v1/valid-protocol-action-actions/
Example URI
GET /irb/api/v1/valid-protocol-action-actions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"validProtocolActionActionId": "(val)",
"protocolActionTypeCode": "(val)",
"motionTypeCode": "(val)",
"actionNumber": "(val)",
"followupActionCode": "(val)",
"userPromptFlag": "(val)",
"userPrompt": "(val)",
"_primaryKey": "(val)"
},
{
"validProtocolActionActionId": "(val)",
"protocolActionTypeCode": "(val)",
"motionTypeCode": "(val)",
"actionNumber": "(val)",
"followupActionCode": "(val)",
"userPromptFlag": "(val)",
"userPrompt": "(val)",
"_primaryKey": "(val)"
}
]Get All Valid Protocol Action Actions with FilteringGET/irb/api/v1/valid-protocol-action-actions/
Example URI
GET /irb/api/v1/valid-protocol-action-actions/
URI Parameters
- validProtocolActionActionId
string(optional)Valid Protocol Action Action Id. Maximum length is 12.
- protocolActionTypeCode
string(optional)Protocol Action Type. Maximum length is 3.
- motionTypeCode
string(optional)Committee Motion Type. Maximum length is 3.
- actionNumber
string(optional)Action Number. Maximum length is 3.
- followupActionCode
string(optional)Follow-up Action Type. Maximum length is 3.
- userPromptFlag
string(optional)User Prompt Flag. Maximum length is 1.
- userPrompt
string(optional)Comments. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"validProtocolActionActionId": "(val)",
"protocolActionTypeCode": "(val)",
"motionTypeCode": "(val)",
"actionNumber": "(val)",
"followupActionCode": "(val)",
"userPromptFlag": "(val)",
"userPrompt": "(val)",
"_primaryKey": "(val)"
},
{
"validProtocolActionActionId": "(val)",
"protocolActionTypeCode": "(val)",
"motionTypeCode": "(val)",
"actionNumber": "(val)",
"followupActionCode": "(val)",
"userPromptFlag": "(val)",
"userPrompt": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Valid Protocol Action ActionsGET/irb/api/v1/valid-protocol-action-actions/
Example URI
GET /irb/api/v1/valid-protocol-action-actions/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"validProtocolActionActionId",
"protocolActionTypeCode",
"motionTypeCode",
"actionNumber",
"followupActionCode",
"userPromptFlag",
"userPrompt"
],
"primaryKey": "validProtocolActionActionId"
}Get Blueprint API specification for Valid Protocol Action ActionsGET/irb/api/v1/valid-protocol-action-actions/
Example URI
GET /irb/api/v1/valid-protocol-action-actions/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Valid Protocol Action Actions.md"
transfer-encoding: chunkedUpdate Valid Protocol Action ActionsPUT/irb/api/v1/valid-protocol-action-actions/(key)
Example URI
PUT /irb/api/v1/valid-protocol-action-actions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"validProtocolActionActionId": "(val)",
"protocolActionTypeCode": "(val)",
"motionTypeCode": "(val)",
"actionNumber": "(val)",
"followupActionCode": "(val)",
"userPromptFlag": "(val)",
"userPrompt": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Valid Protocol Action ActionsPUT/irb/api/v1/valid-protocol-action-actions/
Example URI
PUT /irb/api/v1/valid-protocol-action-actions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"validProtocolActionActionId": "(val)",
"protocolActionTypeCode": "(val)",
"motionTypeCode": "(val)",
"actionNumber": "(val)",
"followupActionCode": "(val)",
"userPromptFlag": "(val)",
"userPrompt": "(val)",
"_primaryKey": "(val)"
},
{
"validProtocolActionActionId": "(val)",
"protocolActionTypeCode": "(val)",
"motionTypeCode": "(val)",
"actionNumber": "(val)",
"followupActionCode": "(val)",
"userPromptFlag": "(val)",
"userPrompt": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Valid Protocol Action ActionsPATCH/irb/api/v1/valid-protocol-action-actions/(key)
Example URI
PATCH /irb/api/v1/valid-protocol-action-actions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"validProtocolActionActionId": "(val)",
"protocolActionTypeCode": "(val)",
"motionTypeCode": "(val)",
"actionNumber": "(val)",
"followupActionCode": "(val)",
"userPromptFlag": "(val)",
"userPrompt": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"validProtocolActionActionId": "(val)",
"protocolActionTypeCode": "(val)",
"motionTypeCode": "(val)",
"actionNumber": "(val)",
"followupActionCode": "(val)",
"userPromptFlag": "(val)",
"userPrompt": "(val)",
"_primaryKey": "(val)"
}Insert Valid Protocol Action ActionsPOST/irb/api/v1/valid-protocol-action-actions/
Example URI
POST /irb/api/v1/valid-protocol-action-actions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"validProtocolActionActionId": "(val)",
"protocolActionTypeCode": "(val)",
"motionTypeCode": "(val)",
"actionNumber": "(val)",
"followupActionCode": "(val)",
"userPromptFlag": "(val)",
"userPrompt": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"validProtocolActionActionId": "(val)",
"protocolActionTypeCode": "(val)",
"motionTypeCode": "(val)",
"actionNumber": "(val)",
"followupActionCode": "(val)",
"userPromptFlag": "(val)",
"userPrompt": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Valid Protocol Action ActionsPOST/irb/api/v1/valid-protocol-action-actions/
Example URI
POST /irb/api/v1/valid-protocol-action-actions/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"validProtocolActionActionId": "(val)",
"protocolActionTypeCode": "(val)",
"motionTypeCode": "(val)",
"actionNumber": "(val)",
"followupActionCode": "(val)",
"userPromptFlag": "(val)",
"userPrompt": "(val)",
"_primaryKey": "(val)"
},
{
"validProtocolActionActionId": "(val)",
"protocolActionTypeCode": "(val)",
"motionTypeCode": "(val)",
"actionNumber": "(val)",
"followupActionCode": "(val)",
"userPromptFlag": "(val)",
"userPrompt": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"validProtocolActionActionId": "(val)",
"protocolActionTypeCode": "(val)",
"motionTypeCode": "(val)",
"actionNumber": "(val)",
"followupActionCode": "(val)",
"userPromptFlag": "(val)",
"userPrompt": "(val)",
"_primaryKey": "(val)"
},
{
"validProtocolActionActionId": "(val)",
"protocolActionTypeCode": "(val)",
"motionTypeCode": "(val)",
"actionNumber": "(val)",
"followupActionCode": "(val)",
"userPromptFlag": "(val)",
"userPrompt": "(val)",
"_primaryKey": "(val)"
}
]Delete Valid Protocol Action Actions by KeyDELETE/irb/api/v1/valid-protocol-action-actions/(key)
Example URI
DELETE /irb/api/v1/valid-protocol-action-actions/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Valid Protocol Action ActionsDELETE/irb/api/v1/valid-protocol-action-actions/
Example URI
DELETE /irb/api/v1/valid-protocol-action-actions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Valid Protocol Action Actions with MatchingDELETE/irb/api/v1/valid-protocol-action-actions/
Example URI
DELETE /irb/api/v1/valid-protocol-action-actions/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- validProtocolActionActionId
string(optional)Valid Protocol Action Action Id. Maximum length is 12.
- protocolActionTypeCode
string(optional)Protocol Action Type. Maximum length is 3.
- motionTypeCode
string(optional)Committee Motion Type. Maximum length is 3.
- actionNumber
string(optional)Action Number. Maximum length is 3.
- followupActionCode
string(optional)Follow-up Action Type. Maximum length is 3.
- userPromptFlag
string(optional)User Prompt Flag. Maximum length is 1.
- userPrompt
string(optional)Comments. Maximum length is 2000.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Valid Protocol Action Correspondence ¶
Get Valid Protocol Action Correspondence by KeyGET/irb/api/v1/valid-protocol-action-correspondence/(key)
Example URI
GET /irb/api/v1/valid-protocol-action-correspondence/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"validProtoActionCorespId": "(val)",
"protocolActionTypeCode": "(val)",
"protoCorrespTypeCode": "(val)",
"finalFlag": "(val)",
"_primaryKey": "(val)"
}Get All Valid Protocol Action CorrespondenceGET/irb/api/v1/valid-protocol-action-correspondence/
Example URI
GET /irb/api/v1/valid-protocol-action-correspondence/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"validProtoActionCorespId": "(val)",
"protocolActionTypeCode": "(val)",
"protoCorrespTypeCode": "(val)",
"finalFlag": "(val)",
"_primaryKey": "(val)"
},
{
"validProtoActionCorespId": "(val)",
"protocolActionTypeCode": "(val)",
"protoCorrespTypeCode": "(val)",
"finalFlag": "(val)",
"_primaryKey": "(val)"
}
]Get All Valid Protocol Action Correspondence with FilteringGET/irb/api/v1/valid-protocol-action-correspondence/
Example URI
GET /irb/api/v1/valid-protocol-action-correspondence/
URI Parameters
- validProtoActionCorespId
string(optional)Valid Proto Action Coresp Id. Maximum length is 12.
- protocolActionTypeCode
string(optional)Protocol Action Type. Maximum length is 3.
- protoCorrespTypeCode
string(optional)Protocol Correspondence Type. Maximum length is 3.
- finalFlag
string(optional)Final Flag. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"validProtoActionCorespId": "(val)",
"protocolActionTypeCode": "(val)",
"protoCorrespTypeCode": "(val)",
"finalFlag": "(val)",
"_primaryKey": "(val)"
},
{
"validProtoActionCorespId": "(val)",
"protocolActionTypeCode": "(val)",
"protoCorrespTypeCode": "(val)",
"finalFlag": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Valid Protocol Action CorrespondenceGET/irb/api/v1/valid-protocol-action-correspondence/
Example URI
GET /irb/api/v1/valid-protocol-action-correspondence/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"validProtoActionCorespId",
"protocolActionTypeCode",
"protoCorrespTypeCode",
"finalFlag"
],
"primaryKey": "validProtoActionCorespId"
}Get Blueprint API specification for Valid Protocol Action CorrespondenceGET/irb/api/v1/valid-protocol-action-correspondence/
Example URI
GET /irb/api/v1/valid-protocol-action-correspondence/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Valid Protocol Action Correspondence.md"
transfer-encoding: chunkedUpdate Valid Protocol Action CorrespondencePUT/irb/api/v1/valid-protocol-action-correspondence/(key)
Example URI
PUT /irb/api/v1/valid-protocol-action-correspondence/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"validProtoActionCorespId": "(val)",
"protocolActionTypeCode": "(val)",
"protoCorrespTypeCode": "(val)",
"finalFlag": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Valid Protocol Action CorrespondencePUT/irb/api/v1/valid-protocol-action-correspondence/
Example URI
PUT /irb/api/v1/valid-protocol-action-correspondence/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"validProtoActionCorespId": "(val)",
"protocolActionTypeCode": "(val)",
"protoCorrespTypeCode": "(val)",
"finalFlag": "(val)",
"_primaryKey": "(val)"
},
{
"validProtoActionCorespId": "(val)",
"protocolActionTypeCode": "(val)",
"protoCorrespTypeCode": "(val)",
"finalFlag": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Valid Protocol Action CorrespondencePATCH/irb/api/v1/valid-protocol-action-correspondence/(key)
Example URI
PATCH /irb/api/v1/valid-protocol-action-correspondence/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"validProtoActionCorespId": "(val)",
"protocolActionTypeCode": "(val)",
"protoCorrespTypeCode": "(val)",
"finalFlag": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"validProtoActionCorespId": "(val)",
"protocolActionTypeCode": "(val)",
"protoCorrespTypeCode": "(val)",
"finalFlag": "(val)",
"_primaryKey": "(val)"
}Insert Valid Protocol Action CorrespondencePOST/irb/api/v1/valid-protocol-action-correspondence/
Example URI
POST /irb/api/v1/valid-protocol-action-correspondence/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"validProtoActionCorespId": "(val)",
"protocolActionTypeCode": "(val)",
"protoCorrespTypeCode": "(val)",
"finalFlag": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"validProtoActionCorespId": "(val)",
"protocolActionTypeCode": "(val)",
"protoCorrespTypeCode": "(val)",
"finalFlag": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Valid Protocol Action CorrespondencePOST/irb/api/v1/valid-protocol-action-correspondence/
Example URI
POST /irb/api/v1/valid-protocol-action-correspondence/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"validProtoActionCorespId": "(val)",
"protocolActionTypeCode": "(val)",
"protoCorrespTypeCode": "(val)",
"finalFlag": "(val)",
"_primaryKey": "(val)"
},
{
"validProtoActionCorespId": "(val)",
"protocolActionTypeCode": "(val)",
"protoCorrespTypeCode": "(val)",
"finalFlag": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"validProtoActionCorespId": "(val)",
"protocolActionTypeCode": "(val)",
"protoCorrespTypeCode": "(val)",
"finalFlag": "(val)",
"_primaryKey": "(val)"
},
{
"validProtoActionCorespId": "(val)",
"protocolActionTypeCode": "(val)",
"protoCorrespTypeCode": "(val)",
"finalFlag": "(val)",
"_primaryKey": "(val)"
}
]Delete Valid Protocol Action Correspondence by KeyDELETE/irb/api/v1/valid-protocol-action-correspondence/(key)
Example URI
DELETE /irb/api/v1/valid-protocol-action-correspondence/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Valid Protocol Action CorrespondenceDELETE/irb/api/v1/valid-protocol-action-correspondence/
Example URI
DELETE /irb/api/v1/valid-protocol-action-correspondence/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Valid Protocol Action Correspondence with MatchingDELETE/irb/api/v1/valid-protocol-action-correspondence/
Example URI
DELETE /irb/api/v1/valid-protocol-action-correspondence/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- validProtoActionCorespId
string(optional)Valid Proto Action Coresp Id. Maximum length is 12.
- protocolActionTypeCode
string(optional)Protocol Action Type. Maximum length is 3.
- protoCorrespTypeCode
string(optional)Protocol Correspondence Type. Maximum length is 3.
- finalFlag
string(optional)Final Flag. Maximum length is 1.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Valid Protocol Submission Review Types ¶
Get Valid Protocol Submission Review Types by KeyGET/irb/api/v1/valid-protocol-submission-review-types/(key)
Example URI
GET /irb/api/v1/valid-protocol-submission-review-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"validProtoSubRevTypeId": "(val)",
"submissionTypeCode": "(val)",
"protocolReviewTypeCode": "(val)",
"_primaryKey": "(val)"
}Get All Valid Protocol Submission Review TypesGET/irb/api/v1/valid-protocol-submission-review-types/
Example URI
GET /irb/api/v1/valid-protocol-submission-review-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"validProtoSubRevTypeId": "(val)",
"submissionTypeCode": "(val)",
"protocolReviewTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"validProtoSubRevTypeId": "(val)",
"submissionTypeCode": "(val)",
"protocolReviewTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Valid Protocol Submission Review Types with FilteringGET/irb/api/v1/valid-protocol-submission-review-types/
Example URI
GET /irb/api/v1/valid-protocol-submission-review-types/
URI Parameters
- validProtoSubRevTypeId
string(optional)Valid Proto Sub Rev Type Id. Maximum length is 12.
- submissionTypeCode
string(optional)Submission Type Code. Maximum length is 3.
- protocolReviewTypeCode
string(optional)Protocol Review Type Code. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"validProtoSubRevTypeId": "(val)",
"submissionTypeCode": "(val)",
"protocolReviewTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"validProtoSubRevTypeId": "(val)",
"submissionTypeCode": "(val)",
"protocolReviewTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Valid Protocol Submission Review TypesGET/irb/api/v1/valid-protocol-submission-review-types/
Example URI
GET /irb/api/v1/valid-protocol-submission-review-types/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"validProtoSubRevTypeId",
"submissionTypeCode",
"protocolReviewTypeCode"
],
"primaryKey": "validProtoSubRevTypeId"
}Get Blueprint API specification for Valid Protocol Submission Review TypesGET/irb/api/v1/valid-protocol-submission-review-types/
Example URI
GET /irb/api/v1/valid-protocol-submission-review-types/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Valid Protocol Submission Review Types.md"
transfer-encoding: chunkedUpdate Valid Protocol Submission Review TypesPUT/irb/api/v1/valid-protocol-submission-review-types/(key)
Example URI
PUT /irb/api/v1/valid-protocol-submission-review-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"validProtoSubRevTypeId": "(val)",
"submissionTypeCode": "(val)",
"protocolReviewTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Valid Protocol Submission Review TypesPUT/irb/api/v1/valid-protocol-submission-review-types/
Example URI
PUT /irb/api/v1/valid-protocol-submission-review-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"validProtoSubRevTypeId": "(val)",
"submissionTypeCode": "(val)",
"protocolReviewTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"validProtoSubRevTypeId": "(val)",
"submissionTypeCode": "(val)",
"protocolReviewTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Valid Protocol Submission Review TypesPATCH/irb/api/v1/valid-protocol-submission-review-types/(key)
Example URI
PATCH /irb/api/v1/valid-protocol-submission-review-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"validProtoSubRevTypeId": "(val)",
"submissionTypeCode": "(val)",
"protocolReviewTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"validProtoSubRevTypeId": "(val)",
"submissionTypeCode": "(val)",
"protocolReviewTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Valid Protocol Submission Review TypesPOST/irb/api/v1/valid-protocol-submission-review-types/
Example URI
POST /irb/api/v1/valid-protocol-submission-review-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"validProtoSubRevTypeId": "(val)",
"submissionTypeCode": "(val)",
"protocolReviewTypeCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"validProtoSubRevTypeId": "(val)",
"submissionTypeCode": "(val)",
"protocolReviewTypeCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Valid Protocol Submission Review TypesPOST/irb/api/v1/valid-protocol-submission-review-types/
Example URI
POST /irb/api/v1/valid-protocol-submission-review-types/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"validProtoSubRevTypeId": "(val)",
"submissionTypeCode": "(val)",
"protocolReviewTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"validProtoSubRevTypeId": "(val)",
"submissionTypeCode": "(val)",
"protocolReviewTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"validProtoSubRevTypeId": "(val)",
"submissionTypeCode": "(val)",
"protocolReviewTypeCode": "(val)",
"_primaryKey": "(val)"
},
{
"validProtoSubRevTypeId": "(val)",
"submissionTypeCode": "(val)",
"protocolReviewTypeCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Valid Protocol Submission Review Types by KeyDELETE/irb/api/v1/valid-protocol-submission-review-types/(key)
Example URI
DELETE /irb/api/v1/valid-protocol-submission-review-types/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Valid Protocol Submission Review TypesDELETE/irb/api/v1/valid-protocol-submission-review-types/
Example URI
DELETE /irb/api/v1/valid-protocol-submission-review-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Valid Protocol Submission Review Types with MatchingDELETE/irb/api/v1/valid-protocol-submission-review-types/
Example URI
DELETE /irb/api/v1/valid-protocol-submission-review-types/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- validProtoSubRevTypeId
string(optional)Valid Proto Sub Rev Type Id. Maximum length is 12.
- submissionTypeCode
string(optional)Submission Type Code. Maximum length is 3.
- protocolReviewTypeCode
string(optional)Protocol Review Type Code. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Valid Protocol Submission Type Qualifiers ¶
Get Valid Protocol Submission Type Qualifiers by KeyGET/irb/api/v1/valid-protocol-submission-type-qualifiers/(key)
Example URI
GET /irb/api/v1/valid-protocol-submission-type-qualifiers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"validProtoSubTypeQualId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualCode": "(val)",
"_primaryKey": "(val)"
}Get All Valid Protocol Submission Type QualifiersGET/irb/api/v1/valid-protocol-submission-type-qualifiers/
Example URI
GET /irb/api/v1/valid-protocol-submission-type-qualifiers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"validProtoSubTypeQualId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualCode": "(val)",
"_primaryKey": "(val)"
},
{
"validProtoSubTypeQualId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualCode": "(val)",
"_primaryKey": "(val)"
}
]Get All Valid Protocol Submission Type Qualifiers with FilteringGET/irb/api/v1/valid-protocol-submission-type-qualifiers/
Example URI
GET /irb/api/v1/valid-protocol-submission-type-qualifiers/
URI Parameters
- validProtoSubTypeQualId
string(optional)Valid Proto Sub Type Qual Id. Maximum length is 12.
- submissionTypeCode
string(optional)Submission Type Code. Maximum length is 3.
- submissionTypeQualCode
string(optional)Submission Type Qual Code. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"validProtoSubTypeQualId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualCode": "(val)",
"_primaryKey": "(val)"
},
{
"validProtoSubTypeQualId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualCode": "(val)",
"_primaryKey": "(val)"
}
]Get Schema for Valid Protocol Submission Type QualifiersGET/irb/api/v1/valid-protocol-submission-type-qualifiers/
Example URI
GET /irb/api/v1/valid-protocol-submission-type-qualifiers/
URI Parameters
- _schema
string(required)will instruct the endpoint to return a schema data structure for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"columns": [
"validProtoSubTypeQualId",
"submissionTypeCode",
"submissionTypeQualCode"
],
"primaryKey": "validProtoSubTypeQualId"
}Get Blueprint API specification for Valid Protocol Submission Type QualifiersGET/irb/api/v1/valid-protocol-submission-type-qualifiers/
Example URI
GET /irb/api/v1/valid-protocol-submission-type-qualifiers/
URI Parameters
- _blueprint
string(required)will instruct the endpoint to return an api blueprint markdown file for the resource
Request
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdownResponse
200Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Valid Protocol Submission Type Qualifiers.md"
transfer-encoding: chunkedUpdate Valid Protocol Submission Type QualifiersPUT/irb/api/v1/valid-protocol-submission-type-qualifiers/(key)
Example URI
PUT /irb/api/v1/valid-protocol-submission-type-qualifiers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"validProtoSubTypeQualId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualCode": "(val)",
"_primaryKey": "(val)"
}Response
204Update Multiple Valid Protocol Submission Type QualifiersPUT/irb/api/v1/valid-protocol-submission-type-qualifiers/
Example URI
PUT /irb/api/v1/valid-protocol-submission-type-qualifiers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"validProtoSubTypeQualId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualCode": "(val)",
"_primaryKey": "(val)"
},
{
"validProtoSubTypeQualId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualCode": "(val)",
"_primaryKey": "(val)"
}
]Response
204Update Specific Attributes Valid Protocol Submission Type QualifiersPATCH/irb/api/v1/valid-protocol-submission-type-qualifiers/(key)
Example URI
PATCH /irb/api/v1/valid-protocol-submission-type-qualifiers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"validProtoSubTypeQualId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualCode": "(val)",
"_primaryKey": "(val)"
}Response
204Body
{
"validProtoSubTypeQualId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualCode": "(val)",
"_primaryKey": "(val)"
}Insert Valid Protocol Submission Type QualifiersPOST/irb/api/v1/valid-protocol-submission-type-qualifiers/
Example URI
POST /irb/api/v1/valid-protocol-submission-type-qualifiers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
{
"validProtoSubTypeQualId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualCode": "(val)",
"_primaryKey": "(val)"
}Response
201Body
{
"validProtoSubTypeQualId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualCode": "(val)",
"_primaryKey": "(val)"
}Insert Multiple Valid Protocol Submission Type QualifiersPOST/irb/api/v1/valid-protocol-submission-type-qualifiers/
Example URI
POST /irb/api/v1/valid-protocol-submission-type-qualifiers/
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonBody
[
{
"validProtoSubTypeQualId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualCode": "(val)",
"_primaryKey": "(val)"
},
{
"validProtoSubTypeQualId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualCode": "(val)",
"_primaryKey": "(val)"
}
]Response
201Body
[
{
"validProtoSubTypeQualId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualCode": "(val)",
"_primaryKey": "(val)"
},
{
"validProtoSubTypeQualId": "(val)",
"submissionTypeCode": "(val)",
"submissionTypeQualCode": "(val)",
"_primaryKey": "(val)"
}
]Delete Valid Protocol Submission Type Qualifiers by KeyDELETE/irb/api/v1/valid-protocol-submission-type-qualifiers/(key)
Example URI
DELETE /irb/api/v1/valid-protocol-submission-type-qualifiers/(key)
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Valid Protocol Submission Type QualifiersDELETE/irb/api/v1/valid-protocol-submission-type-qualifiers/
Example URI
DELETE /irb/api/v1/valid-protocol-submission-type-qualifiers/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204Delete All Valid Protocol Submission Type Qualifiers with MatchingDELETE/irb/api/v1/valid-protocol-submission-type-qualifiers/
Example URI
DELETE /irb/api/v1/valid-protocol-submission-type-qualifiers/
URI Parameters
- _allowMulti
boolean(required)flag to allow multiple resources to be deleted in one operation
- validProtoSubTypeQualId
string(optional)Valid Proto Sub Type Qual Id. Maximum length is 12.
- submissionTypeCode
string(optional)Submission Type Code. Maximum length is 3.
- submissionTypeQualCode
string(optional)Submission Type Qual Code. Maximum length is 3.
Request
Headers
Authorization: Bearer {api-key}
Content-Type: application/jsonResponse
204