Back to top

API Documentation

< Back

Kuali Research REST APIs - IACUC

Research Iacuc

Iacuc Alternate Searches

Get Iacuc Alternate Searches by Key
GET/iacuc/api/v1/iacuc-alternate-searches/(key)

Example URI

GET /iacuc/api/v1/iacuc-alternate-searches/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "iacucAltSearchId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "searchDate": "(val)",
  "yearsSearched": "(val)",
  "keywords": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Alternate Searches
GET/iacuc/api/v1/iacuc-alternate-searches/

Example URI

GET /iacuc/api/v1/iacuc-alternate-searches/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucAltSearchId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "searchDate": "(val)",
    "yearsSearched": "(val)",
    "keywords": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucAltSearchId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "searchDate": "(val)",
    "yearsSearched": "(val)",
    "keywords": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Alternate Searches with Filtering
GET/iacuc/api/v1/iacuc-alternate-searches/

Example URI

GET /iacuc/api/v1/iacuc-alternate-searches/
URI Parameters
HideShow
iacucAltSearchId
string (optional) 
protocolId
string (optional) 
protocolNumber
string (optional) 
sequenceNumber
string (optional) 
searchDate
string (optional) 

Search Date. Maximum length is 10.

yearsSearched
string (optional) 

Years Searched. Maximum length is 2000.

keywords
string (optional) 

Keywords. Maximum length is 2000.

comments
string (optional) 

Comments. Maximum length is 2000.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucAltSearchId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "searchDate": "(val)",
    "yearsSearched": "(val)",
    "keywords": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucAltSearchId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "searchDate": "(val)",
    "yearsSearched": "(val)",
    "keywords": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Alternate Searches
GET/iacuc/api/v1/iacuc-alternate-searches/

Example URI

GET /iacuc/api/v1/iacuc-alternate-searches/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "iacucAltSearchId",
    "protocolId",
    "protocolNumber",
    "sequenceNumber",
    "searchDate",
    "yearsSearched",
    "keywords",
    "comments"
  ],
  "primaryKey": "iacucAltSearchId"
}

Get Blueprint API specification for Iacuc Alternate Searches
GET/iacuc/api/v1/iacuc-alternate-searches/

Example URI

GET /iacuc/api/v1/iacuc-alternate-searches/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Alternate Searches.md"
transfer-encoding: chunked

Update Iacuc Alternate Searches
PUT/iacuc/api/v1/iacuc-alternate-searches/(key)

Example URI

PUT /iacuc/api/v1/iacuc-alternate-searches/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucAltSearchId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "searchDate": "(val)",
  "yearsSearched": "(val)",
  "keywords": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Alternate Searches
PUT/iacuc/api/v1/iacuc-alternate-searches/

Example URI

PUT /iacuc/api/v1/iacuc-alternate-searches/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucAltSearchId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "searchDate": "(val)",
    "yearsSearched": "(val)",
    "keywords": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucAltSearchId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "searchDate": "(val)",
    "yearsSearched": "(val)",
    "keywords": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Alternate Searches
PATCH/iacuc/api/v1/iacuc-alternate-searches/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-alternate-searches/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucAltSearchId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "searchDate": "(val)",
  "yearsSearched": "(val)",
  "keywords": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "iacucAltSearchId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "searchDate": "(val)",
  "yearsSearched": "(val)",
  "keywords": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Alternate Searches
POST/iacuc/api/v1/iacuc-alternate-searches/

Example URI

POST /iacuc/api/v1/iacuc-alternate-searches/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucAltSearchId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "searchDate": "(val)",
  "yearsSearched": "(val)",
  "keywords": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "iacucAltSearchId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "searchDate": "(val)",
  "yearsSearched": "(val)",
  "keywords": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Alternate Searches
POST/iacuc/api/v1/iacuc-alternate-searches/

Example URI

POST /iacuc/api/v1/iacuc-alternate-searches/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucAltSearchId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "searchDate": "(val)",
    "yearsSearched": "(val)",
    "keywords": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucAltSearchId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "searchDate": "(val)",
    "yearsSearched": "(val)",
    "keywords": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "iacucAltSearchId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "searchDate": "(val)",
    "yearsSearched": "(val)",
    "keywords": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucAltSearchId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "searchDate": "(val)",
    "yearsSearched": "(val)",
    "keywords": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Alternate Searches by Key
DELETE/iacuc/api/v1/iacuc-alternate-searches/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-alternate-searches/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Alternate Searches
DELETE/iacuc/api/v1/iacuc-alternate-searches/

Example URI

DELETE /iacuc/api/v1/iacuc-alternate-searches/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Alternate Searches with Matching
DELETE/iacuc/api/v1/iacuc-alternate-searches/

Example URI

DELETE /iacuc/api/v1/iacuc-alternate-searches/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

iacucAltSearchId
string (optional) 
protocolId
string (optional) 
protocolNumber
string (optional) 
sequenceNumber
string (optional) 
searchDate
string (optional) 

Search Date. Maximum length is 10.

yearsSearched
string (optional) 

Years Searched. Maximum length is 2000.

keywords
string (optional) 

Keywords. Maximum length is 2000.

comments
string (optional) 

Comments. Maximum length is 2000.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Batch Correspondence Details

Get Iacuc Batch Correspondence Details by Key
GET/iacuc/api/v1/iacuc-batch-correspondence-details/(key)

Example URI

GET /iacuc/api/v1/iacuc-batch-correspondence-details/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "batchCorrespondenceDetailId": "(val)",
  "batchCorrespondenceTypeCode": "(val)",
  "protoCorrespTypeCode": "(val)",
  "daysToEvent": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Batch Correspondence Details
GET/iacuc/api/v1/iacuc-batch-correspondence-details/

Example URI

GET /iacuc/api/v1/iacuc-batch-correspondence-details/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "batchCorrespondenceDetailId": "(val)",
    "batchCorrespondenceTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "daysToEvent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "batchCorrespondenceDetailId": "(val)",
    "batchCorrespondenceTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "daysToEvent": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Batch Correspondence Details with Filtering
GET/iacuc/api/v1/iacuc-batch-correspondence-details/

Example URI

GET /iacuc/api/v1/iacuc-batch-correspondence-details/
URI Parameters
HideShow
batchCorrespondenceDetailId
string (optional) 

Batch Corresponcence Detail Id. Maximum length is 12.

batchCorrespondenceTypeCode
string (optional) 

Batch Corresponcence Type Code. Maximum length is 3.

protoCorrespTypeCode
string (optional) 

Protocol Correspondence Type Code. Maximum length is 3.

daysToEvent
string (optional) 

The days before/after the event. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "batchCorrespondenceDetailId": "(val)",
    "batchCorrespondenceTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "daysToEvent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "batchCorrespondenceDetailId": "(val)",
    "batchCorrespondenceTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "daysToEvent": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Batch Correspondence Details
GET/iacuc/api/v1/iacuc-batch-correspondence-details/

Example URI

GET /iacuc/api/v1/iacuc-batch-correspondence-details/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "batchCorrespondenceDetailId",
    "batchCorrespondenceTypeCode",
    "protoCorrespTypeCode",
    "daysToEvent"
  ],
  "primaryKey": "batchCorrespondenceDetailId"
}

Get Blueprint API specification for Iacuc Batch Correspondence Details
GET/iacuc/api/v1/iacuc-batch-correspondence-details/

Example URI

GET /iacuc/api/v1/iacuc-batch-correspondence-details/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Batch Correspondence Details.md"
transfer-encoding: chunked

Update Iacuc Batch Correspondence Details
PUT/iacuc/api/v1/iacuc-batch-correspondence-details/(key)

Example URI

PUT /iacuc/api/v1/iacuc-batch-correspondence-details/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "batchCorrespondenceDetailId": "(val)",
  "batchCorrespondenceTypeCode": "(val)",
  "protoCorrespTypeCode": "(val)",
  "daysToEvent": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Batch Correspondence Details
PUT/iacuc/api/v1/iacuc-batch-correspondence-details/

Example URI

PUT /iacuc/api/v1/iacuc-batch-correspondence-details/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "batchCorrespondenceDetailId": "(val)",
    "batchCorrespondenceTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "daysToEvent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "batchCorrespondenceDetailId": "(val)",
    "batchCorrespondenceTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "daysToEvent": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Batch Correspondence Details
PATCH/iacuc/api/v1/iacuc-batch-correspondence-details/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-batch-correspondence-details/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "batchCorrespondenceDetailId": "(val)",
  "batchCorrespondenceTypeCode": "(val)",
  "protoCorrespTypeCode": "(val)",
  "daysToEvent": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "batchCorrespondenceDetailId": "(val)",
  "batchCorrespondenceTypeCode": "(val)",
  "protoCorrespTypeCode": "(val)",
  "daysToEvent": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Batch Correspondence Details
POST/iacuc/api/v1/iacuc-batch-correspondence-details/

Example URI

POST /iacuc/api/v1/iacuc-batch-correspondence-details/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "batchCorrespondenceDetailId": "(val)",
  "batchCorrespondenceTypeCode": "(val)",
  "protoCorrespTypeCode": "(val)",
  "daysToEvent": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "batchCorrespondenceDetailId": "(val)",
  "batchCorrespondenceTypeCode": "(val)",
  "protoCorrespTypeCode": "(val)",
  "daysToEvent": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Batch Correspondence Details
POST/iacuc/api/v1/iacuc-batch-correspondence-details/

Example URI

POST /iacuc/api/v1/iacuc-batch-correspondence-details/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "batchCorrespondenceDetailId": "(val)",
    "batchCorrespondenceTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "daysToEvent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "batchCorrespondenceDetailId": "(val)",
    "batchCorrespondenceTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "daysToEvent": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "batchCorrespondenceDetailId": "(val)",
    "batchCorrespondenceTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "daysToEvent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "batchCorrespondenceDetailId": "(val)",
    "batchCorrespondenceTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "daysToEvent": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Batch Correspondence Details by Key
DELETE/iacuc/api/v1/iacuc-batch-correspondence-details/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-batch-correspondence-details/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Batch Correspondence Details
DELETE/iacuc/api/v1/iacuc-batch-correspondence-details/

Example URI

DELETE /iacuc/api/v1/iacuc-batch-correspondence-details/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Batch Correspondence Details with Matching
DELETE/iacuc/api/v1/iacuc-batch-correspondence-details/

Example URI

DELETE /iacuc/api/v1/iacuc-batch-correspondence-details/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

batchCorrespondenceDetailId
string (optional) 

Batch Corresponcence Detail Id. Maximum length is 12.

batchCorrespondenceTypeCode
string (optional) 

Batch Corresponcence Type Code. Maximum length is 3.

protoCorrespTypeCode
string (optional) 

Protocol Correspondence Type Code. Maximum length is 3.

daysToEvent
string (optional) 

The days before/after the event. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Batch Correspondences

Get Iacuc Batch Correspondences by Key
GET/iacuc/api/v1/iacuc-batch-correspondences/(key)

Example URI

GET /iacuc/api/v1/iacuc-batch-correspondences/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "batchCorrespondenceTypeCode": "(val)",
  "description": "(val)",
  "daysToEventUiText": "(val)",
  "sendCorrespondence": "(val)",
  "finalActionDay": "(val)",
  "finalActionTypeCode": "(val)",
  "finalActionCorrespType": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Batch Correspondences
GET/iacuc/api/v1/iacuc-batch-correspondences/

Example URI

GET /iacuc/api/v1/iacuc-batch-correspondences/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "batchCorrespondenceTypeCode": "(val)",
    "description": "(val)",
    "daysToEventUiText": "(val)",
    "sendCorrespondence": "(val)",
    "finalActionDay": "(val)",
    "finalActionTypeCode": "(val)",
    "finalActionCorrespType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "batchCorrespondenceTypeCode": "(val)",
    "description": "(val)",
    "daysToEventUiText": "(val)",
    "sendCorrespondence": "(val)",
    "finalActionDay": "(val)",
    "finalActionTypeCode": "(val)",
    "finalActionCorrespType": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Batch Correspondences with Filtering
GET/iacuc/api/v1/iacuc-batch-correspondences/

Example URI

GET /iacuc/api/v1/iacuc-batch-correspondences/
URI Parameters
HideShow
batchCorrespondenceTypeCode
string (optional) 

Batch Correspondence Type Code. Maximum length is 3.

description
string (optional) 

Description. Maximum length is 200.

daysToEventUiText
string (optional) 

Days to Event UI Text. Maximum length is 400.

sendCorrespondence
string (optional) 

Send correspondence before/after event. Maximum length is 10.

finalActionDay
string (optional) 

Final Action Day. Maximum length is 3.

finalActionTypeCode
string (optional) 

Final Action Type Code. Maximum length is 3.

finalActionCorrespType
string (optional) 

Final Action Corresp Type. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "batchCorrespondenceTypeCode": "(val)",
    "description": "(val)",
    "daysToEventUiText": "(val)",
    "sendCorrespondence": "(val)",
    "finalActionDay": "(val)",
    "finalActionTypeCode": "(val)",
    "finalActionCorrespType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "batchCorrespondenceTypeCode": "(val)",
    "description": "(val)",
    "daysToEventUiText": "(val)",
    "sendCorrespondence": "(val)",
    "finalActionDay": "(val)",
    "finalActionTypeCode": "(val)",
    "finalActionCorrespType": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Batch Correspondences
GET/iacuc/api/v1/iacuc-batch-correspondences/

Example URI

GET /iacuc/api/v1/iacuc-batch-correspondences/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "batchCorrespondenceTypeCode",
    "description",
    "daysToEventUiText",
    "sendCorrespondence",
    "finalActionDay",
    "finalActionTypeCode",
    "finalActionCorrespType"
  ],
  "primaryKey": "batchCorrespondenceTypeCode"
}

Get Blueprint API specification for Iacuc Batch Correspondences
GET/iacuc/api/v1/iacuc-batch-correspondences/

Example URI

GET /iacuc/api/v1/iacuc-batch-correspondences/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Batch Correspondences.md"
transfer-encoding: chunked

Update Iacuc Batch Correspondences
PUT/iacuc/api/v1/iacuc-batch-correspondences/(key)

Example URI

PUT /iacuc/api/v1/iacuc-batch-correspondences/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "batchCorrespondenceTypeCode": "(val)",
  "description": "(val)",
  "daysToEventUiText": "(val)",
  "sendCorrespondence": "(val)",
  "finalActionDay": "(val)",
  "finalActionTypeCode": "(val)",
  "finalActionCorrespType": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Batch Correspondences
PUT/iacuc/api/v1/iacuc-batch-correspondences/

Example URI

PUT /iacuc/api/v1/iacuc-batch-correspondences/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "batchCorrespondenceTypeCode": "(val)",
    "description": "(val)",
    "daysToEventUiText": "(val)",
    "sendCorrespondence": "(val)",
    "finalActionDay": "(val)",
    "finalActionTypeCode": "(val)",
    "finalActionCorrespType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "batchCorrespondenceTypeCode": "(val)",
    "description": "(val)",
    "daysToEventUiText": "(val)",
    "sendCorrespondence": "(val)",
    "finalActionDay": "(val)",
    "finalActionTypeCode": "(val)",
    "finalActionCorrespType": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Batch Correspondences
PATCH/iacuc/api/v1/iacuc-batch-correspondences/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-batch-correspondences/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "batchCorrespondenceTypeCode": "(val)",
  "description": "(val)",
  "daysToEventUiText": "(val)",
  "sendCorrespondence": "(val)",
  "finalActionDay": "(val)",
  "finalActionTypeCode": "(val)",
  "finalActionCorrespType": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "batchCorrespondenceTypeCode": "(val)",
  "description": "(val)",
  "daysToEventUiText": "(val)",
  "sendCorrespondence": "(val)",
  "finalActionDay": "(val)",
  "finalActionTypeCode": "(val)",
  "finalActionCorrespType": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Batch Correspondences
POST/iacuc/api/v1/iacuc-batch-correspondences/

Example URI

POST /iacuc/api/v1/iacuc-batch-correspondences/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "batchCorrespondenceTypeCode": "(val)",
  "description": "(val)",
  "daysToEventUiText": "(val)",
  "sendCorrespondence": "(val)",
  "finalActionDay": "(val)",
  "finalActionTypeCode": "(val)",
  "finalActionCorrespType": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "batchCorrespondenceTypeCode": "(val)",
  "description": "(val)",
  "daysToEventUiText": "(val)",
  "sendCorrespondence": "(val)",
  "finalActionDay": "(val)",
  "finalActionTypeCode": "(val)",
  "finalActionCorrespType": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Batch Correspondences
POST/iacuc/api/v1/iacuc-batch-correspondences/

Example URI

POST /iacuc/api/v1/iacuc-batch-correspondences/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "batchCorrespondenceTypeCode": "(val)",
    "description": "(val)",
    "daysToEventUiText": "(val)",
    "sendCorrespondence": "(val)",
    "finalActionDay": "(val)",
    "finalActionTypeCode": "(val)",
    "finalActionCorrespType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "batchCorrespondenceTypeCode": "(val)",
    "description": "(val)",
    "daysToEventUiText": "(val)",
    "sendCorrespondence": "(val)",
    "finalActionDay": "(val)",
    "finalActionTypeCode": "(val)",
    "finalActionCorrespType": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "batchCorrespondenceTypeCode": "(val)",
    "description": "(val)",
    "daysToEventUiText": "(val)",
    "sendCorrespondence": "(val)",
    "finalActionDay": "(val)",
    "finalActionTypeCode": "(val)",
    "finalActionCorrespType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "batchCorrespondenceTypeCode": "(val)",
    "description": "(val)",
    "daysToEventUiText": "(val)",
    "sendCorrespondence": "(val)",
    "finalActionDay": "(val)",
    "finalActionTypeCode": "(val)",
    "finalActionCorrespType": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Batch Correspondences by Key
DELETE/iacuc/api/v1/iacuc-batch-correspondences/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-batch-correspondences/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Batch Correspondences
DELETE/iacuc/api/v1/iacuc-batch-correspondences/

Example URI

DELETE /iacuc/api/v1/iacuc-batch-correspondences/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Batch Correspondences with Matching
DELETE/iacuc/api/v1/iacuc-batch-correspondences/

Example URI

DELETE /iacuc/api/v1/iacuc-batch-correspondences/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

batchCorrespondenceTypeCode
string (optional) 

Batch Correspondence Type Code. Maximum length is 3.

description
string (optional) 

Description. Maximum length is 200.

daysToEventUiText
string (optional) 

Days to Event UI Text. Maximum length is 400.

sendCorrespondence
string (optional) 

Send correspondence before/after event. Maximum length is 10.

finalActionDay
string (optional) 

Final Action Day. Maximum length is 3.

finalActionTypeCode
string (optional) 

Final Action Type Code. Maximum length is 3.

finalActionCorrespType
string (optional) 

Final Action Corresp Type. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Committee Membership Expertise Entries

Get Iacuc Committee Membership Expertise Entries by Key
GET/iacuc/api/v1/iacuc-committee-membership-expertise-entries/(key)

Example URI

GET /iacuc/api/v1/iacuc-committee-membership-expertise-entries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "committeeMembershipExpertiseId": "(val)",
  "committeeMembershipIdFk": "(val)",
  "researchAreaCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Committee Membership Expertise Entries
GET/iacuc/api/v1/iacuc-committee-membership-expertise-entries/

Example URI

GET /iacuc/api/v1/iacuc-committee-membership-expertise-entries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "committeeMembershipExpertiseId": "(val)",
    "committeeMembershipIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "committeeMembershipExpertiseId": "(val)",
    "committeeMembershipIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Committee Membership Expertise Entries with Filtering
GET/iacuc/api/v1/iacuc-committee-membership-expertise-entries/

Example URI

GET /iacuc/api/v1/iacuc-committee-membership-expertise-entries/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "committeeMembershipExpertiseId": "(val)",
    "committeeMembershipIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "committeeMembershipExpertiseId": "(val)",
    "committeeMembershipIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Committee Membership Expertise Entries
GET/iacuc/api/v1/iacuc-committee-membership-expertise-entries/

Example URI

GET /iacuc/api/v1/iacuc-committee-membership-expertise-entries/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "committeeMembershipExpertiseId",
    "committeeMembershipIdFk",
    "researchAreaCode"
  ],
  "primaryKey": "committeeMembershipExpertiseId"
}

Get Blueprint API specification for Iacuc Committee Membership Expertise Entries
GET/iacuc/api/v1/iacuc-committee-membership-expertise-entries/

Example URI

GET /iacuc/api/v1/iacuc-committee-membership-expertise-entries/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Committee Membership Expertise Entries.md"
transfer-encoding: chunked

Update Iacuc Committee Membership Expertise Entries
PUT/iacuc/api/v1/iacuc-committee-membership-expertise-entries/(key)

Example URI

PUT /iacuc/api/v1/iacuc-committee-membership-expertise-entries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "committeeMembershipExpertiseId": "(val)",
  "committeeMembershipIdFk": "(val)",
  "researchAreaCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Committee Membership Expertise Entries
PUT/iacuc/api/v1/iacuc-committee-membership-expertise-entries/

Example URI

PUT /iacuc/api/v1/iacuc-committee-membership-expertise-entries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "committeeMembershipExpertiseId": "(val)",
    "committeeMembershipIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "committeeMembershipExpertiseId": "(val)",
    "committeeMembershipIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Committee Membership Expertise Entries
PATCH/iacuc/api/v1/iacuc-committee-membership-expertise-entries/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-committee-membership-expertise-entries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "committeeMembershipExpertiseId": "(val)",
  "committeeMembershipIdFk": "(val)",
  "researchAreaCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "committeeMembershipExpertiseId": "(val)",
  "committeeMembershipIdFk": "(val)",
  "researchAreaCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Committee Membership Expertise Entries
POST/iacuc/api/v1/iacuc-committee-membership-expertise-entries/

Example URI

POST /iacuc/api/v1/iacuc-committee-membership-expertise-entries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "committeeMembershipExpertiseId": "(val)",
  "committeeMembershipIdFk": "(val)",
  "researchAreaCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "committeeMembershipExpertiseId": "(val)",
  "committeeMembershipIdFk": "(val)",
  "researchAreaCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Committee Membership Expertise Entries
POST/iacuc/api/v1/iacuc-committee-membership-expertise-entries/

Example URI

POST /iacuc/api/v1/iacuc-committee-membership-expertise-entries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "committeeMembershipExpertiseId": "(val)",
    "committeeMembershipIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "committeeMembershipExpertiseId": "(val)",
    "committeeMembershipIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "committeeMembershipExpertiseId": "(val)",
    "committeeMembershipIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "committeeMembershipExpertiseId": "(val)",
    "committeeMembershipIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Committee Membership Expertise Entries by Key
DELETE/iacuc/api/v1/iacuc-committee-membership-expertise-entries/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-committee-membership-expertise-entries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Committee Membership Expertise Entries
DELETE/iacuc/api/v1/iacuc-committee-membership-expertise-entries/

Example URI

DELETE /iacuc/api/v1/iacuc-committee-membership-expertise-entries/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Committee Membership Expertise Entries with Matching
DELETE/iacuc/api/v1/iacuc-committee-membership-expertise-entries/

Example URI

DELETE /iacuc/api/v1/iacuc-committee-membership-expertise-entries/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Committee Memberships

Get Iacuc Committee Memberships by Key
GET/iacuc/api/v1/iacuc-committee-memberships/(key)

Example URI

GET /iacuc/api/v1/iacuc-committee-memberships/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "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 Iacuc Committee Memberships
GET/iacuc/api/v1/iacuc-committee-memberships/

Example URI

GET /iacuc/api/v1/iacuc-committee-memberships/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Committee Memberships with Filtering
GET/iacuc/api/v1/iacuc-committee-memberships/

Example URI

GET /iacuc/api/v1/iacuc-committee-memberships/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Committee Memberships
GET/iacuc/api/v1/iacuc-committee-memberships/

Example URI

GET /iacuc/api/v1/iacuc-committee-memberships/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "committeeMembershipId",
    "committeeIdFk",
    "personId",
    "rolodexId",
    "personName",
    "membershipId",
    "paidMember",
    "termStartDate",
    "termEndDate",
    "membershipTypeCode",
    "comments",
    "contactNotes",
    "trainingNotes"
  ],
  "primaryKey": "committeeMembershipId"
}

Get Blueprint API specification for Iacuc Committee Memberships
GET/iacuc/api/v1/iacuc-committee-memberships/

Example URI

GET /iacuc/api/v1/iacuc-committee-memberships/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Committee Memberships.md"
transfer-encoding: chunked

Update Iacuc Committee Memberships
PUT/iacuc/api/v1/iacuc-committee-memberships/(key)

Example URI

PUT /iacuc/api/v1/iacuc-committee-memberships/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  204

Update Multiple Iacuc Committee Memberships
PUT/iacuc/api/v1/iacuc-committee-memberships/

Example URI

PUT /iacuc/api/v1/iacuc-committee-memberships/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Committee Memberships
PATCH/iacuc/api/v1/iacuc-committee-memberships/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-committee-memberships/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  204
HideShow
Body
{
  "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 Iacuc Committee Memberships
POST/iacuc/api/v1/iacuc-committee-memberships/

Example URI

POST /iacuc/api/v1/iacuc-committee-memberships/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  201
HideShow
Body
{
  "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 Iacuc Committee Memberships
POST/iacuc/api/v1/iacuc-committee-memberships/

Example URI

POST /iacuc/api/v1/iacuc-committee-memberships/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Committee Memberships by Key
DELETE/iacuc/api/v1/iacuc-committee-memberships/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-committee-memberships/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Committee Memberships
DELETE/iacuc/api/v1/iacuc-committee-memberships/

Example URI

DELETE /iacuc/api/v1/iacuc-committee-memberships/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Committee Memberships with Matching
DELETE/iacuc/api/v1/iacuc-committee-memberships/

Example URI

DELETE /iacuc/api/v1/iacuc-committee-memberships/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Committee Research Areas

Get Iacuc Committee Research Areas by Key
GET/iacuc/api/v1/iacuc-committee-research-areas/(key)

Example URI

GET /iacuc/api/v1/iacuc-committee-research-areas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "committeeIdFk": "(val)",
  "researchAreaCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Committee Research Areas
GET/iacuc/api/v1/iacuc-committee-research-areas/

Example URI

GET /iacuc/api/v1/iacuc-committee-research-areas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "committeeIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "committeeIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Committee Research Areas with Filtering
GET/iacuc/api/v1/iacuc-committee-research-areas/

Example URI

GET /iacuc/api/v1/iacuc-committee-research-areas/
URI Parameters
HideShow
id
string (optional) 

Committee Research Area Id.

committeeIdFk
string (optional) 

Committee Id Fk.

researchAreaCode
string (optional) 

Research Area Code.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "committeeIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "committeeIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Committee Research Areas
GET/iacuc/api/v1/iacuc-committee-research-areas/

Example URI

GET /iacuc/api/v1/iacuc-committee-research-areas/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "committeeIdFk",
    "researchAreaCode"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Iacuc Committee Research Areas
GET/iacuc/api/v1/iacuc-committee-research-areas/

Example URI

GET /iacuc/api/v1/iacuc-committee-research-areas/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Committee Research Areas.md"
transfer-encoding: chunked

Update Iacuc Committee Research Areas
PUT/iacuc/api/v1/iacuc-committee-research-areas/(key)

Example URI

PUT /iacuc/api/v1/iacuc-committee-research-areas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "committeeIdFk": "(val)",
  "researchAreaCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Committee Research Areas
PUT/iacuc/api/v1/iacuc-committee-research-areas/

Example URI

PUT /iacuc/api/v1/iacuc-committee-research-areas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "committeeIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "committeeIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Committee Research Areas
PATCH/iacuc/api/v1/iacuc-committee-research-areas/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-committee-research-areas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "committeeIdFk": "(val)",
  "researchAreaCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "committeeIdFk": "(val)",
  "researchAreaCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Committee Research Areas
POST/iacuc/api/v1/iacuc-committee-research-areas/

Example URI

POST /iacuc/api/v1/iacuc-committee-research-areas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "committeeIdFk": "(val)",
  "researchAreaCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "committeeIdFk": "(val)",
  "researchAreaCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Committee Research Areas
POST/iacuc/api/v1/iacuc-committee-research-areas/

Example URI

POST /iacuc/api/v1/iacuc-committee-research-areas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "committeeIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "committeeIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "committeeIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "committeeIdFk": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Committee Research Areas by Key
DELETE/iacuc/api/v1/iacuc-committee-research-areas/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-committee-research-areas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Committee Research Areas
DELETE/iacuc/api/v1/iacuc-committee-research-areas/

Example URI

DELETE /iacuc/api/v1/iacuc-committee-research-areas/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Committee Research Areas with Matching
DELETE/iacuc/api/v1/iacuc-committee-research-areas/

Example URI

DELETE /iacuc/api/v1/iacuc-committee-research-areas/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Committee Schedule Action Items

Get Iacuc Committee Schedule Action Items by Key
GET/iacuc/api/v1/iacuc-committee-schedule-action-items/(key)

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-action-items/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "commScheduleActItemsId": "(val)",
  "scheduleIdFk": "(val)",
  "actionItemNumber": "(val)",
  "scheduleActItemTypeCode": "(val)",
  "itemDescription": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Committee Schedule Action Items
GET/iacuc/api/v1/iacuc-committee-schedule-action-items/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-action-items/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Committee Schedule Action Items with Filtering
GET/iacuc/api/v1/iacuc-committee-schedule-action-items/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-action-items/
URI Parameters
HideShow
commScheduleActItemsId
string (optional) 
scheduleIdFk
string (optional) 
actionItemNumber
string (optional) 
scheduleActItemTypeCode
string (optional) 
itemDescription
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Committee Schedule Action Items
GET/iacuc/api/v1/iacuc-committee-schedule-action-items/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-action-items/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "commScheduleActItemsId",
    "scheduleIdFk",
    "actionItemNumber",
    "scheduleActItemTypeCode",
    "itemDescription"
  ],
  "primaryKey": "commScheduleActItemsId"
}

Get Blueprint API specification for Iacuc Committee Schedule Action Items
GET/iacuc/api/v1/iacuc-committee-schedule-action-items/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-action-items/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Committee Schedule Action Items.md"
transfer-encoding: chunked

Update Iacuc Committee Schedule Action Items
PUT/iacuc/api/v1/iacuc-committee-schedule-action-items/(key)

Example URI

PUT /iacuc/api/v1/iacuc-committee-schedule-action-items/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "commScheduleActItemsId": "(val)",
  "scheduleIdFk": "(val)",
  "actionItemNumber": "(val)",
  "scheduleActItemTypeCode": "(val)",
  "itemDescription": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Committee Schedule Action Items
PUT/iacuc/api/v1/iacuc-committee-schedule-action-items/

Example URI

PUT /iacuc/api/v1/iacuc-committee-schedule-action-items/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Committee Schedule Action Items
PATCH/iacuc/api/v1/iacuc-committee-schedule-action-items/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-committee-schedule-action-items/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "commScheduleActItemsId": "(val)",
  "scheduleIdFk": "(val)",
  "actionItemNumber": "(val)",
  "scheduleActItemTypeCode": "(val)",
  "itemDescription": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "commScheduleActItemsId": "(val)",
  "scheduleIdFk": "(val)",
  "actionItemNumber": "(val)",
  "scheduleActItemTypeCode": "(val)",
  "itemDescription": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Committee Schedule Action Items
POST/iacuc/api/v1/iacuc-committee-schedule-action-items/

Example URI

POST /iacuc/api/v1/iacuc-committee-schedule-action-items/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "commScheduleActItemsId": "(val)",
  "scheduleIdFk": "(val)",
  "actionItemNumber": "(val)",
  "scheduleActItemTypeCode": "(val)",
  "itemDescription": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "commScheduleActItemsId": "(val)",
  "scheduleIdFk": "(val)",
  "actionItemNumber": "(val)",
  "scheduleActItemTypeCode": "(val)",
  "itemDescription": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Committee Schedule Action Items
POST/iacuc/api/v1/iacuc-committee-schedule-action-items/

Example URI

POST /iacuc/api/v1/iacuc-committee-schedule-action-items/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Committee Schedule Action Items by Key
DELETE/iacuc/api/v1/iacuc-committee-schedule-action-items/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-committee-schedule-action-items/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Committee Schedule Action Items
DELETE/iacuc/api/v1/iacuc-committee-schedule-action-items/

Example URI

DELETE /iacuc/api/v1/iacuc-committee-schedule-action-items/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Committee Schedule Action Items with Matching
DELETE/iacuc/api/v1/iacuc-committee-schedule-action-items/

Example URI

DELETE /iacuc/api/v1/iacuc-committee-schedule-action-items/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

commScheduleActItemsId
string (optional) 
scheduleIdFk
string (optional) 
actionItemNumber
string (optional) 
scheduleActItemTypeCode
string (optional) 
itemDescription
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Committee Schedule Attachments

Get Iacuc Committee Schedule Attachments by Key
GET/iacuc/api/v1/iacuc-committee-schedule-attachments/(key)

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "scheduleId": "(val)",
  "attachmentId": "(val)",
  "attachmentsTypeCode": "(val)",
  "description": "(val)",
  "fileName": "(val)",
  "document": "(val)",
  "mimeType": "(val)",
  "newUpdateTimestamp": "(val)",
  "newUpdateUser": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Committee Schedule Attachments
GET/iacuc/api/v1/iacuc-committee-schedule-attachments/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Committee Schedule Attachments with Filtering
GET/iacuc/api/v1/iacuc-committee-schedule-attachments/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-attachments/
URI Parameters
HideShow
scheduleId
string (optional) 
attachmentId
string (optional) 
attachmentsTypeCode
string (optional) 
description
string (optional) 
fileName
string (optional) 
document
string (optional) 
mimeType
string (optional) 
newUpdateTimestamp
string (optional) 
newUpdateUser
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Committee Schedule Attachments
GET/iacuc/api/v1/iacuc-committee-schedule-attachments/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-attachments/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "scheduleId",
    "attachmentId",
    "attachmentsTypeCode",
    "description",
    "fileName",
    "document",
    "mimeType",
    "newUpdateTimestamp",
    "newUpdateUser"
  ],
  "primaryKey": "attachmentId"
}

Get Blueprint API specification for Iacuc Committee Schedule Attachments
GET/iacuc/api/v1/iacuc-committee-schedule-attachments/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-attachments/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Committee Schedule Attachments.md"
transfer-encoding: chunked

Update Iacuc Committee Schedule Attachments
PUT/iacuc/api/v1/iacuc-committee-schedule-attachments/(key)

Example URI

PUT /iacuc/api/v1/iacuc-committee-schedule-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "scheduleId": "(val)",
  "attachmentId": "(val)",
  "attachmentsTypeCode": "(val)",
  "description": "(val)",
  "fileName": "(val)",
  "document": "(val)",
  "mimeType": "(val)",
  "newUpdateTimestamp": "(val)",
  "newUpdateUser": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Committee Schedule Attachments
PUT/iacuc/api/v1/iacuc-committee-schedule-attachments/

Example URI

PUT /iacuc/api/v1/iacuc-committee-schedule-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Committee Schedule Attachments
PATCH/iacuc/api/v1/iacuc-committee-schedule-attachments/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-committee-schedule-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "scheduleId": "(val)",
  "attachmentId": "(val)",
  "attachmentsTypeCode": "(val)",
  "description": "(val)",
  "fileName": "(val)",
  "document": "(val)",
  "mimeType": "(val)",
  "newUpdateTimestamp": "(val)",
  "newUpdateUser": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "scheduleId": "(val)",
  "attachmentId": "(val)",
  "attachmentsTypeCode": "(val)",
  "description": "(val)",
  "fileName": "(val)",
  "document": "(val)",
  "mimeType": "(val)",
  "newUpdateTimestamp": "(val)",
  "newUpdateUser": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Committee Schedule Attachments
POST/iacuc/api/v1/iacuc-committee-schedule-attachments/

Example URI

POST /iacuc/api/v1/iacuc-committee-schedule-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "scheduleId": "(val)",
  "attachmentId": "(val)",
  "attachmentsTypeCode": "(val)",
  "description": "(val)",
  "fileName": "(val)",
  "document": "(val)",
  "mimeType": "(val)",
  "newUpdateTimestamp": "(val)",
  "newUpdateUser": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "scheduleId": "(val)",
  "attachmentId": "(val)",
  "attachmentsTypeCode": "(val)",
  "description": "(val)",
  "fileName": "(val)",
  "document": "(val)",
  "mimeType": "(val)",
  "newUpdateTimestamp": "(val)",
  "newUpdateUser": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Committee Schedule Attachments
POST/iacuc/api/v1/iacuc-committee-schedule-attachments/

Example URI

POST /iacuc/api/v1/iacuc-committee-schedule-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Committee Schedule Attachments by Key
DELETE/iacuc/api/v1/iacuc-committee-schedule-attachments/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-committee-schedule-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Committee Schedule Attachments
DELETE/iacuc/api/v1/iacuc-committee-schedule-attachments/

Example URI

DELETE /iacuc/api/v1/iacuc-committee-schedule-attachments/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Committee Schedule Attachments with Matching
DELETE/iacuc/api/v1/iacuc-committee-schedule-attachments/

Example URI

DELETE /iacuc/api/v1/iacuc-committee-schedule-attachments/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

scheduleId
string (optional) 
attachmentId
string (optional) 
attachmentsTypeCode
string (optional) 
description
string (optional) 
fileName
string (optional) 
document
string (optional) 
mimeType
string (optional) 
newUpdateTimestamp
string (optional) 
newUpdateUser
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Committee Schedule Attendances

Get Iacuc Committee Schedule Attendances by Key
GET/iacuc/api/v1/iacuc-committee-schedule-attendances/(key)

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-attendances/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "commScheduleAttendanceId": "(val)",
  "scheduleIdFk": "(val)",
  "personId": "(val)",
  "personName": "(val)",
  "guestFlag": "(val)",
  "alternateFlag": "(val)",
  "alternateFor": "(val)",
  "nonEmployeeFlag": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Committee Schedule Attendances
GET/iacuc/api/v1/iacuc-committee-schedule-attendances/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-attendances/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Committee Schedule Attendances with Filtering
GET/iacuc/api/v1/iacuc-committee-schedule-attendances/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-attendances/
URI Parameters
HideShow
commScheduleAttendanceId
string (optional) 
scheduleIdFk
string (optional) 
personId
string (optional) 
personName
string (optional) 
guestFlag
string (optional) 
alternateFlag
string (optional) 
alternateFor
string (optional) 
nonEmployeeFlag
string (optional) 
comments
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Committee Schedule Attendances
GET/iacuc/api/v1/iacuc-committee-schedule-attendances/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-attendances/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "commScheduleAttendanceId",
    "scheduleIdFk",
    "personId",
    "personName",
    "guestFlag",
    "alternateFlag",
    "alternateFor",
    "nonEmployeeFlag",
    "comments"
  ],
  "primaryKey": "commScheduleAttendanceId"
}

Get Blueprint API specification for Iacuc Committee Schedule Attendances
GET/iacuc/api/v1/iacuc-committee-schedule-attendances/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-attendances/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Committee Schedule Attendances.md"
transfer-encoding: chunked

Update Iacuc Committee Schedule Attendances
PUT/iacuc/api/v1/iacuc-committee-schedule-attendances/(key)

Example URI

PUT /iacuc/api/v1/iacuc-committee-schedule-attendances/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "commScheduleAttendanceId": "(val)",
  "scheduleIdFk": "(val)",
  "personId": "(val)",
  "personName": "(val)",
  "guestFlag": "(val)",
  "alternateFlag": "(val)",
  "alternateFor": "(val)",
  "nonEmployeeFlag": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Committee Schedule Attendances
PUT/iacuc/api/v1/iacuc-committee-schedule-attendances/

Example URI

PUT /iacuc/api/v1/iacuc-committee-schedule-attendances/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Committee Schedule Attendances
PATCH/iacuc/api/v1/iacuc-committee-schedule-attendances/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-committee-schedule-attendances/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "commScheduleAttendanceId": "(val)",
  "scheduleIdFk": "(val)",
  "personId": "(val)",
  "personName": "(val)",
  "guestFlag": "(val)",
  "alternateFlag": "(val)",
  "alternateFor": "(val)",
  "nonEmployeeFlag": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "commScheduleAttendanceId": "(val)",
  "scheduleIdFk": "(val)",
  "personId": "(val)",
  "personName": "(val)",
  "guestFlag": "(val)",
  "alternateFlag": "(val)",
  "alternateFor": "(val)",
  "nonEmployeeFlag": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Committee Schedule Attendances
POST/iacuc/api/v1/iacuc-committee-schedule-attendances/

Example URI

POST /iacuc/api/v1/iacuc-committee-schedule-attendances/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "commScheduleAttendanceId": "(val)",
  "scheduleIdFk": "(val)",
  "personId": "(val)",
  "personName": "(val)",
  "guestFlag": "(val)",
  "alternateFlag": "(val)",
  "alternateFor": "(val)",
  "nonEmployeeFlag": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "commScheduleAttendanceId": "(val)",
  "scheduleIdFk": "(val)",
  "personId": "(val)",
  "personName": "(val)",
  "guestFlag": "(val)",
  "alternateFlag": "(val)",
  "alternateFor": "(val)",
  "nonEmployeeFlag": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Committee Schedule Attendances
POST/iacuc/api/v1/iacuc-committee-schedule-attendances/

Example URI

POST /iacuc/api/v1/iacuc-committee-schedule-attendances/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Committee Schedule Attendances by Key
DELETE/iacuc/api/v1/iacuc-committee-schedule-attendances/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-committee-schedule-attendances/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Committee Schedule Attendances
DELETE/iacuc/api/v1/iacuc-committee-schedule-attendances/

Example URI

DELETE /iacuc/api/v1/iacuc-committee-schedule-attendances/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Committee Schedule Attendances with Matching
DELETE/iacuc/api/v1/iacuc-committee-schedule-attendances/

Example URI

DELETE /iacuc/api/v1/iacuc-committee-schedule-attendances/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

commScheduleAttendanceId
string (optional) 
scheduleIdFk
string (optional) 
personId
string (optional) 
personName
string (optional) 
guestFlag
string (optional) 
alternateFlag
string (optional) 
alternateFor
string (optional) 
nonEmployeeFlag
string (optional) 
comments
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Committee Schedule Minute Docs

Get Iacuc Committee Schedule Minute Docs by Key
GET/iacuc/api/v1/iacuc-committee-schedule-minute-docs/(key)

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-minute-docs/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "commScheduleMinuteDocId": "(val)",
  "scheduleIdFk": "(val)",
  "minuteNumber": "(val)",
  "minuteName": "(val)",
  "pdfStore": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Committee Schedule Minute Docs
GET/iacuc/api/v1/iacuc-committee-schedule-minute-docs/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-minute-docs/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Committee Schedule Minute Docs with Filtering
GET/iacuc/api/v1/iacuc-committee-schedule-minute-docs/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-minute-docs/
URI Parameters
HideShow
commScheduleMinuteDocId
string (optional) 
scheduleIdFk
string (optional) 
minuteNumber
string (optional) 
minuteName
string (optional) 
pdfStore
string (optional) 
createTimestamp
string (optional) 
createUser
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Committee Schedule Minute Docs
GET/iacuc/api/v1/iacuc-committee-schedule-minute-docs/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-minute-docs/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "commScheduleMinuteDocId",
    "scheduleIdFk",
    "minuteNumber",
    "minuteName",
    "pdfStore",
    "createTimestamp",
    "createUser"
  ],
  "primaryKey": "commScheduleMinuteDocId"
}

Get Blueprint API specification for Iacuc Committee Schedule Minute Docs
GET/iacuc/api/v1/iacuc-committee-schedule-minute-docs/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-minute-docs/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Committee Schedule Minute Docs.md"
transfer-encoding: chunked

Update Iacuc Committee Schedule Minute Docs
PUT/iacuc/api/v1/iacuc-committee-schedule-minute-docs/(key)

Example URI

PUT /iacuc/api/v1/iacuc-committee-schedule-minute-docs/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "commScheduleMinuteDocId": "(val)",
  "scheduleIdFk": "(val)",
  "minuteNumber": "(val)",
  "minuteName": "(val)",
  "pdfStore": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Committee Schedule Minute Docs
PUT/iacuc/api/v1/iacuc-committee-schedule-minute-docs/

Example URI

PUT /iacuc/api/v1/iacuc-committee-schedule-minute-docs/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Committee Schedule Minute Docs
PATCH/iacuc/api/v1/iacuc-committee-schedule-minute-docs/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-committee-schedule-minute-docs/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "commScheduleMinuteDocId": "(val)",
  "scheduleIdFk": "(val)",
  "minuteNumber": "(val)",
  "minuteName": "(val)",
  "pdfStore": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "commScheduleMinuteDocId": "(val)",
  "scheduleIdFk": "(val)",
  "minuteNumber": "(val)",
  "minuteName": "(val)",
  "pdfStore": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Committee Schedule Minute Docs
POST/iacuc/api/v1/iacuc-committee-schedule-minute-docs/

Example URI

POST /iacuc/api/v1/iacuc-committee-schedule-minute-docs/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "commScheduleMinuteDocId": "(val)",
  "scheduleIdFk": "(val)",
  "minuteNumber": "(val)",
  "minuteName": "(val)",
  "pdfStore": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "commScheduleMinuteDocId": "(val)",
  "scheduleIdFk": "(val)",
  "minuteNumber": "(val)",
  "minuteName": "(val)",
  "pdfStore": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Committee Schedule Minute Docs
POST/iacuc/api/v1/iacuc-committee-schedule-minute-docs/

Example URI

POST /iacuc/api/v1/iacuc-committee-schedule-minute-docs/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Committee Schedule Minute Docs by Key
DELETE/iacuc/api/v1/iacuc-committee-schedule-minute-docs/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-committee-schedule-minute-docs/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Committee Schedule Minute Docs
DELETE/iacuc/api/v1/iacuc-committee-schedule-minute-docs/

Example URI

DELETE /iacuc/api/v1/iacuc-committee-schedule-minute-docs/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Committee Schedule Minute Docs with Matching
DELETE/iacuc/api/v1/iacuc-committee-schedule-minute-docs/

Example URI

DELETE /iacuc/api/v1/iacuc-committee-schedule-minute-docs/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

commScheduleMinuteDocId
string (optional) 
scheduleIdFk
string (optional) 
minuteNumber
string (optional) 
minuteName
string (optional) 
pdfStore
string (optional) 
createTimestamp
string (optional) 
createUser
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Committee Schedule Minutes

Get Iacuc Committee Schedule Minutes by Key
GET/iacuc/api/v1/iacuc-committee-schedule-minutes/(key)

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-minutes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "commScheduleMinutesId": "(val)",
  "scheduleIdFk": "(val)",
  "entryNumber": "(val)",
  "minuteEntryTypeCode": "(val)",
  "protocolIdFk": "(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 Iacuc Committee Schedule Minutes
GET/iacuc/api/v1/iacuc-committee-schedule-minutes/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-minutes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "commScheduleMinutesId": "(val)",
    "scheduleIdFk": "(val)",
    "entryNumber": "(val)",
    "minuteEntryTypeCode": "(val)",
    "protocolIdFk": "(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)",
    "commScheduleActItemsIdFk": "(val)",
    "submissionIdFk": "(val)",
    "privateCommentFlag": "(val)",
    "protocolContingencyCode": "(val)",
    "minuteEntry": "(val)",
    "finalFlag": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "protocolReviewerIdFk": "(val)",
    "protocolOnlineReviewIdFk": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Committee Schedule Minutes with Filtering
GET/iacuc/api/v1/iacuc-committee-schedule-minutes/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-minutes/
URI Parameters
HideShow
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.

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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "commScheduleMinutesId": "(val)",
    "scheduleIdFk": "(val)",
    "entryNumber": "(val)",
    "minuteEntryTypeCode": "(val)",
    "protocolIdFk": "(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)",
    "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 Iacuc Committee Schedule Minutes
GET/iacuc/api/v1/iacuc-committee-schedule-minutes/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-minutes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "commScheduleMinutesId",
    "scheduleIdFk",
    "entryNumber",
    "minuteEntryTypeCode",
    "protocolIdFk",
    "commScheduleActItemsIdFk",
    "submissionIdFk",
    "privateCommentFlag",
    "protocolContingencyCode",
    "minuteEntry",
    "finalFlag",
    "createTimestamp",
    "createUser",
    "protocolReviewerIdFk",
    "protocolOnlineReviewIdFk"
  ],
  "primaryKey": "commScheduleMinutesId"
}

Get Blueprint API specification for Iacuc Committee Schedule Minutes
GET/iacuc/api/v1/iacuc-committee-schedule-minutes/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedule-minutes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Committee Schedule Minutes.md"
transfer-encoding: chunked

Update Iacuc Committee Schedule Minutes
PUT/iacuc/api/v1/iacuc-committee-schedule-minutes/(key)

Example URI

PUT /iacuc/api/v1/iacuc-committee-schedule-minutes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "commScheduleMinutesId": "(val)",
  "scheduleIdFk": "(val)",
  "entryNumber": "(val)",
  "minuteEntryTypeCode": "(val)",
  "protocolIdFk": "(val)",
  "commScheduleActItemsIdFk": "(val)",
  "submissionIdFk": "(val)",
  "privateCommentFlag": "(val)",
  "protocolContingencyCode": "(val)",
  "minuteEntry": "(val)",
  "finalFlag": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "protocolReviewerIdFk": "(val)",
  "protocolOnlineReviewIdFk": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Committee Schedule Minutes
PUT/iacuc/api/v1/iacuc-committee-schedule-minutes/

Example URI

PUT /iacuc/api/v1/iacuc-committee-schedule-minutes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "commScheduleMinutesId": "(val)",
    "scheduleIdFk": "(val)",
    "entryNumber": "(val)",
    "minuteEntryTypeCode": "(val)",
    "protocolIdFk": "(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)",
    "commScheduleActItemsIdFk": "(val)",
    "submissionIdFk": "(val)",
    "privateCommentFlag": "(val)",
    "protocolContingencyCode": "(val)",
    "minuteEntry": "(val)",
    "finalFlag": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "protocolReviewerIdFk": "(val)",
    "protocolOnlineReviewIdFk": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Committee Schedule Minutes
PATCH/iacuc/api/v1/iacuc-committee-schedule-minutes/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-committee-schedule-minutes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "commScheduleMinutesId": "(val)",
  "scheduleIdFk": "(val)",
  "entryNumber": "(val)",
  "minuteEntryTypeCode": "(val)",
  "protocolIdFk": "(val)",
  "commScheduleActItemsIdFk": "(val)",
  "submissionIdFk": "(val)",
  "privateCommentFlag": "(val)",
  "protocolContingencyCode": "(val)",
  "minuteEntry": "(val)",
  "finalFlag": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "protocolReviewerIdFk": "(val)",
  "protocolOnlineReviewIdFk": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "commScheduleMinutesId": "(val)",
  "scheduleIdFk": "(val)",
  "entryNumber": "(val)",
  "minuteEntryTypeCode": "(val)",
  "protocolIdFk": "(val)",
  "commScheduleActItemsIdFk": "(val)",
  "submissionIdFk": "(val)",
  "privateCommentFlag": "(val)",
  "protocolContingencyCode": "(val)",
  "minuteEntry": "(val)",
  "finalFlag": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "protocolReviewerIdFk": "(val)",
  "protocolOnlineReviewIdFk": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Committee Schedule Minutes
POST/iacuc/api/v1/iacuc-committee-schedule-minutes/

Example URI

POST /iacuc/api/v1/iacuc-committee-schedule-minutes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "commScheduleMinutesId": "(val)",
  "scheduleIdFk": "(val)",
  "entryNumber": "(val)",
  "minuteEntryTypeCode": "(val)",
  "protocolIdFk": "(val)",
  "commScheduleActItemsIdFk": "(val)",
  "submissionIdFk": "(val)",
  "privateCommentFlag": "(val)",
  "protocolContingencyCode": "(val)",
  "minuteEntry": "(val)",
  "finalFlag": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "protocolReviewerIdFk": "(val)",
  "protocolOnlineReviewIdFk": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "commScheduleMinutesId": "(val)",
  "scheduleIdFk": "(val)",
  "entryNumber": "(val)",
  "minuteEntryTypeCode": "(val)",
  "protocolIdFk": "(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 Iacuc Committee Schedule Minutes
POST/iacuc/api/v1/iacuc-committee-schedule-minutes/

Example URI

POST /iacuc/api/v1/iacuc-committee-schedule-minutes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "commScheduleMinutesId": "(val)",
    "scheduleIdFk": "(val)",
    "entryNumber": "(val)",
    "minuteEntryTypeCode": "(val)",
    "protocolIdFk": "(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)",
    "commScheduleActItemsIdFk": "(val)",
    "submissionIdFk": "(val)",
    "privateCommentFlag": "(val)",
    "protocolContingencyCode": "(val)",
    "minuteEntry": "(val)",
    "finalFlag": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "protocolReviewerIdFk": "(val)",
    "protocolOnlineReviewIdFk": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "commScheduleMinutesId": "(val)",
    "scheduleIdFk": "(val)",
    "entryNumber": "(val)",
    "minuteEntryTypeCode": "(val)",
    "protocolIdFk": "(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)",
    "commScheduleActItemsIdFk": "(val)",
    "submissionIdFk": "(val)",
    "privateCommentFlag": "(val)",
    "protocolContingencyCode": "(val)",
    "minuteEntry": "(val)",
    "finalFlag": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "protocolReviewerIdFk": "(val)",
    "protocolOnlineReviewIdFk": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Committee Schedule Minutes by Key
DELETE/iacuc/api/v1/iacuc-committee-schedule-minutes/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-committee-schedule-minutes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Committee Schedule Minutes
DELETE/iacuc/api/v1/iacuc-committee-schedule-minutes/

Example URI

DELETE /iacuc/api/v1/iacuc-committee-schedule-minutes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Committee Schedule Minutes with Matching
DELETE/iacuc/api/v1/iacuc-committee-schedule-minutes/

Example URI

DELETE /iacuc/api/v1/iacuc-committee-schedule-minutes/
URI Parameters
HideShow
_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.

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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Committee Schedules

Get Iacuc Committee Schedules by Key
GET/iacuc/api/v1/iacuc-committee-schedules/(key)

Example URI

GET /iacuc/api/v1/iacuc-committee-schedules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "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 Iacuc Committee Schedules
GET/iacuc/api/v1/iacuc-committee-schedules/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Committee Schedules with Filtering
GET/iacuc/api/v1/iacuc-committee-schedules/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedules/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Committee Schedules
GET/iacuc/api/v1/iacuc-committee-schedules/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedules/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "scheduleId",
    "committeeIdFk",
    "scheduledDate",
    "place",
    "time",
    "protocolSubDeadline",
    "scheduleStatusCode",
    "meetingDate",
    "startTime",
    "endTime",
    "agendaProdRevDate",
    "maxProtocols",
    "comments",
    "availableToReviewers"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Iacuc Committee Schedules
GET/iacuc/api/v1/iacuc-committee-schedules/

Example URI

GET /iacuc/api/v1/iacuc-committee-schedules/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Committee Schedules.md"
transfer-encoding: chunked

Update Iacuc Committee Schedules
PUT/iacuc/api/v1/iacuc-committee-schedules/(key)

Example URI

PUT /iacuc/api/v1/iacuc-committee-schedules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  204

Update Multiple Iacuc Committee Schedules
PUT/iacuc/api/v1/iacuc-committee-schedules/

Example URI

PUT /iacuc/api/v1/iacuc-committee-schedules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Committee Schedules
PATCH/iacuc/api/v1/iacuc-committee-schedules/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-committee-schedules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  204
HideShow
Body
{
  "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 Iacuc Committee Schedules
POST/iacuc/api/v1/iacuc-committee-schedules/

Example URI

POST /iacuc/api/v1/iacuc-committee-schedules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  201
HideShow
Body
{
  "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 Iacuc Committee Schedules
POST/iacuc/api/v1/iacuc-committee-schedules/

Example URI

POST /iacuc/api/v1/iacuc-committee-schedules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Committee Schedules by Key
DELETE/iacuc/api/v1/iacuc-committee-schedules/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-committee-schedules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Committee Schedules
DELETE/iacuc/api/v1/iacuc-committee-schedules/

Example URI

DELETE /iacuc/api/v1/iacuc-committee-schedules/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Committee Schedules with Matching
DELETE/iacuc/api/v1/iacuc-committee-schedules/

Example URI

DELETE /iacuc/api/v1/iacuc-committee-schedules/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Committees

Get Iacuc Committees by Key
GET/iacuc/api/v1/iacuc-committees/(key)

Example URI

GET /iacuc/api/v1/iacuc-committees/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "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 Iacuc Committees
GET/iacuc/api/v1/iacuc-committees/

Example URI

GET /iacuc/api/v1/iacuc-committees/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Committees with Filtering
GET/iacuc/api/v1/iacuc-committees/

Example URI

GET /iacuc/api/v1/iacuc-committees/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Committees
GET/iacuc/api/v1/iacuc-committees/

Example URI

GET /iacuc/api/v1/iacuc-committees/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "committeeId",
    "sequenceNumber",
    "committeeName",
    "homeUnitNumber",
    "committeeDescription",
    "scheduleDescription",
    "committeeTypeCode",
    "minimumMembersRequired",
    "maxProtocols",
    "advancedSubmissionDaysRequired",
    "reviewTypeCode",
    "committeeDocument.documentNumber"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Iacuc Committees
GET/iacuc/api/v1/iacuc-committees/

Example URI

GET /iacuc/api/v1/iacuc-committees/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Committees.md"
transfer-encoding: chunked

Iacuc Correspondent Types

Get Iacuc Correspondent Types by Key
GET/iacuc/api/v1/iacuc-correspondent-types/(key)

Example URI

GET /iacuc/api/v1/iacuc-correspondent-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "correspondentTypeCode": "(val)",
  "description": "(val)",
  "qualifier": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Correspondent Types
GET/iacuc/api/v1/iacuc-correspondent-types/

Example URI

GET /iacuc/api/v1/iacuc-correspondent-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "correspondentTypeCode": "(val)",
    "description": "(val)",
    "qualifier": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "correspondentTypeCode": "(val)",
    "description": "(val)",
    "qualifier": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Correspondent Types with Filtering
GET/iacuc/api/v1/iacuc-correspondent-types/

Example URI

GET /iacuc/api/v1/iacuc-correspondent-types/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "correspondentTypeCode": "(val)",
    "description": "(val)",
    "qualifier": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "correspondentTypeCode": "(val)",
    "description": "(val)",
    "qualifier": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Correspondent Types
GET/iacuc/api/v1/iacuc-correspondent-types/

Example URI

GET /iacuc/api/v1/iacuc-correspondent-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "correspondentTypeCode",
    "description",
    "qualifier"
  ],
  "primaryKey": "correspondentTypeCode"
}

Get Blueprint API specification for Iacuc Correspondent Types
GET/iacuc/api/v1/iacuc-correspondent-types/

Example URI

GET /iacuc/api/v1/iacuc-correspondent-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Correspondent Types.md"
transfer-encoding: chunked

Update Iacuc Correspondent Types
PUT/iacuc/api/v1/iacuc-correspondent-types/(key)

Example URI

PUT /iacuc/api/v1/iacuc-correspondent-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "correspondentTypeCode": "(val)",
  "description": "(val)",
  "qualifier": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Correspondent Types
PUT/iacuc/api/v1/iacuc-correspondent-types/

Example URI

PUT /iacuc/api/v1/iacuc-correspondent-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "correspondentTypeCode": "(val)",
    "description": "(val)",
    "qualifier": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "correspondentTypeCode": "(val)",
    "description": "(val)",
    "qualifier": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Correspondent Types
PATCH/iacuc/api/v1/iacuc-correspondent-types/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-correspondent-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "correspondentTypeCode": "(val)",
  "description": "(val)",
  "qualifier": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "correspondentTypeCode": "(val)",
  "description": "(val)",
  "qualifier": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Correspondent Types
POST/iacuc/api/v1/iacuc-correspondent-types/

Example URI

POST /iacuc/api/v1/iacuc-correspondent-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "correspondentTypeCode": "(val)",
  "description": "(val)",
  "qualifier": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "correspondentTypeCode": "(val)",
  "description": "(val)",
  "qualifier": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Correspondent Types
POST/iacuc/api/v1/iacuc-correspondent-types/

Example URI

POST /iacuc/api/v1/iacuc-correspondent-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "correspondentTypeCode": "(val)",
    "description": "(val)",
    "qualifier": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "correspondentTypeCode": "(val)",
    "description": "(val)",
    "qualifier": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "correspondentTypeCode": "(val)",
    "description": "(val)",
    "qualifier": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "correspondentTypeCode": "(val)",
    "description": "(val)",
    "qualifier": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Correspondent Types by Key
DELETE/iacuc/api/v1/iacuc-correspondent-types/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-correspondent-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Correspondent Types
DELETE/iacuc/api/v1/iacuc-correspondent-types/

Example URI

DELETE /iacuc/api/v1/iacuc-correspondent-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Correspondent Types with Matching
DELETE/iacuc/api/v1/iacuc-correspondent-types/

Example URI

DELETE /iacuc/api/v1/iacuc-correspondent-types/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Exception Categories

Get Iacuc Exception Categories by Key
GET/iacuc/api/v1/iacuc-exception-categories/(key)

Example URI

GET /iacuc/api/v1/iacuc-exception-categories/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "exceptionCategoryCode": "(val)",
  "exceptionCategoryDesc": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Exception Categories
GET/iacuc/api/v1/iacuc-exception-categories/

Example URI

GET /iacuc/api/v1/iacuc-exception-categories/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "exceptionCategoryCode": "(val)",
    "exceptionCategoryDesc": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "exceptionCategoryCode": "(val)",
    "exceptionCategoryDesc": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Exception Categories with Filtering
GET/iacuc/api/v1/iacuc-exception-categories/

Example URI

GET /iacuc/api/v1/iacuc-exception-categories/
URI Parameters
HideShow
exceptionCategoryCode
string (optional) 

Exception Category Code. Maximum length is 3.

exceptionCategoryDesc
string (optional) 

Exception Category. Maximum length is 200.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "exceptionCategoryCode": "(val)",
    "exceptionCategoryDesc": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "exceptionCategoryCode": "(val)",
    "exceptionCategoryDesc": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Exception Categories
GET/iacuc/api/v1/iacuc-exception-categories/

Example URI

GET /iacuc/api/v1/iacuc-exception-categories/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "exceptionCategoryCode",
    "exceptionCategoryDesc",
    "active"
  ],
  "primaryKey": "exceptionCategoryCode"
}

Get Blueprint API specification for Iacuc Exception Categories
GET/iacuc/api/v1/iacuc-exception-categories/

Example URI

GET /iacuc/api/v1/iacuc-exception-categories/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Exception Categories.md"
transfer-encoding: chunked

Update Iacuc Exception Categories
PUT/iacuc/api/v1/iacuc-exception-categories/(key)

Example URI

PUT /iacuc/api/v1/iacuc-exception-categories/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "exceptionCategoryCode": "(val)",
  "exceptionCategoryDesc": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Exception Categories
PUT/iacuc/api/v1/iacuc-exception-categories/

Example URI

PUT /iacuc/api/v1/iacuc-exception-categories/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "exceptionCategoryCode": "(val)",
    "exceptionCategoryDesc": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "exceptionCategoryCode": "(val)",
    "exceptionCategoryDesc": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Exception Categories
PATCH/iacuc/api/v1/iacuc-exception-categories/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-exception-categories/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "exceptionCategoryCode": "(val)",
  "exceptionCategoryDesc": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "exceptionCategoryCode": "(val)",
  "exceptionCategoryDesc": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Exception Categories
POST/iacuc/api/v1/iacuc-exception-categories/

Example URI

POST /iacuc/api/v1/iacuc-exception-categories/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "exceptionCategoryCode": "(val)",
  "exceptionCategoryDesc": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "exceptionCategoryCode": "(val)",
  "exceptionCategoryDesc": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Exception Categories
POST/iacuc/api/v1/iacuc-exception-categories/

Example URI

POST /iacuc/api/v1/iacuc-exception-categories/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "exceptionCategoryCode": "(val)",
    "exceptionCategoryDesc": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "exceptionCategoryCode": "(val)",
    "exceptionCategoryDesc": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "exceptionCategoryCode": "(val)",
    "exceptionCategoryDesc": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "exceptionCategoryCode": "(val)",
    "exceptionCategoryDesc": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Exception Categories by Key
DELETE/iacuc/api/v1/iacuc-exception-categories/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-exception-categories/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Exception Categories
DELETE/iacuc/api/v1/iacuc-exception-categories/

Example URI

DELETE /iacuc/api/v1/iacuc-exception-categories/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Exception Categories with Matching
DELETE/iacuc/api/v1/iacuc-exception-categories/

Example URI

DELETE /iacuc/api/v1/iacuc-exception-categories/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

exceptionCategoryCode
string (optional) 

Exception Category Code. Maximum length is 3.

exceptionCategoryDesc
string (optional) 

Exception Category. Maximum length is 200.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Location Names

Get Iacuc Location Names by Key
GET/iacuc/api/v1/iacuc-location-names/(key)

Example URI

GET /iacuc/api/v1/iacuc-location-names/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "locationId": "(val)",
  "locationName": "(val)",
  "locationTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Location Names
GET/iacuc/api/v1/iacuc-location-names/

Example URI

GET /iacuc/api/v1/iacuc-location-names/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "locationId": "(val)",
    "locationName": "(val)",
    "locationTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "locationId": "(val)",
    "locationName": "(val)",
    "locationTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Location Names with Filtering
GET/iacuc/api/v1/iacuc-location-names/

Example URI

GET /iacuc/api/v1/iacuc-location-names/
URI Parameters
HideShow
locationId
string (optional) 

Location Name Code. Maximum length is 3.

locationName
string (optional) 

Location Name. Maximum length is 200.

locationTypeCode
string (optional) 

Location Type Code. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "locationId": "(val)",
    "locationName": "(val)",
    "locationTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "locationId": "(val)",
    "locationName": "(val)",
    "locationTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Location Names
GET/iacuc/api/v1/iacuc-location-names/

Example URI

GET /iacuc/api/v1/iacuc-location-names/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "locationId",
    "locationName",
    "locationTypeCode"
  ],
  "primaryKey": "locationId"
}

Get Blueprint API specification for Iacuc Location Names
GET/iacuc/api/v1/iacuc-location-names/

Example URI

GET /iacuc/api/v1/iacuc-location-names/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Location Names.md"
transfer-encoding: chunked

Update Iacuc Location Names
PUT/iacuc/api/v1/iacuc-location-names/(key)

Example URI

PUT /iacuc/api/v1/iacuc-location-names/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "locationId": "(val)",
  "locationName": "(val)",
  "locationTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Location Names
PUT/iacuc/api/v1/iacuc-location-names/

Example URI

PUT /iacuc/api/v1/iacuc-location-names/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "locationId": "(val)",
    "locationName": "(val)",
    "locationTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "locationId": "(val)",
    "locationName": "(val)",
    "locationTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Location Names
PATCH/iacuc/api/v1/iacuc-location-names/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-location-names/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "locationId": "(val)",
  "locationName": "(val)",
  "locationTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "locationId": "(val)",
  "locationName": "(val)",
  "locationTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Location Names
POST/iacuc/api/v1/iacuc-location-names/

Example URI

POST /iacuc/api/v1/iacuc-location-names/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "locationId": "(val)",
  "locationName": "(val)",
  "locationTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "locationId": "(val)",
  "locationName": "(val)",
  "locationTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Location Names
POST/iacuc/api/v1/iacuc-location-names/

Example URI

POST /iacuc/api/v1/iacuc-location-names/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "locationId": "(val)",
    "locationName": "(val)",
    "locationTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "locationId": "(val)",
    "locationName": "(val)",
    "locationTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "locationId": "(val)",
    "locationName": "(val)",
    "locationTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "locationId": "(val)",
    "locationName": "(val)",
    "locationTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Location Names by Key
DELETE/iacuc/api/v1/iacuc-location-names/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-location-names/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Location Names
DELETE/iacuc/api/v1/iacuc-location-names/

Example URI

DELETE /iacuc/api/v1/iacuc-location-names/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Location Names with Matching
DELETE/iacuc/api/v1/iacuc-location-names/

Example URI

DELETE /iacuc/api/v1/iacuc-location-names/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

locationId
string (optional) 

Location Name Code. Maximum length is 3.

locationName
string (optional) 

Location Name. Maximum length is 200.

locationTypeCode
string (optional) 

Location Type Code. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Location Types

Get Iacuc Location Types by Key
GET/iacuc/api/v1/iacuc-location-types/(key)

Example URI

GET /iacuc/api/v1/iacuc-location-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "locationTypeCode": "(val)",
  "location": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Location Types
GET/iacuc/api/v1/iacuc-location-types/

Example URI

GET /iacuc/api/v1/iacuc-location-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "locationTypeCode": "(val)",
    "location": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "locationTypeCode": "(val)",
    "location": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Location Types with Filtering
GET/iacuc/api/v1/iacuc-location-types/

Example URI

GET /iacuc/api/v1/iacuc-location-types/
URI Parameters
HideShow
locationTypeCode
string (optional) 

Location Type Code. Maximum length is 3.

location
string (optional) 

Location Type. Maximum length is 200.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "locationTypeCode": "(val)",
    "location": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "locationTypeCode": "(val)",
    "location": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Location Types
GET/iacuc/api/v1/iacuc-location-types/

Example URI

GET /iacuc/api/v1/iacuc-location-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "locationTypeCode",
    "location"
  ],
  "primaryKey": "locationTypeCode"
}

Get Blueprint API specification for Iacuc Location Types
GET/iacuc/api/v1/iacuc-location-types/

Example URI

GET /iacuc/api/v1/iacuc-location-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Location Types.md"
transfer-encoding: chunked

Update Iacuc Location Types
PUT/iacuc/api/v1/iacuc-location-types/(key)

Example URI

PUT /iacuc/api/v1/iacuc-location-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "locationTypeCode": "(val)",
  "location": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Location Types
PUT/iacuc/api/v1/iacuc-location-types/

Example URI

PUT /iacuc/api/v1/iacuc-location-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "locationTypeCode": "(val)",
    "location": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "locationTypeCode": "(val)",
    "location": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Location Types
PATCH/iacuc/api/v1/iacuc-location-types/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-location-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "locationTypeCode": "(val)",
  "location": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "locationTypeCode": "(val)",
  "location": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Location Types
POST/iacuc/api/v1/iacuc-location-types/

Example URI

POST /iacuc/api/v1/iacuc-location-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "locationTypeCode": "(val)",
  "location": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "locationTypeCode": "(val)",
  "location": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Location Types
POST/iacuc/api/v1/iacuc-location-types/

Example URI

POST /iacuc/api/v1/iacuc-location-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "locationTypeCode": "(val)",
    "location": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "locationTypeCode": "(val)",
    "location": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "locationTypeCode": "(val)",
    "location": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "locationTypeCode": "(val)",
    "location": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Location Types by Key
DELETE/iacuc/api/v1/iacuc-location-types/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-location-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Location Types
DELETE/iacuc/api/v1/iacuc-location-types/

Example URI

DELETE /iacuc/api/v1/iacuc-location-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Location Types with Matching
DELETE/iacuc/api/v1/iacuc-location-types/

Example URI

DELETE /iacuc/api/v1/iacuc-location-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

locationTypeCode
string (optional) 

Location Type Code. Maximum length is 3.

location
string (optional) 

Location Type. Maximum length is 200.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Organization Correspondents

Get Iacuc Organization Correspondents by Key
GET/iacuc/api/v1/iacuc-organization-correspondents/(key)

Example URI

GET /iacuc/api/v1/iacuc-organization-correspondents/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "correspondentId": "(val)",
  "organizationId": "(val)",
  "correspondentTypeCode": "(val)",
  "personId": "(val)",
  "nonEmployeeFlag": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Organization Correspondents
GET/iacuc/api/v1/iacuc-organization-correspondents/

Example URI

GET /iacuc/api/v1/iacuc-organization-correspondents/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "correspondentId": "(val)",
    "organizationId": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "correspondentId": "(val)",
    "organizationId": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Organization Correspondents with Filtering
GET/iacuc/api/v1/iacuc-organization-correspondents/

Example URI

GET /iacuc/api/v1/iacuc-organization-correspondents/
URI Parameters
HideShow
correspondentId
string (optional) 
organizationId
string (optional) 

Organization Id. Maximum length is 8.

correspondentTypeCode
string (optional) 

Correspondent Type Code. Maximum length is 22.

personId
string (optional) 

This is a generic implementation of a ‘SystemId’ attribute. It should always be overriden on the label, shortLabel, summary, and description, as these are only generic placeholders. Maximum length is 40.

nonEmployeeFlag
string (optional) 

Non Employee Flag. Maximum length is 1.

description
string (optional) 

Description. Maximum length is 2000.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "correspondentId": "(val)",
    "organizationId": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "correspondentId": "(val)",
    "organizationId": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Organization Correspondents
GET/iacuc/api/v1/iacuc-organization-correspondents/

Example URI

GET /iacuc/api/v1/iacuc-organization-correspondents/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "correspondentId",
    "organizationId",
    "correspondentTypeCode",
    "personId",
    "nonEmployeeFlag",
    "description"
  ],
  "primaryKey": "correspondentId"
}

Get Blueprint API specification for Iacuc Organization Correspondents
GET/iacuc/api/v1/iacuc-organization-correspondents/

Example URI

GET /iacuc/api/v1/iacuc-organization-correspondents/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Organization Correspondents.md"
transfer-encoding: chunked

Update Iacuc Organization Correspondents
PUT/iacuc/api/v1/iacuc-organization-correspondents/(key)

Example URI

PUT /iacuc/api/v1/iacuc-organization-correspondents/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "correspondentId": "(val)",
  "organizationId": "(val)",
  "correspondentTypeCode": "(val)",
  "personId": "(val)",
  "nonEmployeeFlag": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Organization Correspondents
PUT/iacuc/api/v1/iacuc-organization-correspondents/

Example URI

PUT /iacuc/api/v1/iacuc-organization-correspondents/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "correspondentId": "(val)",
    "organizationId": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "correspondentId": "(val)",
    "organizationId": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Organization Correspondents
PATCH/iacuc/api/v1/iacuc-organization-correspondents/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-organization-correspondents/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "correspondentId": "(val)",
  "organizationId": "(val)",
  "correspondentTypeCode": "(val)",
  "personId": "(val)",
  "nonEmployeeFlag": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "correspondentId": "(val)",
  "organizationId": "(val)",
  "correspondentTypeCode": "(val)",
  "personId": "(val)",
  "nonEmployeeFlag": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Organization Correspondents
POST/iacuc/api/v1/iacuc-organization-correspondents/

Example URI

POST /iacuc/api/v1/iacuc-organization-correspondents/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "correspondentId": "(val)",
  "organizationId": "(val)",
  "correspondentTypeCode": "(val)",
  "personId": "(val)",
  "nonEmployeeFlag": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "correspondentId": "(val)",
  "organizationId": "(val)",
  "correspondentTypeCode": "(val)",
  "personId": "(val)",
  "nonEmployeeFlag": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Organization Correspondents
POST/iacuc/api/v1/iacuc-organization-correspondents/

Example URI

POST /iacuc/api/v1/iacuc-organization-correspondents/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "correspondentId": "(val)",
    "organizationId": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "correspondentId": "(val)",
    "organizationId": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "correspondentId": "(val)",
    "organizationId": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "correspondentId": "(val)",
    "organizationId": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Organization Correspondents by Key
DELETE/iacuc/api/v1/iacuc-organization-correspondents/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-organization-correspondents/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Organization Correspondents
DELETE/iacuc/api/v1/iacuc-organization-correspondents/

Example URI

DELETE /iacuc/api/v1/iacuc-organization-correspondents/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Organization Correspondents with Matching
DELETE/iacuc/api/v1/iacuc-organization-correspondents/

Example URI

DELETE /iacuc/api/v1/iacuc-organization-correspondents/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

correspondentId
string (optional) 
organizationId
string (optional) 

Organization Id. Maximum length is 8.

correspondentTypeCode
string (optional) 

Correspondent Type Code. Maximum length is 22.

personId
string (optional) 

This is a generic implementation of a ‘SystemId’ attribute. It should always be overriden on the label, shortLabel, summary, and description, as these are only generic placeholders. Maximum length is 40.

nonEmployeeFlag
string (optional) 

Non Employee Flag. Maximum length is 1.

description
string (optional) 

Description. Maximum length is 2000.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Pain Categories

Get Iacuc Pain Categories by Key
GET/iacuc/api/v1/iacuc-pain-categories/(key)

Example URI

GET /iacuc/api/v1/iacuc-pain-categories/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "painCategoryCode": "(val)",
  "painCategory": "(val)",
  "painLevel": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Pain Categories
GET/iacuc/api/v1/iacuc-pain-categories/

Example URI

GET /iacuc/api/v1/iacuc-pain-categories/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "painCategoryCode": "(val)",
    "painCategory": "(val)",
    "painLevel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "painCategoryCode": "(val)",
    "painCategory": "(val)",
    "painLevel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Pain Categories with Filtering
GET/iacuc/api/v1/iacuc-pain-categories/

Example URI

GET /iacuc/api/v1/iacuc-pain-categories/
URI Parameters
HideShow
painCategoryCode
string (optional) 

Pain Category Code. Maximum length is 3.

painCategory
string (optional) 

Pain Category. Maximum length is 200.

painLevel
string (optional) 

Pain Level. Maximum length is 3.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "painCategoryCode": "(val)",
    "painCategory": "(val)",
    "painLevel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "painCategoryCode": "(val)",
    "painCategory": "(val)",
    "painLevel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Pain Categories
GET/iacuc/api/v1/iacuc-pain-categories/

Example URI

GET /iacuc/api/v1/iacuc-pain-categories/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "painCategoryCode",
    "painCategory",
    "painLevel",
    "active"
  ],
  "primaryKey": "painCategoryCode"
}

Get Blueprint API specification for Iacuc Pain Categories
GET/iacuc/api/v1/iacuc-pain-categories/

Example URI

GET /iacuc/api/v1/iacuc-pain-categories/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Pain Categories.md"
transfer-encoding: chunked

Update Iacuc Pain Categories
PUT/iacuc/api/v1/iacuc-pain-categories/(key)

Example URI

PUT /iacuc/api/v1/iacuc-pain-categories/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "painCategoryCode": "(val)",
  "painCategory": "(val)",
  "painLevel": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Pain Categories
PUT/iacuc/api/v1/iacuc-pain-categories/

Example URI

PUT /iacuc/api/v1/iacuc-pain-categories/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "painCategoryCode": "(val)",
    "painCategory": "(val)",
    "painLevel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "painCategoryCode": "(val)",
    "painCategory": "(val)",
    "painLevel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Pain Categories
PATCH/iacuc/api/v1/iacuc-pain-categories/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-pain-categories/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "painCategoryCode": "(val)",
  "painCategory": "(val)",
  "painLevel": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "painCategoryCode": "(val)",
  "painCategory": "(val)",
  "painLevel": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Pain Categories
POST/iacuc/api/v1/iacuc-pain-categories/

Example URI

POST /iacuc/api/v1/iacuc-pain-categories/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "painCategoryCode": "(val)",
  "painCategory": "(val)",
  "painLevel": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "painCategoryCode": "(val)",
  "painCategory": "(val)",
  "painLevel": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Pain Categories
POST/iacuc/api/v1/iacuc-pain-categories/

Example URI

POST /iacuc/api/v1/iacuc-pain-categories/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "painCategoryCode": "(val)",
    "painCategory": "(val)",
    "painLevel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "painCategoryCode": "(val)",
    "painCategory": "(val)",
    "painLevel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "painCategoryCode": "(val)",
    "painCategory": "(val)",
    "painLevel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "painCategoryCode": "(val)",
    "painCategory": "(val)",
    "painLevel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Pain Categories by Key
DELETE/iacuc/api/v1/iacuc-pain-categories/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-pain-categories/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Pain Categories
DELETE/iacuc/api/v1/iacuc-pain-categories/

Example URI

DELETE /iacuc/api/v1/iacuc-pain-categories/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Pain Categories with Matching
DELETE/iacuc/api/v1/iacuc-pain-categories/

Example URI

DELETE /iacuc/api/v1/iacuc-pain-categories/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

painCategoryCode
string (optional) 

Pain Category Code. Maximum length is 3.

painCategory
string (optional) 

Pain Category. Maximum length is 200.

painLevel
string (optional) 

Pain Level. Maximum length is 3.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Person Trainings

Get Iacuc Person Trainings by Key
GET/iacuc/api/v1/iacuc-person-trainings/(key)

Example URI

GET /iacuc/api/v1/iacuc-person-trainings/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "iacucPersonTrainingId": "(val)",
  "personTrainingId": "(val)",
  "personId": "(val)",
  "speciesCode": "(val)",
  "procedureCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Person Trainings
GET/iacuc/api/v1/iacuc-person-trainings/

Example URI

GET /iacuc/api/v1/iacuc-person-trainings/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucPersonTrainingId": "(val)",
    "personTrainingId": "(val)",
    "personId": "(val)",
    "speciesCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucPersonTrainingId": "(val)",
    "personTrainingId": "(val)",
    "personId": "(val)",
    "speciesCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Person Trainings with Filtering
GET/iacuc/api/v1/iacuc-person-trainings/

Example URI

GET /iacuc/api/v1/iacuc-person-trainings/
URI Parameters
HideShow
iacucPersonTrainingId
string (optional) 

IACUC Person Training Id. Maximum length is 5.

personTrainingId
string (optional) 

Person Training Id. Maximum length is 22.

personId
string (optional) 

Person Id. Maximum length is 40.

speciesCode
string (optional) 

Species Code. Maximum length is 4.

procedureCode
string (optional) 

Procedure Code. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucPersonTrainingId": "(val)",
    "personTrainingId": "(val)",
    "personId": "(val)",
    "speciesCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucPersonTrainingId": "(val)",
    "personTrainingId": "(val)",
    "personId": "(val)",
    "speciesCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Person Trainings
GET/iacuc/api/v1/iacuc-person-trainings/

Example URI

GET /iacuc/api/v1/iacuc-person-trainings/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "iacucPersonTrainingId",
    "personTrainingId",
    "personId",
    "speciesCode",
    "procedureCode"
  ],
  "primaryKey": "iacucPersonTrainingId"
}

Get Blueprint API specification for Iacuc Person Trainings
GET/iacuc/api/v1/iacuc-person-trainings/

Example URI

GET /iacuc/api/v1/iacuc-person-trainings/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Person Trainings.md"
transfer-encoding: chunked

Update Iacuc Person Trainings
PUT/iacuc/api/v1/iacuc-person-trainings/(key)

Example URI

PUT /iacuc/api/v1/iacuc-person-trainings/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucPersonTrainingId": "(val)",
  "personTrainingId": "(val)",
  "personId": "(val)",
  "speciesCode": "(val)",
  "procedureCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Person Trainings
PUT/iacuc/api/v1/iacuc-person-trainings/

Example URI

PUT /iacuc/api/v1/iacuc-person-trainings/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucPersonTrainingId": "(val)",
    "personTrainingId": "(val)",
    "personId": "(val)",
    "speciesCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucPersonTrainingId": "(val)",
    "personTrainingId": "(val)",
    "personId": "(val)",
    "speciesCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Person Trainings
PATCH/iacuc/api/v1/iacuc-person-trainings/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-person-trainings/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucPersonTrainingId": "(val)",
  "personTrainingId": "(val)",
  "personId": "(val)",
  "speciesCode": "(val)",
  "procedureCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "iacucPersonTrainingId": "(val)",
  "personTrainingId": "(val)",
  "personId": "(val)",
  "speciesCode": "(val)",
  "procedureCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Person Trainings
POST/iacuc/api/v1/iacuc-person-trainings/

Example URI

POST /iacuc/api/v1/iacuc-person-trainings/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucPersonTrainingId": "(val)",
  "personTrainingId": "(val)",
  "personId": "(val)",
  "speciesCode": "(val)",
  "procedureCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "iacucPersonTrainingId": "(val)",
  "personTrainingId": "(val)",
  "personId": "(val)",
  "speciesCode": "(val)",
  "procedureCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Person Trainings
POST/iacuc/api/v1/iacuc-person-trainings/

Example URI

POST /iacuc/api/v1/iacuc-person-trainings/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucPersonTrainingId": "(val)",
    "personTrainingId": "(val)",
    "personId": "(val)",
    "speciesCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucPersonTrainingId": "(val)",
    "personTrainingId": "(val)",
    "personId": "(val)",
    "speciesCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "iacucPersonTrainingId": "(val)",
    "personTrainingId": "(val)",
    "personId": "(val)",
    "speciesCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucPersonTrainingId": "(val)",
    "personTrainingId": "(val)",
    "personId": "(val)",
    "speciesCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Person Trainings by Key
DELETE/iacuc/api/v1/iacuc-person-trainings/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-person-trainings/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Person Trainings
DELETE/iacuc/api/v1/iacuc-person-trainings/

Example URI

DELETE /iacuc/api/v1/iacuc-person-trainings/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Person Trainings with Matching
DELETE/iacuc/api/v1/iacuc-person-trainings/

Example URI

DELETE /iacuc/api/v1/iacuc-person-trainings/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

iacucPersonTrainingId
string (optional) 

IACUC Person Training Id. Maximum length is 5.

personTrainingId
string (optional) 

Person Training Id. Maximum length is 22.

personId
string (optional) 

Person Id. Maximum length is 40.

speciesCode
string (optional) 

Species Code. Maximum length is 4.

procedureCode
string (optional) 

Procedure Code. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Principles

Get Iacuc Principles by Key
GET/iacuc/api/v1/iacuc-principles/(key)

Example URI

GET /iacuc/api/v1/iacuc-principles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "iacucPrinciplesId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "reduction": "(val)",
  "refinement": "(val)",
  "replacement": "(val)",
  "searchRequired": "(val)",
  "exceptionsPresent": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Principles
GET/iacuc/api/v1/iacuc-principles/

Example URI

GET /iacuc/api/v1/iacuc-principles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucPrinciplesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "reduction": "(val)",
    "refinement": "(val)",
    "replacement": "(val)",
    "searchRequired": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucPrinciplesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "reduction": "(val)",
    "refinement": "(val)",
    "replacement": "(val)",
    "searchRequired": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Principles with Filtering
GET/iacuc/api/v1/iacuc-principles/

Example URI

GET /iacuc/api/v1/iacuc-principles/
URI Parameters
HideShow
iacucPrinciplesId
string (optional) 
protocolId
string (optional) 
protocolNumber
string (optional) 
sequenceNumber
string (optional) 
reduction
string (optional) 

Reduction. Maximum length is 2000.

refinement
string (optional) 

Refinement. Maximum length is 2000.

replacement
string (optional) 

Replacement. Maximum length is 2000.

searchRequired
string (optional) 

Search Required. Maximum length is 1.

exceptionsPresent
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucPrinciplesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "reduction": "(val)",
    "refinement": "(val)",
    "replacement": "(val)",
    "searchRequired": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucPrinciplesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "reduction": "(val)",
    "refinement": "(val)",
    "replacement": "(val)",
    "searchRequired": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Principles
GET/iacuc/api/v1/iacuc-principles/

Example URI

GET /iacuc/api/v1/iacuc-principles/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "iacucPrinciplesId",
    "protocolId",
    "protocolNumber",
    "sequenceNumber",
    "reduction",
    "refinement",
    "replacement",
    "searchRequired",
    "exceptionsPresent"
  ],
  "primaryKey": "iacucPrinciplesId"
}

Get Blueprint API specification for Iacuc Principles
GET/iacuc/api/v1/iacuc-principles/

Example URI

GET /iacuc/api/v1/iacuc-principles/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Principles.md"
transfer-encoding: chunked

Update Iacuc Principles
PUT/iacuc/api/v1/iacuc-principles/(key)

Example URI

PUT /iacuc/api/v1/iacuc-principles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucPrinciplesId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "reduction": "(val)",
  "refinement": "(val)",
  "replacement": "(val)",
  "searchRequired": "(val)",
  "exceptionsPresent": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Principles
PUT/iacuc/api/v1/iacuc-principles/

Example URI

PUT /iacuc/api/v1/iacuc-principles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucPrinciplesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "reduction": "(val)",
    "refinement": "(val)",
    "replacement": "(val)",
    "searchRequired": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucPrinciplesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "reduction": "(val)",
    "refinement": "(val)",
    "replacement": "(val)",
    "searchRequired": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Principles
PATCH/iacuc/api/v1/iacuc-principles/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-principles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucPrinciplesId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "reduction": "(val)",
  "refinement": "(val)",
  "replacement": "(val)",
  "searchRequired": "(val)",
  "exceptionsPresent": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "iacucPrinciplesId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "reduction": "(val)",
  "refinement": "(val)",
  "replacement": "(val)",
  "searchRequired": "(val)",
  "exceptionsPresent": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Principles
POST/iacuc/api/v1/iacuc-principles/

Example URI

POST /iacuc/api/v1/iacuc-principles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucPrinciplesId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "reduction": "(val)",
  "refinement": "(val)",
  "replacement": "(val)",
  "searchRequired": "(val)",
  "exceptionsPresent": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "iacucPrinciplesId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "reduction": "(val)",
  "refinement": "(val)",
  "replacement": "(val)",
  "searchRequired": "(val)",
  "exceptionsPresent": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Principles
POST/iacuc/api/v1/iacuc-principles/

Example URI

POST /iacuc/api/v1/iacuc-principles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucPrinciplesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "reduction": "(val)",
    "refinement": "(val)",
    "replacement": "(val)",
    "searchRequired": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucPrinciplesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "reduction": "(val)",
    "refinement": "(val)",
    "replacement": "(val)",
    "searchRequired": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "iacucPrinciplesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "reduction": "(val)",
    "refinement": "(val)",
    "replacement": "(val)",
    "searchRequired": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucPrinciplesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "reduction": "(val)",
    "refinement": "(val)",
    "replacement": "(val)",
    "searchRequired": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Principles by Key
DELETE/iacuc/api/v1/iacuc-principles/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-principles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Principles
DELETE/iacuc/api/v1/iacuc-principles/

Example URI

DELETE /iacuc/api/v1/iacuc-principles/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Principles with Matching
DELETE/iacuc/api/v1/iacuc-principles/

Example URI

DELETE /iacuc/api/v1/iacuc-principles/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

iacucPrinciplesId
string (optional) 
protocolId
string (optional) 
protocolNumber
string (optional) 
sequenceNumber
string (optional) 
reduction
string (optional) 

Reduction. Maximum length is 2000.

refinement
string (optional) 

Refinement. Maximum length is 2000.

replacement
string (optional) 

Replacement. Maximum length is 2000.

searchRequired
string (optional) 

Search Required. Maximum length is 1.

exceptionsPresent
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Procedure Categories

Get Iacuc Procedure Categories by Key
GET/iacuc/api/v1/iacuc-procedure-categories/(key)

Example URI

GET /iacuc/api/v1/iacuc-procedure-categories/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "procedureCategoryCode": "(val)",
  "procedureCategory": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Procedure Categories
GET/iacuc/api/v1/iacuc-procedure-categories/

Example URI

GET /iacuc/api/v1/iacuc-procedure-categories/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "procedureCategoryCode": "(val)",
    "procedureCategory": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "procedureCategoryCode": "(val)",
    "procedureCategory": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Procedure Categories with Filtering
GET/iacuc/api/v1/iacuc-procedure-categories/

Example URI

GET /iacuc/api/v1/iacuc-procedure-categories/
URI Parameters
HideShow
procedureCategoryCode
string (optional) 

Procedure Category Code. Maximum length is 3.

procedureCategory
string (optional) 

Procedure Category. Maximum length is 200.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "procedureCategoryCode": "(val)",
    "procedureCategory": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "procedureCategoryCode": "(val)",
    "procedureCategory": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Procedure Categories
GET/iacuc/api/v1/iacuc-procedure-categories/

Example URI

GET /iacuc/api/v1/iacuc-procedure-categories/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "procedureCategoryCode",
    "procedureCategory",
    "active"
  ],
  "primaryKey": "procedureCategoryCode"
}

Get Blueprint API specification for Iacuc Procedure Categories
GET/iacuc/api/v1/iacuc-procedure-categories/

Example URI

GET /iacuc/api/v1/iacuc-procedure-categories/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Procedure Categories.md"
transfer-encoding: chunked

Update Iacuc Procedure Categories
PUT/iacuc/api/v1/iacuc-procedure-categories/(key)

Example URI

PUT /iacuc/api/v1/iacuc-procedure-categories/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "procedureCategoryCode": "(val)",
  "procedureCategory": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Procedure Categories
PUT/iacuc/api/v1/iacuc-procedure-categories/

Example URI

PUT /iacuc/api/v1/iacuc-procedure-categories/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "procedureCategoryCode": "(val)",
    "procedureCategory": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "procedureCategoryCode": "(val)",
    "procedureCategory": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Procedure Categories
PATCH/iacuc/api/v1/iacuc-procedure-categories/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-procedure-categories/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "procedureCategoryCode": "(val)",
  "procedureCategory": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "procedureCategoryCode": "(val)",
  "procedureCategory": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Procedure Categories
POST/iacuc/api/v1/iacuc-procedure-categories/

Example URI

POST /iacuc/api/v1/iacuc-procedure-categories/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "procedureCategoryCode": "(val)",
  "procedureCategory": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "procedureCategoryCode": "(val)",
  "procedureCategory": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Procedure Categories
POST/iacuc/api/v1/iacuc-procedure-categories/

Example URI

POST /iacuc/api/v1/iacuc-procedure-categories/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "procedureCategoryCode": "(val)",
    "procedureCategory": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "procedureCategoryCode": "(val)",
    "procedureCategory": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "procedureCategoryCode": "(val)",
    "procedureCategory": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "procedureCategoryCode": "(val)",
    "procedureCategory": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Procedure Categories by Key
DELETE/iacuc/api/v1/iacuc-procedure-categories/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-procedure-categories/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Procedure Categories
DELETE/iacuc/api/v1/iacuc-procedure-categories/

Example URI

DELETE /iacuc/api/v1/iacuc-procedure-categories/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Procedure Categories with Matching
DELETE/iacuc/api/v1/iacuc-procedure-categories/

Example URI

DELETE /iacuc/api/v1/iacuc-procedure-categories/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

procedureCategoryCode
string (optional) 

Procedure Category Code. Maximum length is 3.

procedureCategory
string (optional) 

Procedure Category. Maximum length is 200.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Procedure Category Custom Data

Get Iacuc Procedure Category Custom Data by Key
GET/iacuc/api/v1/iacuc-procedure-category-custom-data/(key)

Example URI

GET /iacuc/api/v1/iacuc-procedure-category-custom-data/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "procedureCategoryCode": "(val)",
  "dataLength": "(val)",
  "dataTypeCode": "(val)",
  "defaultValue": "(val)",
  "label": "(val)",
  "lookupClass": "(val)",
  "lookupReturn": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortId": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Procedure Category Custom Data
GET/iacuc/api/v1/iacuc-procedure-category-custom-data/

Example URI

GET /iacuc/api/v1/iacuc-procedure-category-custom-data/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "procedureCategoryCode": "(val)",
    "dataLength": "(val)",
    "dataTypeCode": "(val)",
    "defaultValue": "(val)",
    "label": "(val)",
    "lookupClass": "(val)",
    "lookupReturn": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "procedureCategoryCode": "(val)",
    "dataLength": "(val)",
    "dataTypeCode": "(val)",
    "defaultValue": "(val)",
    "label": "(val)",
    "lookupClass": "(val)",
    "lookupReturn": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Procedure Category Custom Data with Filtering
GET/iacuc/api/v1/iacuc-procedure-category-custom-data/

Example URI

GET /iacuc/api/v1/iacuc-procedure-category-custom-data/
URI Parameters
HideShow
id
string (optional) 

Id. Maximum length is 12.

procedureCategoryCode
string (optional) 

Procedure Category Code. Maximum length is 3.

dataLength
string (optional) 

Data Length. Maximum length is 4.

dataTypeCode
string (optional) 

Data Type Code. Maximum length is 3.

defaultValue
string (optional) 

Default Value. Maximum length is 2000.

label
string (optional) 

Label. Maximum length is 30.

lookupClass
string (optional) 

Lookup Class. Maximum length is 100.

lookupReturn
string (optional) 

Lookup Return. Maximum length is 30.

name
string (optional) 

Name. Maximum length is 30.

active
string (optional) 

Active. Maximum length is 1.

sortId
string (optional) 

Sort Id. Maximum length is 22.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "procedureCategoryCode": "(val)",
    "dataLength": "(val)",
    "dataTypeCode": "(val)",
    "defaultValue": "(val)",
    "label": "(val)",
    "lookupClass": "(val)",
    "lookupReturn": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "procedureCategoryCode": "(val)",
    "dataLength": "(val)",
    "dataTypeCode": "(val)",
    "defaultValue": "(val)",
    "label": "(val)",
    "lookupClass": "(val)",
    "lookupReturn": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Procedure Category Custom Data
GET/iacuc/api/v1/iacuc-procedure-category-custom-data/

Example URI

GET /iacuc/api/v1/iacuc-procedure-category-custom-data/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "procedureCategoryCode",
    "dataLength",
    "dataTypeCode",
    "defaultValue",
    "label",
    "lookupClass",
    "lookupReturn",
    "name",
    "active",
    "sortId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Iacuc Procedure Category Custom Data
GET/iacuc/api/v1/iacuc-procedure-category-custom-data/

Example URI

GET /iacuc/api/v1/iacuc-procedure-category-custom-data/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Procedure Category Custom Data.md"
transfer-encoding: chunked

Update Iacuc Procedure Category Custom Data
PUT/iacuc/api/v1/iacuc-procedure-category-custom-data/(key)

Example URI

PUT /iacuc/api/v1/iacuc-procedure-category-custom-data/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "procedureCategoryCode": "(val)",
  "dataLength": "(val)",
  "dataTypeCode": "(val)",
  "defaultValue": "(val)",
  "label": "(val)",
  "lookupClass": "(val)",
  "lookupReturn": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Procedure Category Custom Data
PUT/iacuc/api/v1/iacuc-procedure-category-custom-data/

Example URI

PUT /iacuc/api/v1/iacuc-procedure-category-custom-data/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "procedureCategoryCode": "(val)",
    "dataLength": "(val)",
    "dataTypeCode": "(val)",
    "defaultValue": "(val)",
    "label": "(val)",
    "lookupClass": "(val)",
    "lookupReturn": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "procedureCategoryCode": "(val)",
    "dataLength": "(val)",
    "dataTypeCode": "(val)",
    "defaultValue": "(val)",
    "label": "(val)",
    "lookupClass": "(val)",
    "lookupReturn": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Procedure Category Custom Data
PATCH/iacuc/api/v1/iacuc-procedure-category-custom-data/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-procedure-category-custom-data/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "procedureCategoryCode": "(val)",
  "dataLength": "(val)",
  "dataTypeCode": "(val)",
  "defaultValue": "(val)",
  "label": "(val)",
  "lookupClass": "(val)",
  "lookupReturn": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "procedureCategoryCode": "(val)",
  "dataLength": "(val)",
  "dataTypeCode": "(val)",
  "defaultValue": "(val)",
  "label": "(val)",
  "lookupClass": "(val)",
  "lookupReturn": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortId": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Procedure Category Custom Data
POST/iacuc/api/v1/iacuc-procedure-category-custom-data/

Example URI

POST /iacuc/api/v1/iacuc-procedure-category-custom-data/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "procedureCategoryCode": "(val)",
  "dataLength": "(val)",
  "dataTypeCode": "(val)",
  "defaultValue": "(val)",
  "label": "(val)",
  "lookupClass": "(val)",
  "lookupReturn": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "procedureCategoryCode": "(val)",
  "dataLength": "(val)",
  "dataTypeCode": "(val)",
  "defaultValue": "(val)",
  "label": "(val)",
  "lookupClass": "(val)",
  "lookupReturn": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Procedure Category Custom Data
POST/iacuc/api/v1/iacuc-procedure-category-custom-data/

Example URI

POST /iacuc/api/v1/iacuc-procedure-category-custom-data/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "procedureCategoryCode": "(val)",
    "dataLength": "(val)",
    "dataTypeCode": "(val)",
    "defaultValue": "(val)",
    "label": "(val)",
    "lookupClass": "(val)",
    "lookupReturn": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "procedureCategoryCode": "(val)",
    "dataLength": "(val)",
    "dataTypeCode": "(val)",
    "defaultValue": "(val)",
    "label": "(val)",
    "lookupClass": "(val)",
    "lookupReturn": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "procedureCategoryCode": "(val)",
    "dataLength": "(val)",
    "dataTypeCode": "(val)",
    "defaultValue": "(val)",
    "label": "(val)",
    "lookupClass": "(val)",
    "lookupReturn": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "procedureCategoryCode": "(val)",
    "dataLength": "(val)",
    "dataTypeCode": "(val)",
    "defaultValue": "(val)",
    "label": "(val)",
    "lookupClass": "(val)",
    "lookupReturn": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Procedure Category Custom Data by Key
DELETE/iacuc/api/v1/iacuc-procedure-category-custom-data/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-procedure-category-custom-data/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Procedure Category Custom Data
DELETE/iacuc/api/v1/iacuc-procedure-category-custom-data/

Example URI

DELETE /iacuc/api/v1/iacuc-procedure-category-custom-data/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Procedure Category Custom Data with Matching
DELETE/iacuc/api/v1/iacuc-procedure-category-custom-data/

Example URI

DELETE /iacuc/api/v1/iacuc-procedure-category-custom-data/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Id. Maximum length is 12.

procedureCategoryCode
string (optional) 

Procedure Category Code. Maximum length is 3.

dataLength
string (optional) 

Data Length. Maximum length is 4.

dataTypeCode
string (optional) 

Data Type Code. Maximum length is 3.

defaultValue
string (optional) 

Default Value. Maximum length is 2000.

label
string (optional) 

Label. Maximum length is 30.

lookupClass
string (optional) 

Lookup Class. Maximum length is 100.

lookupReturn
string (optional) 

Lookup Return. Maximum length is 30.

name
string (optional) 

Name. Maximum length is 30.

active
string (optional) 

Active. Maximum length is 1.

sortId
string (optional) 

Sort Id. Maximum length is 22.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Procedure Responsible Persons

Get Iacuc Procedure Responsible Persons by Key
GET/iacuc/api/v1/iacuc-procedure-responsible-persons/(key)

Example URI

GET /iacuc/api/v1/iacuc-procedure-responsible-persons/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "iacucProcedurePersonResponsibleId": "(val)",
  "iacucProtocolStudyGroupId": "(val)",
  "protocolPersonId": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Procedure Responsible Persons
GET/iacuc/api/v1/iacuc-procedure-responsible-persons/

Example URI

GET /iacuc/api/v1/iacuc-procedure-responsible-persons/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProcedurePersonResponsibleId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "protocolPersonId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProcedurePersonResponsibleId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "protocolPersonId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Procedure Responsible Persons with Filtering
GET/iacuc/api/v1/iacuc-procedure-responsible-persons/

Example URI

GET /iacuc/api/v1/iacuc-procedure-responsible-persons/
URI Parameters
HideShow
iacucProcedurePersonResponsibleId
string (optional) 

Procedure Person Responsible Id. Maximum length is 22.

iacucProtocolStudyGroupId
string (optional) 

Protocol Study Group Id. Maximum length is 22.

protocolPersonId
string (optional) 

IACUC Protocol Person Id. Maximum length is 12.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProcedurePersonResponsibleId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "protocolPersonId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProcedurePersonResponsibleId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "protocolPersonId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Procedure Responsible Persons
GET/iacuc/api/v1/iacuc-procedure-responsible-persons/

Example URI

GET /iacuc/api/v1/iacuc-procedure-responsible-persons/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "iacucProcedurePersonResponsibleId",
    "iacucProtocolStudyGroupId",
    "protocolPersonId"
  ],
  "primaryKey": "iacucProcedurePersonResponsibleId"
}

Get Blueprint API specification for Iacuc Procedure Responsible Persons
GET/iacuc/api/v1/iacuc-procedure-responsible-persons/

Example URI

GET /iacuc/api/v1/iacuc-procedure-responsible-persons/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Procedure Responsible Persons.md"
transfer-encoding: chunked

Update Iacuc Procedure Responsible Persons
PUT/iacuc/api/v1/iacuc-procedure-responsible-persons/(key)

Example URI

PUT /iacuc/api/v1/iacuc-procedure-responsible-persons/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProcedurePersonResponsibleId": "(val)",
  "iacucProtocolStudyGroupId": "(val)",
  "protocolPersonId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Procedure Responsible Persons
PUT/iacuc/api/v1/iacuc-procedure-responsible-persons/

Example URI

PUT /iacuc/api/v1/iacuc-procedure-responsible-persons/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucProcedurePersonResponsibleId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "protocolPersonId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProcedurePersonResponsibleId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "protocolPersonId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Procedure Responsible Persons
PATCH/iacuc/api/v1/iacuc-procedure-responsible-persons/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-procedure-responsible-persons/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProcedurePersonResponsibleId": "(val)",
  "iacucProtocolStudyGroupId": "(val)",
  "protocolPersonId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "iacucProcedurePersonResponsibleId": "(val)",
  "iacucProtocolStudyGroupId": "(val)",
  "protocolPersonId": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Procedure Responsible Persons
POST/iacuc/api/v1/iacuc-procedure-responsible-persons/

Example URI

POST /iacuc/api/v1/iacuc-procedure-responsible-persons/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProcedurePersonResponsibleId": "(val)",
  "iacucProtocolStudyGroupId": "(val)",
  "protocolPersonId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "iacucProcedurePersonResponsibleId": "(val)",
  "iacucProtocolStudyGroupId": "(val)",
  "protocolPersonId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Procedure Responsible Persons
POST/iacuc/api/v1/iacuc-procedure-responsible-persons/

Example URI

POST /iacuc/api/v1/iacuc-procedure-responsible-persons/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucProcedurePersonResponsibleId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "protocolPersonId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProcedurePersonResponsibleId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "protocolPersonId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "iacucProcedurePersonResponsibleId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "protocolPersonId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProcedurePersonResponsibleId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "protocolPersonId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Procedure Responsible Persons by Key
DELETE/iacuc/api/v1/iacuc-procedure-responsible-persons/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-procedure-responsible-persons/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Procedure Responsible Persons
DELETE/iacuc/api/v1/iacuc-procedure-responsible-persons/

Example URI

DELETE /iacuc/api/v1/iacuc-procedure-responsible-persons/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Procedure Responsible Persons with Matching
DELETE/iacuc/api/v1/iacuc-procedure-responsible-persons/

Example URI

DELETE /iacuc/api/v1/iacuc-procedure-responsible-persons/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

iacucProcedurePersonResponsibleId
string (optional) 

Procedure Person Responsible Id. Maximum length is 22.

iacucProtocolStudyGroupId
string (optional) 

Protocol Study Group Id. Maximum length is 22.

protocolPersonId
string (optional) 

IACUC Protocol Person Id. Maximum length is 12.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Procedures

Get Iacuc Procedures by Key
GET/iacuc/api/v1/iacuc-procedures/(key)

Example URI

GET /iacuc/api/v1/iacuc-procedures/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "procedureCode": "(val)",
  "procedureDescription": "(val)",
  "procedureCategoryCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Procedures
GET/iacuc/api/v1/iacuc-procedures/

Example URI

GET /iacuc/api/v1/iacuc-procedures/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "procedureCode": "(val)",
    "procedureDescription": "(val)",
    "procedureCategoryCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "procedureCode": "(val)",
    "procedureDescription": "(val)",
    "procedureCategoryCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Procedures with Filtering
GET/iacuc/api/v1/iacuc-procedures/

Example URI

GET /iacuc/api/v1/iacuc-procedures/
URI Parameters
HideShow
procedureCode
string (optional) 

Procedure Code. Maximum length is 3.

procedureDescription
string (optional) 

Procedure Description. Maximum length is 2000.

procedureCategoryCode
string (optional) 

Procedure Category Code. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "procedureCode": "(val)",
    "procedureDescription": "(val)",
    "procedureCategoryCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "procedureCode": "(val)",
    "procedureDescription": "(val)",
    "procedureCategoryCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Procedures
GET/iacuc/api/v1/iacuc-procedures/

Example URI

GET /iacuc/api/v1/iacuc-procedures/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "procedureCode",
    "procedureDescription",
    "procedureCategoryCode"
  ],
  "primaryKey": "procedureCode"
}

Get Blueprint API specification for Iacuc Procedures
GET/iacuc/api/v1/iacuc-procedures/

Example URI

GET /iacuc/api/v1/iacuc-procedures/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Procedures.md"
transfer-encoding: chunked

Update Iacuc Procedures
PUT/iacuc/api/v1/iacuc-procedures/(key)

Example URI

PUT /iacuc/api/v1/iacuc-procedures/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "procedureCode": "(val)",
  "procedureDescription": "(val)",
  "procedureCategoryCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Procedures
PUT/iacuc/api/v1/iacuc-procedures/

Example URI

PUT /iacuc/api/v1/iacuc-procedures/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "procedureCode": "(val)",
    "procedureDescription": "(val)",
    "procedureCategoryCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "procedureCode": "(val)",
    "procedureDescription": "(val)",
    "procedureCategoryCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Procedures
PATCH/iacuc/api/v1/iacuc-procedures/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-procedures/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "procedureCode": "(val)",
  "procedureDescription": "(val)",
  "procedureCategoryCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "procedureCode": "(val)",
  "procedureDescription": "(val)",
  "procedureCategoryCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Procedures
POST/iacuc/api/v1/iacuc-procedures/

Example URI

POST /iacuc/api/v1/iacuc-procedures/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "procedureCode": "(val)",
  "procedureDescription": "(val)",
  "procedureCategoryCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "procedureCode": "(val)",
  "procedureDescription": "(val)",
  "procedureCategoryCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Procedures
POST/iacuc/api/v1/iacuc-procedures/

Example URI

POST /iacuc/api/v1/iacuc-procedures/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "procedureCode": "(val)",
    "procedureDescription": "(val)",
    "procedureCategoryCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "procedureCode": "(val)",
    "procedureDescription": "(val)",
    "procedureCategoryCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "procedureCode": "(val)",
    "procedureDescription": "(val)",
    "procedureCategoryCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "procedureCode": "(val)",
    "procedureDescription": "(val)",
    "procedureCategoryCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Procedures by Key
DELETE/iacuc/api/v1/iacuc-procedures/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-procedures/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Procedures
DELETE/iacuc/api/v1/iacuc-procedures/

Example URI

DELETE /iacuc/api/v1/iacuc-procedures/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Procedures with Matching
DELETE/iacuc/api/v1/iacuc-procedures/

Example URI

DELETE /iacuc/api/v1/iacuc-procedures/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

procedureCode
string (optional) 

Procedure Code. Maximum length is 3.

procedureDescription
string (optional) 

Procedure Description. Maximum length is 2000.

procedureCategoryCode
string (optional) 

Procedure Category Code. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Action Types

Get Iacuc Protocol Action Types by Key
GET/iacuc/api/v1/iacuc-protocol-action-types/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-action-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolActionTypeCode": "(val)",
  "description": "(val)",
  "triggerSubmission": "(val)",
  "triggerCorrespondence": "(val)",
  "finalActionForBatchCorrespondence": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Action Types
GET/iacuc/api/v1/iacuc-protocol-action-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-action-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Action Types with Filtering
GET/iacuc/api/v1/iacuc-protocol-action-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-action-types/
URI Parameters
HideShow
protocolActionTypeCode
string (optional) 

Protocol Action Type Code. Maximum length is 22.

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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Action Types
GET/iacuc/api/v1/iacuc-protocol-action-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-action-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolActionTypeCode",
    "description",
    "triggerSubmission",
    "triggerCorrespondence",
    "finalActionForBatchCorrespondence"
  ],
  "primaryKey": "protocolActionTypeCode"
}

Get Blueprint API specification for Iacuc Protocol Action Types
GET/iacuc/api/v1/iacuc-protocol-action-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-action-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Action Types.md"
transfer-encoding: chunked

Update Iacuc Protocol Action Types
PUT/iacuc/api/v1/iacuc-protocol-action-types/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-action-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolActionTypeCode": "(val)",
  "description": "(val)",
  "triggerSubmission": "(val)",
  "triggerCorrespondence": "(val)",
  "finalActionForBatchCorrespondence": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Action Types
PUT/iacuc/api/v1/iacuc-protocol-action-types/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-action-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Protocol Action Types
PATCH/iacuc/api/v1/iacuc-protocol-action-types/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-action-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolActionTypeCode": "(val)",
  "description": "(val)",
  "triggerSubmission": "(val)",
  "triggerCorrespondence": "(val)",
  "finalActionForBatchCorrespondence": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolActionTypeCode": "(val)",
  "description": "(val)",
  "triggerSubmission": "(val)",
  "triggerCorrespondence": "(val)",
  "finalActionForBatchCorrespondence": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Action Types
POST/iacuc/api/v1/iacuc-protocol-action-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-action-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolActionTypeCode": "(val)",
  "description": "(val)",
  "triggerSubmission": "(val)",
  "triggerCorrespondence": "(val)",
  "finalActionForBatchCorrespondence": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolActionTypeCode": "(val)",
  "description": "(val)",
  "triggerSubmission": "(val)",
  "triggerCorrespondence": "(val)",
  "finalActionForBatchCorrespondence": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Action Types
POST/iacuc/api/v1/iacuc-protocol-action-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-action-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol Action Types by Key
DELETE/iacuc/api/v1/iacuc-protocol-action-types/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-action-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Action Types
DELETE/iacuc/api/v1/iacuc-protocol-action-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-action-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Action Types with Matching
DELETE/iacuc/api/v1/iacuc-protocol-action-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-action-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

protocolActionTypeCode
string (optional) 

Protocol Action Type Code. Maximum length is 22.

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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Actions

Get Iacuc Protocol Actions by Key
GET/iacuc/api/v1/iacuc-protocol-actions/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolActionId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "actionId": "(val)",
  "protocolActionTypeCode": "(val)",
  "submissionNumber": "(val)",
  "comments": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "actionDate": "(val)",
  "protocolId": "(val)",
  "submissionIdFk": "(val)",
  "actualActionDate": "(val)",
  "prevSubmissionStatusCode": "(val)",
  "submissionTypeCode": "(val)",
  "prevProtocolStatusCode": "(val)",
  "followupActionCode": "(val)",
  "createdSubmission": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Actions
GET/iacuc/api/v1/iacuc-protocol-actions/

Example URI

GET /iacuc/api/v1/iacuc-protocol-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolActionId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "actionId": "(val)",
    "protocolActionTypeCode": "(val)",
    "submissionNumber": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "actionDate": "(val)",
    "protocolId": "(val)",
    "submissionIdFk": "(val)",
    "actualActionDate": "(val)",
    "prevSubmissionStatusCode": "(val)",
    "submissionTypeCode": "(val)",
    "prevProtocolStatusCode": "(val)",
    "followupActionCode": "(val)",
    "createdSubmission": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolActionId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "actionId": "(val)",
    "protocolActionTypeCode": "(val)",
    "submissionNumber": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "actionDate": "(val)",
    "protocolId": "(val)",
    "submissionIdFk": "(val)",
    "actualActionDate": "(val)",
    "prevSubmissionStatusCode": "(val)",
    "submissionTypeCode": "(val)",
    "prevProtocolStatusCode": "(val)",
    "followupActionCode": "(val)",
    "createdSubmission": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Actions with Filtering
GET/iacuc/api/v1/iacuc-protocol-actions/

Example URI

GET /iacuc/api/v1/iacuc-protocol-actions/
URI Parameters
HideShow
protocolActionId
string (optional) 

Ac Protocol Actions Id. Maximum length is 22.

protocolNumber
string (optional) 

Protocol Number. Maximum length is 20.

sequenceNumber
string (optional) 

Sequence Number. Maximum length is 22.

actionId
string (optional) 

Action Id. Maximum length is 22.

protocolActionTypeCode
string (optional) 

Protocol Action Type Code. Maximum length is 22.

submissionNumber
string (optional) 

Submission Number. Maximum length is 22.

comments
string (optional) 

Comments. Maximum length is 2000.

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.

protocolId
string (optional) 
submissionIdFk
string (optional) 
actualActionDate
string (optional) 
prevSubmissionStatusCode
string (optional) 
submissionTypeCode
string (optional) 
prevProtocolStatusCode
string (optional) 
followupActionCode
string (optional) 
createdSubmission
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolActionId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "actionId": "(val)",
    "protocolActionTypeCode": "(val)",
    "submissionNumber": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "actionDate": "(val)",
    "protocolId": "(val)",
    "submissionIdFk": "(val)",
    "actualActionDate": "(val)",
    "prevSubmissionStatusCode": "(val)",
    "submissionTypeCode": "(val)",
    "prevProtocolStatusCode": "(val)",
    "followupActionCode": "(val)",
    "createdSubmission": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolActionId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "actionId": "(val)",
    "protocolActionTypeCode": "(val)",
    "submissionNumber": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "actionDate": "(val)",
    "protocolId": "(val)",
    "submissionIdFk": "(val)",
    "actualActionDate": "(val)",
    "prevSubmissionStatusCode": "(val)",
    "submissionTypeCode": "(val)",
    "prevProtocolStatusCode": "(val)",
    "followupActionCode": "(val)",
    "createdSubmission": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Actions
GET/iacuc/api/v1/iacuc-protocol-actions/

Example URI

GET /iacuc/api/v1/iacuc-protocol-actions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolActionId",
    "protocolNumber",
    "sequenceNumber",
    "actionId",
    "protocolActionTypeCode",
    "submissionNumber",
    "comments",
    "createTimestamp",
    "createUser",
    "actionDate",
    "protocolId",
    "submissionIdFk",
    "actualActionDate",
    "prevSubmissionStatusCode",
    "submissionTypeCode",
    "prevProtocolStatusCode",
    "followupActionCode",
    "createdSubmission"
  ],
  "primaryKey": "protocolActionId"
}

Get Blueprint API specification for Iacuc Protocol Actions
GET/iacuc/api/v1/iacuc-protocol-actions/

Example URI

GET /iacuc/api/v1/iacuc-protocol-actions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Actions.md"
transfer-encoding: chunked

Update Iacuc Protocol Actions
PUT/iacuc/api/v1/iacuc-protocol-actions/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolActionId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "actionId": "(val)",
  "protocolActionTypeCode": "(val)",
  "submissionNumber": "(val)",
  "comments": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "actionDate": "(val)",
  "protocolId": "(val)",
  "submissionIdFk": "(val)",
  "actualActionDate": "(val)",
  "prevSubmissionStatusCode": "(val)",
  "submissionTypeCode": "(val)",
  "prevProtocolStatusCode": "(val)",
  "followupActionCode": "(val)",
  "createdSubmission": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Actions
PUT/iacuc/api/v1/iacuc-protocol-actions/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolActionId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "actionId": "(val)",
    "protocolActionTypeCode": "(val)",
    "submissionNumber": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "actionDate": "(val)",
    "protocolId": "(val)",
    "submissionIdFk": "(val)",
    "actualActionDate": "(val)",
    "prevSubmissionStatusCode": "(val)",
    "submissionTypeCode": "(val)",
    "prevProtocolStatusCode": "(val)",
    "followupActionCode": "(val)",
    "createdSubmission": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolActionId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "actionId": "(val)",
    "protocolActionTypeCode": "(val)",
    "submissionNumber": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "actionDate": "(val)",
    "protocolId": "(val)",
    "submissionIdFk": "(val)",
    "actualActionDate": "(val)",
    "prevSubmissionStatusCode": "(val)",
    "submissionTypeCode": "(val)",
    "prevProtocolStatusCode": "(val)",
    "followupActionCode": "(val)",
    "createdSubmission": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Actions
PATCH/iacuc/api/v1/iacuc-protocol-actions/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolActionId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "actionId": "(val)",
  "protocolActionTypeCode": "(val)",
  "submissionNumber": "(val)",
  "comments": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "actionDate": "(val)",
  "protocolId": "(val)",
  "submissionIdFk": "(val)",
  "actualActionDate": "(val)",
  "prevSubmissionStatusCode": "(val)",
  "submissionTypeCode": "(val)",
  "prevProtocolStatusCode": "(val)",
  "followupActionCode": "(val)",
  "createdSubmission": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolActionId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "actionId": "(val)",
  "protocolActionTypeCode": "(val)",
  "submissionNumber": "(val)",
  "comments": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "actionDate": "(val)",
  "protocolId": "(val)",
  "submissionIdFk": "(val)",
  "actualActionDate": "(val)",
  "prevSubmissionStatusCode": "(val)",
  "submissionTypeCode": "(val)",
  "prevProtocolStatusCode": "(val)",
  "followupActionCode": "(val)",
  "createdSubmission": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Actions
POST/iacuc/api/v1/iacuc-protocol-actions/

Example URI

POST /iacuc/api/v1/iacuc-protocol-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolActionId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "actionId": "(val)",
  "protocolActionTypeCode": "(val)",
  "submissionNumber": "(val)",
  "comments": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "actionDate": "(val)",
  "protocolId": "(val)",
  "submissionIdFk": "(val)",
  "actualActionDate": "(val)",
  "prevSubmissionStatusCode": "(val)",
  "submissionTypeCode": "(val)",
  "prevProtocolStatusCode": "(val)",
  "followupActionCode": "(val)",
  "createdSubmission": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolActionId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "actionId": "(val)",
  "protocolActionTypeCode": "(val)",
  "submissionNumber": "(val)",
  "comments": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "actionDate": "(val)",
  "protocolId": "(val)",
  "submissionIdFk": "(val)",
  "actualActionDate": "(val)",
  "prevSubmissionStatusCode": "(val)",
  "submissionTypeCode": "(val)",
  "prevProtocolStatusCode": "(val)",
  "followupActionCode": "(val)",
  "createdSubmission": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Actions
POST/iacuc/api/v1/iacuc-protocol-actions/

Example URI

POST /iacuc/api/v1/iacuc-protocol-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolActionId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "actionId": "(val)",
    "protocolActionTypeCode": "(val)",
    "submissionNumber": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "actionDate": "(val)",
    "protocolId": "(val)",
    "submissionIdFk": "(val)",
    "actualActionDate": "(val)",
    "prevSubmissionStatusCode": "(val)",
    "submissionTypeCode": "(val)",
    "prevProtocolStatusCode": "(val)",
    "followupActionCode": "(val)",
    "createdSubmission": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolActionId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "actionId": "(val)",
    "protocolActionTypeCode": "(val)",
    "submissionNumber": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "actionDate": "(val)",
    "protocolId": "(val)",
    "submissionIdFk": "(val)",
    "actualActionDate": "(val)",
    "prevSubmissionStatusCode": "(val)",
    "submissionTypeCode": "(val)",
    "prevProtocolStatusCode": "(val)",
    "followupActionCode": "(val)",
    "createdSubmission": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "protocolActionId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "actionId": "(val)",
    "protocolActionTypeCode": "(val)",
    "submissionNumber": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "actionDate": "(val)",
    "protocolId": "(val)",
    "submissionIdFk": "(val)",
    "actualActionDate": "(val)",
    "prevSubmissionStatusCode": "(val)",
    "submissionTypeCode": "(val)",
    "prevProtocolStatusCode": "(val)",
    "followupActionCode": "(val)",
    "createdSubmission": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolActionId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "actionId": "(val)",
    "protocolActionTypeCode": "(val)",
    "submissionNumber": "(val)",
    "comments": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "actionDate": "(val)",
    "protocolId": "(val)",
    "submissionIdFk": "(val)",
    "actualActionDate": "(val)",
    "prevSubmissionStatusCode": "(val)",
    "submissionTypeCode": "(val)",
    "prevProtocolStatusCode": "(val)",
    "followupActionCode": "(val)",
    "createdSubmission": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Actions by Key
DELETE/iacuc/api/v1/iacuc-protocol-actions/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Actions
DELETE/iacuc/api/v1/iacuc-protocol-actions/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-actions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Actions with Matching
DELETE/iacuc/api/v1/iacuc-protocol-actions/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-actions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

protocolActionId
string (optional) 

Ac Protocol Actions Id. Maximum length is 22.

protocolNumber
string (optional) 

Protocol Number. Maximum length is 20.

sequenceNumber
string (optional) 

Sequence Number. Maximum length is 22.

actionId
string (optional) 

Action Id. Maximum length is 22.

protocolActionTypeCode
string (optional) 

Protocol Action Type Code. Maximum length is 22.

submissionNumber
string (optional) 

Submission Number. Maximum length is 22.

comments
string (optional) 

Comments. Maximum length is 2000.

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.

protocolId
string (optional) 
submissionIdFk
string (optional) 
actualActionDate
string (optional) 
prevSubmissionStatusCode
string (optional) 
submissionTypeCode
string (optional) 
prevProtocolStatusCode
string (optional) 
followupActionCode
string (optional) 
createdSubmission
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Affiliation Types

Get Iacuc Protocol Affiliation Types by Key
GET/iacuc/api/v1/iacuc-protocol-affiliation-types/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-affiliation-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "affiliationTypeCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Affiliation Types
GET/iacuc/api/v1/iacuc-protocol-affiliation-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-affiliation-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "affiliationTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "affiliationTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Affiliation Types with Filtering
GET/iacuc/api/v1/iacuc-protocol-affiliation-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-affiliation-types/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "affiliationTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "affiliationTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Affiliation Types
GET/iacuc/api/v1/iacuc-protocol-affiliation-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-affiliation-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "affiliationTypeCode",
    "description",
    "active"
  ],
  "primaryKey": "affiliationTypeCode"
}

Get Blueprint API specification for Iacuc Protocol Affiliation Types
GET/iacuc/api/v1/iacuc-protocol-affiliation-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-affiliation-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Affiliation Types.md"
transfer-encoding: chunked

Update Iacuc Protocol Affiliation Types
PUT/iacuc/api/v1/iacuc-protocol-affiliation-types/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-affiliation-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "affiliationTypeCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Affiliation Types
PUT/iacuc/api/v1/iacuc-protocol-affiliation-types/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-affiliation-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "affiliationTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "affiliationTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Affiliation Types
PATCH/iacuc/api/v1/iacuc-protocol-affiliation-types/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-affiliation-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "affiliationTypeCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "affiliationTypeCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Affiliation Types
POST/iacuc/api/v1/iacuc-protocol-affiliation-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-affiliation-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "affiliationTypeCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "affiliationTypeCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Affiliation Types
POST/iacuc/api/v1/iacuc-protocol-affiliation-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-affiliation-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "affiliationTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "affiliationTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "affiliationTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "affiliationTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Affiliation Types by Key
DELETE/iacuc/api/v1/iacuc-protocol-affiliation-types/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-affiliation-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Affiliation Types
DELETE/iacuc/api/v1/iacuc-protocol-affiliation-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-affiliation-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Affiliation Types with Matching
DELETE/iacuc/api/v1/iacuc-protocol-affiliation-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-affiliation-types/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Amend Renew Modules

Get Iacuc Protocol Amend Renew Modules by Key
GET/iacuc/api/v1/iacuc-protocol-amend-renew-modules/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-amend-renew-modules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolAmendRenewModuleId": "(val)",
  "protocolAmendRenewalNumber": "(val)",
  "protocolAmendRenewalId": "(val)",
  "protocolNumber": "(val)",
  "protocolModuleTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Amend Renew Modules
GET/iacuc/api/v1/iacuc-protocol-amend-renew-modules/

Example URI

GET /iacuc/api/v1/iacuc-protocol-amend-renew-modules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Amend Renew Modules with Filtering
GET/iacuc/api/v1/iacuc-protocol-amend-renew-modules/

Example URI

GET /iacuc/api/v1/iacuc-protocol-amend-renew-modules/
URI Parameters
HideShow
protocolAmendRenewModuleId
string (optional) 
protocolAmendRenewalNumber
string (optional) 
protocolAmendRenewalId
string (optional) 
protocolNumber
string (optional) 
protocolModuleTypeCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Amend Renew Modules
GET/iacuc/api/v1/iacuc-protocol-amend-renew-modules/

Example URI

GET /iacuc/api/v1/iacuc-protocol-amend-renew-modules/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolAmendRenewModuleId",
    "protocolAmendRenewalNumber",
    "protocolAmendRenewalId",
    "protocolNumber",
    "protocolModuleTypeCode"
  ],
  "primaryKey": "protocolAmendRenewModuleId"
}

Get Blueprint API specification for Iacuc Protocol Amend Renew Modules
GET/iacuc/api/v1/iacuc-protocol-amend-renew-modules/

Example URI

GET /iacuc/api/v1/iacuc-protocol-amend-renew-modules/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Amend Renew Modules.md"
transfer-encoding: chunked

Update Iacuc Protocol Amend Renew Modules
PUT/iacuc/api/v1/iacuc-protocol-amend-renew-modules/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-amend-renew-modules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolAmendRenewModuleId": "(val)",
  "protocolAmendRenewalNumber": "(val)",
  "protocolAmendRenewalId": "(val)",
  "protocolNumber": "(val)",
  "protocolModuleTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Amend Renew Modules
PUT/iacuc/api/v1/iacuc-protocol-amend-renew-modules/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-amend-renew-modules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Protocol Amend Renew Modules
PATCH/iacuc/api/v1/iacuc-protocol-amend-renew-modules/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-amend-renew-modules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolAmendRenewModuleId": "(val)",
  "protocolAmendRenewalNumber": "(val)",
  "protocolAmendRenewalId": "(val)",
  "protocolNumber": "(val)",
  "protocolModuleTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolAmendRenewModuleId": "(val)",
  "protocolAmendRenewalNumber": "(val)",
  "protocolAmendRenewalId": "(val)",
  "protocolNumber": "(val)",
  "protocolModuleTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Amend Renew Modules
POST/iacuc/api/v1/iacuc-protocol-amend-renew-modules/

Example URI

POST /iacuc/api/v1/iacuc-protocol-amend-renew-modules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolAmendRenewModuleId": "(val)",
  "protocolAmendRenewalNumber": "(val)",
  "protocolAmendRenewalId": "(val)",
  "protocolNumber": "(val)",
  "protocolModuleTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolAmendRenewModuleId": "(val)",
  "protocolAmendRenewalNumber": "(val)",
  "protocolAmendRenewalId": "(val)",
  "protocolNumber": "(val)",
  "protocolModuleTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Amend Renew Modules
POST/iacuc/api/v1/iacuc-protocol-amend-renew-modules/

Example URI

POST /iacuc/api/v1/iacuc-protocol-amend-renew-modules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol Amend Renew Modules by Key
DELETE/iacuc/api/v1/iacuc-protocol-amend-renew-modules/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-amend-renew-modules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Amend Renew Modules
DELETE/iacuc/api/v1/iacuc-protocol-amend-renew-modules/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-amend-renew-modules/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Amend Renew Modules with Matching
DELETE/iacuc/api/v1/iacuc-protocol-amend-renew-modules/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-amend-renew-modules/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Amend Renewals

Get Iacuc Protocol Amend Renewals by Key
GET/iacuc/api/v1/iacuc-protocol-amend-renewals/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-amend-renewals/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "protoAmendRenNumber": "(val)",
  "dateCreated": "(val)",
  "summary": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Amend Renewals
GET/iacuc/api/v1/iacuc-protocol-amend-renewals/

Example URI

GET /iacuc/api/v1/iacuc-protocol-amend-renewals/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Amend Renewals with Filtering
GET/iacuc/api/v1/iacuc-protocol-amend-renewals/

Example URI

GET /iacuc/api/v1/iacuc-protocol-amend-renewals/
URI Parameters
HideShow
id
string (optional) 
protoAmendRenNumber
string (optional) 
dateCreated
string (optional) 
summary
string (optional) 
protocolId
string (optional) 
protocolNumber
string (optional) 
sequenceNumber
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Amend Renewals
GET/iacuc/api/v1/iacuc-protocol-amend-renewals/

Example URI

GET /iacuc/api/v1/iacuc-protocol-amend-renewals/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "protoAmendRenNumber",
    "dateCreated",
    "summary",
    "protocolId",
    "protocolNumber",
    "sequenceNumber"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Iacuc Protocol Amend Renewals
GET/iacuc/api/v1/iacuc-protocol-amend-renewals/

Example URI

GET /iacuc/api/v1/iacuc-protocol-amend-renewals/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Amend Renewals.md"
transfer-encoding: chunked

Update Iacuc Protocol Amend Renewals
PUT/iacuc/api/v1/iacuc-protocol-amend-renewals/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-amend-renewals/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "protoAmendRenNumber": "(val)",
  "dateCreated": "(val)",
  "summary": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Amend Renewals
PUT/iacuc/api/v1/iacuc-protocol-amend-renewals/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-amend-renewals/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Protocol Amend Renewals
PATCH/iacuc/api/v1/iacuc-protocol-amend-renewals/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-amend-renewals/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "protoAmendRenNumber": "(val)",
  "dateCreated": "(val)",
  "summary": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "protoAmendRenNumber": "(val)",
  "dateCreated": "(val)",
  "summary": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Amend Renewals
POST/iacuc/api/v1/iacuc-protocol-amend-renewals/

Example URI

POST /iacuc/api/v1/iacuc-protocol-amend-renewals/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "protoAmendRenNumber": "(val)",
  "dateCreated": "(val)",
  "summary": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "protoAmendRenNumber": "(val)",
  "dateCreated": "(val)",
  "summary": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Amend Renewals
POST/iacuc/api/v1/iacuc-protocol-amend-renewals/

Example URI

POST /iacuc/api/v1/iacuc-protocol-amend-renewals/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol Amend Renewals by Key
DELETE/iacuc/api/v1/iacuc-protocol-amend-renewals/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-amend-renewals/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Amend Renewals
DELETE/iacuc/api/v1/iacuc-protocol-amend-renewals/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-amend-renewals/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Amend Renewals with Matching
DELETE/iacuc/api/v1/iacuc-protocol-amend-renewals/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-amend-renewals/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
protoAmendRenNumber
string (optional) 
dateCreated
string (optional) 
summary
string (optional) 
protocolId
string (optional) 
protocolNumber
string (optional) 
sequenceNumber
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Attachment Groups

Get Iacuc Protocol Attachment Groups by Key
GET/iacuc/api/v1/iacuc-protocol-attachment-groups/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Attachment Groups
GET/iacuc/api/v1/iacuc-protocol-attachment-groups/

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Attachment Groups with Filtering
GET/iacuc/api/v1/iacuc-protocol-attachment-groups/

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-groups/
URI Parameters
HideShow
code
string (optional) 

Code. Maximum length is 3.

description
string (optional) 

Description. Maximum length is 300.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Attachment Groups
GET/iacuc/api/v1/iacuc-protocol-attachment-groups/

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-groups/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "code",
    "description"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Iacuc Protocol Attachment Groups
GET/iacuc/api/v1/iacuc-protocol-attachment-groups/

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-groups/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Attachment Groups.md"
transfer-encoding: chunked

Update Iacuc Protocol Attachment Groups
PUT/iacuc/api/v1/iacuc-protocol-attachment-groups/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-attachment-groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Attachment Groups
PUT/iacuc/api/v1/iacuc-protocol-attachment-groups/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-attachment-groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Attachment Groups
PATCH/iacuc/api/v1/iacuc-protocol-attachment-groups/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-attachment-groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Attachment Groups
POST/iacuc/api/v1/iacuc-protocol-attachment-groups/

Example URI

POST /iacuc/api/v1/iacuc-protocol-attachment-groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Attachment Groups
POST/iacuc/api/v1/iacuc-protocol-attachment-groups/

Example URI

POST /iacuc/api/v1/iacuc-protocol-attachment-groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Attachment Groups by Key
DELETE/iacuc/api/v1/iacuc-protocol-attachment-groups/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-attachment-groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Attachment Groups
DELETE/iacuc/api/v1/iacuc-protocol-attachment-groups/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-attachment-groups/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Attachment Groups with Matching
DELETE/iacuc/api/v1/iacuc-protocol-attachment-groups/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-attachment-groups/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Attachment Statuses

Get Iacuc Protocol Attachment Statuses by Key
GET/iacuc/api/v1/iacuc-protocol-attachment-statuses/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Attachment Statuses
GET/iacuc/api/v1/iacuc-protocol-attachment-statuses/

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Attachment Statuses with Filtering
GET/iacuc/api/v1/iacuc-protocol-attachment-statuses/

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-statuses/
URI Parameters
HideShow
code
string (optional) 

Code. Maximum length is 3.

description
string (optional) 

Description. Maximum length is 300.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Attachment Statuses
GET/iacuc/api/v1/iacuc-protocol-attachment-statuses/

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-statuses/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "code",
    "description"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Iacuc Protocol Attachment Statuses
GET/iacuc/api/v1/iacuc-protocol-attachment-statuses/

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-statuses/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Attachment Statuses.md"
transfer-encoding: chunked

Update Iacuc Protocol Attachment Statuses
PUT/iacuc/api/v1/iacuc-protocol-attachment-statuses/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-attachment-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Attachment Statuses
PUT/iacuc/api/v1/iacuc-protocol-attachment-statuses/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-attachment-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Attachment Statuses
PATCH/iacuc/api/v1/iacuc-protocol-attachment-statuses/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-attachment-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Attachment Statuses
POST/iacuc/api/v1/iacuc-protocol-attachment-statuses/

Example URI

POST /iacuc/api/v1/iacuc-protocol-attachment-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Attachment Statuses
POST/iacuc/api/v1/iacuc-protocol-attachment-statuses/

Example URI

POST /iacuc/api/v1/iacuc-protocol-attachment-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Attachment Statuses by Key
DELETE/iacuc/api/v1/iacuc-protocol-attachment-statuses/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-attachment-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Attachment Statuses
DELETE/iacuc/api/v1/iacuc-protocol-attachment-statuses/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-attachment-statuses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Attachment Statuses with Matching
DELETE/iacuc/api/v1/iacuc-protocol-attachment-statuses/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-attachment-statuses/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Attachment Type Groups

Get Iacuc Protocol Attachment Type Groups by Key
GET/iacuc/api/v1/iacuc-protocol-attachment-type-groups/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-type-groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "typeCode": "(val)",
  "groupCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Attachment Type Groups
GET/iacuc/api/v1/iacuc-protocol-attachment-type-groups/

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-type-groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "typeCode": "(val)",
    "groupCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "typeCode": "(val)",
    "groupCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Attachment Type Groups with Filtering
GET/iacuc/api/v1/iacuc-protocol-attachment-type-groups/

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-type-groups/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "typeCode": "(val)",
    "groupCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "typeCode": "(val)",
    "groupCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Attachment Type Groups
GET/iacuc/api/v1/iacuc-protocol-attachment-type-groups/

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-type-groups/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "typeCode",
    "groupCode"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Iacuc Protocol Attachment Type Groups
GET/iacuc/api/v1/iacuc-protocol-attachment-type-groups/

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-type-groups/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Attachment Type Groups.md"
transfer-encoding: chunked

Update Iacuc Protocol Attachment Type Groups
PUT/iacuc/api/v1/iacuc-protocol-attachment-type-groups/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-attachment-type-groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "typeCode": "(val)",
  "groupCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Attachment Type Groups
PUT/iacuc/api/v1/iacuc-protocol-attachment-type-groups/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-attachment-type-groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "typeCode": "(val)",
    "groupCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "typeCode": "(val)",
    "groupCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Attachment Type Groups
PATCH/iacuc/api/v1/iacuc-protocol-attachment-type-groups/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-attachment-type-groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "typeCode": "(val)",
  "groupCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "typeCode": "(val)",
  "groupCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Attachment Type Groups
POST/iacuc/api/v1/iacuc-protocol-attachment-type-groups/

Example URI

POST /iacuc/api/v1/iacuc-protocol-attachment-type-groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "typeCode": "(val)",
  "groupCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "typeCode": "(val)",
  "groupCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Attachment Type Groups
POST/iacuc/api/v1/iacuc-protocol-attachment-type-groups/

Example URI

POST /iacuc/api/v1/iacuc-protocol-attachment-type-groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "typeCode": "(val)",
    "groupCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "typeCode": "(val)",
    "groupCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "typeCode": "(val)",
    "groupCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "typeCode": "(val)",
    "groupCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Attachment Type Groups by Key
DELETE/iacuc/api/v1/iacuc-protocol-attachment-type-groups/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-attachment-type-groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Attachment Type Groups
DELETE/iacuc/api/v1/iacuc-protocol-attachment-type-groups/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-attachment-type-groups/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Attachment Type Groups with Matching
DELETE/iacuc/api/v1/iacuc-protocol-attachment-type-groups/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-attachment-type-groups/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Attachment Types

Get Iacuc Protocol Attachment Types by Key
GET/iacuc/api/v1/iacuc-protocol-attachment-types/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Attachment Types
GET/iacuc/api/v1/iacuc-protocol-attachment-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Attachment Types with Filtering
GET/iacuc/api/v1/iacuc-protocol-attachment-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-types/
URI Parameters
HideShow
code
string (optional) 

Code. Maximum length is 3.

description
string (optional) 

Description. Maximum length is 300.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Attachment Types
GET/iacuc/api/v1/iacuc-protocol-attachment-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "code",
    "description"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Iacuc Protocol Attachment Types
GET/iacuc/api/v1/iacuc-protocol-attachment-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-attachment-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Attachment Types.md"
transfer-encoding: chunked

Update Iacuc Protocol Attachment Types
PUT/iacuc/api/v1/iacuc-protocol-attachment-types/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-attachment-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Attachment Types
PUT/iacuc/api/v1/iacuc-protocol-attachment-types/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-attachment-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Attachment Types
PATCH/iacuc/api/v1/iacuc-protocol-attachment-types/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-attachment-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Attachment Types
POST/iacuc/api/v1/iacuc-protocol-attachment-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-attachment-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "code": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Attachment Types
POST/iacuc/api/v1/iacuc-protocol-attachment-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-attachment-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Attachment Types by Key
DELETE/iacuc/api/v1/iacuc-protocol-attachment-types/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-attachment-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Attachment Types
DELETE/iacuc/api/v1/iacuc-protocol-attachment-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-attachment-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Attachment Types with Matching
DELETE/iacuc/api/v1/iacuc-protocol-attachment-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-attachment-types/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Contingencies

Get Iacuc Protocol Contingencies by Key
GET/iacuc/api/v1/iacuc-protocol-contingencies/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-contingencies/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolContingencyCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Contingencies
GET/iacuc/api/v1/iacuc-protocol-contingencies/

Example URI

GET /iacuc/api/v1/iacuc-protocol-contingencies/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolContingencyCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolContingencyCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Contingencies with Filtering
GET/iacuc/api/v1/iacuc-protocol-contingencies/

Example URI

GET /iacuc/api/v1/iacuc-protocol-contingencies/
URI Parameters
HideShow
protocolContingencyCode
string (optional) 

Protocol Contingency Code. Maximum length is 4.

description
string (optional) 

Description. Maximum length is 2000.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolContingencyCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolContingencyCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Contingencies
GET/iacuc/api/v1/iacuc-protocol-contingencies/

Example URI

GET /iacuc/api/v1/iacuc-protocol-contingencies/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolContingencyCode",
    "description"
  ],
  "primaryKey": "protocolContingencyCode"
}

Get Blueprint API specification for Iacuc Protocol Contingencies
GET/iacuc/api/v1/iacuc-protocol-contingencies/

Example URI

GET /iacuc/api/v1/iacuc-protocol-contingencies/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Contingencies.md"
transfer-encoding: chunked

Update Iacuc Protocol Contingencies
PUT/iacuc/api/v1/iacuc-protocol-contingencies/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-contingencies/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolContingencyCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Contingencies
PUT/iacuc/api/v1/iacuc-protocol-contingencies/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-contingencies/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolContingencyCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolContingencyCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Contingencies
PATCH/iacuc/api/v1/iacuc-protocol-contingencies/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-contingencies/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolContingencyCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolContingencyCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Contingencies
POST/iacuc/api/v1/iacuc-protocol-contingencies/

Example URI

POST /iacuc/api/v1/iacuc-protocol-contingencies/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolContingencyCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolContingencyCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Contingencies
POST/iacuc/api/v1/iacuc-protocol-contingencies/

Example URI

POST /iacuc/api/v1/iacuc-protocol-contingencies/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolContingencyCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolContingencyCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "protocolContingencyCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolContingencyCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Contingencies by Key
DELETE/iacuc/api/v1/iacuc-protocol-contingencies/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-contingencies/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Contingencies
DELETE/iacuc/api/v1/iacuc-protocol-contingencies/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-contingencies/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Contingencies with Matching
DELETE/iacuc/api/v1/iacuc-protocol-contingencies/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-contingencies/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Correspondence Templates

Get Iacuc Protocol Correspondence Templates by Key
GET/iacuc/api/v1/iacuc-protocol-correspondence-templates/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-correspondence-templates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protoCorrespTemplId": "(val)",
  "protoCorrespTypeCode": "(val)",
  "committeeId": "(val)",
  "fileName": "(val)",
  "correspondenceTemplate": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Correspondence Templates
GET/iacuc/api/v1/iacuc-protocol-correspondence-templates/

Example URI

GET /iacuc/api/v1/iacuc-protocol-correspondence-templates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Correspondence Templates with Filtering
GET/iacuc/api/v1/iacuc-protocol-correspondence-templates/

Example URI

GET /iacuc/api/v1/iacuc-protocol-correspondence-templates/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Correspondence Templates
GET/iacuc/api/v1/iacuc-protocol-correspondence-templates/

Example URI

GET /iacuc/api/v1/iacuc-protocol-correspondence-templates/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protoCorrespTemplId",
    "protoCorrespTypeCode",
    "committeeId",
    "fileName",
    "correspondenceTemplate"
  ],
  "primaryKey": "protoCorrespTemplId"
}

Get Blueprint API specification for Iacuc Protocol Correspondence Templates
GET/iacuc/api/v1/iacuc-protocol-correspondence-templates/

Example URI

GET /iacuc/api/v1/iacuc-protocol-correspondence-templates/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Correspondence Templates.md"
transfer-encoding: chunked

Update Iacuc Protocol Correspondence Templates
PUT/iacuc/api/v1/iacuc-protocol-correspondence-templates/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-correspondence-templates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protoCorrespTemplId": "(val)",
  "protoCorrespTypeCode": "(val)",
  "committeeId": "(val)",
  "fileName": "(val)",
  "correspondenceTemplate": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Correspondence Templates
PUT/iacuc/api/v1/iacuc-protocol-correspondence-templates/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-correspondence-templates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Protocol Correspondence Templates
PATCH/iacuc/api/v1/iacuc-protocol-correspondence-templates/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-correspondence-templates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protoCorrespTemplId": "(val)",
  "protoCorrespTypeCode": "(val)",
  "committeeId": "(val)",
  "fileName": "(val)",
  "correspondenceTemplate": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protoCorrespTemplId": "(val)",
  "protoCorrespTypeCode": "(val)",
  "committeeId": "(val)",
  "fileName": "(val)",
  "correspondenceTemplate": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Correspondence Templates
POST/iacuc/api/v1/iacuc-protocol-correspondence-templates/

Example URI

POST /iacuc/api/v1/iacuc-protocol-correspondence-templates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protoCorrespTemplId": "(val)",
  "protoCorrespTypeCode": "(val)",
  "committeeId": "(val)",
  "fileName": "(val)",
  "correspondenceTemplate": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protoCorrespTemplId": "(val)",
  "protoCorrespTypeCode": "(val)",
  "committeeId": "(val)",
  "fileName": "(val)",
  "correspondenceTemplate": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Correspondence Templates
POST/iacuc/api/v1/iacuc-protocol-correspondence-templates/

Example URI

POST /iacuc/api/v1/iacuc-protocol-correspondence-templates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol Correspondence Templates by Key
DELETE/iacuc/api/v1/iacuc-protocol-correspondence-templates/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-correspondence-templates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Correspondence Templates
DELETE/iacuc/api/v1/iacuc-protocol-correspondence-templates/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-correspondence-templates/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Correspondence Templates with Matching
DELETE/iacuc/api/v1/iacuc-protocol-correspondence-templates/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-correspondence-templates/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Correspondence Types

Get Iacuc Protocol Correspondence Types by Key
GET/iacuc/api/v1/iacuc-protocol-correspondence-types/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-correspondence-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protoCorrespTypeCode": "(val)",
  "description": "(val)",
  "moduleId": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Correspondence Types
GET/iacuc/api/v1/iacuc-protocol-correspondence-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-correspondence-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protoCorrespTypeCode": "(val)",
    "description": "(val)",
    "moduleId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protoCorrespTypeCode": "(val)",
    "description": "(val)",
    "moduleId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Correspondence Types with Filtering
GET/iacuc/api/v1/iacuc-protocol-correspondence-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-correspondence-types/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protoCorrespTypeCode": "(val)",
    "description": "(val)",
    "moduleId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protoCorrespTypeCode": "(val)",
    "description": "(val)",
    "moduleId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Correspondence Types
GET/iacuc/api/v1/iacuc-protocol-correspondence-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-correspondence-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protoCorrespTypeCode",
    "description",
    "moduleId"
  ],
  "primaryKey": "protoCorrespTypeCode"
}

Get Blueprint API specification for Iacuc Protocol Correspondence Types
GET/iacuc/api/v1/iacuc-protocol-correspondence-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-correspondence-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Correspondence Types.md"
transfer-encoding: chunked

Update Iacuc Protocol Correspondence Types
PUT/iacuc/api/v1/iacuc-protocol-correspondence-types/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-correspondence-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protoCorrespTypeCode": "(val)",
  "description": "(val)",
  "moduleId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Correspondence Types
PUT/iacuc/api/v1/iacuc-protocol-correspondence-types/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-correspondence-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protoCorrespTypeCode": "(val)",
    "description": "(val)",
    "moduleId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protoCorrespTypeCode": "(val)",
    "description": "(val)",
    "moduleId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Correspondence Types
PATCH/iacuc/api/v1/iacuc-protocol-correspondence-types/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-correspondence-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protoCorrespTypeCode": "(val)",
  "description": "(val)",
  "moduleId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protoCorrespTypeCode": "(val)",
  "description": "(val)",
  "moduleId": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Correspondence Types
POST/iacuc/api/v1/iacuc-protocol-correspondence-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-correspondence-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protoCorrespTypeCode": "(val)",
  "description": "(val)",
  "moduleId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protoCorrespTypeCode": "(val)",
  "description": "(val)",
  "moduleId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Correspondence Types
POST/iacuc/api/v1/iacuc-protocol-correspondence-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-correspondence-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protoCorrespTypeCode": "(val)",
    "description": "(val)",
    "moduleId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protoCorrespTypeCode": "(val)",
    "description": "(val)",
    "moduleId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "protoCorrespTypeCode": "(val)",
    "description": "(val)",
    "moduleId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protoCorrespTypeCode": "(val)",
    "description": "(val)",
    "moduleId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Correspondence Types by Key
DELETE/iacuc/api/v1/iacuc-protocol-correspondence-types/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-correspondence-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Correspondence Types
DELETE/iacuc/api/v1/iacuc-protocol-correspondence-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-correspondence-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Correspondence Types with Matching
DELETE/iacuc/api/v1/iacuc-protocol-correspondence-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-correspondence-types/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Correspondences

Get Iacuc Protocol Correspondences by Key
GET/iacuc/api/v1/iacuc-protocol-correspondences/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-correspondences/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "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 Iacuc Protocol Correspondences
GET/iacuc/api/v1/iacuc-protocol-correspondences/

Example URI

GET /iacuc/api/v1/iacuc-protocol-correspondences/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Correspondences with Filtering
GET/iacuc/api/v1/iacuc-protocol-correspondences/

Example URI

GET /iacuc/api/v1/iacuc-protocol-correspondences/
URI Parameters
HideShow
id
string (optional) 
protocolId
string (optional) 
protocolNumber
string (optional) 
sequenceNumber
string (optional) 
actionId
string (optional) 
actionIdFk
string (optional) 
protoCorrespTypeCode
string (optional) 
correspondence
string (optional) 
finalFlag
string (optional) 
createUser
string (optional) 
createTimestamp
string (optional) 
finalFlagTimestamp
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Correspondences
GET/iacuc/api/v1/iacuc-protocol-correspondences/

Example URI

GET /iacuc/api/v1/iacuc-protocol-correspondences/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "protocolId",
    "protocolNumber",
    "sequenceNumber",
    "actionId",
    "actionIdFk",
    "protoCorrespTypeCode",
    "correspondence",
    "finalFlag",
    "createUser",
    "createTimestamp",
    "finalFlagTimestamp"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Iacuc Protocol Correspondences
GET/iacuc/api/v1/iacuc-protocol-correspondences/

Example URI

GET /iacuc/api/v1/iacuc-protocol-correspondences/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Correspondences.md"
transfer-encoding: chunked

Update Iacuc Protocol Correspondences
PUT/iacuc/api/v1/iacuc-protocol-correspondences/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-correspondences/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  204

Update Multiple Iacuc Protocol Correspondences
PUT/iacuc/api/v1/iacuc-protocol-correspondences/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-correspondences/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Protocol Correspondences
PATCH/iacuc/api/v1/iacuc-protocol-correspondences/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-correspondences/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  204
HideShow
Body
{
  "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 Iacuc Protocol Correspondences
POST/iacuc/api/v1/iacuc-protocol-correspondences/

Example URI

POST /iacuc/api/v1/iacuc-protocol-correspondences/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  201
HideShow
Body
{
  "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 Iacuc Protocol Correspondences
POST/iacuc/api/v1/iacuc-protocol-correspondences/

Example URI

POST /iacuc/api/v1/iacuc-protocol-correspondences/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol Correspondences by Key
DELETE/iacuc/api/v1/iacuc-protocol-correspondences/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-correspondences/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Correspondences
DELETE/iacuc/api/v1/iacuc-protocol-correspondences/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-correspondences/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Correspondences with Matching
DELETE/iacuc/api/v1/iacuc-protocol-correspondences/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-correspondences/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
protocolId
string (optional) 
protocolNumber
string (optional) 
sequenceNumber
string (optional) 
actionId
string (optional) 
actionIdFk
string (optional) 
protoCorrespTypeCode
string (optional) 
correspondence
string (optional) 
finalFlag
string (optional) 
createUser
string (optional) 
createTimestamp
string (optional) 
finalFlagTimestamp
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Custom Data

Get Iacuc Protocol Custom Data by Key
GET/iacuc/api/v1/iacuc-protocol-custom-data/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-custom-data/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "iacucProtocolCustomDataId": "(val)",
  "customAttributeId": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Custom Data
GET/iacuc/api/v1/iacuc-protocol-custom-data/

Example URI

GET /iacuc/api/v1/iacuc-protocol-custom-data/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProtocolCustomDataId": "(val)",
    "customAttributeId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolCustomDataId": "(val)",
    "customAttributeId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Custom Data with Filtering
GET/iacuc/api/v1/iacuc-protocol-custom-data/

Example URI

GET /iacuc/api/v1/iacuc-protocol-custom-data/
URI Parameters
HideShow
iacucProtocolCustomDataId
string (optional) 

IACUC Protocol Custom Data Id. Maximum length is 22.

customAttributeId
string (optional) 

Custom Attribute Id. Maximum length is 22.

value
string (optional) 

Value. Maximum length is 2000.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProtocolCustomDataId": "(val)",
    "customAttributeId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolCustomDataId": "(val)",
    "customAttributeId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Custom Data
GET/iacuc/api/v1/iacuc-protocol-custom-data/

Example URI

GET /iacuc/api/v1/iacuc-protocol-custom-data/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "iacucProtocolCustomDataId",
    "customAttributeId",
    "value"
  ],
  "primaryKey": "iacucProtocolCustomDataId"
}

Get Blueprint API specification for Iacuc Protocol Custom Data
GET/iacuc/api/v1/iacuc-protocol-custom-data/

Example URI

GET /iacuc/api/v1/iacuc-protocol-custom-data/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Custom Data.md"
transfer-encoding: chunked

Iacuc Protocol Exceptions

Get Iacuc Protocol Exceptions by Key
GET/iacuc/api/v1/iacuc-protocol-exceptions/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-exceptions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "iacucProtocolExceptionId": "(val)",
  "speciesCode": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "exceptionId": "(val)",
  "exceptionCategoryCode": "(val)",
  "exceptionDescription": "(val)",
  "exceptionCount": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Exceptions
GET/iacuc/api/v1/iacuc-protocol-exceptions/

Example URI

GET /iacuc/api/v1/iacuc-protocol-exceptions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProtocolExceptionId": "(val)",
    "speciesCode": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "exceptionId": "(val)",
    "exceptionCategoryCode": "(val)",
    "exceptionDescription": "(val)",
    "exceptionCount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolExceptionId": "(val)",
    "speciesCode": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "exceptionId": "(val)",
    "exceptionCategoryCode": "(val)",
    "exceptionDescription": "(val)",
    "exceptionCount": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Exceptions with Filtering
GET/iacuc/api/v1/iacuc-protocol-exceptions/

Example URI

GET /iacuc/api/v1/iacuc-protocol-exceptions/
URI Parameters
HideShow
iacucProtocolExceptionId
string (optional) 

Protocol Exception Id. Maximum length is 22.

speciesCode
string (optional) 

Species. Maximum length is 50.

protocolId
string (optional) 
protocolNumber
string (optional) 
sequenceNumber
string (optional) 
exceptionId
string (optional) 

Exception Id. Maximum length is 22.

exceptionCategoryCode
string (optional) 

Exception Category. Maximum length is 50.

exceptionDescription
string (optional) 

Exception Justification and Description. Maximum length is 1000.

exceptionCount
string (optional) 

Exception Count. Maximum length is 8.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProtocolExceptionId": "(val)",
    "speciesCode": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "exceptionId": "(val)",
    "exceptionCategoryCode": "(val)",
    "exceptionDescription": "(val)",
    "exceptionCount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolExceptionId": "(val)",
    "speciesCode": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "exceptionId": "(val)",
    "exceptionCategoryCode": "(val)",
    "exceptionDescription": "(val)",
    "exceptionCount": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Exceptions
GET/iacuc/api/v1/iacuc-protocol-exceptions/

Example URI

GET /iacuc/api/v1/iacuc-protocol-exceptions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "iacucProtocolExceptionId",
    "speciesCode",
    "protocolId",
    "protocolNumber",
    "sequenceNumber",
    "exceptionId",
    "exceptionCategoryCode",
    "exceptionDescription",
    "exceptionCount"
  ],
  "primaryKey": "iacucProtocolExceptionId"
}

Get Blueprint API specification for Iacuc Protocol Exceptions
GET/iacuc/api/v1/iacuc-protocol-exceptions/

Example URI

GET /iacuc/api/v1/iacuc-protocol-exceptions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Exceptions.md"
transfer-encoding: chunked

Update Iacuc Protocol Exceptions
PUT/iacuc/api/v1/iacuc-protocol-exceptions/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-exceptions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolExceptionId": "(val)",
  "speciesCode": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "exceptionId": "(val)",
  "exceptionCategoryCode": "(val)",
  "exceptionDescription": "(val)",
  "exceptionCount": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Exceptions
PUT/iacuc/api/v1/iacuc-protocol-exceptions/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-exceptions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucProtocolExceptionId": "(val)",
    "speciesCode": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "exceptionId": "(val)",
    "exceptionCategoryCode": "(val)",
    "exceptionDescription": "(val)",
    "exceptionCount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolExceptionId": "(val)",
    "speciesCode": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "exceptionId": "(val)",
    "exceptionCategoryCode": "(val)",
    "exceptionDescription": "(val)",
    "exceptionCount": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Exceptions
PATCH/iacuc/api/v1/iacuc-protocol-exceptions/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-exceptions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolExceptionId": "(val)",
  "speciesCode": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "exceptionId": "(val)",
  "exceptionCategoryCode": "(val)",
  "exceptionDescription": "(val)",
  "exceptionCount": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "iacucProtocolExceptionId": "(val)",
  "speciesCode": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "exceptionId": "(val)",
  "exceptionCategoryCode": "(val)",
  "exceptionDescription": "(val)",
  "exceptionCount": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Exceptions
POST/iacuc/api/v1/iacuc-protocol-exceptions/

Example URI

POST /iacuc/api/v1/iacuc-protocol-exceptions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolExceptionId": "(val)",
  "speciesCode": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "exceptionId": "(val)",
  "exceptionCategoryCode": "(val)",
  "exceptionDescription": "(val)",
  "exceptionCount": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "iacucProtocolExceptionId": "(val)",
  "speciesCode": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "exceptionId": "(val)",
  "exceptionCategoryCode": "(val)",
  "exceptionDescription": "(val)",
  "exceptionCount": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Exceptions
POST/iacuc/api/v1/iacuc-protocol-exceptions/

Example URI

POST /iacuc/api/v1/iacuc-protocol-exceptions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucProtocolExceptionId": "(val)",
    "speciesCode": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "exceptionId": "(val)",
    "exceptionCategoryCode": "(val)",
    "exceptionDescription": "(val)",
    "exceptionCount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolExceptionId": "(val)",
    "speciesCode": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "exceptionId": "(val)",
    "exceptionCategoryCode": "(val)",
    "exceptionDescription": "(val)",
    "exceptionCount": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "iacucProtocolExceptionId": "(val)",
    "speciesCode": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "exceptionId": "(val)",
    "exceptionCategoryCode": "(val)",
    "exceptionDescription": "(val)",
    "exceptionCount": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolExceptionId": "(val)",
    "speciesCode": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "exceptionId": "(val)",
    "exceptionCategoryCode": "(val)",
    "exceptionDescription": "(val)",
    "exceptionCount": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Exceptions by Key
DELETE/iacuc/api/v1/iacuc-protocol-exceptions/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-exceptions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Exceptions
DELETE/iacuc/api/v1/iacuc-protocol-exceptions/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-exceptions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Exceptions with Matching
DELETE/iacuc/api/v1/iacuc-protocol-exceptions/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-exceptions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

iacucProtocolExceptionId
string (optional) 

Protocol Exception Id. Maximum length is 22.

speciesCode
string (optional) 

Species. Maximum length is 50.

protocolId
string (optional) 
protocolNumber
string (optional) 
sequenceNumber
string (optional) 
exceptionId
string (optional) 

Exception Id. Maximum length is 22.

exceptionCategoryCode
string (optional) 

Exception Category. Maximum length is 50.

exceptionDescription
string (optional) 

Exception Justification and Description. Maximum length is 1000.

exceptionCount
string (optional) 

Exception Count. Maximum length is 8.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Funding Sources

Get Iacuc Protocol Funding Sources by Key
GET/iacuc/api/v1/iacuc-protocol-funding-sources/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-funding-sources/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolFundingSourceId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "fundingSourceTypeCode": "(val)",
  "fundingSourceNumber": "(val)",
  "fundingSourceName": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Funding Sources
GET/iacuc/api/v1/iacuc-protocol-funding-sources/

Example URI

GET /iacuc/api/v1/iacuc-protocol-funding-sources/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Funding Sources with Filtering
GET/iacuc/api/v1/iacuc-protocol-funding-sources/

Example URI

GET /iacuc/api/v1/iacuc-protocol-funding-sources/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Funding Sources
GET/iacuc/api/v1/iacuc-protocol-funding-sources/

Example URI

GET /iacuc/api/v1/iacuc-protocol-funding-sources/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolFundingSourceId",
    "protocolId",
    "protocolNumber",
    "sequenceNumber",
    "fundingSourceTypeCode",
    "fundingSourceNumber",
    "fundingSourceName"
  ],
  "primaryKey": "protocolFundingSourceId"
}

Get Blueprint API specification for Iacuc Protocol Funding Sources
GET/iacuc/api/v1/iacuc-protocol-funding-sources/

Example URI

GET /iacuc/api/v1/iacuc-protocol-funding-sources/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Funding Sources.md"
transfer-encoding: chunked

Update Iacuc Protocol Funding Sources
PUT/iacuc/api/v1/iacuc-protocol-funding-sources/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-funding-sources/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolFundingSourceId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "fundingSourceTypeCode": "(val)",
  "fundingSourceNumber": "(val)",
  "fundingSourceName": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Funding Sources
PUT/iacuc/api/v1/iacuc-protocol-funding-sources/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-funding-sources/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Protocol Funding Sources
PATCH/iacuc/api/v1/iacuc-protocol-funding-sources/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-funding-sources/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolFundingSourceId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "fundingSourceTypeCode": "(val)",
  "fundingSourceNumber": "(val)",
  "fundingSourceName": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolFundingSourceId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "fundingSourceTypeCode": "(val)",
  "fundingSourceNumber": "(val)",
  "fundingSourceName": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Funding Sources
POST/iacuc/api/v1/iacuc-protocol-funding-sources/

Example URI

POST /iacuc/api/v1/iacuc-protocol-funding-sources/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolFundingSourceId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "fundingSourceTypeCode": "(val)",
  "fundingSourceNumber": "(val)",
  "fundingSourceName": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolFundingSourceId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "fundingSourceTypeCode": "(val)",
  "fundingSourceNumber": "(val)",
  "fundingSourceName": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Funding Sources
POST/iacuc/api/v1/iacuc-protocol-funding-sources/

Example URI

POST /iacuc/api/v1/iacuc-protocol-funding-sources/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol Funding Sources by Key
DELETE/iacuc/api/v1/iacuc-protocol-funding-sources/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-funding-sources/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Funding Sources
DELETE/iacuc/api/v1/iacuc-protocol-funding-sources/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-funding-sources/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Funding Sources with Matching
DELETE/iacuc/api/v1/iacuc-protocol-funding-sources/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-funding-sources/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Locations

Get Iacuc Protocol Locations by Key
GET/iacuc/api/v1/iacuc-protocol-locations/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-locations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolLocationId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "protocolOrganizationTypeCode": "(val)",
  "organizationId": "(val)",
  "rolodexId": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Locations
GET/iacuc/api/v1/iacuc-protocol-locations/

Example URI

GET /iacuc/api/v1/iacuc-protocol-locations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Locations with Filtering
GET/iacuc/api/v1/iacuc-protocol-locations/

Example URI

GET /iacuc/api/v1/iacuc-protocol-locations/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Locations
GET/iacuc/api/v1/iacuc-protocol-locations/

Example URI

GET /iacuc/api/v1/iacuc-protocol-locations/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolLocationId",
    "protocolId",
    "protocolNumber",
    "sequenceNumber",
    "protocolOrganizationTypeCode",
    "organizationId",
    "rolodexId"
  ],
  "primaryKey": "protocolLocationId"
}

Get Blueprint API specification for Iacuc Protocol Locations
GET/iacuc/api/v1/iacuc-protocol-locations/

Example URI

GET /iacuc/api/v1/iacuc-protocol-locations/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Locations.md"
transfer-encoding: chunked

Update Iacuc Protocol Locations
PUT/iacuc/api/v1/iacuc-protocol-locations/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-locations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolLocationId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "protocolOrganizationTypeCode": "(val)",
  "organizationId": "(val)",
  "rolodexId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Locations
PUT/iacuc/api/v1/iacuc-protocol-locations/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-locations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Protocol Locations
PATCH/iacuc/api/v1/iacuc-protocol-locations/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-locations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolLocationId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "protocolOrganizationTypeCode": "(val)",
  "organizationId": "(val)",
  "rolodexId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolLocationId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "protocolOrganizationTypeCode": "(val)",
  "organizationId": "(val)",
  "rolodexId": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Locations
POST/iacuc/api/v1/iacuc-protocol-locations/

Example URI

POST /iacuc/api/v1/iacuc-protocol-locations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolLocationId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "protocolOrganizationTypeCode": "(val)",
  "organizationId": "(val)",
  "rolodexId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolLocationId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "protocolOrganizationTypeCode": "(val)",
  "organizationId": "(val)",
  "rolodexId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Locations
POST/iacuc/api/v1/iacuc-protocol-locations/

Example URI

POST /iacuc/api/v1/iacuc-protocol-locations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol Locations by Key
DELETE/iacuc/api/v1/iacuc-protocol-locations/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-locations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Locations
DELETE/iacuc/api/v1/iacuc-protocol-locations/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-locations/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Locations with Matching
DELETE/iacuc/api/v1/iacuc-protocol-locations/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-locations/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Modules

Get Iacuc Protocol Modules by Key
GET/iacuc/api/v1/iacuc-protocol-modules/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-modules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolModuleCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Modules
GET/iacuc/api/v1/iacuc-protocol-modules/

Example URI

GET /iacuc/api/v1/iacuc-protocol-modules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolModuleCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolModuleCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Modules with Filtering
GET/iacuc/api/v1/iacuc-protocol-modules/

Example URI

GET /iacuc/api/v1/iacuc-protocol-modules/
URI Parameters
HideShow
protocolModuleCode
string (optional) 
description
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolModuleCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolModuleCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Modules
GET/iacuc/api/v1/iacuc-protocol-modules/

Example URI

GET /iacuc/api/v1/iacuc-protocol-modules/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolModuleCode",
    "description"
  ],
  "primaryKey": "protocolModuleCode"
}

Get Blueprint API specification for Iacuc Protocol Modules
GET/iacuc/api/v1/iacuc-protocol-modules/

Example URI

GET /iacuc/api/v1/iacuc-protocol-modules/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Modules.md"
transfer-encoding: chunked

Update Iacuc Protocol Modules
PUT/iacuc/api/v1/iacuc-protocol-modules/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-modules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolModuleCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Modules
PUT/iacuc/api/v1/iacuc-protocol-modules/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-modules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolModuleCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolModuleCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Modules
PATCH/iacuc/api/v1/iacuc-protocol-modules/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-modules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolModuleCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolModuleCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Modules
POST/iacuc/api/v1/iacuc-protocol-modules/

Example URI

POST /iacuc/api/v1/iacuc-protocol-modules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolModuleCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolModuleCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Modules
POST/iacuc/api/v1/iacuc-protocol-modules/

Example URI

POST /iacuc/api/v1/iacuc-protocol-modules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolModuleCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolModuleCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "protocolModuleCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolModuleCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Modules by Key
DELETE/iacuc/api/v1/iacuc-protocol-modules/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-modules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Modules
DELETE/iacuc/api/v1/iacuc-protocol-modules/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-modules/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Modules with Matching
DELETE/iacuc/api/v1/iacuc-protocol-modules/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-modules/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

protocolModuleCode
string (optional) 
description
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Notepads

Get Iacuc Protocol Notepads by Key
GET/iacuc/api/v1/iacuc-protocol-notepads/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-notepads/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "entryNumber": "(val)",
  "comments": "(val)",
  "restrictedView": "(val)",
  "noteTopic": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Notepads
GET/iacuc/api/v1/iacuc-protocol-notepads/

Example URI

GET /iacuc/api/v1/iacuc-protocol-notepads/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Notepads with Filtering
GET/iacuc/api/v1/iacuc-protocol-notepads/

Example URI

GET /iacuc/api/v1/iacuc-protocol-notepads/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Notepads
GET/iacuc/api/v1/iacuc-protocol-notepads/

Example URI

GET /iacuc/api/v1/iacuc-protocol-notepads/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "protocolId",
    "protocolNumber",
    "sequenceNumber",
    "entryNumber",
    "comments",
    "restrictedView",
    "noteTopic",
    "createTimestamp",
    "createUser"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Iacuc Protocol Notepads
GET/iacuc/api/v1/iacuc-protocol-notepads/

Example URI

GET /iacuc/api/v1/iacuc-protocol-notepads/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Notepads.md"
transfer-encoding: chunked

Update Iacuc Protocol Notepads
PUT/iacuc/api/v1/iacuc-protocol-notepads/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-notepads/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "entryNumber": "(val)",
  "comments": "(val)",
  "restrictedView": "(val)",
  "noteTopic": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Notepads
PUT/iacuc/api/v1/iacuc-protocol-notepads/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-notepads/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Protocol Notepads
PATCH/iacuc/api/v1/iacuc-protocol-notepads/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-notepads/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "entryNumber": "(val)",
  "comments": "(val)",
  "restrictedView": "(val)",
  "noteTopic": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "entryNumber": "(val)",
  "comments": "(val)",
  "restrictedView": "(val)",
  "noteTopic": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Notepads
POST/iacuc/api/v1/iacuc-protocol-notepads/

Example URI

POST /iacuc/api/v1/iacuc-protocol-notepads/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "entryNumber": "(val)",
  "comments": "(val)",
  "restrictedView": "(val)",
  "noteTopic": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "entryNumber": "(val)",
  "comments": "(val)",
  "restrictedView": "(val)",
  "noteTopic": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Notepads
POST/iacuc/api/v1/iacuc-protocol-notepads/

Example URI

POST /iacuc/api/v1/iacuc-protocol-notepads/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol Notepads by Key
DELETE/iacuc/api/v1/iacuc-protocol-notepads/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-notepads/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Notepads
DELETE/iacuc/api/v1/iacuc-protocol-notepads/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-notepads/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Notepads with Matching
DELETE/iacuc/api/v1/iacuc-protocol-notepads/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-notepads/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Notifications

Get Iacuc Protocol Notifications by Key
GET/iacuc/api/v1/iacuc-protocol-notifications/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-notifications/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "notificationId": "(val)",
  "notificationTypeId": "(val)",
  "documentNumber": "(val)",
  "owningDocumentIdFk": "(val)",
  "recipients": "(val)",
  "subject": "(val)",
  "message": "(val)",
  "createUser": "(val)",
  "createTimestamp": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Notifications
GET/iacuc/api/v1/iacuc-protocol-notifications/

Example URI

GET /iacuc/api/v1/iacuc-protocol-notifications/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Notifications with Filtering
GET/iacuc/api/v1/iacuc-protocol-notifications/

Example URI

GET /iacuc/api/v1/iacuc-protocol-notifications/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Notifications
GET/iacuc/api/v1/iacuc-protocol-notifications/

Example URI

GET /iacuc/api/v1/iacuc-protocol-notifications/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "notificationId",
    "notificationTypeId",
    "documentNumber",
    "owningDocumentIdFk",
    "recipients",
    "subject",
    "message",
    "createUser",
    "createTimestamp"
  ],
  "primaryKey": "notificationId"
}

Get Blueprint API specification for Iacuc Protocol Notifications
GET/iacuc/api/v1/iacuc-protocol-notifications/

Example URI

GET /iacuc/api/v1/iacuc-protocol-notifications/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Notifications.md"
transfer-encoding: chunked

Update Iacuc Protocol Notifications
PUT/iacuc/api/v1/iacuc-protocol-notifications/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-notifications/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "notificationId": "(val)",
  "notificationTypeId": "(val)",
  "documentNumber": "(val)",
  "owningDocumentIdFk": "(val)",
  "recipients": "(val)",
  "subject": "(val)",
  "message": "(val)",
  "createUser": "(val)",
  "createTimestamp": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Notifications
PUT/iacuc/api/v1/iacuc-protocol-notifications/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-notifications/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Protocol Notifications
PATCH/iacuc/api/v1/iacuc-protocol-notifications/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-notifications/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "notificationId": "(val)",
  "notificationTypeId": "(val)",
  "documentNumber": "(val)",
  "owningDocumentIdFk": "(val)",
  "recipients": "(val)",
  "subject": "(val)",
  "message": "(val)",
  "createUser": "(val)",
  "createTimestamp": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "notificationId": "(val)",
  "notificationTypeId": "(val)",
  "documentNumber": "(val)",
  "owningDocumentIdFk": "(val)",
  "recipients": "(val)",
  "subject": "(val)",
  "message": "(val)",
  "createUser": "(val)",
  "createTimestamp": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Notifications
POST/iacuc/api/v1/iacuc-protocol-notifications/

Example URI

POST /iacuc/api/v1/iacuc-protocol-notifications/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "notificationId": "(val)",
  "notificationTypeId": "(val)",
  "documentNumber": "(val)",
  "owningDocumentIdFk": "(val)",
  "recipients": "(val)",
  "subject": "(val)",
  "message": "(val)",
  "createUser": "(val)",
  "createTimestamp": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "notificationId": "(val)",
  "notificationTypeId": "(val)",
  "documentNumber": "(val)",
  "owningDocumentIdFk": "(val)",
  "recipients": "(val)",
  "subject": "(val)",
  "message": "(val)",
  "createUser": "(val)",
  "createTimestamp": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Notifications
POST/iacuc/api/v1/iacuc-protocol-notifications/

Example URI

POST /iacuc/api/v1/iacuc-protocol-notifications/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol Notifications by Key
DELETE/iacuc/api/v1/iacuc-protocol-notifications/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-notifications/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Notifications
DELETE/iacuc/api/v1/iacuc-protocol-notifications/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-notifications/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Notifications with Matching
DELETE/iacuc/api/v1/iacuc-protocol-notifications/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-notifications/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Online Review Determination Recommendations

Get Iacuc Protocol Online Review Determination Recommendations by Key
GET/iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
  "description": "(val)",
  "iacucProtocolReviewTypeCode": "(val)",
  "iacucProtocolActionTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Online Review Determination Recommendations
GET/iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
    "description": "(val)",
    "iacucProtocolReviewTypeCode": "(val)",
    "iacucProtocolActionTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
    "description": "(val)",
    "iacucProtocolReviewTypeCode": "(val)",
    "iacucProtocolActionTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Online Review Determination Recommendations with Filtering
GET/iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/
URI Parameters
HideShow
protocolOnlineReviewDeterminationRecommendationCode
string (optional) 

Status Code. Maximum length is 3.

description
string (optional) 

Description. Maximum length is 300.

iacucProtocolReviewTypeCode
string (optional) 

Review Type. Maximum length is 3.

iacucProtocolActionTypeCode
string (optional) 

Recommended Action. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
    "description": "(val)",
    "iacucProtocolReviewTypeCode": "(val)",
    "iacucProtocolActionTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
    "description": "(val)",
    "iacucProtocolReviewTypeCode": "(val)",
    "iacucProtocolActionTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Online Review Determination Recommendations
GET/iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolOnlineReviewDeterminationRecommendationCode",
    "description",
    "iacucProtocolReviewTypeCode",
    "iacucProtocolActionTypeCode"
  ],
  "primaryKey": "protocolOnlineReviewDeterminationRecommendationCode"
}

Get Blueprint API specification for Iacuc Protocol Online Review Determination Recommendations
GET/iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Online Review Determination Recommendations.md"
transfer-encoding: chunked

Update Iacuc Protocol Online Review Determination Recommendations
PUT/iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
  "description": "(val)",
  "iacucProtocolReviewTypeCode": "(val)",
  "iacucProtocolActionTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Online Review Determination Recommendations
PUT/iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
    "description": "(val)",
    "iacucProtocolReviewTypeCode": "(val)",
    "iacucProtocolActionTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
    "description": "(val)",
    "iacucProtocolReviewTypeCode": "(val)",
    "iacucProtocolActionTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Online Review Determination Recommendations
PATCH/iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
  "description": "(val)",
  "iacucProtocolReviewTypeCode": "(val)",
  "iacucProtocolActionTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
  "description": "(val)",
  "iacucProtocolReviewTypeCode": "(val)",
  "iacucProtocolActionTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Online Review Determination Recommendations
POST/iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/

Example URI

POST /iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
  "description": "(val)",
  "iacucProtocolReviewTypeCode": "(val)",
  "iacucProtocolActionTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
  "description": "(val)",
  "iacucProtocolReviewTypeCode": "(val)",
  "iacucProtocolActionTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Online Review Determination Recommendations
POST/iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/

Example URI

POST /iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
    "description": "(val)",
    "iacucProtocolReviewTypeCode": "(val)",
    "iacucProtocolActionTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
    "description": "(val)",
    "iacucProtocolReviewTypeCode": "(val)",
    "iacucProtocolActionTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
    "description": "(val)",
    "iacucProtocolReviewTypeCode": "(val)",
    "iacucProtocolActionTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
    "description": "(val)",
    "iacucProtocolReviewTypeCode": "(val)",
    "iacucProtocolActionTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Online Review Determination Recommendations by Key
DELETE/iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Online Review Determination Recommendations
DELETE/iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Online Review Determination Recommendations with Matching
DELETE/iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-online-review-determination-recommendations/
URI Parameters
HideShow
_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.

iacucProtocolReviewTypeCode
string (optional) 

Review Type. Maximum length is 3.

iacucProtocolActionTypeCode
string (optional) 

Recommended Action. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Online Review Determination Type Recommendations

Get Iacuc Protocol Online Review Determination Type Recommendations by Key
GET/iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "iacucProtocolReviewTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Online Review Determination Type Recommendations
GET/iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProtocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Online Review Determination Type Recommendations with Filtering
GET/iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/
URI Parameters
HideShow
iacucProtocolReviewTypeCode
string (optional) 

Review Type. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProtocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Online Review Determination Type Recommendations
GET/iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "iacucProtocolReviewTypeCode"
  ],
  "primaryKey": "iacucProtocolReviewTypeCode"
}

Get Blueprint API specification for Iacuc Protocol Online Review Determination Type Recommendations
GET/iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Online Review Determination Type Recommendations.md"
transfer-encoding: chunked

Update Iacuc Protocol Online Review Determination Type Recommendations
PUT/iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolReviewTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Online Review Determination Type Recommendations
PUT/iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucProtocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Online Review Determination Type Recommendations
PATCH/iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolReviewTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "iacucProtocolReviewTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Online Review Determination Type Recommendations
POST/iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/

Example URI

POST /iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolReviewTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "iacucProtocolReviewTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Online Review Determination Type Recommendations
POST/iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/

Example URI

POST /iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucProtocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "iacucProtocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Online Review Determination Type Recommendations by Key
DELETE/iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Online Review Determination Type Recommendations
DELETE/iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Online Review Determination Type Recommendations with Matching
DELETE/iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-online-review-determination-type-recommendations/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

iacucProtocolReviewTypeCode
string (optional) 

Review Type. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Online Review Documents

Get Iacuc Protocol Online Review Documents by Key
GET/iacuc/api/v1/iacuc-protocol-online-review-documents/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-documents/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Online Review Documents
GET/iacuc/api/v1/iacuc-protocol-online-review-documents/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-documents/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Online Review Documents with Filtering
GET/iacuc/api/v1/iacuc-protocol-online-review-documents/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-documents/
URI Parameters
HideShow
documentNumber
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Online Review Documents
GET/iacuc/api/v1/iacuc-protocol-online-review-documents/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-documents/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "documentNumber"
  ],
  "primaryKey": "documentNumber"
}

Get Blueprint API specification for Iacuc Protocol Online Review Documents
GET/iacuc/api/v1/iacuc-protocol-online-review-documents/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-documents/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Online Review Documents.md"
transfer-encoding: chunked

Update Iacuc Protocol Online Review Documents
PUT/iacuc/api/v1/iacuc-protocol-online-review-documents/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-online-review-documents/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Online Review Documents
PUT/iacuc/api/v1/iacuc-protocol-online-review-documents/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-online-review-documents/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Online Review Documents
PATCH/iacuc/api/v1/iacuc-protocol-online-review-documents/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-online-review-documents/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Online Review Documents
POST/iacuc/api/v1/iacuc-protocol-online-review-documents/

Example URI

POST /iacuc/api/v1/iacuc-protocol-online-review-documents/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Online Review Documents
POST/iacuc/api/v1/iacuc-protocol-online-review-documents/

Example URI

POST /iacuc/api/v1/iacuc-protocol-online-review-documents/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Online Review Documents by Key
DELETE/iacuc/api/v1/iacuc-protocol-online-review-documents/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-online-review-documents/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Online Review Documents
DELETE/iacuc/api/v1/iacuc-protocol-online-review-documents/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-online-review-documents/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Online Review Documents with Matching
DELETE/iacuc/api/v1/iacuc-protocol-online-review-documents/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-online-review-documents/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

documentNumber
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Online Review Statuses

Get Iacuc Protocol Online Review Statuses by Key
GET/iacuc/api/v1/iacuc-protocol-online-review-statuses/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "statusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Online Review Statuses
GET/iacuc/api/v1/iacuc-protocol-online-review-statuses/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Online Review Statuses with Filtering
GET/iacuc/api/v1/iacuc-protocol-online-review-statuses/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-statuses/
URI Parameters
HideShow
statusCode
string (optional) 

Status Code. Maximum length is 3.

description
string (optional) 

Description. Maximum length is 300.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Online Review Statuses
GET/iacuc/api/v1/iacuc-protocol-online-review-statuses/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-statuses/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "statusCode",
    "description"
  ],
  "primaryKey": "statusCode"
}

Get Blueprint API specification for Iacuc Protocol Online Review Statuses
GET/iacuc/api/v1/iacuc-protocol-online-review-statuses/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-review-statuses/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Online Review Statuses.md"
transfer-encoding: chunked

Update Iacuc Protocol Online Review Statuses
PUT/iacuc/api/v1/iacuc-protocol-online-review-statuses/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-online-review-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "statusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Online Review Statuses
PUT/iacuc/api/v1/iacuc-protocol-online-review-statuses/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-online-review-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Online Review Statuses
PATCH/iacuc/api/v1/iacuc-protocol-online-review-statuses/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-online-review-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "statusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "statusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Online Review Statuses
POST/iacuc/api/v1/iacuc-protocol-online-review-statuses/

Example URI

POST /iacuc/api/v1/iacuc-protocol-online-review-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "statusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "statusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Online Review Statuses
POST/iacuc/api/v1/iacuc-protocol-online-review-statuses/

Example URI

POST /iacuc/api/v1/iacuc-protocol-online-review-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "statusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Online Review Statuses by Key
DELETE/iacuc/api/v1/iacuc-protocol-online-review-statuses/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-online-review-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Online Review Statuses
DELETE/iacuc/api/v1/iacuc-protocol-online-review-statuses/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-online-review-statuses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Online Review Statuses with Matching
DELETE/iacuc/api/v1/iacuc-protocol-online-review-statuses/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-online-review-statuses/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Online Reviews

Get Iacuc Protocol Online Reviews by Key
GET/iacuc/api/v1/iacuc-protocol-online-reviews/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-reviews/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolOnlineReviewId": "(val)",
  "protocolId": "(val)",
  "submissionIdFk": "(val)",
  "protocolReviewerId": "(val)",
  "protocolOnlineReviewStatusCode": "(val)",
  "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
  "dateDue": "(val)",
  "dateRequested": "(val)",
  "actionsPerformed": "(val)",
  "reviewerApproved": "(val)",
  "adminAccepted": "(val)",
  "determinationReviewTypeCode": "(val)",
  "determinationReviewDateDue": "(val)",
  "protocolOnlineReviewDocument.documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Online Reviews
GET/iacuc/api/v1/iacuc-protocol-online-reviews/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-reviews/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolOnlineReviewId": "(val)",
    "protocolId": "(val)",
    "submissionIdFk": "(val)",
    "protocolReviewerId": "(val)",
    "protocolOnlineReviewStatusCode": "(val)",
    "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
    "dateDue": "(val)",
    "dateRequested": "(val)",
    "actionsPerformed": "(val)",
    "reviewerApproved": "(val)",
    "adminAccepted": "(val)",
    "determinationReviewTypeCode": "(val)",
    "determinationReviewDateDue": "(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)",
    "determinationReviewTypeCode": "(val)",
    "determinationReviewDateDue": "(val)",
    "protocolOnlineReviewDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Online Reviews with Filtering
GET/iacuc/api/v1/iacuc-protocol-online-reviews/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-reviews/
URI Parameters
HideShow
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) 
determinationReviewTypeCode
string (optional) 

Review Type Determination. Maximum length is 3.

determinationReviewDateDue
string (optional) 

Determination Due Date. Maximum length is 10.

protocolOnlineReviewDocument.documentNumber
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolOnlineReviewId": "(val)",
    "protocolId": "(val)",
    "submissionIdFk": "(val)",
    "protocolReviewerId": "(val)",
    "protocolOnlineReviewStatusCode": "(val)",
    "protocolOnlineReviewDeterminationRecommendationCode": "(val)",
    "dateDue": "(val)",
    "dateRequested": "(val)",
    "actionsPerformed": "(val)",
    "reviewerApproved": "(val)",
    "adminAccepted": "(val)",
    "determinationReviewTypeCode": "(val)",
    "determinationReviewDateDue": "(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)",
    "determinationReviewTypeCode": "(val)",
    "determinationReviewDateDue": "(val)",
    "protocolOnlineReviewDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Online Reviews
GET/iacuc/api/v1/iacuc-protocol-online-reviews/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-reviews/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolOnlineReviewId",
    "protocolId",
    "submissionIdFk",
    "protocolReviewerId",
    "protocolOnlineReviewStatusCode",
    "protocolOnlineReviewDeterminationRecommendationCode",
    "dateDue",
    "dateRequested",
    "actionsPerformed",
    "reviewerApproved",
    "adminAccepted",
    "determinationReviewTypeCode",
    "determinationReviewDateDue",
    "protocolOnlineReviewDocument.documentNumber"
  ],
  "primaryKey": "protocolOnlineReviewId"
}

Get Blueprint API specification for Iacuc Protocol Online Reviews
GET/iacuc/api/v1/iacuc-protocol-online-reviews/

Example URI

GET /iacuc/api/v1/iacuc-protocol-online-reviews/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Online Reviews.md"
transfer-encoding: chunked

Iacuc Protocol Organization Types

Get Iacuc Protocol Organization Types by Key
GET/iacuc/api/v1/iacuc-protocol-organization-types/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-organization-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolOrganizationTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Organization Types
GET/iacuc/api/v1/iacuc-protocol-organization-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-organization-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolOrganizationTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolOrganizationTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Organization Types with Filtering
GET/iacuc/api/v1/iacuc-protocol-organization-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-organization-types/
URI Parameters
HideShow
protocolOrganizationTypeCode
string (optional) 

Protocol Organization Type Code. Maximum length is 3.

description
string (optional) 

Description. Maximum length is 200.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolOrganizationTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolOrganizationTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Organization Types
GET/iacuc/api/v1/iacuc-protocol-organization-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-organization-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolOrganizationTypeCode",
    "description"
  ],
  "primaryKey": "protocolOrganizationTypeCode"
}

Get Blueprint API specification for Iacuc Protocol Organization Types
GET/iacuc/api/v1/iacuc-protocol-organization-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-organization-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Organization Types.md"
transfer-encoding: chunked

Update Iacuc Protocol Organization Types
PUT/iacuc/api/v1/iacuc-protocol-organization-types/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-organization-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolOrganizationTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Organization Types
PUT/iacuc/api/v1/iacuc-protocol-organization-types/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-organization-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolOrganizationTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolOrganizationTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Organization Types
PATCH/iacuc/api/v1/iacuc-protocol-organization-types/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-organization-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolOrganizationTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolOrganizationTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Organization Types
POST/iacuc/api/v1/iacuc-protocol-organization-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-organization-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolOrganizationTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolOrganizationTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Organization Types
POST/iacuc/api/v1/iacuc-protocol-organization-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-organization-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolOrganizationTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolOrganizationTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "protocolOrganizationTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolOrganizationTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Organization Types by Key
DELETE/iacuc/api/v1/iacuc-protocol-organization-types/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-organization-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Organization Types
DELETE/iacuc/api/v1/iacuc-protocol-organization-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-organization-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Organization Types with Matching
DELETE/iacuc/api/v1/iacuc-protocol-organization-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-organization-types/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Person Mass Changes

Get Iacuc Protocol Person Mass Changes by Key
GET/iacuc/api/v1/iacuc-protocol-person-mass-changes/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-mass-changes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "iacucProtocolPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "investigator": "(val)",
  "keyStudyPerson": "(val)",
  "correspondents": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Person Mass Changes
GET/iacuc/api/v1/iacuc-protocol-person-mass-changes/

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-mass-changes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProtocolPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "correspondents": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "correspondents": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Person Mass Changes with Filtering
GET/iacuc/api/v1/iacuc-protocol-person-mass-changes/

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-mass-changes/
URI Parameters
HideShow
iacucProtocolPersonMassChangeId
string (optional) 

IACUC 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.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProtocolPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "correspondents": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "correspondents": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Person Mass Changes
GET/iacuc/api/v1/iacuc-protocol-person-mass-changes/

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-mass-changes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "iacucProtocolPersonMassChangeId",
    "personMassChangeId",
    "investigator",
    "keyStudyPerson",
    "correspondents"
  ],
  "primaryKey": "iacucProtocolPersonMassChangeId"
}

Get Blueprint API specification for Iacuc Protocol Person Mass Changes
GET/iacuc/api/v1/iacuc-protocol-person-mass-changes/

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-mass-changes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Person Mass Changes.md"
transfer-encoding: chunked

Update Iacuc Protocol Person Mass Changes
PUT/iacuc/api/v1/iacuc-protocol-person-mass-changes/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-person-mass-changes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "investigator": "(val)",
  "keyStudyPerson": "(val)",
  "correspondents": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Person Mass Changes
PUT/iacuc/api/v1/iacuc-protocol-person-mass-changes/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-person-mass-changes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucProtocolPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "correspondents": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "correspondents": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Person Mass Changes
PATCH/iacuc/api/v1/iacuc-protocol-person-mass-changes/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-person-mass-changes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "investigator": "(val)",
  "keyStudyPerson": "(val)",
  "correspondents": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "iacucProtocolPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "investigator": "(val)",
  "keyStudyPerson": "(val)",
  "correspondents": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Person Mass Changes
POST/iacuc/api/v1/iacuc-protocol-person-mass-changes/

Example URI

POST /iacuc/api/v1/iacuc-protocol-person-mass-changes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "investigator": "(val)",
  "keyStudyPerson": "(val)",
  "correspondents": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "iacucProtocolPersonMassChangeId": "(val)",
  "personMassChangeId": "(val)",
  "investigator": "(val)",
  "keyStudyPerson": "(val)",
  "correspondents": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Person Mass Changes
POST/iacuc/api/v1/iacuc-protocol-person-mass-changes/

Example URI

POST /iacuc/api/v1/iacuc-protocol-person-mass-changes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucProtocolPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "correspondents": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "correspondents": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "iacucProtocolPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "correspondents": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolPersonMassChangeId": "(val)",
    "personMassChangeId": "(val)",
    "investigator": "(val)",
    "keyStudyPerson": "(val)",
    "correspondents": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Person Mass Changes by Key
DELETE/iacuc/api/v1/iacuc-protocol-person-mass-changes/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-person-mass-changes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Person Mass Changes
DELETE/iacuc/api/v1/iacuc-protocol-person-mass-changes/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-person-mass-changes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Person Mass Changes with Matching
DELETE/iacuc/api/v1/iacuc-protocol-person-mass-changes/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-person-mass-changes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

iacucProtocolPersonMassChangeId
string (optional) 

IACUC 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.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Person Role Mappings

Get Iacuc Protocol Person Role Mappings by Key
GET/iacuc/api/v1/iacuc-protocol-person-role-mappings/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-role-mappings/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "roleMappingId": "(val)",
  "sourceRoleId": "(val)",
  "targetRoleId": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Person Role Mappings
GET/iacuc/api/v1/iacuc-protocol-person-role-mappings/

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-role-mappings/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "roleMappingId": "(val)",
    "sourceRoleId": "(val)",
    "targetRoleId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleMappingId": "(val)",
    "sourceRoleId": "(val)",
    "targetRoleId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Person Role Mappings with Filtering
GET/iacuc/api/v1/iacuc-protocol-person-role-mappings/

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-role-mappings/
URI Parameters
HideShow
roleMappingId
string (optional) 
sourceRoleId
string (optional) 
targetRoleId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "roleMappingId": "(val)",
    "sourceRoleId": "(val)",
    "targetRoleId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleMappingId": "(val)",
    "sourceRoleId": "(val)",
    "targetRoleId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Person Role Mappings
GET/iacuc/api/v1/iacuc-protocol-person-role-mappings/

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-role-mappings/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "roleMappingId",
    "sourceRoleId",
    "targetRoleId"
  ],
  "primaryKey": "roleMappingId"
}

Get Blueprint API specification for Iacuc Protocol Person Role Mappings
GET/iacuc/api/v1/iacuc-protocol-person-role-mappings/

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-role-mappings/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Person Role Mappings.md"
transfer-encoding: chunked

Update Iacuc Protocol Person Role Mappings
PUT/iacuc/api/v1/iacuc-protocol-person-role-mappings/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-person-role-mappings/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleMappingId": "(val)",
  "sourceRoleId": "(val)",
  "targetRoleId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Person Role Mappings
PUT/iacuc/api/v1/iacuc-protocol-person-role-mappings/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-person-role-mappings/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "roleMappingId": "(val)",
    "sourceRoleId": "(val)",
    "targetRoleId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleMappingId": "(val)",
    "sourceRoleId": "(val)",
    "targetRoleId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Person Role Mappings
PATCH/iacuc/api/v1/iacuc-protocol-person-role-mappings/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-person-role-mappings/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleMappingId": "(val)",
  "sourceRoleId": "(val)",
  "targetRoleId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "roleMappingId": "(val)",
  "sourceRoleId": "(val)",
  "targetRoleId": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Person Role Mappings
POST/iacuc/api/v1/iacuc-protocol-person-role-mappings/

Example URI

POST /iacuc/api/v1/iacuc-protocol-person-role-mappings/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleMappingId": "(val)",
  "sourceRoleId": "(val)",
  "targetRoleId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "roleMappingId": "(val)",
  "sourceRoleId": "(val)",
  "targetRoleId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Person Role Mappings
POST/iacuc/api/v1/iacuc-protocol-person-role-mappings/

Example URI

POST /iacuc/api/v1/iacuc-protocol-person-role-mappings/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "roleMappingId": "(val)",
    "sourceRoleId": "(val)",
    "targetRoleId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleMappingId": "(val)",
    "sourceRoleId": "(val)",
    "targetRoleId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "roleMappingId": "(val)",
    "sourceRoleId": "(val)",
    "targetRoleId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleMappingId": "(val)",
    "sourceRoleId": "(val)",
    "targetRoleId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Person Role Mappings by Key
DELETE/iacuc/api/v1/iacuc-protocol-person-role-mappings/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-person-role-mappings/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Person Role Mappings
DELETE/iacuc/api/v1/iacuc-protocol-person-role-mappings/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-person-role-mappings/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Person Role Mappings with Matching
DELETE/iacuc/api/v1/iacuc-protocol-person-role-mappings/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-person-role-mappings/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

roleMappingId
string (optional) 
sourceRoleId
string (optional) 
targetRoleId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Person Roles

Get Iacuc Protocol Person Roles by Key
GET/iacuc/api/v1/iacuc-protocol-person-roles/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-roles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolPersonRoleId": "(val)",
  "description": "(val)",
  "unitDetailsRequired": "(val)",
  "affiliationDetailsRequired": "(val)",
  "trainingDetailsRequired": "(val)",
  "commentsDetailsRequired": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Person Roles
GET/iacuc/api/v1/iacuc-protocol-person-roles/

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-roles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Person Roles with Filtering
GET/iacuc/api/v1/iacuc-protocol-person-roles/

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-roles/
URI Parameters
HideShow
protocolPersonRoleId
string (optional) 

IACUC 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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Person Roles
GET/iacuc/api/v1/iacuc-protocol-person-roles/

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-roles/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolPersonRoleId",
    "description",
    "unitDetailsRequired",
    "affiliationDetailsRequired",
    "trainingDetailsRequired",
    "commentsDetailsRequired",
    "active"
  ],
  "primaryKey": "protocolPersonRoleId"
}

Get Blueprint API specification for Iacuc Protocol Person Roles
GET/iacuc/api/v1/iacuc-protocol-person-roles/

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-roles/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Person Roles.md"
transfer-encoding: chunked

Update Iacuc Protocol Person Roles
PUT/iacuc/api/v1/iacuc-protocol-person-roles/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-person-roles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolPersonRoleId": "(val)",
  "description": "(val)",
  "unitDetailsRequired": "(val)",
  "affiliationDetailsRequired": "(val)",
  "trainingDetailsRequired": "(val)",
  "commentsDetailsRequired": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Person Roles
PUT/iacuc/api/v1/iacuc-protocol-person-roles/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-person-roles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Protocol Person Roles
PATCH/iacuc/api/v1/iacuc-protocol-person-roles/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-person-roles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolPersonRoleId": "(val)",
  "description": "(val)",
  "unitDetailsRequired": "(val)",
  "affiliationDetailsRequired": "(val)",
  "trainingDetailsRequired": "(val)",
  "commentsDetailsRequired": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolPersonRoleId": "(val)",
  "description": "(val)",
  "unitDetailsRequired": "(val)",
  "affiliationDetailsRequired": "(val)",
  "trainingDetailsRequired": "(val)",
  "commentsDetailsRequired": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Person Roles
POST/iacuc/api/v1/iacuc-protocol-person-roles/

Example URI

POST /iacuc/api/v1/iacuc-protocol-person-roles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolPersonRoleId": "(val)",
  "description": "(val)",
  "unitDetailsRequired": "(val)",
  "affiliationDetailsRequired": "(val)",
  "trainingDetailsRequired": "(val)",
  "commentsDetailsRequired": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolPersonRoleId": "(val)",
  "description": "(val)",
  "unitDetailsRequired": "(val)",
  "affiliationDetailsRequired": "(val)",
  "trainingDetailsRequired": "(val)",
  "commentsDetailsRequired": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Person Roles
POST/iacuc/api/v1/iacuc-protocol-person-roles/

Example URI

POST /iacuc/api/v1/iacuc-protocol-person-roles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol Person Roles by Key
DELETE/iacuc/api/v1/iacuc-protocol-person-roles/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-person-roles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Person Roles
DELETE/iacuc/api/v1/iacuc-protocol-person-roles/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-person-roles/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Person Roles with Matching
DELETE/iacuc/api/v1/iacuc-protocol-person-roles/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-person-roles/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

protocolPersonRoleId
string (optional) 

IACUC 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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Person Rolodexes

Get Iacuc Protocol Person Rolodexes by Key
GET/iacuc/api/v1/iacuc-protocol-person-rolodexes/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-rolodexes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "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 Iacuc Protocol Person Rolodexes
GET/iacuc/api/v1/iacuc-protocol-person-rolodexes/

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-rolodexes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Person Rolodexes with Filtering
GET/iacuc/api/v1/iacuc-protocol-person-rolodexes/

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-rolodexes/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Person Rolodexes
GET/iacuc/api/v1/iacuc-protocol-person-rolodexes/

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-rolodexes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "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 Iacuc Protocol Person Rolodexes
GET/iacuc/api/v1/iacuc-protocol-person-rolodexes/

Example URI

GET /iacuc/api/v1/iacuc-protocol-person-rolodexes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Person Rolodexes.md"
transfer-encoding: chunked

Update Iacuc Protocol Person Rolodexes
PUT/iacuc/api/v1/iacuc-protocol-person-rolodexes/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-person-rolodexes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  204

Update Multiple Iacuc Protocol Person Rolodexes
PUT/iacuc/api/v1/iacuc-protocol-person-rolodexes/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-person-rolodexes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Protocol Person Rolodexes
PATCH/iacuc/api/v1/iacuc-protocol-person-rolodexes/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-person-rolodexes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  204
HideShow
Body
{
  "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 Iacuc Protocol Person Rolodexes
POST/iacuc/api/v1/iacuc-protocol-person-rolodexes/

Example URI

POST /iacuc/api/v1/iacuc-protocol-person-rolodexes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  201
HideShow
Body
{
  "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 Iacuc Protocol Person Rolodexes
POST/iacuc/api/v1/iacuc-protocol-person-rolodexes/

Example URI

POST /iacuc/api/v1/iacuc-protocol-person-rolodexes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol Person Rolodexes by Key
DELETE/iacuc/api/v1/iacuc-protocol-person-rolodexes/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-person-rolodexes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Person Rolodexes
DELETE/iacuc/api/v1/iacuc-protocol-person-rolodexes/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-person-rolodexes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Person Rolodexes with Matching
DELETE/iacuc/api/v1/iacuc-protocol-person-rolodexes/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-person-rolodexes/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Personnel Attachments

Get Iacuc Protocol Personnel Attachments by Key
GET/iacuc/api/v1/iacuc-protocol-personnel-attachments/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-personnel-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "typeCode": "(val)",
  "documentId": "(val)",
  "fileId": "(val)",
  "description": "(val)",
  "personId": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Personnel Attachments
GET/iacuc/api/v1/iacuc-protocol-personnel-attachments/

Example URI

GET /iacuc/api/v1/iacuc-protocol-personnel-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Personnel Attachments with Filtering
GET/iacuc/api/v1/iacuc-protocol-personnel-attachments/

Example URI

GET /iacuc/api/v1/iacuc-protocol-personnel-attachments/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Personnel Attachments
GET/iacuc/api/v1/iacuc-protocol-personnel-attachments/

Example URI

GET /iacuc/api/v1/iacuc-protocol-personnel-attachments/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "protocolId",
    "protocolNumber",
    "sequenceNumber",
    "typeCode",
    "documentId",
    "fileId",
    "description",
    "personId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Iacuc Protocol Personnel Attachments
GET/iacuc/api/v1/iacuc-protocol-personnel-attachments/

Example URI

GET /iacuc/api/v1/iacuc-protocol-personnel-attachments/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Personnel Attachments.md"
transfer-encoding: chunked

Update Iacuc Protocol Personnel Attachments
PUT/iacuc/api/v1/iacuc-protocol-personnel-attachments/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-personnel-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "typeCode": "(val)",
  "documentId": "(val)",
  "fileId": "(val)",
  "description": "(val)",
  "personId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Personnel Attachments
PUT/iacuc/api/v1/iacuc-protocol-personnel-attachments/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-personnel-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Protocol Personnel Attachments
PATCH/iacuc/api/v1/iacuc-protocol-personnel-attachments/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-personnel-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "typeCode": "(val)",
  "documentId": "(val)",
  "fileId": "(val)",
  "description": "(val)",
  "personId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "typeCode": "(val)",
  "documentId": "(val)",
  "fileId": "(val)",
  "description": "(val)",
  "personId": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Personnel Attachments
POST/iacuc/api/v1/iacuc-protocol-personnel-attachments/

Example URI

POST /iacuc/api/v1/iacuc-protocol-personnel-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "typeCode": "(val)",
  "documentId": "(val)",
  "fileId": "(val)",
  "description": "(val)",
  "personId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "typeCode": "(val)",
  "documentId": "(val)",
  "fileId": "(val)",
  "description": "(val)",
  "personId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Personnel Attachments
POST/iacuc/api/v1/iacuc-protocol-personnel-attachments/

Example URI

POST /iacuc/api/v1/iacuc-protocol-personnel-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol Personnel Attachments by Key
DELETE/iacuc/api/v1/iacuc-protocol-personnel-attachments/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-personnel-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Personnel Attachments
DELETE/iacuc/api/v1/iacuc-protocol-personnel-attachments/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-personnel-attachments/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Personnel Attachments with Matching
DELETE/iacuc/api/v1/iacuc-protocol-personnel-attachments/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-personnel-attachments/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Persons

Get Iacuc Protocol Persons by Key
GET/iacuc/api/v1/iacuc-protocol-persons/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-persons/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolPersonId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "personId": "(val)",
  "personName": "(val)",
  "protocolPersonRoleId": "(val)",
  "rolodexId": "(val)",
  "affiliationTypeCode": "(val)",
  "comments": "(val)",
  "lastName": "(val)",
  "firstName": "(val)",
  "middleName": "(val)",
  "fullName": "(val)",
  "priorName": "(val)",
  "userName": "(val)",
  "emailAddress": "(val)",
  "dateOfBirth": "(val)",
  "age": "(val)",
  "ageByFiscalYear": "(val)",
  "gender": "(val)",
  "race": "(val)",
  "educationLevel": "(val)",
  "degree": "(val)",
  "major": "(val)",
  "handicappedFlag": "(val)",
  "handicapType": "(val)",
  "veteranFlag": "(val)",
  "veteranType": "(val)",
  "visaCode": "(val)",
  "visaType": "(val)",
  "visaRenewalDate": "(val)",
  "hasVisa": "(val)",
  "officeLocation": "(val)",
  "officePhone": "(val)",
  "secondaryOfficeLocation": "(val)",
  "secondaryOfficePhone": "(val)",
  "school": "(val)",
  "yearGraduated": "(val)",
  "directoryDepartment": "(val)",
  "saluation": "(val)",
  "countryOfCitizenship": "(val)",
  "primaryTitle": "(val)",
  "directoryTitle": "(val)",
  "homeUnit": "(val)",
  "facultyFlag": "(val)",
  "graduateStudentStaffFlag": "(val)",
  "researchStaffFlag": "(val)",
  "serviceStaffFlag": "(val)",
  "supportStaffFlag": "(val)",
  "otherAcademicGroupFlag": "(val)",
  "medicalStaffFlag": "(val)",
  "vacationAccrualFlag": "(val)",
  "onSabbaticalFlag": "(val)",
  "idProvided": "(val)",
  "idVerified": "(val)",
  "addressLine1": "(val)",
  "addressLine2": "(val)",
  "addressLine3": "(val)",
  "city": "(val)",
  "county": "(val)",
  "state": "(val)",
  "postalCode": "(val)",
  "countryCode": "(val)",
  "faxNumber": "(val)",
  "pagerNumber": "(val)",
  "mobilePhoneNumber": "(val)",
  "eraCommonsUserName": "(val)",
  "procedureQualificationDescription": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Persons
GET/iacuc/api/v1/iacuc-protocol-persons/

Example URI

GET /iacuc/api/v1/iacuc-protocol-persons/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolPersonId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "personId": "(val)",
    "personName": "(val)",
    "protocolPersonRoleId": "(val)",
    "rolodexId": "(val)",
    "affiliationTypeCode": "(val)",
    "comments": "(val)",
    "lastName": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "fullName": "(val)",
    "priorName": "(val)",
    "userName": "(val)",
    "emailAddress": "(val)",
    "dateOfBirth": "(val)",
    "age": "(val)",
    "ageByFiscalYear": "(val)",
    "gender": "(val)",
    "race": "(val)",
    "educationLevel": "(val)",
    "degree": "(val)",
    "major": "(val)",
    "handicappedFlag": "(val)",
    "handicapType": "(val)",
    "veteranFlag": "(val)",
    "veteranType": "(val)",
    "visaCode": "(val)",
    "visaType": "(val)",
    "visaRenewalDate": "(val)",
    "hasVisa": "(val)",
    "officeLocation": "(val)",
    "officePhone": "(val)",
    "secondaryOfficeLocation": "(val)",
    "secondaryOfficePhone": "(val)",
    "school": "(val)",
    "yearGraduated": "(val)",
    "directoryDepartment": "(val)",
    "saluation": "(val)",
    "countryOfCitizenship": "(val)",
    "primaryTitle": "(val)",
    "directoryTitle": "(val)",
    "homeUnit": "(val)",
    "facultyFlag": "(val)",
    "graduateStudentStaffFlag": "(val)",
    "researchStaffFlag": "(val)",
    "serviceStaffFlag": "(val)",
    "supportStaffFlag": "(val)",
    "otherAcademicGroupFlag": "(val)",
    "medicalStaffFlag": "(val)",
    "vacationAccrualFlag": "(val)",
    "onSabbaticalFlag": "(val)",
    "idProvided": "(val)",
    "idVerified": "(val)",
    "addressLine1": "(val)",
    "addressLine2": "(val)",
    "addressLine3": "(val)",
    "city": "(val)",
    "county": "(val)",
    "state": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "faxNumber": "(val)",
    "pagerNumber": "(val)",
    "mobilePhoneNumber": "(val)",
    "eraCommonsUserName": "(val)",
    "procedureQualificationDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolPersonId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "personId": "(val)",
    "personName": "(val)",
    "protocolPersonRoleId": "(val)",
    "rolodexId": "(val)",
    "affiliationTypeCode": "(val)",
    "comments": "(val)",
    "lastName": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "fullName": "(val)",
    "priorName": "(val)",
    "userName": "(val)",
    "emailAddress": "(val)",
    "dateOfBirth": "(val)",
    "age": "(val)",
    "ageByFiscalYear": "(val)",
    "gender": "(val)",
    "race": "(val)",
    "educationLevel": "(val)",
    "degree": "(val)",
    "major": "(val)",
    "handicappedFlag": "(val)",
    "handicapType": "(val)",
    "veteranFlag": "(val)",
    "veteranType": "(val)",
    "visaCode": "(val)",
    "visaType": "(val)",
    "visaRenewalDate": "(val)",
    "hasVisa": "(val)",
    "officeLocation": "(val)",
    "officePhone": "(val)",
    "secondaryOfficeLocation": "(val)",
    "secondaryOfficePhone": "(val)",
    "school": "(val)",
    "yearGraduated": "(val)",
    "directoryDepartment": "(val)",
    "saluation": "(val)",
    "countryOfCitizenship": "(val)",
    "primaryTitle": "(val)",
    "directoryTitle": "(val)",
    "homeUnit": "(val)",
    "facultyFlag": "(val)",
    "graduateStudentStaffFlag": "(val)",
    "researchStaffFlag": "(val)",
    "serviceStaffFlag": "(val)",
    "supportStaffFlag": "(val)",
    "otherAcademicGroupFlag": "(val)",
    "medicalStaffFlag": "(val)",
    "vacationAccrualFlag": "(val)",
    "onSabbaticalFlag": "(val)",
    "idProvided": "(val)",
    "idVerified": "(val)",
    "addressLine1": "(val)",
    "addressLine2": "(val)",
    "addressLine3": "(val)",
    "city": "(val)",
    "county": "(val)",
    "state": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "faxNumber": "(val)",
    "pagerNumber": "(val)",
    "mobilePhoneNumber": "(val)",
    "eraCommonsUserName": "(val)",
    "procedureQualificationDescription": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Persons with Filtering
GET/iacuc/api/v1/iacuc-protocol-persons/

Example URI

GET /iacuc/api/v1/iacuc-protocol-persons/
URI Parameters
HideShow
protocolPersonId
string (optional) 

IACUC Protocol Person Id. Maximum length is 12.

protocolId
string (optional) 
protocolNumber
string (optional) 

IACUC Protocol Number. Maximum length is 20.

sequenceNumber
string (optional) 

Sequence Number. Maximum length is 4.

personId
string (optional) 

Person Id. Maximum length is 40.

personName
string (optional) 

Person Name. Maximum length is 90.

protocolPersonRoleId
string (optional) 

IACUC Protocol Person Role Id. Maximum length is 12.

rolodexId
string (optional) 

Rolodex Id. Maximum length is 12.

affiliationTypeCode
string (optional) 

Affiliation Type. Maximum length is 3.

comments
string (optional) 

Comments. Maximum length is 2000.

lastName
string (optional) 

Last Name. Maximum length is 30.

firstName
string (optional) 

First Name. Maximum length is 30.

middleName
string (optional) 

Middle Name. Maximum length is 30.

fullName
string (optional) 

Full Name. Maximum length is 90.

priorName
string (optional) 

Prior Name. Maximum length is 30.

userName
string (optional) 

User Name. Maximum length is 100.

emailAddress
string (optional) 

Email Address. Maximum length is 60.

dateOfBirth
string (optional) 

Date of Birth. Maximum length is 10.

age
string (optional) 

Age. Maximum length is 3.

ageByFiscalYear
string (optional) 

Age by Fiscal Year. Maximum length is 3.

gender
string (optional) 

Gender. Maximum length is 30.

race
string (optional) 

Race. Maximum length is 30.

educationLevel
string (optional) 

Education Level. Maximum length is 30.

degree
string (optional) 

Degree. Maximum length is 11.

major
string (optional) 

Major. Maximum length is 30.

handicappedFlag
string (optional) 

Is Handicapped. Maximum length is 1.

handicapType
string (optional) 

Handicap Type. Maximum length is 30.

veteranFlag
string (optional) 

Veteran. Maximum length is 1.

veteranType
string (optional) 

Veteran Type. Maximum length is 30.

visaCode
string (optional) 

Visa Code. Maximum length is 20.

visaType
string (optional) 

Visa Type. Maximum length is 30.

visaRenewalDate
string (optional) 

Visa Renewal Date. Maximum length is 10.

hasVisa
string (optional) 

Has Visa. Maximum length is 1.

officeLocation
string (optional) 

Office Location. Maximum length is 30.

officePhone
string (optional) 

Office Phone. Maximum length is 20.

secondaryOfficeLocation
string (optional) 

Secondary Office Location. Maximum length is 30.

secondaryOfficePhone
string (optional) 

Secondary Office Phone. Maximum length is 20.

school
string (optional) 

School. Maximum length is 50.

yearGraduated
string (optional) 

Year Graduated. Maximum length is 30.

directoryDepartment
string (optional) 

Directory Department. Maximum length is 30.

saluation
string (optional) 

Salutation. Maximum length is 30.

countryOfCitizenship
string (optional) 

Country Code. Maximum length is 3.

primaryTitle
string (optional) 

PrimaryTitle. Maximum length is 51.

directoryTitle
string (optional) 

Directory Title. Maximum length is 50.

homeUnit
string (optional) 

Home Unit. Maximum length is 8.

facultyFlag
string (optional) 

Faculty. Maximum length is 1.

graduateStudentStaffFlag
string (optional) 

Create User. Maximum length is 1.

researchStaffFlag
string (optional) 

Is Research Staff. Maximum length is 1.

serviceStaffFlag
string (optional) 

Is Service Staff. Maximum length is 1.

supportStaffFlag
string (optional) 

Is Support Staff. Maximum length is 1.

otherAcademicGroupFlag
string (optional) 

Is Other Academic Group. Maximum length is 1.

medicalStaffFlag
string (optional) 

Is Medical Staff. Maximum length is 1.

vacationAccrualFlag
string (optional) 

Is Vacation Accrual. Maximum length is 1.

onSabbaticalFlag
string (optional) 

Is on Sabbatical. Maximum length is 1.

idProvided
string (optional) 

Id Provided. Maximum length is 30.

idVerified
string (optional) 

Id Verified. Maximum length is 30.

addressLine1
string (optional) 

Address Line 1. Maximum length is 80.

addressLine2
string (optional) 

Address Line 2. Maximum length is 80.

addressLine3
string (optional) 

Address Line 3. Maximum length is 80.

city
string (optional) 

City. Maximum length is 30.

county
string (optional) 

County. Maximum length is 30.

state
string (optional) 

State. Maximum length is 30.

postalCode
string (optional) 

Postal Code. Maximum length is 15.

countryCode
string (optional) 

Country Code. Maximum length is 3.

faxNumber
string (optional) 

Fax Number. Maximum length is 20.

pagerNumber
string (optional) 

Page Number. Maximum length is 20.

mobilePhoneNumber
string (optional) 

Moble Phone Number. Maximum length is 20.

eraCommonsUserName
string (optional) 

Era Commons User Name. Maximum length is 20.

procedureQualificationDescription
string (optional) 

Qualification Description. Maximum length is 2000.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolPersonId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "personId": "(val)",
    "personName": "(val)",
    "protocolPersonRoleId": "(val)",
    "rolodexId": "(val)",
    "affiliationTypeCode": "(val)",
    "comments": "(val)",
    "lastName": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "fullName": "(val)",
    "priorName": "(val)",
    "userName": "(val)",
    "emailAddress": "(val)",
    "dateOfBirth": "(val)",
    "age": "(val)",
    "ageByFiscalYear": "(val)",
    "gender": "(val)",
    "race": "(val)",
    "educationLevel": "(val)",
    "degree": "(val)",
    "major": "(val)",
    "handicappedFlag": "(val)",
    "handicapType": "(val)",
    "veteranFlag": "(val)",
    "veteranType": "(val)",
    "visaCode": "(val)",
    "visaType": "(val)",
    "visaRenewalDate": "(val)",
    "hasVisa": "(val)",
    "officeLocation": "(val)",
    "officePhone": "(val)",
    "secondaryOfficeLocation": "(val)",
    "secondaryOfficePhone": "(val)",
    "school": "(val)",
    "yearGraduated": "(val)",
    "directoryDepartment": "(val)",
    "saluation": "(val)",
    "countryOfCitizenship": "(val)",
    "primaryTitle": "(val)",
    "directoryTitle": "(val)",
    "homeUnit": "(val)",
    "facultyFlag": "(val)",
    "graduateStudentStaffFlag": "(val)",
    "researchStaffFlag": "(val)",
    "serviceStaffFlag": "(val)",
    "supportStaffFlag": "(val)",
    "otherAcademicGroupFlag": "(val)",
    "medicalStaffFlag": "(val)",
    "vacationAccrualFlag": "(val)",
    "onSabbaticalFlag": "(val)",
    "idProvided": "(val)",
    "idVerified": "(val)",
    "addressLine1": "(val)",
    "addressLine2": "(val)",
    "addressLine3": "(val)",
    "city": "(val)",
    "county": "(val)",
    "state": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "faxNumber": "(val)",
    "pagerNumber": "(val)",
    "mobilePhoneNumber": "(val)",
    "eraCommonsUserName": "(val)",
    "procedureQualificationDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolPersonId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "personId": "(val)",
    "personName": "(val)",
    "protocolPersonRoleId": "(val)",
    "rolodexId": "(val)",
    "affiliationTypeCode": "(val)",
    "comments": "(val)",
    "lastName": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "fullName": "(val)",
    "priorName": "(val)",
    "userName": "(val)",
    "emailAddress": "(val)",
    "dateOfBirth": "(val)",
    "age": "(val)",
    "ageByFiscalYear": "(val)",
    "gender": "(val)",
    "race": "(val)",
    "educationLevel": "(val)",
    "degree": "(val)",
    "major": "(val)",
    "handicappedFlag": "(val)",
    "handicapType": "(val)",
    "veteranFlag": "(val)",
    "veteranType": "(val)",
    "visaCode": "(val)",
    "visaType": "(val)",
    "visaRenewalDate": "(val)",
    "hasVisa": "(val)",
    "officeLocation": "(val)",
    "officePhone": "(val)",
    "secondaryOfficeLocation": "(val)",
    "secondaryOfficePhone": "(val)",
    "school": "(val)",
    "yearGraduated": "(val)",
    "directoryDepartment": "(val)",
    "saluation": "(val)",
    "countryOfCitizenship": "(val)",
    "primaryTitle": "(val)",
    "directoryTitle": "(val)",
    "homeUnit": "(val)",
    "facultyFlag": "(val)",
    "graduateStudentStaffFlag": "(val)",
    "researchStaffFlag": "(val)",
    "serviceStaffFlag": "(val)",
    "supportStaffFlag": "(val)",
    "otherAcademicGroupFlag": "(val)",
    "medicalStaffFlag": "(val)",
    "vacationAccrualFlag": "(val)",
    "onSabbaticalFlag": "(val)",
    "idProvided": "(val)",
    "idVerified": "(val)",
    "addressLine1": "(val)",
    "addressLine2": "(val)",
    "addressLine3": "(val)",
    "city": "(val)",
    "county": "(val)",
    "state": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "faxNumber": "(val)",
    "pagerNumber": "(val)",
    "mobilePhoneNumber": "(val)",
    "eraCommonsUserName": "(val)",
    "procedureQualificationDescription": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Persons
GET/iacuc/api/v1/iacuc-protocol-persons/

Example URI

GET /iacuc/api/v1/iacuc-protocol-persons/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolPersonId",
    "protocolId",
    "protocolNumber",
    "sequenceNumber",
    "personId",
    "personName",
    "protocolPersonRoleId",
    "rolodexId",
    "affiliationTypeCode",
    "comments",
    "lastName",
    "firstName",
    "middleName",
    "fullName",
    "priorName",
    "userName",
    "emailAddress",
    "dateOfBirth",
    "age",
    "ageByFiscalYear",
    "gender",
    "race",
    "educationLevel",
    "degree",
    "major",
    "handicappedFlag",
    "handicapType",
    "veteranFlag",
    "veteranType",
    "visaCode",
    "visaType",
    "visaRenewalDate",
    "hasVisa",
    "officeLocation",
    "officePhone",
    "secondaryOfficeLocation",
    "secondaryOfficePhone",
    "school",
    "yearGraduated",
    "directoryDepartment",
    "saluation",
    "countryOfCitizenship",
    "primaryTitle",
    "directoryTitle",
    "homeUnit",
    "facultyFlag",
    "graduateStudentStaffFlag",
    "researchStaffFlag",
    "serviceStaffFlag",
    "supportStaffFlag",
    "otherAcademicGroupFlag",
    "medicalStaffFlag",
    "vacationAccrualFlag",
    "onSabbaticalFlag",
    "idProvided",
    "idVerified",
    "addressLine1",
    "addressLine2",
    "addressLine3",
    "city",
    "county",
    "state",
    "postalCode",
    "countryCode",
    "faxNumber",
    "pagerNumber",
    "mobilePhoneNumber",
    "eraCommonsUserName",
    "procedureQualificationDescription"
  ],
  "primaryKey": "protocolPersonId"
}

Get Blueprint API specification for Iacuc Protocol Persons
GET/iacuc/api/v1/iacuc-protocol-persons/

Example URI

GET /iacuc/api/v1/iacuc-protocol-persons/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Persons.md"
transfer-encoding: chunked

Update Iacuc Protocol Persons
PUT/iacuc/api/v1/iacuc-protocol-persons/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-persons/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolPersonId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "personId": "(val)",
  "personName": "(val)",
  "protocolPersonRoleId": "(val)",
  "rolodexId": "(val)",
  "affiliationTypeCode": "(val)",
  "comments": "(val)",
  "lastName": "(val)",
  "firstName": "(val)",
  "middleName": "(val)",
  "fullName": "(val)",
  "priorName": "(val)",
  "userName": "(val)",
  "emailAddress": "(val)",
  "dateOfBirth": "(val)",
  "age": "(val)",
  "ageByFiscalYear": "(val)",
  "gender": "(val)",
  "race": "(val)",
  "educationLevel": "(val)",
  "degree": "(val)",
  "major": "(val)",
  "handicappedFlag": "(val)",
  "handicapType": "(val)",
  "veteranFlag": "(val)",
  "veteranType": "(val)",
  "visaCode": "(val)",
  "visaType": "(val)",
  "visaRenewalDate": "(val)",
  "hasVisa": "(val)",
  "officeLocation": "(val)",
  "officePhone": "(val)",
  "secondaryOfficeLocation": "(val)",
  "secondaryOfficePhone": "(val)",
  "school": "(val)",
  "yearGraduated": "(val)",
  "directoryDepartment": "(val)",
  "saluation": "(val)",
  "countryOfCitizenship": "(val)",
  "primaryTitle": "(val)",
  "directoryTitle": "(val)",
  "homeUnit": "(val)",
  "facultyFlag": "(val)",
  "graduateStudentStaffFlag": "(val)",
  "researchStaffFlag": "(val)",
  "serviceStaffFlag": "(val)",
  "supportStaffFlag": "(val)",
  "otherAcademicGroupFlag": "(val)",
  "medicalStaffFlag": "(val)",
  "vacationAccrualFlag": "(val)",
  "onSabbaticalFlag": "(val)",
  "idProvided": "(val)",
  "idVerified": "(val)",
  "addressLine1": "(val)",
  "addressLine2": "(val)",
  "addressLine3": "(val)",
  "city": "(val)",
  "county": "(val)",
  "state": "(val)",
  "postalCode": "(val)",
  "countryCode": "(val)",
  "faxNumber": "(val)",
  "pagerNumber": "(val)",
  "mobilePhoneNumber": "(val)",
  "eraCommonsUserName": "(val)",
  "procedureQualificationDescription": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Persons
PUT/iacuc/api/v1/iacuc-protocol-persons/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-persons/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolPersonId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "personId": "(val)",
    "personName": "(val)",
    "protocolPersonRoleId": "(val)",
    "rolodexId": "(val)",
    "affiliationTypeCode": "(val)",
    "comments": "(val)",
    "lastName": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "fullName": "(val)",
    "priorName": "(val)",
    "userName": "(val)",
    "emailAddress": "(val)",
    "dateOfBirth": "(val)",
    "age": "(val)",
    "ageByFiscalYear": "(val)",
    "gender": "(val)",
    "race": "(val)",
    "educationLevel": "(val)",
    "degree": "(val)",
    "major": "(val)",
    "handicappedFlag": "(val)",
    "handicapType": "(val)",
    "veteranFlag": "(val)",
    "veteranType": "(val)",
    "visaCode": "(val)",
    "visaType": "(val)",
    "visaRenewalDate": "(val)",
    "hasVisa": "(val)",
    "officeLocation": "(val)",
    "officePhone": "(val)",
    "secondaryOfficeLocation": "(val)",
    "secondaryOfficePhone": "(val)",
    "school": "(val)",
    "yearGraduated": "(val)",
    "directoryDepartment": "(val)",
    "saluation": "(val)",
    "countryOfCitizenship": "(val)",
    "primaryTitle": "(val)",
    "directoryTitle": "(val)",
    "homeUnit": "(val)",
    "facultyFlag": "(val)",
    "graduateStudentStaffFlag": "(val)",
    "researchStaffFlag": "(val)",
    "serviceStaffFlag": "(val)",
    "supportStaffFlag": "(val)",
    "otherAcademicGroupFlag": "(val)",
    "medicalStaffFlag": "(val)",
    "vacationAccrualFlag": "(val)",
    "onSabbaticalFlag": "(val)",
    "idProvided": "(val)",
    "idVerified": "(val)",
    "addressLine1": "(val)",
    "addressLine2": "(val)",
    "addressLine3": "(val)",
    "city": "(val)",
    "county": "(val)",
    "state": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "faxNumber": "(val)",
    "pagerNumber": "(val)",
    "mobilePhoneNumber": "(val)",
    "eraCommonsUserName": "(val)",
    "procedureQualificationDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolPersonId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "personId": "(val)",
    "personName": "(val)",
    "protocolPersonRoleId": "(val)",
    "rolodexId": "(val)",
    "affiliationTypeCode": "(val)",
    "comments": "(val)",
    "lastName": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "fullName": "(val)",
    "priorName": "(val)",
    "userName": "(val)",
    "emailAddress": "(val)",
    "dateOfBirth": "(val)",
    "age": "(val)",
    "ageByFiscalYear": "(val)",
    "gender": "(val)",
    "race": "(val)",
    "educationLevel": "(val)",
    "degree": "(val)",
    "major": "(val)",
    "handicappedFlag": "(val)",
    "handicapType": "(val)",
    "veteranFlag": "(val)",
    "veteranType": "(val)",
    "visaCode": "(val)",
    "visaType": "(val)",
    "visaRenewalDate": "(val)",
    "hasVisa": "(val)",
    "officeLocation": "(val)",
    "officePhone": "(val)",
    "secondaryOfficeLocation": "(val)",
    "secondaryOfficePhone": "(val)",
    "school": "(val)",
    "yearGraduated": "(val)",
    "directoryDepartment": "(val)",
    "saluation": "(val)",
    "countryOfCitizenship": "(val)",
    "primaryTitle": "(val)",
    "directoryTitle": "(val)",
    "homeUnit": "(val)",
    "facultyFlag": "(val)",
    "graduateStudentStaffFlag": "(val)",
    "researchStaffFlag": "(val)",
    "serviceStaffFlag": "(val)",
    "supportStaffFlag": "(val)",
    "otherAcademicGroupFlag": "(val)",
    "medicalStaffFlag": "(val)",
    "vacationAccrualFlag": "(val)",
    "onSabbaticalFlag": "(val)",
    "idProvided": "(val)",
    "idVerified": "(val)",
    "addressLine1": "(val)",
    "addressLine2": "(val)",
    "addressLine3": "(val)",
    "city": "(val)",
    "county": "(val)",
    "state": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "faxNumber": "(val)",
    "pagerNumber": "(val)",
    "mobilePhoneNumber": "(val)",
    "eraCommonsUserName": "(val)",
    "procedureQualificationDescription": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Persons
PATCH/iacuc/api/v1/iacuc-protocol-persons/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-persons/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolPersonId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "personId": "(val)",
  "personName": "(val)",
  "protocolPersonRoleId": "(val)",
  "rolodexId": "(val)",
  "affiliationTypeCode": "(val)",
  "comments": "(val)",
  "lastName": "(val)",
  "firstName": "(val)",
  "middleName": "(val)",
  "fullName": "(val)",
  "priorName": "(val)",
  "userName": "(val)",
  "emailAddress": "(val)",
  "dateOfBirth": "(val)",
  "age": "(val)",
  "ageByFiscalYear": "(val)",
  "gender": "(val)",
  "race": "(val)",
  "educationLevel": "(val)",
  "degree": "(val)",
  "major": "(val)",
  "handicappedFlag": "(val)",
  "handicapType": "(val)",
  "veteranFlag": "(val)",
  "veteranType": "(val)",
  "visaCode": "(val)",
  "visaType": "(val)",
  "visaRenewalDate": "(val)",
  "hasVisa": "(val)",
  "officeLocation": "(val)",
  "officePhone": "(val)",
  "secondaryOfficeLocation": "(val)",
  "secondaryOfficePhone": "(val)",
  "school": "(val)",
  "yearGraduated": "(val)",
  "directoryDepartment": "(val)",
  "saluation": "(val)",
  "countryOfCitizenship": "(val)",
  "primaryTitle": "(val)",
  "directoryTitle": "(val)",
  "homeUnit": "(val)",
  "facultyFlag": "(val)",
  "graduateStudentStaffFlag": "(val)",
  "researchStaffFlag": "(val)",
  "serviceStaffFlag": "(val)",
  "supportStaffFlag": "(val)",
  "otherAcademicGroupFlag": "(val)",
  "medicalStaffFlag": "(val)",
  "vacationAccrualFlag": "(val)",
  "onSabbaticalFlag": "(val)",
  "idProvided": "(val)",
  "idVerified": "(val)",
  "addressLine1": "(val)",
  "addressLine2": "(val)",
  "addressLine3": "(val)",
  "city": "(val)",
  "county": "(val)",
  "state": "(val)",
  "postalCode": "(val)",
  "countryCode": "(val)",
  "faxNumber": "(val)",
  "pagerNumber": "(val)",
  "mobilePhoneNumber": "(val)",
  "eraCommonsUserName": "(val)",
  "procedureQualificationDescription": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolPersonId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "personId": "(val)",
  "personName": "(val)",
  "protocolPersonRoleId": "(val)",
  "rolodexId": "(val)",
  "affiliationTypeCode": "(val)",
  "comments": "(val)",
  "lastName": "(val)",
  "firstName": "(val)",
  "middleName": "(val)",
  "fullName": "(val)",
  "priorName": "(val)",
  "userName": "(val)",
  "emailAddress": "(val)",
  "dateOfBirth": "(val)",
  "age": "(val)",
  "ageByFiscalYear": "(val)",
  "gender": "(val)",
  "race": "(val)",
  "educationLevel": "(val)",
  "degree": "(val)",
  "major": "(val)",
  "handicappedFlag": "(val)",
  "handicapType": "(val)",
  "veteranFlag": "(val)",
  "veteranType": "(val)",
  "visaCode": "(val)",
  "visaType": "(val)",
  "visaRenewalDate": "(val)",
  "hasVisa": "(val)",
  "officeLocation": "(val)",
  "officePhone": "(val)",
  "secondaryOfficeLocation": "(val)",
  "secondaryOfficePhone": "(val)",
  "school": "(val)",
  "yearGraduated": "(val)",
  "directoryDepartment": "(val)",
  "saluation": "(val)",
  "countryOfCitizenship": "(val)",
  "primaryTitle": "(val)",
  "directoryTitle": "(val)",
  "homeUnit": "(val)",
  "facultyFlag": "(val)",
  "graduateStudentStaffFlag": "(val)",
  "researchStaffFlag": "(val)",
  "serviceStaffFlag": "(val)",
  "supportStaffFlag": "(val)",
  "otherAcademicGroupFlag": "(val)",
  "medicalStaffFlag": "(val)",
  "vacationAccrualFlag": "(val)",
  "onSabbaticalFlag": "(val)",
  "idProvided": "(val)",
  "idVerified": "(val)",
  "addressLine1": "(val)",
  "addressLine2": "(val)",
  "addressLine3": "(val)",
  "city": "(val)",
  "county": "(val)",
  "state": "(val)",
  "postalCode": "(val)",
  "countryCode": "(val)",
  "faxNumber": "(val)",
  "pagerNumber": "(val)",
  "mobilePhoneNumber": "(val)",
  "eraCommonsUserName": "(val)",
  "procedureQualificationDescription": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Persons
POST/iacuc/api/v1/iacuc-protocol-persons/

Example URI

POST /iacuc/api/v1/iacuc-protocol-persons/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolPersonId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "personId": "(val)",
  "personName": "(val)",
  "protocolPersonRoleId": "(val)",
  "rolodexId": "(val)",
  "affiliationTypeCode": "(val)",
  "comments": "(val)",
  "lastName": "(val)",
  "firstName": "(val)",
  "middleName": "(val)",
  "fullName": "(val)",
  "priorName": "(val)",
  "userName": "(val)",
  "emailAddress": "(val)",
  "dateOfBirth": "(val)",
  "age": "(val)",
  "ageByFiscalYear": "(val)",
  "gender": "(val)",
  "race": "(val)",
  "educationLevel": "(val)",
  "degree": "(val)",
  "major": "(val)",
  "handicappedFlag": "(val)",
  "handicapType": "(val)",
  "veteranFlag": "(val)",
  "veteranType": "(val)",
  "visaCode": "(val)",
  "visaType": "(val)",
  "visaRenewalDate": "(val)",
  "hasVisa": "(val)",
  "officeLocation": "(val)",
  "officePhone": "(val)",
  "secondaryOfficeLocation": "(val)",
  "secondaryOfficePhone": "(val)",
  "school": "(val)",
  "yearGraduated": "(val)",
  "directoryDepartment": "(val)",
  "saluation": "(val)",
  "countryOfCitizenship": "(val)",
  "primaryTitle": "(val)",
  "directoryTitle": "(val)",
  "homeUnit": "(val)",
  "facultyFlag": "(val)",
  "graduateStudentStaffFlag": "(val)",
  "researchStaffFlag": "(val)",
  "serviceStaffFlag": "(val)",
  "supportStaffFlag": "(val)",
  "otherAcademicGroupFlag": "(val)",
  "medicalStaffFlag": "(val)",
  "vacationAccrualFlag": "(val)",
  "onSabbaticalFlag": "(val)",
  "idProvided": "(val)",
  "idVerified": "(val)",
  "addressLine1": "(val)",
  "addressLine2": "(val)",
  "addressLine3": "(val)",
  "city": "(val)",
  "county": "(val)",
  "state": "(val)",
  "postalCode": "(val)",
  "countryCode": "(val)",
  "faxNumber": "(val)",
  "pagerNumber": "(val)",
  "mobilePhoneNumber": "(val)",
  "eraCommonsUserName": "(val)",
  "procedureQualificationDescription": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolPersonId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "personId": "(val)",
  "personName": "(val)",
  "protocolPersonRoleId": "(val)",
  "rolodexId": "(val)",
  "affiliationTypeCode": "(val)",
  "comments": "(val)",
  "lastName": "(val)",
  "firstName": "(val)",
  "middleName": "(val)",
  "fullName": "(val)",
  "priorName": "(val)",
  "userName": "(val)",
  "emailAddress": "(val)",
  "dateOfBirth": "(val)",
  "age": "(val)",
  "ageByFiscalYear": "(val)",
  "gender": "(val)",
  "race": "(val)",
  "educationLevel": "(val)",
  "degree": "(val)",
  "major": "(val)",
  "handicappedFlag": "(val)",
  "handicapType": "(val)",
  "veteranFlag": "(val)",
  "veteranType": "(val)",
  "visaCode": "(val)",
  "visaType": "(val)",
  "visaRenewalDate": "(val)",
  "hasVisa": "(val)",
  "officeLocation": "(val)",
  "officePhone": "(val)",
  "secondaryOfficeLocation": "(val)",
  "secondaryOfficePhone": "(val)",
  "school": "(val)",
  "yearGraduated": "(val)",
  "directoryDepartment": "(val)",
  "saluation": "(val)",
  "countryOfCitizenship": "(val)",
  "primaryTitle": "(val)",
  "directoryTitle": "(val)",
  "homeUnit": "(val)",
  "facultyFlag": "(val)",
  "graduateStudentStaffFlag": "(val)",
  "researchStaffFlag": "(val)",
  "serviceStaffFlag": "(val)",
  "supportStaffFlag": "(val)",
  "otherAcademicGroupFlag": "(val)",
  "medicalStaffFlag": "(val)",
  "vacationAccrualFlag": "(val)",
  "onSabbaticalFlag": "(val)",
  "idProvided": "(val)",
  "idVerified": "(val)",
  "addressLine1": "(val)",
  "addressLine2": "(val)",
  "addressLine3": "(val)",
  "city": "(val)",
  "county": "(val)",
  "state": "(val)",
  "postalCode": "(val)",
  "countryCode": "(val)",
  "faxNumber": "(val)",
  "pagerNumber": "(val)",
  "mobilePhoneNumber": "(val)",
  "eraCommonsUserName": "(val)",
  "procedureQualificationDescription": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Persons
POST/iacuc/api/v1/iacuc-protocol-persons/

Example URI

POST /iacuc/api/v1/iacuc-protocol-persons/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolPersonId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "personId": "(val)",
    "personName": "(val)",
    "protocolPersonRoleId": "(val)",
    "rolodexId": "(val)",
    "affiliationTypeCode": "(val)",
    "comments": "(val)",
    "lastName": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "fullName": "(val)",
    "priorName": "(val)",
    "userName": "(val)",
    "emailAddress": "(val)",
    "dateOfBirth": "(val)",
    "age": "(val)",
    "ageByFiscalYear": "(val)",
    "gender": "(val)",
    "race": "(val)",
    "educationLevel": "(val)",
    "degree": "(val)",
    "major": "(val)",
    "handicappedFlag": "(val)",
    "handicapType": "(val)",
    "veteranFlag": "(val)",
    "veteranType": "(val)",
    "visaCode": "(val)",
    "visaType": "(val)",
    "visaRenewalDate": "(val)",
    "hasVisa": "(val)",
    "officeLocation": "(val)",
    "officePhone": "(val)",
    "secondaryOfficeLocation": "(val)",
    "secondaryOfficePhone": "(val)",
    "school": "(val)",
    "yearGraduated": "(val)",
    "directoryDepartment": "(val)",
    "saluation": "(val)",
    "countryOfCitizenship": "(val)",
    "primaryTitle": "(val)",
    "directoryTitle": "(val)",
    "homeUnit": "(val)",
    "facultyFlag": "(val)",
    "graduateStudentStaffFlag": "(val)",
    "researchStaffFlag": "(val)",
    "serviceStaffFlag": "(val)",
    "supportStaffFlag": "(val)",
    "otherAcademicGroupFlag": "(val)",
    "medicalStaffFlag": "(val)",
    "vacationAccrualFlag": "(val)",
    "onSabbaticalFlag": "(val)",
    "idProvided": "(val)",
    "idVerified": "(val)",
    "addressLine1": "(val)",
    "addressLine2": "(val)",
    "addressLine3": "(val)",
    "city": "(val)",
    "county": "(val)",
    "state": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "faxNumber": "(val)",
    "pagerNumber": "(val)",
    "mobilePhoneNumber": "(val)",
    "eraCommonsUserName": "(val)",
    "procedureQualificationDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolPersonId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "personId": "(val)",
    "personName": "(val)",
    "protocolPersonRoleId": "(val)",
    "rolodexId": "(val)",
    "affiliationTypeCode": "(val)",
    "comments": "(val)",
    "lastName": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "fullName": "(val)",
    "priorName": "(val)",
    "userName": "(val)",
    "emailAddress": "(val)",
    "dateOfBirth": "(val)",
    "age": "(val)",
    "ageByFiscalYear": "(val)",
    "gender": "(val)",
    "race": "(val)",
    "educationLevel": "(val)",
    "degree": "(val)",
    "major": "(val)",
    "handicappedFlag": "(val)",
    "handicapType": "(val)",
    "veteranFlag": "(val)",
    "veteranType": "(val)",
    "visaCode": "(val)",
    "visaType": "(val)",
    "visaRenewalDate": "(val)",
    "hasVisa": "(val)",
    "officeLocation": "(val)",
    "officePhone": "(val)",
    "secondaryOfficeLocation": "(val)",
    "secondaryOfficePhone": "(val)",
    "school": "(val)",
    "yearGraduated": "(val)",
    "directoryDepartment": "(val)",
    "saluation": "(val)",
    "countryOfCitizenship": "(val)",
    "primaryTitle": "(val)",
    "directoryTitle": "(val)",
    "homeUnit": "(val)",
    "facultyFlag": "(val)",
    "graduateStudentStaffFlag": "(val)",
    "researchStaffFlag": "(val)",
    "serviceStaffFlag": "(val)",
    "supportStaffFlag": "(val)",
    "otherAcademicGroupFlag": "(val)",
    "medicalStaffFlag": "(val)",
    "vacationAccrualFlag": "(val)",
    "onSabbaticalFlag": "(val)",
    "idProvided": "(val)",
    "idVerified": "(val)",
    "addressLine1": "(val)",
    "addressLine2": "(val)",
    "addressLine3": "(val)",
    "city": "(val)",
    "county": "(val)",
    "state": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "faxNumber": "(val)",
    "pagerNumber": "(val)",
    "mobilePhoneNumber": "(val)",
    "eraCommonsUserName": "(val)",
    "procedureQualificationDescription": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "protocolPersonId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "personId": "(val)",
    "personName": "(val)",
    "protocolPersonRoleId": "(val)",
    "rolodexId": "(val)",
    "affiliationTypeCode": "(val)",
    "comments": "(val)",
    "lastName": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "fullName": "(val)",
    "priorName": "(val)",
    "userName": "(val)",
    "emailAddress": "(val)",
    "dateOfBirth": "(val)",
    "age": "(val)",
    "ageByFiscalYear": "(val)",
    "gender": "(val)",
    "race": "(val)",
    "educationLevel": "(val)",
    "degree": "(val)",
    "major": "(val)",
    "handicappedFlag": "(val)",
    "handicapType": "(val)",
    "veteranFlag": "(val)",
    "veteranType": "(val)",
    "visaCode": "(val)",
    "visaType": "(val)",
    "visaRenewalDate": "(val)",
    "hasVisa": "(val)",
    "officeLocation": "(val)",
    "officePhone": "(val)",
    "secondaryOfficeLocation": "(val)",
    "secondaryOfficePhone": "(val)",
    "school": "(val)",
    "yearGraduated": "(val)",
    "directoryDepartment": "(val)",
    "saluation": "(val)",
    "countryOfCitizenship": "(val)",
    "primaryTitle": "(val)",
    "directoryTitle": "(val)",
    "homeUnit": "(val)",
    "facultyFlag": "(val)",
    "graduateStudentStaffFlag": "(val)",
    "researchStaffFlag": "(val)",
    "serviceStaffFlag": "(val)",
    "supportStaffFlag": "(val)",
    "otherAcademicGroupFlag": "(val)",
    "medicalStaffFlag": "(val)",
    "vacationAccrualFlag": "(val)",
    "onSabbaticalFlag": "(val)",
    "idProvided": "(val)",
    "idVerified": "(val)",
    "addressLine1": "(val)",
    "addressLine2": "(val)",
    "addressLine3": "(val)",
    "city": "(val)",
    "county": "(val)",
    "state": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "faxNumber": "(val)",
    "pagerNumber": "(val)",
    "mobilePhoneNumber": "(val)",
    "eraCommonsUserName": "(val)",
    "procedureQualificationDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolPersonId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "personId": "(val)",
    "personName": "(val)",
    "protocolPersonRoleId": "(val)",
    "rolodexId": "(val)",
    "affiliationTypeCode": "(val)",
    "comments": "(val)",
    "lastName": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "fullName": "(val)",
    "priorName": "(val)",
    "userName": "(val)",
    "emailAddress": "(val)",
    "dateOfBirth": "(val)",
    "age": "(val)",
    "ageByFiscalYear": "(val)",
    "gender": "(val)",
    "race": "(val)",
    "educationLevel": "(val)",
    "degree": "(val)",
    "major": "(val)",
    "handicappedFlag": "(val)",
    "handicapType": "(val)",
    "veteranFlag": "(val)",
    "veteranType": "(val)",
    "visaCode": "(val)",
    "visaType": "(val)",
    "visaRenewalDate": "(val)",
    "hasVisa": "(val)",
    "officeLocation": "(val)",
    "officePhone": "(val)",
    "secondaryOfficeLocation": "(val)",
    "secondaryOfficePhone": "(val)",
    "school": "(val)",
    "yearGraduated": "(val)",
    "directoryDepartment": "(val)",
    "saluation": "(val)",
    "countryOfCitizenship": "(val)",
    "primaryTitle": "(val)",
    "directoryTitle": "(val)",
    "homeUnit": "(val)",
    "facultyFlag": "(val)",
    "graduateStudentStaffFlag": "(val)",
    "researchStaffFlag": "(val)",
    "serviceStaffFlag": "(val)",
    "supportStaffFlag": "(val)",
    "otherAcademicGroupFlag": "(val)",
    "medicalStaffFlag": "(val)",
    "vacationAccrualFlag": "(val)",
    "onSabbaticalFlag": "(val)",
    "idProvided": "(val)",
    "idVerified": "(val)",
    "addressLine1": "(val)",
    "addressLine2": "(val)",
    "addressLine3": "(val)",
    "city": "(val)",
    "county": "(val)",
    "state": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "faxNumber": "(val)",
    "pagerNumber": "(val)",
    "mobilePhoneNumber": "(val)",
    "eraCommonsUserName": "(val)",
    "procedureQualificationDescription": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Persons by Key
DELETE/iacuc/api/v1/iacuc-protocol-persons/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-persons/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Persons
DELETE/iacuc/api/v1/iacuc-protocol-persons/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-persons/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Persons with Matching
DELETE/iacuc/api/v1/iacuc-protocol-persons/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-persons/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

protocolPersonId
string (optional) 

IACUC Protocol Person Id. Maximum length is 12.

protocolId
string (optional) 
protocolNumber
string (optional) 

IACUC Protocol Number. Maximum length is 20.

sequenceNumber
string (optional) 

Sequence Number. Maximum length is 4.

personId
string (optional) 

Person Id. Maximum length is 40.

personName
string (optional) 

Person Name. Maximum length is 90.

protocolPersonRoleId
string (optional) 

IACUC Protocol Person Role Id. Maximum length is 12.

rolodexId
string (optional) 

Rolodex Id. Maximum length is 12.

affiliationTypeCode
string (optional) 

Affiliation Type. Maximum length is 3.

comments
string (optional) 

Comments. Maximum length is 2000.

lastName
string (optional) 

Last Name. Maximum length is 30.

firstName
string (optional) 

First Name. Maximum length is 30.

middleName
string (optional) 

Middle Name. Maximum length is 30.

fullName
string (optional) 

Full Name. Maximum length is 90.

priorName
string (optional) 

Prior Name. Maximum length is 30.

userName
string (optional) 

User Name. Maximum length is 100.

emailAddress
string (optional) 

Email Address. Maximum length is 60.

dateOfBirth
string (optional) 

Date of Birth. Maximum length is 10.

age
string (optional) 

Age. Maximum length is 3.

ageByFiscalYear
string (optional) 

Age by Fiscal Year. Maximum length is 3.

gender
string (optional) 

Gender. Maximum length is 30.

race
string (optional) 

Race. Maximum length is 30.

educationLevel
string (optional) 

Education Level. Maximum length is 30.

degree
string (optional) 

Degree. Maximum length is 11.

major
string (optional) 

Major. Maximum length is 30.

handicappedFlag
string (optional) 

Is Handicapped. Maximum length is 1.

handicapType
string (optional) 

Handicap Type. Maximum length is 30.

veteranFlag
string (optional) 

Veteran. Maximum length is 1.

veteranType
string (optional) 

Veteran Type. Maximum length is 30.

visaCode
string (optional) 

Visa Code. Maximum length is 20.

visaType
string (optional) 

Visa Type. Maximum length is 30.

visaRenewalDate
string (optional) 

Visa Renewal Date. Maximum length is 10.

hasVisa
string (optional) 

Has Visa. Maximum length is 1.

officeLocation
string (optional) 

Office Location. Maximum length is 30.

officePhone
string (optional) 

Office Phone. Maximum length is 20.

secondaryOfficeLocation
string (optional) 

Secondary Office Location. Maximum length is 30.

secondaryOfficePhone
string (optional) 

Secondary Office Phone. Maximum length is 20.

school
string (optional) 

School. Maximum length is 50.

yearGraduated
string (optional) 

Year Graduated. Maximum length is 30.

directoryDepartment
string (optional) 

Directory Department. Maximum length is 30.

saluation
string (optional) 

Salutation. Maximum length is 30.

countryOfCitizenship
string (optional) 

Country Code. Maximum length is 3.

primaryTitle
string (optional) 

PrimaryTitle. Maximum length is 51.

directoryTitle
string (optional) 

Directory Title. Maximum length is 50.

homeUnit
string (optional) 

Home Unit. Maximum length is 8.

facultyFlag
string (optional) 

Faculty. Maximum length is 1.

graduateStudentStaffFlag
string (optional) 

Create User. Maximum length is 1.

researchStaffFlag
string (optional) 

Is Research Staff. Maximum length is 1.

serviceStaffFlag
string (optional) 

Is Service Staff. Maximum length is 1.

supportStaffFlag
string (optional) 

Is Support Staff. Maximum length is 1.

otherAcademicGroupFlag
string (optional) 

Is Other Academic Group. Maximum length is 1.

medicalStaffFlag
string (optional) 

Is Medical Staff. Maximum length is 1.

vacationAccrualFlag
string (optional) 

Is Vacation Accrual. Maximum length is 1.

onSabbaticalFlag
string (optional) 

Is on Sabbatical. Maximum length is 1.

idProvided
string (optional) 

Id Provided. Maximum length is 30.

idVerified
string (optional) 

Id Verified. Maximum length is 30.

addressLine1
string (optional) 

Address Line 1. Maximum length is 80.

addressLine2
string (optional) 

Address Line 2. Maximum length is 80.

addressLine3
string (optional) 

Address Line 3. Maximum length is 80.

city
string (optional) 

City. Maximum length is 30.

county
string (optional) 

County. Maximum length is 30.

state
string (optional) 

State. Maximum length is 30.

postalCode
string (optional) 

Postal Code. Maximum length is 15.

countryCode
string (optional) 

Country Code. Maximum length is 3.

faxNumber
string (optional) 

Fax Number. Maximum length is 20.

pagerNumber
string (optional) 

Page Number. Maximum length is 20.

mobilePhoneNumber
string (optional) 

Moble Phone Number. Maximum length is 20.

eraCommonsUserName
string (optional) 

Era Commons User Name. Maximum length is 20.

procedureQualificationDescription
string (optional) 

Qualification Description. Maximum length is 2000.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Project Types

Get Iacuc Protocol Project Types by Key
GET/iacuc/api/v1/iacuc-protocol-project-types/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-project-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "projectTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Project Types
GET/iacuc/api/v1/iacuc-protocol-project-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-project-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "projectTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "projectTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Project Types with Filtering
GET/iacuc/api/v1/iacuc-protocol-project-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-project-types/
URI Parameters
HideShow
projectTypeCode
string (optional) 

Project Type Code. Maximum length is 22.

description
string (optional) 

Description. Maximum length is 200.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "projectTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "projectTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Project Types
GET/iacuc/api/v1/iacuc-protocol-project-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-project-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "projectTypeCode",
    "description"
  ],
  "primaryKey": "projectTypeCode"
}

Get Blueprint API specification for Iacuc Protocol Project Types
GET/iacuc/api/v1/iacuc-protocol-project-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-project-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Project Types.md"
transfer-encoding: chunked

Update Iacuc Protocol Project Types
PUT/iacuc/api/v1/iacuc-protocol-project-types/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-project-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "projectTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Project Types
PUT/iacuc/api/v1/iacuc-protocol-project-types/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-project-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "projectTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "projectTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Project Types
PATCH/iacuc/api/v1/iacuc-protocol-project-types/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-project-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "projectTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "projectTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Project Types
POST/iacuc/api/v1/iacuc-protocol-project-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-project-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "projectTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "projectTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Project Types
POST/iacuc/api/v1/iacuc-protocol-project-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-project-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "projectTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "projectTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "projectTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "projectTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Project Types by Key
DELETE/iacuc/api/v1/iacuc-protocol-project-types/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-project-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Project Types
DELETE/iacuc/api/v1/iacuc-protocol-project-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-project-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Project Types with Matching
DELETE/iacuc/api/v1/iacuc-protocol-project-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-project-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

projectTypeCode
string (optional) 

Project Type Code. Maximum length is 22.

description
string (optional) 

Description. Maximum length is 200.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Recused Votes

Get Iacuc Protocol Recused Votes by Key
GET/iacuc/api/v1/iacuc-protocol-recused-votes/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-recused-votes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolVoteRecusedId": "(val)",
  "protocolIdFk": "(val)",
  "submissionIdFk": "(val)",
  "personId": "(val)",
  "rolodexId": "(val)",
  "nonEmployeeFlag": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Recused Votes
GET/iacuc/api/v1/iacuc-protocol-recused-votes/

Example URI

GET /iacuc/api/v1/iacuc-protocol-recused-votes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolVoteRecusedId": "(val)",
    "protocolIdFk": "(val)",
    "submissionIdFk": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "nonEmployeeFlag": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolVoteRecusedId": "(val)",
    "protocolIdFk": "(val)",
    "submissionIdFk": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "nonEmployeeFlag": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Recused Votes with Filtering
GET/iacuc/api/v1/iacuc-protocol-recused-votes/

Example URI

GET /iacuc/api/v1/iacuc-protocol-recused-votes/
URI Parameters
HideShow
protocolVoteRecusedId
string (optional) 
protocolIdFk
string (optional) 
submissionIdFk
string (optional) 
personId
string (optional) 
rolodexId
string (optional) 
nonEmployeeFlag
string (optional) 
comments
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolVoteRecusedId": "(val)",
    "protocolIdFk": "(val)",
    "submissionIdFk": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "nonEmployeeFlag": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolVoteRecusedId": "(val)",
    "protocolIdFk": "(val)",
    "submissionIdFk": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "nonEmployeeFlag": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Recused Votes
GET/iacuc/api/v1/iacuc-protocol-recused-votes/

Example URI

GET /iacuc/api/v1/iacuc-protocol-recused-votes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolVoteRecusedId",
    "protocolIdFk",
    "submissionIdFk",
    "personId",
    "rolodexId",
    "nonEmployeeFlag",
    "comments"
  ],
  "primaryKey": "protocolVoteRecusedId"
}

Get Blueprint API specification for Iacuc Protocol Recused Votes
GET/iacuc/api/v1/iacuc-protocol-recused-votes/

Example URI

GET /iacuc/api/v1/iacuc-protocol-recused-votes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Recused Votes.md"
transfer-encoding: chunked

Update Iacuc Protocol Recused Votes
PUT/iacuc/api/v1/iacuc-protocol-recused-votes/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-recused-votes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolVoteRecusedId": "(val)",
  "protocolIdFk": "(val)",
  "submissionIdFk": "(val)",
  "personId": "(val)",
  "rolodexId": "(val)",
  "nonEmployeeFlag": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Recused Votes
PUT/iacuc/api/v1/iacuc-protocol-recused-votes/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-recused-votes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolVoteRecusedId": "(val)",
    "protocolIdFk": "(val)",
    "submissionIdFk": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "nonEmployeeFlag": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolVoteRecusedId": "(val)",
    "protocolIdFk": "(val)",
    "submissionIdFk": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "nonEmployeeFlag": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Recused Votes
PATCH/iacuc/api/v1/iacuc-protocol-recused-votes/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-recused-votes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolVoteRecusedId": "(val)",
  "protocolIdFk": "(val)",
  "submissionIdFk": "(val)",
  "personId": "(val)",
  "rolodexId": "(val)",
  "nonEmployeeFlag": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolVoteRecusedId": "(val)",
  "protocolIdFk": "(val)",
  "submissionIdFk": "(val)",
  "personId": "(val)",
  "rolodexId": "(val)",
  "nonEmployeeFlag": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Recused Votes
POST/iacuc/api/v1/iacuc-protocol-recused-votes/

Example URI

POST /iacuc/api/v1/iacuc-protocol-recused-votes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolVoteRecusedId": "(val)",
  "protocolIdFk": "(val)",
  "submissionIdFk": "(val)",
  "personId": "(val)",
  "rolodexId": "(val)",
  "nonEmployeeFlag": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolVoteRecusedId": "(val)",
  "protocolIdFk": "(val)",
  "submissionIdFk": "(val)",
  "personId": "(val)",
  "rolodexId": "(val)",
  "nonEmployeeFlag": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Recused Votes
POST/iacuc/api/v1/iacuc-protocol-recused-votes/

Example URI

POST /iacuc/api/v1/iacuc-protocol-recused-votes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolVoteRecusedId": "(val)",
    "protocolIdFk": "(val)",
    "submissionIdFk": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "nonEmployeeFlag": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolVoteRecusedId": "(val)",
    "protocolIdFk": "(val)",
    "submissionIdFk": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "nonEmployeeFlag": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "protocolVoteRecusedId": "(val)",
    "protocolIdFk": "(val)",
    "submissionIdFk": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "nonEmployeeFlag": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolVoteRecusedId": "(val)",
    "protocolIdFk": "(val)",
    "submissionIdFk": "(val)",
    "personId": "(val)",
    "rolodexId": "(val)",
    "nonEmployeeFlag": "(val)",
    "comments": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Recused Votes by Key
DELETE/iacuc/api/v1/iacuc-protocol-recused-votes/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-recused-votes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Recused Votes
DELETE/iacuc/api/v1/iacuc-protocol-recused-votes/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-recused-votes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Recused Votes with Matching
DELETE/iacuc/api/v1/iacuc-protocol-recused-votes/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-recused-votes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

protocolVoteRecusedId
string (optional) 
protocolIdFk
string (optional) 
submissionIdFk
string (optional) 
personId
string (optional) 
rolodexId
string (optional) 
nonEmployeeFlag
string (optional) 
comments
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Reference Types

Get Iacuc Protocol Reference Types by Key
GET/iacuc/api/v1/iacuc-protocol-reference-types/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-reference-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolReferenceTypeCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Reference Types
GET/iacuc/api/v1/iacuc-protocol-reference-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-reference-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolReferenceTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolReferenceTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Reference Types with Filtering
GET/iacuc/api/v1/iacuc-protocol-reference-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-reference-types/
URI Parameters
HideShow
protocolReferenceTypeCode
string (optional) 

Protocol Reference Type Code. Maximum length is 22.

description
string (optional) 

Description. Maximum length is 200.

active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolReferenceTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolReferenceTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Reference Types
GET/iacuc/api/v1/iacuc-protocol-reference-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-reference-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolReferenceTypeCode",
    "description",
    "active"
  ],
  "primaryKey": "protocolReferenceTypeCode"
}

Get Blueprint API specification for Iacuc Protocol Reference Types
GET/iacuc/api/v1/iacuc-protocol-reference-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-reference-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Reference Types.md"
transfer-encoding: chunked

Update Iacuc Protocol Reference Types
PUT/iacuc/api/v1/iacuc-protocol-reference-types/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-reference-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolReferenceTypeCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Reference Types
PUT/iacuc/api/v1/iacuc-protocol-reference-types/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-reference-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolReferenceTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolReferenceTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Reference Types
PATCH/iacuc/api/v1/iacuc-protocol-reference-types/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-reference-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolReferenceTypeCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolReferenceTypeCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Reference Types
POST/iacuc/api/v1/iacuc-protocol-reference-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-reference-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolReferenceTypeCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolReferenceTypeCode": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Reference Types
POST/iacuc/api/v1/iacuc-protocol-reference-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-reference-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolReferenceTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolReferenceTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "protocolReferenceTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolReferenceTypeCode": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Reference Types by Key
DELETE/iacuc/api/v1/iacuc-protocol-reference-types/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-reference-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Reference Types
DELETE/iacuc/api/v1/iacuc-protocol-reference-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-reference-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Reference Types with Matching
DELETE/iacuc/api/v1/iacuc-protocol-reference-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-reference-types/
URI Parameters
HideShow
_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 200.

active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol References

Get Iacuc Protocol References by Key
GET/iacuc/api/v1/iacuc-protocol-references/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-references/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolReferenceId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "protocolReferenceNumber": "(val)",
  "protocolReferenceTypeCode": "(val)",
  "referenceKey": "(val)",
  "applicationDate": "(val)",
  "approvalDate": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol References
GET/iacuc/api/v1/iacuc-protocol-references/

Example URI

GET /iacuc/api/v1/iacuc-protocol-references/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol References with Filtering
GET/iacuc/api/v1/iacuc-protocol-references/

Example URI

GET /iacuc/api/v1/iacuc-protocol-references/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol References
GET/iacuc/api/v1/iacuc-protocol-references/

Example URI

GET /iacuc/api/v1/iacuc-protocol-references/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolReferenceId",
    "protocolId",
    "protocolNumber",
    "sequenceNumber",
    "protocolReferenceNumber",
    "protocolReferenceTypeCode",
    "referenceKey",
    "applicationDate",
    "approvalDate",
    "comments"
  ],
  "primaryKey": "protocolReferenceId"
}

Get Blueprint API specification for Iacuc Protocol References
GET/iacuc/api/v1/iacuc-protocol-references/

Example URI

GET /iacuc/api/v1/iacuc-protocol-references/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol References.md"
transfer-encoding: chunked

Update Iacuc Protocol References
PUT/iacuc/api/v1/iacuc-protocol-references/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-references/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolReferenceId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "protocolReferenceNumber": "(val)",
  "protocolReferenceTypeCode": "(val)",
  "referenceKey": "(val)",
  "applicationDate": "(val)",
  "approvalDate": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol References
PUT/iacuc/api/v1/iacuc-protocol-references/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-references/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Protocol References
PATCH/iacuc/api/v1/iacuc-protocol-references/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-references/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolReferenceId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "protocolReferenceNumber": "(val)",
  "protocolReferenceTypeCode": "(val)",
  "referenceKey": "(val)",
  "applicationDate": "(val)",
  "approvalDate": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolReferenceId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "protocolReferenceNumber": "(val)",
  "protocolReferenceTypeCode": "(val)",
  "referenceKey": "(val)",
  "applicationDate": "(val)",
  "approvalDate": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol References
POST/iacuc/api/v1/iacuc-protocol-references/

Example URI

POST /iacuc/api/v1/iacuc-protocol-references/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolReferenceId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "protocolReferenceNumber": "(val)",
  "protocolReferenceTypeCode": "(val)",
  "referenceKey": "(val)",
  "applicationDate": "(val)",
  "approvalDate": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolReferenceId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "protocolReferenceNumber": "(val)",
  "protocolReferenceTypeCode": "(val)",
  "referenceKey": "(val)",
  "applicationDate": "(val)",
  "approvalDate": "(val)",
  "comments": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol References
POST/iacuc/api/v1/iacuc-protocol-references/

Example URI

POST /iacuc/api/v1/iacuc-protocol-references/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol References by Key
DELETE/iacuc/api/v1/iacuc-protocol-references/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-references/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol References
DELETE/iacuc/api/v1/iacuc-protocol-references/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-references/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol References with Matching
DELETE/iacuc/api/v1/iacuc-protocol-references/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-references/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Research Areas

Get Iacuc Protocol Research Areas by Key
GET/iacuc/api/v1/iacuc-protocol-research-areas/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-research-areas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "researchAreaCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Research Areas
GET/iacuc/api/v1/iacuc-protocol-research-areas/

Example URI

GET /iacuc/api/v1/iacuc-protocol-research-areas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Research Areas with Filtering
GET/iacuc/api/v1/iacuc-protocol-research-areas/

Example URI

GET /iacuc/api/v1/iacuc-protocol-research-areas/
URI Parameters
HideShow
id
string (optional) 
protocolId
string (optional) 
protocolNumber
string (optional) 
sequenceNumber
string (optional) 
researchAreaCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Research Areas
GET/iacuc/api/v1/iacuc-protocol-research-areas/

Example URI

GET /iacuc/api/v1/iacuc-protocol-research-areas/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "protocolId",
    "protocolNumber",
    "sequenceNumber",
    "researchAreaCode"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Iacuc Protocol Research Areas
GET/iacuc/api/v1/iacuc-protocol-research-areas/

Example URI

GET /iacuc/api/v1/iacuc-protocol-research-areas/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Research Areas.md"
transfer-encoding: chunked

Update Iacuc Protocol Research Areas
PUT/iacuc/api/v1/iacuc-protocol-research-areas/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-research-areas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "researchAreaCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Research Areas
PUT/iacuc/api/v1/iacuc-protocol-research-areas/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-research-areas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Research Areas
PATCH/iacuc/api/v1/iacuc-protocol-research-areas/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-research-areas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "researchAreaCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "researchAreaCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Research Areas
POST/iacuc/api/v1/iacuc-protocol-research-areas/

Example URI

POST /iacuc/api/v1/iacuc-protocol-research-areas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "researchAreaCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "researchAreaCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Research Areas
POST/iacuc/api/v1/iacuc-protocol-research-areas/

Example URI

POST /iacuc/api/v1/iacuc-protocol-research-areas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "researchAreaCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Research Areas by Key
DELETE/iacuc/api/v1/iacuc-protocol-research-areas/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-research-areas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Research Areas
DELETE/iacuc/api/v1/iacuc-protocol-research-areas/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-research-areas/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Research Areas with Matching
DELETE/iacuc/api/v1/iacuc-protocol-research-areas/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-research-areas/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
protocolId
string (optional) 
protocolNumber
string (optional) 
sequenceNumber
string (optional) 
researchAreaCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Review Attachments

Get Iacuc Protocol Review Attachments by Key
GET/iacuc/api/v1/iacuc-protocol-review-attachments/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-review-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "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 Iacuc Protocol Review Attachments
GET/iacuc/api/v1/iacuc-protocol-review-attachments/

Example URI

GET /iacuc/api/v1/iacuc-protocol-review-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Review Attachments with Filtering
GET/iacuc/api/v1/iacuc-protocol-review-attachments/

Example URI

GET /iacuc/api/v1/iacuc-protocol-review-attachments/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Review Attachments
GET/iacuc/api/v1/iacuc-protocol-review-attachments/

Example URI

GET /iacuc/api/v1/iacuc-protocol-review-attachments/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "reviewerAttachmentId",
    "protocolOnlineReviewIdFk",
    "protocolIdFk",
    "submissionIdFk",
    "attachmentId",
    "description",
    "fileId",
    "personId",
    "createUser",
    "createTimestamp",
    "privateFlag",
    "protocolPersonCanView"
  ],
  "primaryKey": "reviewerAttachmentId"
}

Get Blueprint API specification for Iacuc Protocol Review Attachments
GET/iacuc/api/v1/iacuc-protocol-review-attachments/

Example URI

GET /iacuc/api/v1/iacuc-protocol-review-attachments/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Review Attachments.md"
transfer-encoding: chunked

Update Iacuc Protocol Review Attachments
PUT/iacuc/api/v1/iacuc-protocol-review-attachments/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-review-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  204

Update Multiple Iacuc Protocol Review Attachments
PUT/iacuc/api/v1/iacuc-protocol-review-attachments/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-review-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Protocol Review Attachments
PATCH/iacuc/api/v1/iacuc-protocol-review-attachments/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-review-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  204
HideShow
Body
{
  "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 Iacuc Protocol Review Attachments
POST/iacuc/api/v1/iacuc-protocol-review-attachments/

Example URI

POST /iacuc/api/v1/iacuc-protocol-review-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  201
HideShow
Body
{
  "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 Iacuc Protocol Review Attachments
POST/iacuc/api/v1/iacuc-protocol-review-attachments/

Example URI

POST /iacuc/api/v1/iacuc-protocol-review-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol Review Attachments by Key
DELETE/iacuc/api/v1/iacuc-protocol-review-attachments/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-review-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Review Attachments
DELETE/iacuc/api/v1/iacuc-protocol-review-attachments/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-review-attachments/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Review Attachments with Matching
DELETE/iacuc/api/v1/iacuc-protocol-review-attachments/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-review-attachments/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Review Types

Get Iacuc Protocol Review Types by Key
GET/iacuc/api/v1/iacuc-protocol-review-types/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-review-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "reviewTypeCode": "(val)",
  "description": "(val)",
  "globalFlag": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Review Types
GET/iacuc/api/v1/iacuc-protocol-review-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-review-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "reviewTypeCode": "(val)",
    "description": "(val)",
    "globalFlag": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reviewTypeCode": "(val)",
    "description": "(val)",
    "globalFlag": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Review Types with Filtering
GET/iacuc/api/v1/iacuc-protocol-review-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-review-types/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "reviewTypeCode": "(val)",
    "description": "(val)",
    "globalFlag": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reviewTypeCode": "(val)",
    "description": "(val)",
    "globalFlag": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Review Types
GET/iacuc/api/v1/iacuc-protocol-review-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-review-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "reviewTypeCode",
    "description",
    "globalFlag"
  ],
  "primaryKey": "reviewTypeCode"
}

Get Blueprint API specification for Iacuc Protocol Review Types
GET/iacuc/api/v1/iacuc-protocol-review-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-review-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Review Types.md"
transfer-encoding: chunked

Update Iacuc Protocol Review Types
PUT/iacuc/api/v1/iacuc-protocol-review-types/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-review-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "reviewTypeCode": "(val)",
  "description": "(val)",
  "globalFlag": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Review Types
PUT/iacuc/api/v1/iacuc-protocol-review-types/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-review-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "reviewTypeCode": "(val)",
    "description": "(val)",
    "globalFlag": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reviewTypeCode": "(val)",
    "description": "(val)",
    "globalFlag": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Review Types
PATCH/iacuc/api/v1/iacuc-protocol-review-types/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-review-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "reviewTypeCode": "(val)",
  "description": "(val)",
  "globalFlag": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "reviewTypeCode": "(val)",
  "description": "(val)",
  "globalFlag": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Review Types
POST/iacuc/api/v1/iacuc-protocol-review-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-review-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "reviewTypeCode": "(val)",
  "description": "(val)",
  "globalFlag": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "reviewTypeCode": "(val)",
  "description": "(val)",
  "globalFlag": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Review Types
POST/iacuc/api/v1/iacuc-protocol-review-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-review-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "reviewTypeCode": "(val)",
    "description": "(val)",
    "globalFlag": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reviewTypeCode": "(val)",
    "description": "(val)",
    "globalFlag": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "reviewTypeCode": "(val)",
    "description": "(val)",
    "globalFlag": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reviewTypeCode": "(val)",
    "description": "(val)",
    "globalFlag": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Review Types by Key
DELETE/iacuc/api/v1/iacuc-protocol-review-types/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-review-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Review Types
DELETE/iacuc/api/v1/iacuc-protocol-review-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-review-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Review Types with Matching
DELETE/iacuc/api/v1/iacuc-protocol-review-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-review-types/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Reviewer Types

Get Iacuc Protocol Reviewer Types by Key
GET/iacuc/api/v1/iacuc-protocol-reviewer-types/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-reviewer-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "reviewerTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Reviewer Types
GET/iacuc/api/v1/iacuc-protocol-reviewer-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-reviewer-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "reviewerTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reviewerTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Reviewer Types with Filtering
GET/iacuc/api/v1/iacuc-protocol-reviewer-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-reviewer-types/
URI Parameters
HideShow
reviewerTypeCode
string (optional) 

Reviewer Type. Maximum length is 3.

description
string (optional) 

Description. Maximum length is 200.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "reviewerTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reviewerTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Reviewer Types
GET/iacuc/api/v1/iacuc-protocol-reviewer-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-reviewer-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "reviewerTypeCode",
    "description"
  ],
  "primaryKey": "reviewerTypeCode"
}

Get Blueprint API specification for Iacuc Protocol Reviewer Types
GET/iacuc/api/v1/iacuc-protocol-reviewer-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-reviewer-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Reviewer Types.md"
transfer-encoding: chunked

Update Iacuc Protocol Reviewer Types
PUT/iacuc/api/v1/iacuc-protocol-reviewer-types/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-reviewer-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "reviewerTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Reviewer Types
PUT/iacuc/api/v1/iacuc-protocol-reviewer-types/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-reviewer-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "reviewerTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reviewerTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Reviewer Types
PATCH/iacuc/api/v1/iacuc-protocol-reviewer-types/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-reviewer-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "reviewerTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "reviewerTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Reviewer Types
POST/iacuc/api/v1/iacuc-protocol-reviewer-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-reviewer-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "reviewerTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "reviewerTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Reviewer Types
POST/iacuc/api/v1/iacuc-protocol-reviewer-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-reviewer-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "reviewerTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reviewerTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "reviewerTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "reviewerTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Reviewer Types by Key
DELETE/iacuc/api/v1/iacuc-protocol-reviewer-types/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-reviewer-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Reviewer Types
DELETE/iacuc/api/v1/iacuc-protocol-reviewer-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-reviewer-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Reviewer Types with Matching
DELETE/iacuc/api/v1/iacuc-protocol-reviewer-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-reviewer-types/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Reviewers

Get Iacuc Protocol Reviewers by Key
GET/iacuc/api/v1/iacuc-protocol-reviewers/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-reviewers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolReviewerId": "(val)",
  "protocolIdFk": "(val)",
  "submissionIdFk": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "rolodexId": "(val)",
  "submissionNumber": "(val)",
  "reviewerTypeCode": "(val)",
  "personId": "(val)",
  "nonEmployeeFlag": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Reviewers
GET/iacuc/api/v1/iacuc-protocol-reviewers/

Example URI

GET /iacuc/api/v1/iacuc-protocol-reviewers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Reviewers with Filtering
GET/iacuc/api/v1/iacuc-protocol-reviewers/

Example URI

GET /iacuc/api/v1/iacuc-protocol-reviewers/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Reviewers
GET/iacuc/api/v1/iacuc-protocol-reviewers/

Example URI

GET /iacuc/api/v1/iacuc-protocol-reviewers/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolReviewerId",
    "protocolIdFk",
    "submissionIdFk",
    "protocolNumber",
    "sequenceNumber",
    "rolodexId",
    "submissionNumber",
    "reviewerTypeCode",
    "personId",
    "nonEmployeeFlag"
  ],
  "primaryKey": "protocolReviewerId"
}

Get Blueprint API specification for Iacuc Protocol Reviewers
GET/iacuc/api/v1/iacuc-protocol-reviewers/

Example URI

GET /iacuc/api/v1/iacuc-protocol-reviewers/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Reviewers.md"
transfer-encoding: chunked

Update Iacuc Protocol Reviewers
PUT/iacuc/api/v1/iacuc-protocol-reviewers/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-reviewers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolReviewerId": "(val)",
  "protocolIdFk": "(val)",
  "submissionIdFk": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "rolodexId": "(val)",
  "submissionNumber": "(val)",
  "reviewerTypeCode": "(val)",
  "personId": "(val)",
  "nonEmployeeFlag": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Reviewers
PUT/iacuc/api/v1/iacuc-protocol-reviewers/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-reviewers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Protocol Reviewers
PATCH/iacuc/api/v1/iacuc-protocol-reviewers/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-reviewers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolReviewerId": "(val)",
  "protocolIdFk": "(val)",
  "submissionIdFk": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "rolodexId": "(val)",
  "submissionNumber": "(val)",
  "reviewerTypeCode": "(val)",
  "personId": "(val)",
  "nonEmployeeFlag": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolReviewerId": "(val)",
  "protocolIdFk": "(val)",
  "submissionIdFk": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "rolodexId": "(val)",
  "submissionNumber": "(val)",
  "reviewerTypeCode": "(val)",
  "personId": "(val)",
  "nonEmployeeFlag": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Reviewers
POST/iacuc/api/v1/iacuc-protocol-reviewers/

Example URI

POST /iacuc/api/v1/iacuc-protocol-reviewers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolReviewerId": "(val)",
  "protocolIdFk": "(val)",
  "submissionIdFk": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "rolodexId": "(val)",
  "submissionNumber": "(val)",
  "reviewerTypeCode": "(val)",
  "personId": "(val)",
  "nonEmployeeFlag": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolReviewerId": "(val)",
  "protocolIdFk": "(val)",
  "submissionIdFk": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "rolodexId": "(val)",
  "submissionNumber": "(val)",
  "reviewerTypeCode": "(val)",
  "personId": "(val)",
  "nonEmployeeFlag": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Reviewers
POST/iacuc/api/v1/iacuc-protocol-reviewers/

Example URI

POST /iacuc/api/v1/iacuc-protocol-reviewers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol Reviewers by Key
DELETE/iacuc/api/v1/iacuc-protocol-reviewers/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-reviewers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Reviewers
DELETE/iacuc/api/v1/iacuc-protocol-reviewers/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-reviewers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Reviewers with Matching
DELETE/iacuc/api/v1/iacuc-protocol-reviewers/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-reviewers/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Special Review Exemptions

Get Iacuc Protocol Special Review Exemptions by Key
GET/iacuc/api/v1/iacuc-protocol-special-review-exemptions/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-special-review-exemptions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolSpecialReviewExemptionId": "(val)",
  "exemptionTypeCode": "(val)",
  "protocolSpecialReview.protocolSpecialReviewId": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Special Review Exemptions
GET/iacuc/api/v1/iacuc-protocol-special-review-exemptions/

Example URI

GET /iacuc/api/v1/iacuc-protocol-special-review-exemptions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "protocolSpecialReview.protocolSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "protocolSpecialReview.protocolSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Special Review Exemptions with Filtering
GET/iacuc/api/v1/iacuc-protocol-special-review-exemptions/

Example URI

GET /iacuc/api/v1/iacuc-protocol-special-review-exemptions/
URI Parameters
HideShow
protocolSpecialReviewExemptionId
string (optional) 

IACUC Protocol Special Review Exemption Id. Maximum length is 22.

exemptionTypeCode
string (optional) 

Exemption #. Maximum length is 3.

protocolSpecialReview.protocolSpecialReviewId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "protocolSpecialReview.protocolSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolSpecialReviewExemptionId": "(val)",
    "exemptionTypeCode": "(val)",
    "protocolSpecialReview.protocolSpecialReviewId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Special Review Exemptions
GET/iacuc/api/v1/iacuc-protocol-special-review-exemptions/

Example URI

GET /iacuc/api/v1/iacuc-protocol-special-review-exemptions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolSpecialReviewExemptionId",
    "exemptionTypeCode",
    "protocolSpecialReview.protocolSpecialReviewId"
  ],
  "primaryKey": "protocolSpecialReviewExemptionId"
}

Get Blueprint API specification for Iacuc Protocol Special Review Exemptions
GET/iacuc/api/v1/iacuc-protocol-special-review-exemptions/

Example URI

GET /iacuc/api/v1/iacuc-protocol-special-review-exemptions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Special Review Exemptions.md"
transfer-encoding: chunked

Iacuc Protocol Special Reviews

Get Iacuc Protocol Special Reviews by Key
GET/iacuc/api/v1/iacuc-protocol-special-reviews/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-special-reviews/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "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 Iacuc Protocol Special Reviews
GET/iacuc/api/v1/iacuc-protocol-special-reviews/

Example URI

GET /iacuc/api/v1/iacuc-protocol-special-reviews/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Special Reviews with Filtering
GET/iacuc/api/v1/iacuc-protocol-special-reviews/

Example URI

GET /iacuc/api/v1/iacuc-protocol-special-reviews/
URI Parameters
HideShow
protocolSpecialReviewId
string (optional) 

IACUC 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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Special Reviews
GET/iacuc/api/v1/iacuc-protocol-special-reviews/

Example URI

GET /iacuc/api/v1/iacuc-protocol-special-reviews/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolSpecialReviewId",
    "specialReviewNumber",
    "specialReviewTypeCode",
    "approvalTypeCode",
    "protocolNumber",
    "applicationDate",
    "approvalDate",
    "expirationDate",
    "comments",
    "sequenceOwner.protocolId"
  ],
  "primaryKey": "protocolSpecialReviewId"
}

Get Blueprint API specification for Iacuc Protocol Special Reviews
GET/iacuc/api/v1/iacuc-protocol-special-reviews/

Example URI

GET /iacuc/api/v1/iacuc-protocol-special-reviews/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Special Reviews.md"
transfer-encoding: chunked

Iacuc Protocol Species

Get Iacuc Protocol Species by Key
GET/iacuc/api/v1/iacuc-protocol-species/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-species/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "iacucProtocolSpeciesId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "speciesId": "(val)",
  "speciesCode": "(val)",
  "speciesGroup": "(val)",
  "usdaCovered": "(val)",
  "strain": "(val)",
  "speciesCount": "(val)",
  "painCategoryCode": "(val)",
  "speciesCountCode": "(val)",
  "procedureSummary": "(val)",
  "exceptionsPresent": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Species
GET/iacuc/api/v1/iacuc-protocol-species/

Example URI

GET /iacuc/api/v1/iacuc-protocol-species/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProtocolSpeciesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "speciesId": "(val)",
    "speciesCode": "(val)",
    "speciesGroup": "(val)",
    "usdaCovered": "(val)",
    "strain": "(val)",
    "speciesCount": "(val)",
    "painCategoryCode": "(val)",
    "speciesCountCode": "(val)",
    "procedureSummary": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolSpeciesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "speciesId": "(val)",
    "speciesCode": "(val)",
    "speciesGroup": "(val)",
    "usdaCovered": "(val)",
    "strain": "(val)",
    "speciesCount": "(val)",
    "painCategoryCode": "(val)",
    "speciesCountCode": "(val)",
    "procedureSummary": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Species with Filtering
GET/iacuc/api/v1/iacuc-protocol-species/

Example URI

GET /iacuc/api/v1/iacuc-protocol-species/
URI Parameters
HideShow
iacucProtocolSpeciesId
string (optional) 

Protocol Species Id. Maximum length is 22.

protocolId
string (optional) 

Protocol Id. Maximum length is 22.

protocolNumber
string (optional) 
sequenceNumber
string (optional) 
speciesId
string (optional) 

Species Id. Maximum length is 22.

speciesCode
string (optional) 

Species Code. Maximum length is 50.

speciesGroup
string (optional) 

Species Group. Maximum length is 50.

usdaCovered
string (optional) 

USDA Covered Type. Maximum length is 3.

strain
string (optional) 

Species Strain. Maximum length is 30.

speciesCount
string (optional) 

Species Count. Maximum length is 8.

painCategoryCode
string (optional) 

Pain Category. Maximum length is 50.

speciesCountCode
string (optional) 

Count Type. Maximum length is 50.

procedureSummary
string (optional) 

Procedure Summary. Maximum length is 2000.

exceptionsPresent
string (optional) 

Exceptions. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProtocolSpeciesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "speciesId": "(val)",
    "speciesCode": "(val)",
    "speciesGroup": "(val)",
    "usdaCovered": "(val)",
    "strain": "(val)",
    "speciesCount": "(val)",
    "painCategoryCode": "(val)",
    "speciesCountCode": "(val)",
    "procedureSummary": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolSpeciesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "speciesId": "(val)",
    "speciesCode": "(val)",
    "speciesGroup": "(val)",
    "usdaCovered": "(val)",
    "strain": "(val)",
    "speciesCount": "(val)",
    "painCategoryCode": "(val)",
    "speciesCountCode": "(val)",
    "procedureSummary": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Species
GET/iacuc/api/v1/iacuc-protocol-species/

Example URI

GET /iacuc/api/v1/iacuc-protocol-species/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "iacucProtocolSpeciesId",
    "protocolId",
    "protocolNumber",
    "sequenceNumber",
    "speciesId",
    "speciesCode",
    "speciesGroup",
    "usdaCovered",
    "strain",
    "speciesCount",
    "painCategoryCode",
    "speciesCountCode",
    "procedureSummary",
    "exceptionsPresent"
  ],
  "primaryKey": "iacucProtocolSpeciesId"
}

Get Blueprint API specification for Iacuc Protocol Species
GET/iacuc/api/v1/iacuc-protocol-species/

Example URI

GET /iacuc/api/v1/iacuc-protocol-species/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Species.md"
transfer-encoding: chunked

Update Iacuc Protocol Species
PUT/iacuc/api/v1/iacuc-protocol-species/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-species/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolSpeciesId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "speciesId": "(val)",
  "speciesCode": "(val)",
  "speciesGroup": "(val)",
  "usdaCovered": "(val)",
  "strain": "(val)",
  "speciesCount": "(val)",
  "painCategoryCode": "(val)",
  "speciesCountCode": "(val)",
  "procedureSummary": "(val)",
  "exceptionsPresent": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Species
PUT/iacuc/api/v1/iacuc-protocol-species/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-species/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucProtocolSpeciesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "speciesId": "(val)",
    "speciesCode": "(val)",
    "speciesGroup": "(val)",
    "usdaCovered": "(val)",
    "strain": "(val)",
    "speciesCount": "(val)",
    "painCategoryCode": "(val)",
    "speciesCountCode": "(val)",
    "procedureSummary": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolSpeciesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "speciesId": "(val)",
    "speciesCode": "(val)",
    "speciesGroup": "(val)",
    "usdaCovered": "(val)",
    "strain": "(val)",
    "speciesCount": "(val)",
    "painCategoryCode": "(val)",
    "speciesCountCode": "(val)",
    "procedureSummary": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Species
PATCH/iacuc/api/v1/iacuc-protocol-species/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-species/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolSpeciesId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "speciesId": "(val)",
  "speciesCode": "(val)",
  "speciesGroup": "(val)",
  "usdaCovered": "(val)",
  "strain": "(val)",
  "speciesCount": "(val)",
  "painCategoryCode": "(val)",
  "speciesCountCode": "(val)",
  "procedureSummary": "(val)",
  "exceptionsPresent": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "iacucProtocolSpeciesId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "speciesId": "(val)",
  "speciesCode": "(val)",
  "speciesGroup": "(val)",
  "usdaCovered": "(val)",
  "strain": "(val)",
  "speciesCount": "(val)",
  "painCategoryCode": "(val)",
  "speciesCountCode": "(val)",
  "procedureSummary": "(val)",
  "exceptionsPresent": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Species
POST/iacuc/api/v1/iacuc-protocol-species/

Example URI

POST /iacuc/api/v1/iacuc-protocol-species/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolSpeciesId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "speciesId": "(val)",
  "speciesCode": "(val)",
  "speciesGroup": "(val)",
  "usdaCovered": "(val)",
  "strain": "(val)",
  "speciesCount": "(val)",
  "painCategoryCode": "(val)",
  "speciesCountCode": "(val)",
  "procedureSummary": "(val)",
  "exceptionsPresent": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "iacucProtocolSpeciesId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "speciesId": "(val)",
  "speciesCode": "(val)",
  "speciesGroup": "(val)",
  "usdaCovered": "(val)",
  "strain": "(val)",
  "speciesCount": "(val)",
  "painCategoryCode": "(val)",
  "speciesCountCode": "(val)",
  "procedureSummary": "(val)",
  "exceptionsPresent": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Species
POST/iacuc/api/v1/iacuc-protocol-species/

Example URI

POST /iacuc/api/v1/iacuc-protocol-species/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucProtocolSpeciesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "speciesId": "(val)",
    "speciesCode": "(val)",
    "speciesGroup": "(val)",
    "usdaCovered": "(val)",
    "strain": "(val)",
    "speciesCount": "(val)",
    "painCategoryCode": "(val)",
    "speciesCountCode": "(val)",
    "procedureSummary": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolSpeciesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "speciesId": "(val)",
    "speciesCode": "(val)",
    "speciesGroup": "(val)",
    "usdaCovered": "(val)",
    "strain": "(val)",
    "speciesCount": "(val)",
    "painCategoryCode": "(val)",
    "speciesCountCode": "(val)",
    "procedureSummary": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "iacucProtocolSpeciesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "speciesId": "(val)",
    "speciesCode": "(val)",
    "speciesGroup": "(val)",
    "usdaCovered": "(val)",
    "strain": "(val)",
    "speciesCount": "(val)",
    "painCategoryCode": "(val)",
    "speciesCountCode": "(val)",
    "procedureSummary": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolSpeciesId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "speciesId": "(val)",
    "speciesCode": "(val)",
    "speciesGroup": "(val)",
    "usdaCovered": "(val)",
    "strain": "(val)",
    "speciesCount": "(val)",
    "painCategoryCode": "(val)",
    "speciesCountCode": "(val)",
    "procedureSummary": "(val)",
    "exceptionsPresent": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Species by Key
DELETE/iacuc/api/v1/iacuc-protocol-species/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-species/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Species
DELETE/iacuc/api/v1/iacuc-protocol-species/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-species/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Species with Matching
DELETE/iacuc/api/v1/iacuc-protocol-species/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-species/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

iacucProtocolSpeciesId
string (optional) 

Protocol Species Id. Maximum length is 22.

protocolId
string (optional) 

Protocol Id. Maximum length is 22.

protocolNumber
string (optional) 
sequenceNumber
string (optional) 
speciesId
string (optional) 

Species Id. Maximum length is 22.

speciesCode
string (optional) 

Species Code. Maximum length is 50.

speciesGroup
string (optional) 

Species Group. Maximum length is 50.

usdaCovered
string (optional) 

USDA Covered Type. Maximum length is 3.

strain
string (optional) 

Species Strain. Maximum length is 30.

speciesCount
string (optional) 

Species Count. Maximum length is 8.

painCategoryCode
string (optional) 

Pain Category. Maximum length is 50.

speciesCountCode
string (optional) 

Count Type. Maximum length is 50.

procedureSummary
string (optional) 

Procedure Summary. Maximum length is 2000.

exceptionsPresent
string (optional) 

Exceptions. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Statuses

Get Iacuc Protocol Statuses by Key
GET/iacuc/api/v1/iacuc-protocol-statuses/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Statuses
GET/iacuc/api/v1/iacuc-protocol-statuses/

Example URI

GET /iacuc/api/v1/iacuc-protocol-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Statuses with Filtering
GET/iacuc/api/v1/iacuc-protocol-statuses/

Example URI

GET /iacuc/api/v1/iacuc-protocol-statuses/
URI Parameters
HideShow
protocolStatusCode
string (optional) 

Protocol Status Code. Maximum length is 22.

description
string (optional) 

Description. Maximum length is 200.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Statuses
GET/iacuc/api/v1/iacuc-protocol-statuses/

Example URI

GET /iacuc/api/v1/iacuc-protocol-statuses/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolStatusCode",
    "description"
  ],
  "primaryKey": "protocolStatusCode"
}

Get Blueprint API specification for Iacuc Protocol Statuses
GET/iacuc/api/v1/iacuc-protocol-statuses/

Example URI

GET /iacuc/api/v1/iacuc-protocol-statuses/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Statuses.md"
transfer-encoding: chunked

Update Iacuc Protocol Statuses
PUT/iacuc/api/v1/iacuc-protocol-statuses/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Statuses
PUT/iacuc/api/v1/iacuc-protocol-statuses/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Statuses
PATCH/iacuc/api/v1/iacuc-protocol-statuses/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Statuses
POST/iacuc/api/v1/iacuc-protocol-statuses/

Example URI

POST /iacuc/api/v1/iacuc-protocol-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Statuses
POST/iacuc/api/v1/iacuc-protocol-statuses/

Example URI

POST /iacuc/api/v1/iacuc-protocol-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "protocolStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Statuses by Key
DELETE/iacuc/api/v1/iacuc-protocol-statuses/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Statuses
DELETE/iacuc/api/v1/iacuc-protocol-statuses/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-statuses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Statuses with Matching
DELETE/iacuc/api/v1/iacuc-protocol-statuses/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-statuses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

protocolStatusCode
string (optional) 

Protocol Status Code. Maximum length is 22.

description
string (optional) 

Description. Maximum length is 200.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Study Custom Data

Get Iacuc Protocol Study Custom Data by Key
GET/iacuc/api/v1/iacuc-protocol-study-custom-data/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-custom-data/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "iacucProtocolStudyCustomDataId": "(val)",
  "iacucProtocolStudyGroupId": "(val)",
  "procedureCustomAttributeId": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Study Custom Data
GET/iacuc/api/v1/iacuc-protocol-study-custom-data/

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-custom-data/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProtocolStudyCustomDataId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "procedureCustomAttributeId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyCustomDataId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "procedureCustomAttributeId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Study Custom Data with Filtering
GET/iacuc/api/v1/iacuc-protocol-study-custom-data/

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-custom-data/
URI Parameters
HideShow
iacucProtocolStudyCustomDataId
string (optional) 

IACUC Protocol Study Custom Data Id. Maximum length is 22.

iacucProtocolStudyGroupId
string (optional) 

Protocol Study Group Id. Maximum length is 22.

procedureCustomAttributeId
string (optional) 

Custom Attribute Id. Maximum length is 22.

value
string (optional) 

Value. Maximum length is 2000.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProtocolStudyCustomDataId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "procedureCustomAttributeId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyCustomDataId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "procedureCustomAttributeId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Study Custom Data
GET/iacuc/api/v1/iacuc-protocol-study-custom-data/

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-custom-data/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "iacucProtocolStudyCustomDataId",
    "iacucProtocolStudyGroupId",
    "procedureCustomAttributeId",
    "value"
  ],
  "primaryKey": "iacucProtocolStudyCustomDataId"
}

Get Blueprint API specification for Iacuc Protocol Study Custom Data
GET/iacuc/api/v1/iacuc-protocol-study-custom-data/

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-custom-data/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Study Custom Data.md"
transfer-encoding: chunked

Update Iacuc Protocol Study Custom Data
PUT/iacuc/api/v1/iacuc-protocol-study-custom-data/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-study-custom-data/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolStudyCustomDataId": "(val)",
  "iacucProtocolStudyGroupId": "(val)",
  "procedureCustomAttributeId": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Study Custom Data
PUT/iacuc/api/v1/iacuc-protocol-study-custom-data/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-study-custom-data/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucProtocolStudyCustomDataId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "procedureCustomAttributeId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyCustomDataId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "procedureCustomAttributeId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Study Custom Data
PATCH/iacuc/api/v1/iacuc-protocol-study-custom-data/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-study-custom-data/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolStudyCustomDataId": "(val)",
  "iacucProtocolStudyGroupId": "(val)",
  "procedureCustomAttributeId": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "iacucProtocolStudyCustomDataId": "(val)",
  "iacucProtocolStudyGroupId": "(val)",
  "procedureCustomAttributeId": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Study Custom Data
POST/iacuc/api/v1/iacuc-protocol-study-custom-data/

Example URI

POST /iacuc/api/v1/iacuc-protocol-study-custom-data/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolStudyCustomDataId": "(val)",
  "iacucProtocolStudyGroupId": "(val)",
  "procedureCustomAttributeId": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "iacucProtocolStudyCustomDataId": "(val)",
  "iacucProtocolStudyGroupId": "(val)",
  "procedureCustomAttributeId": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Study Custom Data
POST/iacuc/api/v1/iacuc-protocol-study-custom-data/

Example URI

POST /iacuc/api/v1/iacuc-protocol-study-custom-data/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucProtocolStudyCustomDataId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "procedureCustomAttributeId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyCustomDataId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "procedureCustomAttributeId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "iacucProtocolStudyCustomDataId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "procedureCustomAttributeId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyCustomDataId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "procedureCustomAttributeId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Study Custom Data by Key
DELETE/iacuc/api/v1/iacuc-protocol-study-custom-data/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-study-custom-data/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Study Custom Data
DELETE/iacuc/api/v1/iacuc-protocol-study-custom-data/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-study-custom-data/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Study Custom Data with Matching
DELETE/iacuc/api/v1/iacuc-protocol-study-custom-data/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-study-custom-data/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

iacucProtocolStudyCustomDataId
string (optional) 

IACUC Protocol Study Custom Data Id. Maximum length is 22.

iacucProtocolStudyGroupId
string (optional) 

Protocol Study Group Id. Maximum length is 22.

procedureCustomAttributeId
string (optional) 

Custom Attribute Id. Maximum length is 22.

value
string (optional) 

Value. Maximum length is 2000.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Study Group Beans

Get Iacuc Protocol Study Group Beans by Key
GET/iacuc/api/v1/iacuc-protocol-study-group-beans/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-group-beans/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "iacucProtocolStudyGroupHeaderId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "procedureCategoryCode": "(val)",
  "procedureCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Study Group Beans
GET/iacuc/api/v1/iacuc-protocol-study-group-beans/

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-group-beans/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "procedureCategoryCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "procedureCategoryCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Study Group Beans with Filtering
GET/iacuc/api/v1/iacuc-protocol-study-group-beans/

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-group-beans/
URI Parameters
HideShow
iacucProtocolStudyGroupHeaderId
string (optional) 

Protocol Study Group Header Id. Maximum length is 22.

protocolId
string (optional) 

Protocol Id. Maximum length is 22.

protocolNumber
string (optional) 
sequenceNumber
string (optional) 
procedureCategoryCode
string (optional) 

Procedure Category. Maximum length is 3.

procedureCode
string (optional) 

Procedure Code. Maximum length is 4.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "procedureCategoryCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "procedureCategoryCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Study Group Beans
GET/iacuc/api/v1/iacuc-protocol-study-group-beans/

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-group-beans/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "iacucProtocolStudyGroupHeaderId",
    "protocolId",
    "protocolNumber",
    "sequenceNumber",
    "procedureCategoryCode",
    "procedureCode"
  ],
  "primaryKey": "iacucProtocolStudyGroupHeaderId"
}

Get Blueprint API specification for Iacuc Protocol Study Group Beans
GET/iacuc/api/v1/iacuc-protocol-study-group-beans/

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-group-beans/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Study Group Beans.md"
transfer-encoding: chunked

Update Iacuc Protocol Study Group Beans
PUT/iacuc/api/v1/iacuc-protocol-study-group-beans/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-study-group-beans/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolStudyGroupHeaderId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "procedureCategoryCode": "(val)",
  "procedureCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Study Group Beans
PUT/iacuc/api/v1/iacuc-protocol-study-group-beans/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-study-group-beans/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "procedureCategoryCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "procedureCategoryCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Study Group Beans
PATCH/iacuc/api/v1/iacuc-protocol-study-group-beans/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-study-group-beans/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolStudyGroupHeaderId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "procedureCategoryCode": "(val)",
  "procedureCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "iacucProtocolStudyGroupHeaderId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "procedureCategoryCode": "(val)",
  "procedureCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Study Group Beans
POST/iacuc/api/v1/iacuc-protocol-study-group-beans/

Example URI

POST /iacuc/api/v1/iacuc-protocol-study-group-beans/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolStudyGroupHeaderId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "procedureCategoryCode": "(val)",
  "procedureCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "iacucProtocolStudyGroupHeaderId": "(val)",
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "procedureCategoryCode": "(val)",
  "procedureCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Study Group Beans
POST/iacuc/api/v1/iacuc-protocol-study-group-beans/

Example URI

POST /iacuc/api/v1/iacuc-protocol-study-group-beans/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "procedureCategoryCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "procedureCategoryCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "procedureCategoryCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "procedureCategoryCode": "(val)",
    "procedureCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Study Group Beans by Key
DELETE/iacuc/api/v1/iacuc-protocol-study-group-beans/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-study-group-beans/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Study Group Beans
DELETE/iacuc/api/v1/iacuc-protocol-study-group-beans/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-study-group-beans/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Study Group Beans with Matching
DELETE/iacuc/api/v1/iacuc-protocol-study-group-beans/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-study-group-beans/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

iacucProtocolStudyGroupHeaderId
string (optional) 

Protocol Study Group Header Id. Maximum length is 22.

protocolId
string (optional) 

Protocol Id. Maximum length is 22.

protocolNumber
string (optional) 
sequenceNumber
string (optional) 
procedureCategoryCode
string (optional) 

Procedure Category. Maximum length is 3.

procedureCode
string (optional) 

Procedure Code. Maximum length is 4.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Study Group Locations

Get Iacuc Protocol Study Group Locations by Key
GET/iacuc/api/v1/iacuc-protocol-study-group-locations/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-group-locations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "iacucProtocolStudyGroupLocationId": "(val)",
  "iacucProtocolStudyGroupId": "(val)",
  "locationTypeCode": "(val)",
  "studyGroupLocationId": "(val)",
  "locationId": "(val)",
  "locationRoom": "(val)",
  "studyGroupLocationDescription": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Study Group Locations
GET/iacuc/api/v1/iacuc-protocol-study-group-locations/

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-group-locations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProtocolStudyGroupLocationId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "locationTypeCode": "(val)",
    "studyGroupLocationId": "(val)",
    "locationId": "(val)",
    "locationRoom": "(val)",
    "studyGroupLocationDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyGroupLocationId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "locationTypeCode": "(val)",
    "studyGroupLocationId": "(val)",
    "locationId": "(val)",
    "locationRoom": "(val)",
    "studyGroupLocationDescription": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Study Group Locations with Filtering
GET/iacuc/api/v1/iacuc-protocol-study-group-locations/

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-group-locations/
URI Parameters
HideShow
iacucProtocolStudyGroupLocationId
string (optional) 

Protocol Study Group Location Id. Maximum length is 22.

iacucProtocolStudyGroupId
string (optional) 

Protocol Study Group Id. Maximum length is 22.

locationTypeCode
string (optional) 

Location Type Code. Maximum length is 3.

studyGroupLocationId
string (optional) 

Study Group Location Id. Maximum length is 6.

locationId
string (optional) 

Location Name Code. Maximum length is 3.

locationRoom
string (optional) 

Room. Maximum length is 60.

studyGroupLocationDescription
string (optional) 

Description. Maximum length is 2000.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProtocolStudyGroupLocationId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "locationTypeCode": "(val)",
    "studyGroupLocationId": "(val)",
    "locationId": "(val)",
    "locationRoom": "(val)",
    "studyGroupLocationDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyGroupLocationId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "locationTypeCode": "(val)",
    "studyGroupLocationId": "(val)",
    "locationId": "(val)",
    "locationRoom": "(val)",
    "studyGroupLocationDescription": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Study Group Locations
GET/iacuc/api/v1/iacuc-protocol-study-group-locations/

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-group-locations/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "iacucProtocolStudyGroupLocationId",
    "iacucProtocolStudyGroupId",
    "locationTypeCode",
    "studyGroupLocationId",
    "locationId",
    "locationRoom",
    "studyGroupLocationDescription"
  ],
  "primaryKey": "iacucProtocolStudyGroupLocationId"
}

Get Blueprint API specification for Iacuc Protocol Study Group Locations
GET/iacuc/api/v1/iacuc-protocol-study-group-locations/

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-group-locations/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Study Group Locations.md"
transfer-encoding: chunked

Update Iacuc Protocol Study Group Locations
PUT/iacuc/api/v1/iacuc-protocol-study-group-locations/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-study-group-locations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolStudyGroupLocationId": "(val)",
  "iacucProtocolStudyGroupId": "(val)",
  "locationTypeCode": "(val)",
  "studyGroupLocationId": "(val)",
  "locationId": "(val)",
  "locationRoom": "(val)",
  "studyGroupLocationDescription": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Study Group Locations
PUT/iacuc/api/v1/iacuc-protocol-study-group-locations/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-study-group-locations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucProtocolStudyGroupLocationId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "locationTypeCode": "(val)",
    "studyGroupLocationId": "(val)",
    "locationId": "(val)",
    "locationRoom": "(val)",
    "studyGroupLocationDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyGroupLocationId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "locationTypeCode": "(val)",
    "studyGroupLocationId": "(val)",
    "locationId": "(val)",
    "locationRoom": "(val)",
    "studyGroupLocationDescription": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Study Group Locations
PATCH/iacuc/api/v1/iacuc-protocol-study-group-locations/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-study-group-locations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolStudyGroupLocationId": "(val)",
  "iacucProtocolStudyGroupId": "(val)",
  "locationTypeCode": "(val)",
  "studyGroupLocationId": "(val)",
  "locationId": "(val)",
  "locationRoom": "(val)",
  "studyGroupLocationDescription": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "iacucProtocolStudyGroupLocationId": "(val)",
  "iacucProtocolStudyGroupId": "(val)",
  "locationTypeCode": "(val)",
  "studyGroupLocationId": "(val)",
  "locationId": "(val)",
  "locationRoom": "(val)",
  "studyGroupLocationDescription": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Study Group Locations
POST/iacuc/api/v1/iacuc-protocol-study-group-locations/

Example URI

POST /iacuc/api/v1/iacuc-protocol-study-group-locations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolStudyGroupLocationId": "(val)",
  "iacucProtocolStudyGroupId": "(val)",
  "locationTypeCode": "(val)",
  "studyGroupLocationId": "(val)",
  "locationId": "(val)",
  "locationRoom": "(val)",
  "studyGroupLocationDescription": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "iacucProtocolStudyGroupLocationId": "(val)",
  "iacucProtocolStudyGroupId": "(val)",
  "locationTypeCode": "(val)",
  "studyGroupLocationId": "(val)",
  "locationId": "(val)",
  "locationRoom": "(val)",
  "studyGroupLocationDescription": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Study Group Locations
POST/iacuc/api/v1/iacuc-protocol-study-group-locations/

Example URI

POST /iacuc/api/v1/iacuc-protocol-study-group-locations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucProtocolStudyGroupLocationId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "locationTypeCode": "(val)",
    "studyGroupLocationId": "(val)",
    "locationId": "(val)",
    "locationRoom": "(val)",
    "studyGroupLocationDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyGroupLocationId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "locationTypeCode": "(val)",
    "studyGroupLocationId": "(val)",
    "locationId": "(val)",
    "locationRoom": "(val)",
    "studyGroupLocationDescription": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "iacucProtocolStudyGroupLocationId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "locationTypeCode": "(val)",
    "studyGroupLocationId": "(val)",
    "locationId": "(val)",
    "locationRoom": "(val)",
    "studyGroupLocationDescription": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyGroupLocationId": "(val)",
    "iacucProtocolStudyGroupId": "(val)",
    "locationTypeCode": "(val)",
    "studyGroupLocationId": "(val)",
    "locationId": "(val)",
    "locationRoom": "(val)",
    "studyGroupLocationDescription": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Study Group Locations by Key
DELETE/iacuc/api/v1/iacuc-protocol-study-group-locations/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-study-group-locations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Study Group Locations
DELETE/iacuc/api/v1/iacuc-protocol-study-group-locations/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-study-group-locations/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Study Group Locations with Matching
DELETE/iacuc/api/v1/iacuc-protocol-study-group-locations/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-study-group-locations/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

iacucProtocolStudyGroupLocationId
string (optional) 

Protocol Study Group Location Id. Maximum length is 22.

iacucProtocolStudyGroupId
string (optional) 

Protocol Study Group Id. Maximum length is 22.

locationTypeCode
string (optional) 

Location Type Code. Maximum length is 3.

studyGroupLocationId
string (optional) 

Study Group Location Id. Maximum length is 6.

locationId
string (optional) 

Location Name Code. Maximum length is 3.

locationRoom
string (optional) 

Room. Maximum length is 60.

studyGroupLocationDescription
string (optional) 

Description. Maximum length is 2000.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Study Groups

Get Iacuc Protocol Study Groups by Key
GET/iacuc/api/v1/iacuc-protocol-study-groups/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "iacucProtocolStudyGroupId": "(val)",
  "iacucProtocolStudyGroupHeaderId": "(val)",
  "iacucProtocolSpeciesId": "(val)",
  "painCategoryCode": "(val)",
  "count": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Study Groups
GET/iacuc/api/v1/iacuc-protocol-study-groups/

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProtocolStudyGroupId": "(val)",
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "iacucProtocolSpeciesId": "(val)",
    "painCategoryCode": "(val)",
    "count": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyGroupId": "(val)",
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "iacucProtocolSpeciesId": "(val)",
    "painCategoryCode": "(val)",
    "count": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Study Groups with Filtering
GET/iacuc/api/v1/iacuc-protocol-study-groups/

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-groups/
URI Parameters
HideShow
iacucProtocolStudyGroupId
string (optional) 

Protocol Study Group Id. Maximum length is 22.

iacucProtocolStudyGroupHeaderId
string (optional) 

Protocol Study Group Header Id. Maximum length is 22.

iacucProtocolSpeciesId
string (optional) 

Protocol Species Id. Maximum length is 22.

painCategoryCode
string (optional) 

Pain Category. Maximum length is 3.

count
string (optional) 

Count. Maximum length is 8.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "iacucProtocolStudyGroupId": "(val)",
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "iacucProtocolSpeciesId": "(val)",
    "painCategoryCode": "(val)",
    "count": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyGroupId": "(val)",
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "iacucProtocolSpeciesId": "(val)",
    "painCategoryCode": "(val)",
    "count": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Study Groups
GET/iacuc/api/v1/iacuc-protocol-study-groups/

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-groups/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "iacucProtocolStudyGroupId",
    "iacucProtocolStudyGroupHeaderId",
    "iacucProtocolSpeciesId",
    "painCategoryCode",
    "count"
  ],
  "primaryKey": "iacucProtocolStudyGroupId"
}

Get Blueprint API specification for Iacuc Protocol Study Groups
GET/iacuc/api/v1/iacuc-protocol-study-groups/

Example URI

GET /iacuc/api/v1/iacuc-protocol-study-groups/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Study Groups.md"
transfer-encoding: chunked

Update Iacuc Protocol Study Groups
PUT/iacuc/api/v1/iacuc-protocol-study-groups/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-study-groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolStudyGroupId": "(val)",
  "iacucProtocolStudyGroupHeaderId": "(val)",
  "iacucProtocolSpeciesId": "(val)",
  "painCategoryCode": "(val)",
  "count": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Study Groups
PUT/iacuc/api/v1/iacuc-protocol-study-groups/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-study-groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucProtocolStudyGroupId": "(val)",
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "iacucProtocolSpeciesId": "(val)",
    "painCategoryCode": "(val)",
    "count": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyGroupId": "(val)",
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "iacucProtocolSpeciesId": "(val)",
    "painCategoryCode": "(val)",
    "count": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Study Groups
PATCH/iacuc/api/v1/iacuc-protocol-study-groups/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-study-groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolStudyGroupId": "(val)",
  "iacucProtocolStudyGroupHeaderId": "(val)",
  "iacucProtocolSpeciesId": "(val)",
  "painCategoryCode": "(val)",
  "count": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "iacucProtocolStudyGroupId": "(val)",
  "iacucProtocolStudyGroupHeaderId": "(val)",
  "iacucProtocolSpeciesId": "(val)",
  "painCategoryCode": "(val)",
  "count": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Study Groups
POST/iacuc/api/v1/iacuc-protocol-study-groups/

Example URI

POST /iacuc/api/v1/iacuc-protocol-study-groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "iacucProtocolStudyGroupId": "(val)",
  "iacucProtocolStudyGroupHeaderId": "(val)",
  "iacucProtocolSpeciesId": "(val)",
  "painCategoryCode": "(val)",
  "count": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "iacucProtocolStudyGroupId": "(val)",
  "iacucProtocolStudyGroupHeaderId": "(val)",
  "iacucProtocolSpeciesId": "(val)",
  "painCategoryCode": "(val)",
  "count": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Study Groups
POST/iacuc/api/v1/iacuc-protocol-study-groups/

Example URI

POST /iacuc/api/v1/iacuc-protocol-study-groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "iacucProtocolStudyGroupId": "(val)",
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "iacucProtocolSpeciesId": "(val)",
    "painCategoryCode": "(val)",
    "count": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyGroupId": "(val)",
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "iacucProtocolSpeciesId": "(val)",
    "painCategoryCode": "(val)",
    "count": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "iacucProtocolStudyGroupId": "(val)",
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "iacucProtocolSpeciesId": "(val)",
    "painCategoryCode": "(val)",
    "count": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "iacucProtocolStudyGroupId": "(val)",
    "iacucProtocolStudyGroupHeaderId": "(val)",
    "iacucProtocolSpeciesId": "(val)",
    "painCategoryCode": "(val)",
    "count": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Study Groups by Key
DELETE/iacuc/api/v1/iacuc-protocol-study-groups/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-study-groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Study Groups
DELETE/iacuc/api/v1/iacuc-protocol-study-groups/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-study-groups/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Study Groups with Matching
DELETE/iacuc/api/v1/iacuc-protocol-study-groups/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-study-groups/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

iacucProtocolStudyGroupId
string (optional) 

Protocol Study Group Id. Maximum length is 22.

iacucProtocolStudyGroupHeaderId
string (optional) 

Protocol Study Group Header Id. Maximum length is 22.

iacucProtocolSpeciesId
string (optional) 

Protocol Species Id. Maximum length is 22.

painCategoryCode
string (optional) 

Pain Category. Maximum length is 3.

count
string (optional) 

Count. Maximum length is 8.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Submission Docs

Get Iacuc Protocol Submission Docs by Key
GET/iacuc/api/v1/iacuc-protocol-submission-docs/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-docs/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "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 Iacuc Protocol Submission Docs
GET/iacuc/api/v1/iacuc-protocol-submission-docs/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-docs/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Submission Docs with Filtering
GET/iacuc/api/v1/iacuc-protocol-submission-docs/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-docs/
URI Parameters
HideShow
submissionDocId
string (optional) 

IACUC Protocol Submission Doc Id. Maximum length is 22.

protocolId
string (optional) 
submissionIdFk
string (optional) 

IACUC Protocol Submission Id. Maximum length is 22.

protocolNumber
string (optional) 

IACUC 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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Submission Docs
GET/iacuc/api/v1/iacuc-protocol-submission-docs/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-docs/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "submissionDocId",
    "protocolId",
    "submissionIdFk",
    "protocolNumber",
    "sequenceNumber",
    "submissionNumber",
    "documentId",
    "fileName",
    "contentType",
    "description",
    "document"
  ],
  "primaryKey": "submissionDocId"
}

Get Blueprint API specification for Iacuc Protocol Submission Docs
GET/iacuc/api/v1/iacuc-protocol-submission-docs/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-docs/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Submission Docs.md"
transfer-encoding: chunked

Update Iacuc Protocol Submission Docs
PUT/iacuc/api/v1/iacuc-protocol-submission-docs/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-submission-docs/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  204

Update Multiple Iacuc Protocol Submission Docs
PUT/iacuc/api/v1/iacuc-protocol-submission-docs/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-submission-docs/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Protocol Submission Docs
PATCH/iacuc/api/v1/iacuc-protocol-submission-docs/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-submission-docs/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  204
HideShow
Body
{
  "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 Iacuc Protocol Submission Docs
POST/iacuc/api/v1/iacuc-protocol-submission-docs/

Example URI

POST /iacuc/api/v1/iacuc-protocol-submission-docs/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  201
HideShow
Body
{
  "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 Iacuc Protocol Submission Docs
POST/iacuc/api/v1/iacuc-protocol-submission-docs/

Example URI

POST /iacuc/api/v1/iacuc-protocol-submission-docs/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol Submission Docs by Key
DELETE/iacuc/api/v1/iacuc-protocol-submission-docs/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-submission-docs/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Submission Docs
DELETE/iacuc/api/v1/iacuc-protocol-submission-docs/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-submission-docs/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Submission Docs with Matching
DELETE/iacuc/api/v1/iacuc-protocol-submission-docs/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-submission-docs/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

submissionDocId
string (optional) 

IACUC Protocol Submission Doc Id. Maximum length is 22.

protocolId
string (optional) 
submissionIdFk
string (optional) 

IACUC Protocol Submission Id. Maximum length is 22.

protocolNumber
string (optional) 

IACUC 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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Submission Qualifier Types

Get Iacuc Protocol Submission Qualifier Types by Key
GET/iacuc/api/v1/iacuc-protocol-submission-qualifier-types/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-qualifier-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "submissionQualifierTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Submission Qualifier Types
GET/iacuc/api/v1/iacuc-protocol-submission-qualifier-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-qualifier-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "submissionQualifierTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "submissionQualifierTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Submission Qualifier Types with Filtering
GET/iacuc/api/v1/iacuc-protocol-submission-qualifier-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-qualifier-types/
URI Parameters
HideShow
submissionQualifierTypeCode
string (optional) 

Submission Qualifier Type Code. Maximum length is 3.

description
string (optional) 

Description. Maximum length is 200.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "submissionQualifierTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "submissionQualifierTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Submission Qualifier Types
GET/iacuc/api/v1/iacuc-protocol-submission-qualifier-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-qualifier-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "submissionQualifierTypeCode",
    "description"
  ],
  "primaryKey": "submissionQualifierTypeCode"
}

Get Blueprint API specification for Iacuc Protocol Submission Qualifier Types
GET/iacuc/api/v1/iacuc-protocol-submission-qualifier-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-qualifier-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Submission Qualifier Types.md"
transfer-encoding: chunked

Update Iacuc Protocol Submission Qualifier Types
PUT/iacuc/api/v1/iacuc-protocol-submission-qualifier-types/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-submission-qualifier-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "submissionQualifierTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Submission Qualifier Types
PUT/iacuc/api/v1/iacuc-protocol-submission-qualifier-types/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-submission-qualifier-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "submissionQualifierTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "submissionQualifierTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Submission Qualifier Types
PATCH/iacuc/api/v1/iacuc-protocol-submission-qualifier-types/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-submission-qualifier-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "submissionQualifierTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "submissionQualifierTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Submission Qualifier Types
POST/iacuc/api/v1/iacuc-protocol-submission-qualifier-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-submission-qualifier-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "submissionQualifierTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "submissionQualifierTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Submission Qualifier Types
POST/iacuc/api/v1/iacuc-protocol-submission-qualifier-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-submission-qualifier-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "submissionQualifierTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "submissionQualifierTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "submissionQualifierTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "submissionQualifierTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Submission Qualifier Types by Key
DELETE/iacuc/api/v1/iacuc-protocol-submission-qualifier-types/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-submission-qualifier-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Submission Qualifier Types
DELETE/iacuc/api/v1/iacuc-protocol-submission-qualifier-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-submission-qualifier-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Submission Qualifier Types with Matching
DELETE/iacuc/api/v1/iacuc-protocol-submission-qualifier-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-submission-qualifier-types/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Submission Statuses

Get Iacuc Protocol Submission Statuses by Key
GET/iacuc/api/v1/iacuc-protocol-submission-statuses/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolSubmissionStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Submission Statuses
GET/iacuc/api/v1/iacuc-protocol-submission-statuses/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolSubmissionStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolSubmissionStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Submission Statuses with Filtering
GET/iacuc/api/v1/iacuc-protocol-submission-statuses/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-statuses/
URI Parameters
HideShow
protocolSubmissionStatusCode
string (optional) 

IACUC Submission Status Code. Maximum length is 3.

description
string (optional) 

Description. Maximum length is 200.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolSubmissionStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolSubmissionStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Submission Statuses
GET/iacuc/api/v1/iacuc-protocol-submission-statuses/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-statuses/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolSubmissionStatusCode",
    "description"
  ],
  "primaryKey": "protocolSubmissionStatusCode"
}

Get Blueprint API specification for Iacuc Protocol Submission Statuses
GET/iacuc/api/v1/iacuc-protocol-submission-statuses/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-statuses/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Submission Statuses.md"
transfer-encoding: chunked

Update Iacuc Protocol Submission Statuses
PUT/iacuc/api/v1/iacuc-protocol-submission-statuses/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-submission-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolSubmissionStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Submission Statuses
PUT/iacuc/api/v1/iacuc-protocol-submission-statuses/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-submission-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolSubmissionStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolSubmissionStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Submission Statuses
PATCH/iacuc/api/v1/iacuc-protocol-submission-statuses/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-submission-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolSubmissionStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolSubmissionStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Submission Statuses
POST/iacuc/api/v1/iacuc-protocol-submission-statuses/

Example URI

POST /iacuc/api/v1/iacuc-protocol-submission-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolSubmissionStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolSubmissionStatusCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Submission Statuses
POST/iacuc/api/v1/iacuc-protocol-submission-statuses/

Example URI

POST /iacuc/api/v1/iacuc-protocol-submission-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolSubmissionStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolSubmissionStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "protocolSubmissionStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolSubmissionStatusCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Submission Statuses by Key
DELETE/iacuc/api/v1/iacuc-protocol-submission-statuses/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-submission-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Submission Statuses
DELETE/iacuc/api/v1/iacuc-protocol-submission-statuses/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-submission-statuses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Submission Statuses with Matching
DELETE/iacuc/api/v1/iacuc-protocol-submission-statuses/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-submission-statuses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

protocolSubmissionStatusCode
string (optional) 

IACUC Submission Status Code. Maximum length is 3.

description
string (optional) 

Description. Maximum length is 200.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Submission Types

Get Iacuc Protocol Submission Types by Key
GET/iacuc/api/v1/iacuc-protocol-submission-types/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "submissionTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Submission Types
GET/iacuc/api/v1/iacuc-protocol-submission-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "submissionTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "submissionTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Submission Types with Filtering
GET/iacuc/api/v1/iacuc-protocol-submission-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-types/
URI Parameters
HideShow
submissionTypeCode
string (optional) 

Submission Type Code. Maximum length is 3.

description
string (optional) 

Description. Maximum length is 200.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "submissionTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "submissionTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Submission Types
GET/iacuc/api/v1/iacuc-protocol-submission-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "submissionTypeCode",
    "description"
  ],
  "primaryKey": "submissionTypeCode"
}

Get Blueprint API specification for Iacuc Protocol Submission Types
GET/iacuc/api/v1/iacuc-protocol-submission-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submission-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Submission Types.md"
transfer-encoding: chunked

Update Iacuc Protocol Submission Types
PUT/iacuc/api/v1/iacuc-protocol-submission-types/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-submission-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "submissionTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Submission Types
PUT/iacuc/api/v1/iacuc-protocol-submission-types/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-submission-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "submissionTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "submissionTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Submission Types
PATCH/iacuc/api/v1/iacuc-protocol-submission-types/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-submission-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "submissionTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "submissionTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Submission Types
POST/iacuc/api/v1/iacuc-protocol-submission-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-submission-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "submissionTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "submissionTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Submission Types
POST/iacuc/api/v1/iacuc-protocol-submission-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-submission-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "submissionTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "submissionTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "submissionTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "submissionTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Submission Types by Key
DELETE/iacuc/api/v1/iacuc-protocol-submission-types/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-submission-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Submission Types
DELETE/iacuc/api/v1/iacuc-protocol-submission-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-submission-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Submission Types with Matching
DELETE/iacuc/api/v1/iacuc-protocol-submission-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-submission-types/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Submissions

Get Iacuc Protocol Submissions by Key
GET/iacuc/api/v1/iacuc-protocol-submissions/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-submissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "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 Iacuc Protocol Submissions
GET/iacuc/api/v1/iacuc-protocol-submissions/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Submissions with Filtering
GET/iacuc/api/v1/iacuc-protocol-submissions/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submissions/
URI Parameters
HideShow
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) 

IACUC 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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Submissions
GET/iacuc/api/v1/iacuc-protocol-submissions/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submissions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "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 Iacuc Protocol Submissions
GET/iacuc/api/v1/iacuc-protocol-submissions/

Example URI

GET /iacuc/api/v1/iacuc-protocol-submissions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Submissions.md"
transfer-encoding: chunked

Update Iacuc Protocol Submissions
PUT/iacuc/api/v1/iacuc-protocol-submissions/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-submissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  204

Update Multiple Iacuc Protocol Submissions
PUT/iacuc/api/v1/iacuc-protocol-submissions/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-submissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Protocol Submissions
PATCH/iacuc/api/v1/iacuc-protocol-submissions/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-submissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  204
HideShow
Body
{
  "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 Iacuc Protocol Submissions
POST/iacuc/api/v1/iacuc-protocol-submissions/

Example URI

POST /iacuc/api/v1/iacuc-protocol-submissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  201
HideShow
Body
{
  "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 Iacuc Protocol Submissions
POST/iacuc/api/v1/iacuc-protocol-submissions/

Example URI

POST /iacuc/api/v1/iacuc-protocol-submissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol Submissions by Key
DELETE/iacuc/api/v1/iacuc-protocol-submissions/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-submissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Submissions
DELETE/iacuc/api/v1/iacuc-protocol-submissions/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-submissions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Submissions with Matching
DELETE/iacuc/api/v1/iacuc-protocol-submissions/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-submissions/
URI Parameters
HideShow
_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) 

IACUC 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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Types

Get Iacuc Protocol Types by Key
GET/iacuc/api/v1/iacuc-protocol-types/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Types
GET/iacuc/api/v1/iacuc-protocol-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocol Types with Filtering
GET/iacuc/api/v1/iacuc-protocol-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-types/
URI Parameters
HideShow
protocolTypeCode
string (optional) 

Protocol Type Code. Maximum length is 22.

description
string (optional) 

Description. Maximum length is 200.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocol Types
GET/iacuc/api/v1/iacuc-protocol-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolTypeCode",
    "description"
  ],
  "primaryKey": "protocolTypeCode"
}

Get Blueprint API specification for Iacuc Protocol Types
GET/iacuc/api/v1/iacuc-protocol-types/

Example URI

GET /iacuc/api/v1/iacuc-protocol-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Types.md"
transfer-encoding: chunked

Update Iacuc Protocol Types
PUT/iacuc/api/v1/iacuc-protocol-types/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Types
PUT/iacuc/api/v1/iacuc-protocol-types/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Protocol Types
PATCH/iacuc/api/v1/iacuc-protocol-types/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Types
POST/iacuc/api/v1/iacuc-protocol-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolTypeCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Types
POST/iacuc/api/v1/iacuc-protocol-types/

Example URI

POST /iacuc/api/v1/iacuc-protocol-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "protocolTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "protocolTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "protocolTypeCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Protocol Types by Key
DELETE/iacuc/api/v1/iacuc-protocol-types/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Types
DELETE/iacuc/api/v1/iacuc-protocol-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Types with Matching
DELETE/iacuc/api/v1/iacuc-protocol-types/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

protocolTypeCode
string (optional) 

Protocol Type Code. Maximum length is 22.

description
string (optional) 

Description. Maximum length is 200.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocol Units

Get Iacuc Protocol Units by Key
GET/iacuc/api/v1/iacuc-protocol-units/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocol-units/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolUnitsId": "(val)",
  "protocolPersonId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "unitNumber": "(val)",
  "leadUnitFlag": "(val)",
  "personId": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocol Units
GET/iacuc/api/v1/iacuc-protocol-units/

Example URI

GET /iacuc/api/v1/iacuc-protocol-units/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Units with Filtering
GET/iacuc/api/v1/iacuc-protocol-units/

Example URI

GET /iacuc/api/v1/iacuc-protocol-units/
URI Parameters
HideShow
protocolUnitsId
string (optional) 
protocolPersonId
string (optional) 
protocolNumber
string (optional) 
sequenceNumber
string (optional) 
unitNumber
string (optional) 
leadUnitFlag
string (optional) 
personId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Units
GET/iacuc/api/v1/iacuc-protocol-units/

Example URI

GET /iacuc/api/v1/iacuc-protocol-units/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolUnitsId",
    "protocolPersonId",
    "protocolNumber",
    "sequenceNumber",
    "unitNumber",
    "leadUnitFlag",
    "personId"
  ],
  "primaryKey": "protocolUnitsId"
}

Get Blueprint API specification for Iacuc Protocol Units
GET/iacuc/api/v1/iacuc-protocol-units/

Example URI

GET /iacuc/api/v1/iacuc-protocol-units/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocol Units.md"
transfer-encoding: chunked

Update Iacuc Protocol Units
PUT/iacuc/api/v1/iacuc-protocol-units/(key)

Example URI

PUT /iacuc/api/v1/iacuc-protocol-units/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolUnitsId": "(val)",
  "protocolPersonId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "unitNumber": "(val)",
  "leadUnitFlag": "(val)",
  "personId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Protocol Units
PUT/iacuc/api/v1/iacuc-protocol-units/

Example URI

PUT /iacuc/api/v1/iacuc-protocol-units/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Protocol Units
PATCH/iacuc/api/v1/iacuc-protocol-units/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-protocol-units/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolUnitsId": "(val)",
  "protocolPersonId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "unitNumber": "(val)",
  "leadUnitFlag": "(val)",
  "personId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "protocolUnitsId": "(val)",
  "protocolPersonId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "unitNumber": "(val)",
  "leadUnitFlag": "(val)",
  "personId": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Protocol Units
POST/iacuc/api/v1/iacuc-protocol-units/

Example URI

POST /iacuc/api/v1/iacuc-protocol-units/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "protocolUnitsId": "(val)",
  "protocolPersonId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "unitNumber": "(val)",
  "leadUnitFlag": "(val)",
  "personId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "protocolUnitsId": "(val)",
  "protocolPersonId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "unitNumber": "(val)",
  "leadUnitFlag": "(val)",
  "personId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Protocol Units
POST/iacuc/api/v1/iacuc-protocol-units/

Example URI

POST /iacuc/api/v1/iacuc-protocol-units/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol Units by Key
DELETE/iacuc/api/v1/iacuc-protocol-units/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-units/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Units
DELETE/iacuc/api/v1/iacuc-protocol-units/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-units/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Protocol Units with Matching
DELETE/iacuc/api/v1/iacuc-protocol-units/

Example URI

DELETE /iacuc/api/v1/iacuc-protocol-units/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

protocolUnitsId
string (optional) 
protocolPersonId
string (optional) 
protocolNumber
string (optional) 
sequenceNumber
string (optional) 
unitNumber
string (optional) 
leadUnitFlag
string (optional) 
personId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Protocols

Get Iacuc Protocols by Key
GET/iacuc/api/v1/iacuc-protocols/(key)

Example URI

GET /iacuc/api/v1/iacuc-protocols/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "protocolId": "(val)",
  "protocolNumber": "(val)",
  "sequenceNumber": "(val)",
  "active": "(val)",
  "protocolTypeCode": "(val)",
  "protocolStatusCode": "(val)",
  "title": "(val)",
  "description": "(val)",
  "initialSubmissionDate": "(val)",
  "approvalDate": "(val)",
  "expirationDate": "(val)",
  "fdaApplicationNumber": "(val)",
  "protocolProjectTypeCode": "(val)",
  "referenceNumber1": "(val)",
  "referenceNumber2": "(val)",
  "isBillable": "(val)",
  "specialReviewIndicator": "(val)",
  "keyStudyPersonIndicator": "(val)",
  "fundingSourceIndicator": "(val)",
  "correspondentIndicator": "(val)",
  "referenceIndicator": "(val)",
  "layStatement1": "(val)",
  "layStatement2": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "lastApprovalDate": "(val)",
  "overviewTimeline": "(val)",
  "speciesStudyGroupIndicator": "(val)",
  "alternativeSearchIndicator": "(val)",
  "scientificJustifIndicator": "(val)",
  "protocolDocument.documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Protocols
GET/iacuc/api/v1/iacuc-protocols/

Example URI

GET /iacuc/api/v1/iacuc-protocols/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "protocolTypeCode": "(val)",
    "protocolStatusCode": "(val)",
    "title": "(val)",
    "description": "(val)",
    "initialSubmissionDate": "(val)",
    "approvalDate": "(val)",
    "expirationDate": "(val)",
    "fdaApplicationNumber": "(val)",
    "protocolProjectTypeCode": "(val)",
    "referenceNumber1": "(val)",
    "referenceNumber2": "(val)",
    "isBillable": "(val)",
    "specialReviewIndicator": "(val)",
    "keyStudyPersonIndicator": "(val)",
    "fundingSourceIndicator": "(val)",
    "correspondentIndicator": "(val)",
    "referenceIndicator": "(val)",
    "layStatement1": "(val)",
    "layStatement2": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "lastApprovalDate": "(val)",
    "overviewTimeline": "(val)",
    "speciesStudyGroupIndicator": "(val)",
    "alternativeSearchIndicator": "(val)",
    "scientificJustifIndicator": "(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)",
    "fdaApplicationNumber": "(val)",
    "protocolProjectTypeCode": "(val)",
    "referenceNumber1": "(val)",
    "referenceNumber2": "(val)",
    "isBillable": "(val)",
    "specialReviewIndicator": "(val)",
    "keyStudyPersonIndicator": "(val)",
    "fundingSourceIndicator": "(val)",
    "correspondentIndicator": "(val)",
    "referenceIndicator": "(val)",
    "layStatement1": "(val)",
    "layStatement2": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "lastApprovalDate": "(val)",
    "overviewTimeline": "(val)",
    "speciesStudyGroupIndicator": "(val)",
    "alternativeSearchIndicator": "(val)",
    "scientificJustifIndicator": "(val)",
    "protocolDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Protocols with Filtering
GET/iacuc/api/v1/iacuc-protocols/

Example URI

GET /iacuc/api/v1/iacuc-protocols/
URI Parameters
HideShow
protocolId
string (optional) 

Ac Protocol Id. Maximum length is 22.

protocolNumber
string (optional) 

Protocol Number. Maximum length is 20.

sequenceNumber
string (optional) 

Sequence Number. Maximum length is 22.

active
string (optional) 

Active. Maximum length is 1.

protocolTypeCode
string (optional) 

Protocol Type Code. Maximum length is 22.

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.

fdaApplicationNumber
string (optional) 

Fda Application Number. Maximum length is 15.

protocolProjectTypeCode
string (optional) 

Protocol Project Type Code. Maximum length is 3.

referenceNumber1
string (optional) 

Reference Number 1. Maximum length is 50.

referenceNumber2
string (optional) 

Reference Number 2. Maximum length is 50.

isBillable
string (optional) 

Is Billable. Maximum length is 1.

specialReviewIndicator
string (optional) 

Special Review Indicator. Maximum length is 2.

keyStudyPersonIndicator
string (optional) 

Key Study Person Indicator. Maximum length is 2.

fundingSourceIndicator
string (optional) 

Funding Source Indicator. Maximum length is 2.

correspondentIndicator
string (optional) 

Correspondent Indicator. Maximum length is 2.

referenceIndicator
string (optional) 

Reference Indicator. Maximum length is 2.

layStatement1
string (optional) 

Lay Statement 1. Maximum length is 2000.

layStatement2
string (optional) 

Lay Statement 2. Maximum length is 2000.

createTimestamp
string (optional) 

Protocol Create Date. Maximum length is 21.

createUser
string (optional) 
lastApprovalDate
string (optional) 

Last Approval Date. Maximum length is 10.

overviewTimeline
string (optional) 

Overview and Timeline. Maximum length is 2000.

speciesStudyGroupIndicator
string (optional) 

Species Study Group Indicator. Maximum length is 2.

alternativeSearchIndicator
string (optional) 

Alternative Search Indicator. Maximum length is 2.

scientificJustifIndicator
string (optional) 

Scientific Justif Indicator. Maximum length is 2.

protocolDocument.documentNumber
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "protocolId": "(val)",
    "protocolNumber": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "protocolTypeCode": "(val)",
    "protocolStatusCode": "(val)",
    "title": "(val)",
    "description": "(val)",
    "initialSubmissionDate": "(val)",
    "approvalDate": "(val)",
    "expirationDate": "(val)",
    "fdaApplicationNumber": "(val)",
    "protocolProjectTypeCode": "(val)",
    "referenceNumber1": "(val)",
    "referenceNumber2": "(val)",
    "isBillable": "(val)",
    "specialReviewIndicator": "(val)",
    "keyStudyPersonIndicator": "(val)",
    "fundingSourceIndicator": "(val)",
    "correspondentIndicator": "(val)",
    "referenceIndicator": "(val)",
    "layStatement1": "(val)",
    "layStatement2": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "lastApprovalDate": "(val)",
    "overviewTimeline": "(val)",
    "speciesStudyGroupIndicator": "(val)",
    "alternativeSearchIndicator": "(val)",
    "scientificJustifIndicator": "(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)",
    "fdaApplicationNumber": "(val)",
    "protocolProjectTypeCode": "(val)",
    "referenceNumber1": "(val)",
    "referenceNumber2": "(val)",
    "isBillable": "(val)",
    "specialReviewIndicator": "(val)",
    "keyStudyPersonIndicator": "(val)",
    "fundingSourceIndicator": "(val)",
    "correspondentIndicator": "(val)",
    "referenceIndicator": "(val)",
    "layStatement1": "(val)",
    "layStatement2": "(val)",
    "createTimestamp": "(val)",
    "createUser": "(val)",
    "lastApprovalDate": "(val)",
    "overviewTimeline": "(val)",
    "speciesStudyGroupIndicator": "(val)",
    "alternativeSearchIndicator": "(val)",
    "scientificJustifIndicator": "(val)",
    "protocolDocument.documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Protocols
GET/iacuc/api/v1/iacuc-protocols/

Example URI

GET /iacuc/api/v1/iacuc-protocols/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "protocolId",
    "protocolNumber",
    "sequenceNumber",
    "active",
    "protocolTypeCode",
    "protocolStatusCode",
    "title",
    "description",
    "initialSubmissionDate",
    "approvalDate",
    "expirationDate",
    "fdaApplicationNumber",
    "protocolProjectTypeCode",
    "referenceNumber1",
    "referenceNumber2",
    "isBillable",
    "specialReviewIndicator",
    "keyStudyPersonIndicator",
    "fundingSourceIndicator",
    "correspondentIndicator",
    "referenceIndicator",
    "layStatement1",
    "layStatement2",
    "createTimestamp",
    "createUser",
    "lastApprovalDate",
    "overviewTimeline",
    "speciesStudyGroupIndicator",
    "alternativeSearchIndicator",
    "scientificJustifIndicator",
    "protocolDocument.documentNumber"
  ],
  "primaryKey": "protocolId"
}

Get Blueprint API specification for Iacuc Protocols
GET/iacuc/api/v1/iacuc-protocols/

Example URI

GET /iacuc/api/v1/iacuc-protocols/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Protocols.md"
transfer-encoding: chunked

Iacuc Research Areas

Get Iacuc Research Areas by Key
GET/iacuc/api/v1/iacuc-research-areas/(key)

Example URI

GET /iacuc/api/v1/iacuc-research-areas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "researchAreaCode": "(val)",
  "description": "(val)",
  "hasChildrenFlag": "(val)",
  "parentResearchAreaCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Research Areas
GET/iacuc/api/v1/iacuc-research-areas/

Example URI

GET /iacuc/api/v1/iacuc-research-areas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Research Areas with Filtering
GET/iacuc/api/v1/iacuc-research-areas/

Example URI

GET /iacuc/api/v1/iacuc-research-areas/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Research Areas
GET/iacuc/api/v1/iacuc-research-areas/

Example URI

GET /iacuc/api/v1/iacuc-research-areas/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "researchAreaCode",
    "description",
    "hasChildrenFlag",
    "parentResearchAreaCode",
    "active"
  ],
  "primaryKey": "researchAreaCode"
}

Get Blueprint API specification for Iacuc Research Areas
GET/iacuc/api/v1/iacuc-research-areas/

Example URI

GET /iacuc/api/v1/iacuc-research-areas/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Research Areas.md"
transfer-encoding: chunked

Update Iacuc Research Areas
PUT/iacuc/api/v1/iacuc-research-areas/(key)

Example URI

PUT /iacuc/api/v1/iacuc-research-areas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "researchAreaCode": "(val)",
  "description": "(val)",
  "hasChildrenFlag": "(val)",
  "parentResearchAreaCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Research Areas
PUT/iacuc/api/v1/iacuc-research-areas/

Example URI

PUT /iacuc/api/v1/iacuc-research-areas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Research Areas
PATCH/iacuc/api/v1/iacuc-research-areas/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-research-areas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "researchAreaCode": "(val)",
  "description": "(val)",
  "hasChildrenFlag": "(val)",
  "parentResearchAreaCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "researchAreaCode": "(val)",
  "description": "(val)",
  "hasChildrenFlag": "(val)",
  "parentResearchAreaCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Research Areas
POST/iacuc/api/v1/iacuc-research-areas/

Example URI

POST /iacuc/api/v1/iacuc-research-areas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "researchAreaCode": "(val)",
  "description": "(val)",
  "hasChildrenFlag": "(val)",
  "parentResearchAreaCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "researchAreaCode": "(val)",
  "description": "(val)",
  "hasChildrenFlag": "(val)",
  "parentResearchAreaCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Research Areas
POST/iacuc/api/v1/iacuc-research-areas/

Example URI

POST /iacuc/api/v1/iacuc-research-areas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Research Areas by Key
DELETE/iacuc/api/v1/iacuc-research-areas/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-research-areas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Research Areas
DELETE/iacuc/api/v1/iacuc-research-areas/

Example URI

DELETE /iacuc/api/v1/iacuc-research-areas/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Research Areas with Matching
DELETE/iacuc/api/v1/iacuc-research-areas/

Example URI

DELETE /iacuc/api/v1/iacuc-research-areas/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Schedule Agendas

Get Iacuc Schedule Agendas by Key
GET/iacuc/api/v1/iacuc-schedule-agendas/(key)

Example URI

GET /iacuc/api/v1/iacuc-schedule-agendas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "scheduleAgendaId": "(val)",
  "scheduleIdFk": "(val)",
  "agendaNumber": "(val)",
  "agendaName": "(val)",
  "pdfStore": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Schedule Agendas
GET/iacuc/api/v1/iacuc-schedule-agendas/

Example URI

GET /iacuc/api/v1/iacuc-schedule-agendas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Schedule Agendas with Filtering
GET/iacuc/api/v1/iacuc-schedule-agendas/

Example URI

GET /iacuc/api/v1/iacuc-schedule-agendas/
URI Parameters
HideShow
scheduleAgendaId
string (optional) 
scheduleIdFk
string (optional) 
agendaNumber
string (optional) 
agendaName
string (optional) 
pdfStore
string (optional) 
createTimestamp
string (optional) 
createUser
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Schedule Agendas
GET/iacuc/api/v1/iacuc-schedule-agendas/

Example URI

GET /iacuc/api/v1/iacuc-schedule-agendas/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "scheduleAgendaId",
    "scheduleIdFk",
    "agendaNumber",
    "agendaName",
    "pdfStore",
    "createTimestamp",
    "createUser"
  ],
  "primaryKey": "scheduleAgendaId"
}

Get Blueprint API specification for Iacuc Schedule Agendas
GET/iacuc/api/v1/iacuc-schedule-agendas/

Example URI

GET /iacuc/api/v1/iacuc-schedule-agendas/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Schedule Agendas.md"
transfer-encoding: chunked

Update Iacuc Schedule Agendas
PUT/iacuc/api/v1/iacuc-schedule-agendas/(key)

Example URI

PUT /iacuc/api/v1/iacuc-schedule-agendas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "scheduleAgendaId": "(val)",
  "scheduleIdFk": "(val)",
  "agendaNumber": "(val)",
  "agendaName": "(val)",
  "pdfStore": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Schedule Agendas
PUT/iacuc/api/v1/iacuc-schedule-agendas/

Example URI

PUT /iacuc/api/v1/iacuc-schedule-agendas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Schedule Agendas
PATCH/iacuc/api/v1/iacuc-schedule-agendas/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-schedule-agendas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "scheduleAgendaId": "(val)",
  "scheduleIdFk": "(val)",
  "agendaNumber": "(val)",
  "agendaName": "(val)",
  "pdfStore": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "scheduleAgendaId": "(val)",
  "scheduleIdFk": "(val)",
  "agendaNumber": "(val)",
  "agendaName": "(val)",
  "pdfStore": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Schedule Agendas
POST/iacuc/api/v1/iacuc-schedule-agendas/

Example URI

POST /iacuc/api/v1/iacuc-schedule-agendas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "scheduleAgendaId": "(val)",
  "scheduleIdFk": "(val)",
  "agendaNumber": "(val)",
  "agendaName": "(val)",
  "pdfStore": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "scheduleAgendaId": "(val)",
  "scheduleIdFk": "(val)",
  "agendaNumber": "(val)",
  "agendaName": "(val)",
  "pdfStore": "(val)",
  "createTimestamp": "(val)",
  "createUser": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Schedule Agendas
POST/iacuc/api/v1/iacuc-schedule-agendas/

Example URI

POST /iacuc/api/v1/iacuc-schedule-agendas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Schedule Agendas by Key
DELETE/iacuc/api/v1/iacuc-schedule-agendas/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-schedule-agendas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Schedule Agendas
DELETE/iacuc/api/v1/iacuc-schedule-agendas/

Example URI

DELETE /iacuc/api/v1/iacuc-schedule-agendas/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Schedule Agendas with Matching
DELETE/iacuc/api/v1/iacuc-schedule-agendas/

Example URI

DELETE /iacuc/api/v1/iacuc-schedule-agendas/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

scheduleAgendaId
string (optional) 
scheduleIdFk
string (optional) 
agendaNumber
string (optional) 
agendaName
string (optional) 
pdfStore
string (optional) 
createTimestamp
string (optional) 
createUser
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Species

Get Iacuc Species by Key
GET/iacuc/api/v1/iacuc-species/(key)

Example URI

GET /iacuc/api/v1/iacuc-species/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "speciesCode": "(val)",
  "speciesName": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Species
GET/iacuc/api/v1/iacuc-species/

Example URI

GET /iacuc/api/v1/iacuc-species/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "speciesCode": "(val)",
    "speciesName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "speciesCode": "(val)",
    "speciesName": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Species with Filtering
GET/iacuc/api/v1/iacuc-species/

Example URI

GET /iacuc/api/v1/iacuc-species/
URI Parameters
HideShow
speciesCode
string (optional) 

Species Code. Maximum length is 4.

speciesName
string (optional) 

Species Name. Maximum length is 200.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "speciesCode": "(val)",
    "speciesName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "speciesCode": "(val)",
    "speciesName": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Species
GET/iacuc/api/v1/iacuc-species/

Example URI

GET /iacuc/api/v1/iacuc-species/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "speciesCode",
    "speciesName"
  ],
  "primaryKey": "speciesCode"
}

Get Blueprint API specification for Iacuc Species
GET/iacuc/api/v1/iacuc-species/

Example URI

GET /iacuc/api/v1/iacuc-species/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Species.md"
transfer-encoding: chunked

Update Iacuc Species
PUT/iacuc/api/v1/iacuc-species/(key)

Example URI

PUT /iacuc/api/v1/iacuc-species/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "speciesCode": "(val)",
  "speciesName": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Species
PUT/iacuc/api/v1/iacuc-species/

Example URI

PUT /iacuc/api/v1/iacuc-species/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "speciesCode": "(val)",
    "speciesName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "speciesCode": "(val)",
    "speciesName": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Species
PATCH/iacuc/api/v1/iacuc-species/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-species/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "speciesCode": "(val)",
  "speciesName": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "speciesCode": "(val)",
  "speciesName": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Species
POST/iacuc/api/v1/iacuc-species/

Example URI

POST /iacuc/api/v1/iacuc-species/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "speciesCode": "(val)",
  "speciesName": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "speciesCode": "(val)",
  "speciesName": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Species
POST/iacuc/api/v1/iacuc-species/

Example URI

POST /iacuc/api/v1/iacuc-species/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "speciesCode": "(val)",
    "speciesName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "speciesCode": "(val)",
    "speciesName": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "speciesCode": "(val)",
    "speciesName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "speciesCode": "(val)",
    "speciesName": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Species by Key
DELETE/iacuc/api/v1/iacuc-species/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-species/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Species
DELETE/iacuc/api/v1/iacuc-species/

Example URI

DELETE /iacuc/api/v1/iacuc-species/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Species with Matching
DELETE/iacuc/api/v1/iacuc-species/

Example URI

DELETE /iacuc/api/v1/iacuc-species/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

speciesCode
string (optional) 

Species Code. Maximum length is 4.

speciesName
string (optional) 

Species Name. Maximum length is 200.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Species Count Types

Get Iacuc Species Count Types by Key
GET/iacuc/api/v1/iacuc-species-count-types/(key)

Example URI

GET /iacuc/api/v1/iacuc-species-count-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "speciesCountCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Species Count Types
GET/iacuc/api/v1/iacuc-species-count-types/

Example URI

GET /iacuc/api/v1/iacuc-species-count-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "speciesCountCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "speciesCountCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Species Count Types with Filtering
GET/iacuc/api/v1/iacuc-species-count-types/

Example URI

GET /iacuc/api/v1/iacuc-species-count-types/
URI Parameters
HideShow
speciesCountCode
string (optional) 

Species Count Code. Maximum length is 3.

description
string (optional) 

Description. Maximum length is 200.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "speciesCountCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "speciesCountCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Species Count Types
GET/iacuc/api/v1/iacuc-species-count-types/

Example URI

GET /iacuc/api/v1/iacuc-species-count-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "speciesCountCode",
    "description"
  ],
  "primaryKey": "speciesCountCode"
}

Get Blueprint API specification for Iacuc Species Count Types
GET/iacuc/api/v1/iacuc-species-count-types/

Example URI

GET /iacuc/api/v1/iacuc-species-count-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Species Count Types.md"
transfer-encoding: chunked

Update Iacuc Species Count Types
PUT/iacuc/api/v1/iacuc-species-count-types/(key)

Example URI

PUT /iacuc/api/v1/iacuc-species-count-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "speciesCountCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Species Count Types
PUT/iacuc/api/v1/iacuc-species-count-types/

Example URI

PUT /iacuc/api/v1/iacuc-species-count-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "speciesCountCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "speciesCountCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Species Count Types
PATCH/iacuc/api/v1/iacuc-species-count-types/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-species-count-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "speciesCountCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "speciesCountCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Species Count Types
POST/iacuc/api/v1/iacuc-species-count-types/

Example URI

POST /iacuc/api/v1/iacuc-species-count-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "speciesCountCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "speciesCountCode": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Species Count Types
POST/iacuc/api/v1/iacuc-species-count-types/

Example URI

POST /iacuc/api/v1/iacuc-species-count-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "speciesCountCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "speciesCountCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "speciesCountCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "speciesCountCode": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Species Count Types by Key
DELETE/iacuc/api/v1/iacuc-species-count-types/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-species-count-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Species Count Types
DELETE/iacuc/api/v1/iacuc-species-count-types/

Example URI

DELETE /iacuc/api/v1/iacuc-species-count-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Species Count Types with Matching
DELETE/iacuc/api/v1/iacuc-species-count-types/

Example URI

DELETE /iacuc/api/v1/iacuc-species-count-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

speciesCountCode
string (optional) 

Species Count Code. Maximum length is 3.

description
string (optional) 

Description. Maximum length is 200.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Unit Correspondents

Get Iacuc Unit Correspondents by Key
GET/iacuc/api/v1/iacuc-unit-correspondents/(key)

Example URI

GET /iacuc/api/v1/iacuc-unit-correspondents/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "correspondentId": "(val)",
  "unitNumber": "(val)",
  "correspondentTypeCode": "(val)",
  "personId": "(val)",
  "nonEmployeeFlag": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Unit Correspondents
GET/iacuc/api/v1/iacuc-unit-correspondents/

Example URI

GET /iacuc/api/v1/iacuc-unit-correspondents/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "correspondentId": "(val)",
    "unitNumber": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "correspondentId": "(val)",
    "unitNumber": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Unit Correspondents with Filtering
GET/iacuc/api/v1/iacuc-unit-correspondents/

Example URI

GET /iacuc/api/v1/iacuc-unit-correspondents/
URI Parameters
HideShow
correspondentId
string (optional) 
unitNumber
string (optional) 

Unit Number. Maximum length is 8.

correspondentTypeCode
string (optional) 

Correspondent Type Code. Maximum length is 22.

personId
string (optional) 

This is a generic implementation of a ‘SystemId’ attribute. It should always be overriden on the label, shortLabel, summary, and description, as these are only generic placeholders. Maximum length is 40.

nonEmployeeFlag
string (optional) 

Non Employee Flag. Maximum length is 1.

description
string (optional) 

Description. Maximum length is 2000.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "correspondentId": "(val)",
    "unitNumber": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "correspondentId": "(val)",
    "unitNumber": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Unit Correspondents
GET/iacuc/api/v1/iacuc-unit-correspondents/

Example URI

GET /iacuc/api/v1/iacuc-unit-correspondents/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "correspondentId",
    "unitNumber",
    "correspondentTypeCode",
    "personId",
    "nonEmployeeFlag",
    "description"
  ],
  "primaryKey": "correspondentId"
}

Get Blueprint API specification for Iacuc Unit Correspondents
GET/iacuc/api/v1/iacuc-unit-correspondents/

Example URI

GET /iacuc/api/v1/iacuc-unit-correspondents/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Unit Correspondents.md"
transfer-encoding: chunked

Update Iacuc Unit Correspondents
PUT/iacuc/api/v1/iacuc-unit-correspondents/(key)

Example URI

PUT /iacuc/api/v1/iacuc-unit-correspondents/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "correspondentId": "(val)",
  "unitNumber": "(val)",
  "correspondentTypeCode": "(val)",
  "personId": "(val)",
  "nonEmployeeFlag": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Unit Correspondents
PUT/iacuc/api/v1/iacuc-unit-correspondents/

Example URI

PUT /iacuc/api/v1/iacuc-unit-correspondents/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "correspondentId": "(val)",
    "unitNumber": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "correspondentId": "(val)",
    "unitNumber": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Unit Correspondents
PATCH/iacuc/api/v1/iacuc-unit-correspondents/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-unit-correspondents/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "correspondentId": "(val)",
  "unitNumber": "(val)",
  "correspondentTypeCode": "(val)",
  "personId": "(val)",
  "nonEmployeeFlag": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "correspondentId": "(val)",
  "unitNumber": "(val)",
  "correspondentTypeCode": "(val)",
  "personId": "(val)",
  "nonEmployeeFlag": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Unit Correspondents
POST/iacuc/api/v1/iacuc-unit-correspondents/

Example URI

POST /iacuc/api/v1/iacuc-unit-correspondents/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "correspondentId": "(val)",
  "unitNumber": "(val)",
  "correspondentTypeCode": "(val)",
  "personId": "(val)",
  "nonEmployeeFlag": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "correspondentId": "(val)",
  "unitNumber": "(val)",
  "correspondentTypeCode": "(val)",
  "personId": "(val)",
  "nonEmployeeFlag": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Unit Correspondents
POST/iacuc/api/v1/iacuc-unit-correspondents/

Example URI

POST /iacuc/api/v1/iacuc-unit-correspondents/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "correspondentId": "(val)",
    "unitNumber": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "correspondentId": "(val)",
    "unitNumber": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "correspondentId": "(val)",
    "unitNumber": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "correspondentId": "(val)",
    "unitNumber": "(val)",
    "correspondentTypeCode": "(val)",
    "personId": "(val)",
    "nonEmployeeFlag": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Unit Correspondents by Key
DELETE/iacuc/api/v1/iacuc-unit-correspondents/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-unit-correspondents/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Unit Correspondents
DELETE/iacuc/api/v1/iacuc-unit-correspondents/

Example URI

DELETE /iacuc/api/v1/iacuc-unit-correspondents/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Unit Correspondents with Matching
DELETE/iacuc/api/v1/iacuc-unit-correspondents/

Example URI

DELETE /iacuc/api/v1/iacuc-unit-correspondents/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

correspondentId
string (optional) 
unitNumber
string (optional) 

Unit Number. Maximum length is 8.

correspondentTypeCode
string (optional) 

Correspondent Type Code. Maximum length is 22.

personId
string (optional) 

This is a generic implementation of a ‘SystemId’ attribute. It should always be overriden on the label, shortLabel, summary, and description, as these are only generic placeholders. Maximum length is 40.

nonEmployeeFlag
string (optional) 

Non Employee Flag. Maximum length is 1.

description
string (optional) 

Description. Maximum length is 2000.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Valid Protocol Action Actions

Get Iacuc Valid Protocol Action Actions by Key
GET/iacuc/api/v1/iacuc-valid-protocol-action-actions/(key)

Example URI

GET /iacuc/api/v1/iacuc-valid-protocol-action-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "validProtocolActionActionId": "(val)",
  "protocolActionTypeCode": "(val)",
  "motionTypeCode": "(val)",
  "actionNumber": "(val)",
  "followupActionCode": "(val)",
  "userPromptFlag": "(val)",
  "userPrompt": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Valid Protocol Action Actions
GET/iacuc/api/v1/iacuc-valid-protocol-action-actions/

Example URI

GET /iacuc/api/v1/iacuc-valid-protocol-action-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Valid Protocol Action Actions with Filtering
GET/iacuc/api/v1/iacuc-valid-protocol-action-actions/

Example URI

GET /iacuc/api/v1/iacuc-valid-protocol-action-actions/
URI Parameters
HideShow
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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Valid Protocol Action Actions
GET/iacuc/api/v1/iacuc-valid-protocol-action-actions/

Example URI

GET /iacuc/api/v1/iacuc-valid-protocol-action-actions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "validProtocolActionActionId",
    "protocolActionTypeCode",
    "motionTypeCode",
    "actionNumber",
    "followupActionCode",
    "userPromptFlag",
    "userPrompt"
  ],
  "primaryKey": "validProtocolActionActionId"
}

Get Blueprint API specification for Iacuc Valid Protocol Action Actions
GET/iacuc/api/v1/iacuc-valid-protocol-action-actions/

Example URI

GET /iacuc/api/v1/iacuc-valid-protocol-action-actions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Valid Protocol Action Actions.md"
transfer-encoding: chunked

Update Iacuc Valid Protocol Action Actions
PUT/iacuc/api/v1/iacuc-valid-protocol-action-actions/(key)

Example URI

PUT /iacuc/api/v1/iacuc-valid-protocol-action-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "validProtocolActionActionId": "(val)",
  "protocolActionTypeCode": "(val)",
  "motionTypeCode": "(val)",
  "actionNumber": "(val)",
  "followupActionCode": "(val)",
  "userPromptFlag": "(val)",
  "userPrompt": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Valid Protocol Action Actions
PUT/iacuc/api/v1/iacuc-valid-protocol-action-actions/

Example URI

PUT /iacuc/api/v1/iacuc-valid-protocol-action-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Iacuc Valid Protocol Action Actions
PATCH/iacuc/api/v1/iacuc-valid-protocol-action-actions/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-valid-protocol-action-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "validProtocolActionActionId": "(val)",
  "protocolActionTypeCode": "(val)",
  "motionTypeCode": "(val)",
  "actionNumber": "(val)",
  "followupActionCode": "(val)",
  "userPromptFlag": "(val)",
  "userPrompt": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "validProtocolActionActionId": "(val)",
  "protocolActionTypeCode": "(val)",
  "motionTypeCode": "(val)",
  "actionNumber": "(val)",
  "followupActionCode": "(val)",
  "userPromptFlag": "(val)",
  "userPrompt": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Valid Protocol Action Actions
POST/iacuc/api/v1/iacuc-valid-protocol-action-actions/

Example URI

POST /iacuc/api/v1/iacuc-valid-protocol-action-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "validProtocolActionActionId": "(val)",
  "protocolActionTypeCode": "(val)",
  "motionTypeCode": "(val)",
  "actionNumber": "(val)",
  "followupActionCode": "(val)",
  "userPromptFlag": "(val)",
  "userPrompt": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "validProtocolActionActionId": "(val)",
  "protocolActionTypeCode": "(val)",
  "motionTypeCode": "(val)",
  "actionNumber": "(val)",
  "followupActionCode": "(val)",
  "userPromptFlag": "(val)",
  "userPrompt": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Valid Protocol Action Actions
POST/iacuc/api/v1/iacuc-valid-protocol-action-actions/

Example URI

POST /iacuc/api/v1/iacuc-valid-protocol-action-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Valid Protocol Action Actions by Key
DELETE/iacuc/api/v1/iacuc-valid-protocol-action-actions/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-valid-protocol-action-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Valid Protocol Action Actions
DELETE/iacuc/api/v1/iacuc-valid-protocol-action-actions/

Example URI

DELETE /iacuc/api/v1/iacuc-valid-protocol-action-actions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Valid Protocol Action Actions with Matching
DELETE/iacuc/api/v1/iacuc-valid-protocol-action-actions/

Example URI

DELETE /iacuc/api/v1/iacuc-valid-protocol-action-actions/
URI Parameters
HideShow
_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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Valid Protocol Submission Review Types

Get Iacuc Valid Protocol Submission Review Types by Key
GET/iacuc/api/v1/iacuc-valid-protocol-submission-review-types/(key)

Example URI

GET /iacuc/api/v1/iacuc-valid-protocol-submission-review-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "validProtoSubRevTypeId": "(val)",
  "submissionTypeCode": "(val)",
  "protocolReviewTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Valid Protocol Submission Review Types
GET/iacuc/api/v1/iacuc-valid-protocol-submission-review-types/

Example URI

GET /iacuc/api/v1/iacuc-valid-protocol-submission-review-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "validProtoSubRevTypeId": "(val)",
    "submissionTypeCode": "(val)",
    "protocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validProtoSubRevTypeId": "(val)",
    "submissionTypeCode": "(val)",
    "protocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Valid Protocol Submission Review Types with Filtering
GET/iacuc/api/v1/iacuc-valid-protocol-submission-review-types/

Example URI

GET /iacuc/api/v1/iacuc-valid-protocol-submission-review-types/
URI Parameters
HideShow
validProtoSubRevTypeId
string (optional) 

Valid Protocol Submission Review Type Id. Maximum length is 12.

submissionTypeCode
string (optional) 

Protocol Submission Type Code. Maximum length is 3.

protocolReviewTypeCode
string (optional) 

IACUC Protocol Review Type Code. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "validProtoSubRevTypeId": "(val)",
    "submissionTypeCode": "(val)",
    "protocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validProtoSubRevTypeId": "(val)",
    "submissionTypeCode": "(val)",
    "protocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Valid Protocol Submission Review Types
GET/iacuc/api/v1/iacuc-valid-protocol-submission-review-types/

Example URI

GET /iacuc/api/v1/iacuc-valid-protocol-submission-review-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "validProtoSubRevTypeId",
    "submissionTypeCode",
    "protocolReviewTypeCode"
  ],
  "primaryKey": "validProtoSubRevTypeId"
}

Get Blueprint API specification for Iacuc Valid Protocol Submission Review Types
GET/iacuc/api/v1/iacuc-valid-protocol-submission-review-types/

Example URI

GET /iacuc/api/v1/iacuc-valid-protocol-submission-review-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Valid Protocol Submission Review Types.md"
transfer-encoding: chunked

Update Iacuc Valid Protocol Submission Review Types
PUT/iacuc/api/v1/iacuc-valid-protocol-submission-review-types/(key)

Example URI

PUT /iacuc/api/v1/iacuc-valid-protocol-submission-review-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "validProtoSubRevTypeId": "(val)",
  "submissionTypeCode": "(val)",
  "protocolReviewTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Valid Protocol Submission Review Types
PUT/iacuc/api/v1/iacuc-valid-protocol-submission-review-types/

Example URI

PUT /iacuc/api/v1/iacuc-valid-protocol-submission-review-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "validProtoSubRevTypeId": "(val)",
    "submissionTypeCode": "(val)",
    "protocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validProtoSubRevTypeId": "(val)",
    "submissionTypeCode": "(val)",
    "protocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Valid Protocol Submission Review Types
PATCH/iacuc/api/v1/iacuc-valid-protocol-submission-review-types/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-valid-protocol-submission-review-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "validProtoSubRevTypeId": "(val)",
  "submissionTypeCode": "(val)",
  "protocolReviewTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "validProtoSubRevTypeId": "(val)",
  "submissionTypeCode": "(val)",
  "protocolReviewTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Valid Protocol Submission Review Types
POST/iacuc/api/v1/iacuc-valid-protocol-submission-review-types/

Example URI

POST /iacuc/api/v1/iacuc-valid-protocol-submission-review-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "validProtoSubRevTypeId": "(val)",
  "submissionTypeCode": "(val)",
  "protocolReviewTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "validProtoSubRevTypeId": "(val)",
  "submissionTypeCode": "(val)",
  "protocolReviewTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Valid Protocol Submission Review Types
POST/iacuc/api/v1/iacuc-valid-protocol-submission-review-types/

Example URI

POST /iacuc/api/v1/iacuc-valid-protocol-submission-review-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "validProtoSubRevTypeId": "(val)",
    "submissionTypeCode": "(val)",
    "protocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validProtoSubRevTypeId": "(val)",
    "submissionTypeCode": "(val)",
    "protocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "validProtoSubRevTypeId": "(val)",
    "submissionTypeCode": "(val)",
    "protocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validProtoSubRevTypeId": "(val)",
    "submissionTypeCode": "(val)",
    "protocolReviewTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Valid Protocol Submission Review Types by Key
DELETE/iacuc/api/v1/iacuc-valid-protocol-submission-review-types/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-valid-protocol-submission-review-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Valid Protocol Submission Review Types
DELETE/iacuc/api/v1/iacuc-valid-protocol-submission-review-types/

Example URI

DELETE /iacuc/api/v1/iacuc-valid-protocol-submission-review-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Valid Protocol Submission Review Types with Matching
DELETE/iacuc/api/v1/iacuc-valid-protocol-submission-review-types/

Example URI

DELETE /iacuc/api/v1/iacuc-valid-protocol-submission-review-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

validProtoSubRevTypeId
string (optional) 

Valid Protocol Submission Review Type Id. Maximum length is 12.

submissionTypeCode
string (optional) 

Protocol Submission Type Code. Maximum length is 3.

protocolReviewTypeCode
string (optional) 

IACUC Protocol Review Type Code. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Iacuc Valid Protocol Submission Type Qualifiers

Get Iacuc Valid Protocol Submission Type Qualifiers by Key
GET/iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/(key)

Example URI

GET /iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "validProtoSubTypeQualId": "(val)",
  "submissionTypeCode": "(val)",
  "submissionTypeQualCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Iacuc Valid Protocol Submission Type Qualifiers
GET/iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/

Example URI

GET /iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "validProtoSubTypeQualId": "(val)",
    "submissionTypeCode": "(val)",
    "submissionTypeQualCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validProtoSubTypeQualId": "(val)",
    "submissionTypeCode": "(val)",
    "submissionTypeQualCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Iacuc Valid Protocol Submission Type Qualifiers with Filtering
GET/iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/

Example URI

GET /iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/
URI Parameters
HideShow
validProtoSubTypeQualId
string (optional) 

Valid Protocol Submission Type Qualifier Id. Maximum length is 12.

submissionTypeCode
string (optional) 

Protocol Submission Type Code. Maximum length is 3.

submissionTypeQualCode
string (optional) 

IACUC Submission Type Qual Code. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "validProtoSubTypeQualId": "(val)",
    "submissionTypeCode": "(val)",
    "submissionTypeQualCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validProtoSubTypeQualId": "(val)",
    "submissionTypeCode": "(val)",
    "submissionTypeQualCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Iacuc Valid Protocol Submission Type Qualifiers
GET/iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/

Example URI

GET /iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "validProtoSubTypeQualId",
    "submissionTypeCode",
    "submissionTypeQualCode"
  ],
  "primaryKey": "validProtoSubTypeQualId"
}

Get Blueprint API specification for Iacuc Valid Protocol Submission Type Qualifiers
GET/iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/

Example URI

GET /iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Iacuc Valid Protocol Submission Type Qualifiers.md"
transfer-encoding: chunked

Update Iacuc Valid Protocol Submission Type Qualifiers
PUT/iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/(key)

Example URI

PUT /iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "validProtoSubTypeQualId": "(val)",
  "submissionTypeCode": "(val)",
  "submissionTypeQualCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Iacuc Valid Protocol Submission Type Qualifiers
PUT/iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/

Example URI

PUT /iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "validProtoSubTypeQualId": "(val)",
    "submissionTypeCode": "(val)",
    "submissionTypeQualCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validProtoSubTypeQualId": "(val)",
    "submissionTypeCode": "(val)",
    "submissionTypeQualCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Iacuc Valid Protocol Submission Type Qualifiers
PATCH/iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/(key)

Example URI

PATCH /iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "validProtoSubTypeQualId": "(val)",
  "submissionTypeCode": "(val)",
  "submissionTypeQualCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "validProtoSubTypeQualId": "(val)",
  "submissionTypeCode": "(val)",
  "submissionTypeQualCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Iacuc Valid Protocol Submission Type Qualifiers
POST/iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/

Example URI

POST /iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "validProtoSubTypeQualId": "(val)",
  "submissionTypeCode": "(val)",
  "submissionTypeQualCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "validProtoSubTypeQualId": "(val)",
  "submissionTypeCode": "(val)",
  "submissionTypeQualCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Iacuc Valid Protocol Submission Type Qualifiers
POST/iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/

Example URI

POST /iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "validProtoSubTypeQualId": "(val)",
    "submissionTypeCode": "(val)",
    "submissionTypeQualCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validProtoSubTypeQualId": "(val)",
    "submissionTypeCode": "(val)",
    "submissionTypeQualCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "validProtoSubTypeQualId": "(val)",
    "submissionTypeCode": "(val)",
    "submissionTypeQualCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validProtoSubTypeQualId": "(val)",
    "submissionTypeCode": "(val)",
    "submissionTypeQualCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Iacuc Valid Protocol Submission Type Qualifiers by Key
DELETE/iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/(key)

Example URI

DELETE /iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Valid Protocol Submission Type Qualifiers
DELETE/iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/

Example URI

DELETE /iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Iacuc Valid Protocol Submission Type Qualifiers with Matching
DELETE/iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/

Example URI

DELETE /iacuc/api/v1/iacuc-valid-protocol-submission-type-qualifiers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

validProtoSubTypeQualId
string (optional) 

Valid Protocol Submission Type Qualifier Id. Maximum length is 12.

submissionTypeCode
string (optional) 

Protocol Submission Type Code. Maximum length is 3.

submissionTypeQualCode
string (optional) 

IACUC Submission Type Qual Code. Maximum length is 3.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Lite View Iacuc Protocol Submissions

Get Lite View Iacuc Protocol Submissions by Key
GET/iacuc/api/v1/lite-view-iacuc-protocol-submissions/(key)

Example URI

GET /iacuc/api/v1/lite-view-iacuc-protocol-submissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "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 Iacuc Protocol Submissions
GET/iacuc/api/v1/lite-view-iacuc-protocol-submissions/

Example URI

GET /iacuc/api/v1/lite-view-iacuc-protocol-submissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Submissions with Filtering
GET/iacuc/api/v1/lite-view-iacuc-protocol-submissions/

Example URI

GET /iacuc/api/v1/lite-view-iacuc-protocol-submissions/
URI Parameters
HideShow
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) 

IACUC 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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "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 Iacuc Protocol Submissions
GET/iacuc/api/v1/lite-view-iacuc-protocol-submissions/

Example URI

GET /iacuc/api/v1/lite-view-iacuc-protocol-submissions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "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 Iacuc Protocol Submissions
GET/iacuc/api/v1/lite-view-iacuc-protocol-submissions/

Example URI

GET /iacuc/api/v1/lite-view-iacuc-protocol-submissions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Lite View Iacuc Protocol Submissions.md"
transfer-encoding: chunked

Update Lite View Iacuc Protocol Submissions
PUT/iacuc/api/v1/lite-view-iacuc-protocol-submissions/(key)

Example URI

PUT /iacuc/api/v1/lite-view-iacuc-protocol-submissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  204

Update Multiple Lite View Iacuc Protocol Submissions
PUT/iacuc/api/v1/lite-view-iacuc-protocol-submissions/

Example URI

PUT /iacuc/api/v1/lite-view-iacuc-protocol-submissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  204

Update Specific Attributes Lite View Iacuc Protocol Submissions
PATCH/iacuc/api/v1/lite-view-iacuc-protocol-submissions/(key)

Example URI

PATCH /iacuc/api/v1/lite-view-iacuc-protocol-submissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  204
HideShow
Body
{
  "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 Iacuc Protocol Submissions
POST/iacuc/api/v1/lite-view-iacuc-protocol-submissions/

Example URI

POST /iacuc/api/v1/lite-view-iacuc-protocol-submissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "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  201
HideShow
Body
{
  "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 Iacuc Protocol Submissions
POST/iacuc/api/v1/lite-view-iacuc-protocol-submissions/

Example URI

POST /iacuc/api/v1/lite-view-iacuc-protocol-submissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "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  201
HideShow
Body
[
  {
    "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 Iacuc Protocol Submissions by Key
DELETE/iacuc/api/v1/lite-view-iacuc-protocol-submissions/(key)

Example URI

DELETE /iacuc/api/v1/lite-view-iacuc-protocol-submissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Lite View Iacuc Protocol Submissions
DELETE/iacuc/api/v1/lite-view-iacuc-protocol-submissions/

Example URI

DELETE /iacuc/api/v1/lite-view-iacuc-protocol-submissions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Lite View Iacuc Protocol Submissions with Matching
DELETE/iacuc/api/v1/lite-view-iacuc-protocol-submissions/

Example URI

DELETE /iacuc/api/v1/lite-view-iacuc-protocol-submissions/
URI Parameters
HideShow
_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) 

IACUC 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
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Valid Iacuc Protocol Action Correspondence

Get Valid Iacuc Protocol Action Correspondence by Key
GET/iacuc/api/v1/valid-iacuc-protocol-action-correspondence/(key)

Example URI

GET /iacuc/api/v1/valid-iacuc-protocol-action-correspondence/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "validProtoActionCorespId": "(val)",
  "protocolActionTypeCode": "(val)",
  "protoCorrespTypeCode": "(val)",
  "finalFlag": "(val)",
  "_primaryKey": "(val)"
}

Get All Valid Iacuc Protocol Action Correspondence
GET/iacuc/api/v1/valid-iacuc-protocol-action-correspondence/

Example URI

GET /iacuc/api/v1/valid-iacuc-protocol-action-correspondence/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "validProtoActionCorespId": "(val)",
    "protocolActionTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "finalFlag": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validProtoActionCorespId": "(val)",
    "protocolActionTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "finalFlag": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Valid Iacuc Protocol Action Correspondence with Filtering
GET/iacuc/api/v1/valid-iacuc-protocol-action-correspondence/

Example URI

GET /iacuc/api/v1/valid-iacuc-protocol-action-correspondence/
URI Parameters
HideShow
validProtoActionCorespId
string (optional) 

Valid Proto Action Coresp Id. Maximum length is 12.

protocolActionTypeCode
string (optional) 

Iacuc Protocol Action Type. Maximum length is 3.

protoCorrespTypeCode
string (optional) 

Iacuc Protocol Correspondence Type. Maximum length is 3.

finalFlag
string (optional) 

Final Flag. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "validProtoActionCorespId": "(val)",
    "protocolActionTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "finalFlag": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validProtoActionCorespId": "(val)",
    "protocolActionTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "finalFlag": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Valid Iacuc Protocol Action Correspondence
GET/iacuc/api/v1/valid-iacuc-protocol-action-correspondence/

Example URI

GET /iacuc/api/v1/valid-iacuc-protocol-action-correspondence/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "validProtoActionCorespId",
    "protocolActionTypeCode",
    "protoCorrespTypeCode",
    "finalFlag"
  ],
  "primaryKey": "validProtoActionCorespId"
}

Get Blueprint API specification for Valid Iacuc Protocol Action Correspondence
GET/iacuc/api/v1/valid-iacuc-protocol-action-correspondence/

Example URI

GET /iacuc/api/v1/valid-iacuc-protocol-action-correspondence/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Valid Iacuc Protocol Action Correspondence.md"
transfer-encoding: chunked

Update Valid Iacuc Protocol Action Correspondence
PUT/iacuc/api/v1/valid-iacuc-protocol-action-correspondence/(key)

Example URI

PUT /iacuc/api/v1/valid-iacuc-protocol-action-correspondence/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "validProtoActionCorespId": "(val)",
  "protocolActionTypeCode": "(val)",
  "protoCorrespTypeCode": "(val)",
  "finalFlag": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Valid Iacuc Protocol Action Correspondence
PUT/iacuc/api/v1/valid-iacuc-protocol-action-correspondence/

Example URI

PUT /iacuc/api/v1/valid-iacuc-protocol-action-correspondence/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "validProtoActionCorespId": "(val)",
    "protocolActionTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "finalFlag": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validProtoActionCorespId": "(val)",
    "protocolActionTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "finalFlag": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Valid Iacuc Protocol Action Correspondence
PATCH/iacuc/api/v1/valid-iacuc-protocol-action-correspondence/(key)

Example URI

PATCH /iacuc/api/v1/valid-iacuc-protocol-action-correspondence/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "validProtoActionCorespId": "(val)",
  "protocolActionTypeCode": "(val)",
  "protoCorrespTypeCode": "(val)",
  "finalFlag": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "validProtoActionCorespId": "(val)",
  "protocolActionTypeCode": "(val)",
  "protoCorrespTypeCode": "(val)",
  "finalFlag": "(val)",
  "_primaryKey": "(val)"
}

Insert Valid Iacuc Protocol Action Correspondence
POST/iacuc/api/v1/valid-iacuc-protocol-action-correspondence/

Example URI

POST /iacuc/api/v1/valid-iacuc-protocol-action-correspondence/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "validProtoActionCorespId": "(val)",
  "protocolActionTypeCode": "(val)",
  "protoCorrespTypeCode": "(val)",
  "finalFlag": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "validProtoActionCorespId": "(val)",
  "protocolActionTypeCode": "(val)",
  "protoCorrespTypeCode": "(val)",
  "finalFlag": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Valid Iacuc Protocol Action Correspondence
POST/iacuc/api/v1/valid-iacuc-protocol-action-correspondence/

Example URI

POST /iacuc/api/v1/valid-iacuc-protocol-action-correspondence/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "validProtoActionCorespId": "(val)",
    "protocolActionTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "finalFlag": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validProtoActionCorespId": "(val)",
    "protocolActionTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "finalFlag": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "validProtoActionCorespId": "(val)",
    "protocolActionTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "finalFlag": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "validProtoActionCorespId": "(val)",
    "protocolActionTypeCode": "(val)",
    "protoCorrespTypeCode": "(val)",
    "finalFlag": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Valid Iacuc Protocol Action Correspondence by Key
DELETE/iacuc/api/v1/valid-iacuc-protocol-action-correspondence/(key)

Example URI

DELETE /iacuc/api/v1/valid-iacuc-protocol-action-correspondence/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Valid Iacuc Protocol Action Correspondence
DELETE/iacuc/api/v1/valid-iacuc-protocol-action-correspondence/

Example URI

DELETE /iacuc/api/v1/valid-iacuc-protocol-action-correspondence/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Valid Iacuc Protocol Action Correspondence with Matching
DELETE/iacuc/api/v1/valid-iacuc-protocol-action-correspondence/

Example URI

DELETE /iacuc/api/v1/valid-iacuc-protocol-action-correspondence/
URI Parameters
HideShow
_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) 

Iacuc Protocol Action Type. Maximum length is 3.

protoCorrespTypeCode
string (optional) 

Iacuc Protocol Correspondence Type. Maximum length is 3.

finalFlag
string (optional) 

Final Flag. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Generated by aglio on 31 Oct 2019