Ellucian Banner - Holds
Overview and Prerequisites
Prior to reviewing this page, please review the Ellucian Banner Integration Directory page, including prerequisites found here.
User Experience
The holds service allows students to view their current holds. Functionality includes:
- Display list of user's holds including description, start and end dates, originator and processes affected
- Link to Banner for additional information
Tile
| Property | Live Tile | Static Tile |
|---|---|---|
| Default Size | 1x1 | 1x1 |
| Minimum Size | 1x1 | 1x1 |
| Suggested Design |  |
 |
Screenshots
Sample Requests
| Sample Request |
|---|
|
https://{HOST}/StudentApi/api/students/{userid}/holds |
| Sample Response |
|---|
{
"holdResponse":{
"link":"https://banneruniversity.edu/ssomanager/c/SSB?pkg=bwskoacc.P_ViewHold",
"holdCount":"11",
"hold":[
{
"description":"Health Services",
"startDate":"04/05/2004",
"endDate":"12/31/2099",
"originator":"Medical Services 620-2900",
"processesAffected":"Registration, Transcripts"
},
{
"description":"Need Immunization - Meng/Hep B",
"startDate":"10/23/2009",
"endDate":"12/31/2099",
"originator":"Medical Compliance 620-2175",
"processesAffected":"Registration"
}
]
}
}
|
Offline Functionality
Not supported.
Configuration Options
Not supported
Labels
| Label | Default Value |
|---|---|
| Tile name on home screen | Holds |
| Page title | Holds |
| Hold originator | Originator |
| Processes affected | Affected |
| Banner link | Click here for more details... |
| No information message | No holds |
Suggested Testing Guidelines
The following acceptance criteria is recommend to be used as part of the testing and approval process:
- Live tile updates with new notifications
- Live tile displays the correct number of notifications
- User can access the Holds tile and see their current holds
- User can deep link from the Holds tile to the appropriate Banner page.