Appearance
Institution
Service path: /json/institution
Institution calls return metadata about a campus: name, short name, currency and date formats, guest settings, photos, buildings, and the guest-deposit lookup fields.
Get the Current Institution
Returns the institution bound to the cached
institutionId.
plaintext
POST /json/institution
method: retrieveParameters
institutionId is injected by the app. No business parameters.
json
{
"method": "retrieve",
"params": {
"sessionId": "{SESSION_ID}",
"institutionId": "{INSTITUTION_UUID}"
}
}Success Response
json
{
"response": {
"id": "{INSTITUTION_UUID}",
"name": "Example University",
"shortName": "example",
"type": 0,
"environmentName": null,
"currencyFormat": "$#,##0.00",
"dateFormat": "MM/dd/yyyy",
"guestLogin": 0,
"guestDeposit": 0,
"guestLoginNotRequired": 0,
"lastChangedTerms": "2026-08-01T00:00:00"
},
"exception": null
}Field notes
| Field | Meaning |
|---|---|
type | 0 = school, 1 = hospital / acute care (observed). |
authenticationSystemType | Numeric login-mechanism enum (1 HOSTED … 6 OKTA_EXT). See Institution authentication type. |
authenticationInfo.authenticationType | String login mechanism. "CAS", "SSO_GENERIC" or "OKTA_EXT" sends the user to the hosted browser login; anything else uses the in-app form. May be absent. |
currencyFormat | .NET-style currency pattern. The app takes the first character as the symbol. |
dateFormat | .NET-style date pattern. |
guestLogin | "1" when guest login is enabled. |
guestDeposit | "1" when unauthenticated deposits are enabled. |
guestLoginNotRequired | "1" when guests may order without logging in. |
lastChangedTerms | Used to decide whether to re-show the terms screen. |
Get an Institution by Id
plaintext
POST /json/institution
method: retrieve| Field | Type | Required | Description |
|---|---|---|---|
institutionId | string | YES | Institution UUID. |
sessionId | string | NO | Pass a system session for pre-login calls. |
json
{
"method": "retrieve",
"params": {
"institutionId": "{INSTITUTION_UUID}",
"sessionId": "{SYSTEM_SESSION_ID}"
}
}Get an Institution by Short Name
plaintext
POST /json/institution
method: retrieveByShortNamejson
{
"method": "retrieveByShortName",
"params": {
"shortName": "example",
"sessionId": "{SYSTEM_SESSION_ID}"
}
}TIP
shortName is what appears in URLs such as https://get.cbord.com/example/.... Use this to resolve a campus from a link or subdomain.
Get an Institution Photo
plaintext
POST /json/institution
method: retrieveInstitutionPhoto| Field | Type | Required |
|---|---|---|
institutionId | string | YES |
sessionId | string | NO |
Response:
json
{
"response": {
"id": "{PHOTO_ID}",
"mimeType": "image/png",
"data": "{BASE64_PNG}"
},
"exception": null
}List Institutions
Returns every institution in the deployment. This is the call behind the app's institution picker.
plaintext
POST /json/institution
method: retrieveLookupListParameters
| Field | Type | Required | Description |
|---|---|---|---|
sessionId | string | YES | System session. Explicit — not injected. |
json
{
"method": "retrieveLookupList",
"params": { "sessionId": "{SYSTEM_SESSION_ID}" }
}Success Response
json
{
"response": {
"institutions": [
{
"id": "{INSTITUTION_UUID}",
"name": "Example University",
"shortName": "example",
"type": 0,
"guestLogin": "0",
"guestDeposit": "1",
"guestLoginNotRequired": "0"
}
]
},
"exception": null
}NOTE
The array is at response.institutions, not response. The list is large (~470 entries on production) and is not paginated, so filter locally.
Anonymous Deposit Fields
Returns the lookup fields an unauthenticated user must supply to deposit money to a patron (for example
lastName+dateOfBirth+cardNumber).
plaintext
POST /json/institution
method: retrieveAnonymousDepositFields| Field | Type | Required | Description |
|---|---|---|---|
institutionId | string | YES | Institution UUID. |
sessionId | string | YES | System session. |
json
{
"method": "retrieveAnonymousDepositFields",
"params": {
"institutionId": "{INSTITUTION_UUID}",
"sessionId": "{SYSTEM_SESSION_ID}"
}
}Response:
json
{
"response": {
"lookupFields": [
{ "name": "lastName", "label": "Last Name", "type": "text" }
]
},
"exception": null
}List Buildings
Returns active campus buildings. Used by the delivery-address form.
plaintext
POST /json/institution
method: retrieveBuildings| Field | Type | Required | Description |
|---|---|---|---|
active | boolean | YES | Always true in the app. |
sessionId | string | YES | Injected. |
institutionId | string | YES | Injected. |
Response is { "list": [ ... ] }; the app unwraps response.list.