Appearance
Reference
Enums, exception names, route trees, storage keys, and other constants used by GET Mobile 5.1.20.
Enums
Account type
| Value | Name | Meaning |
|---|---|---|
1 | MEALS | Meal plan (swipes / meal points) |
2 | CHARGE | Charge account (paid later) |
3 | DECLINING_BALANCE | Prepaid declining balance |
4 | APPLEPAY | Apple Pay funding source |
Payment category
| Value | Name | Meaning |
|---|---|---|
1 | CREDIT | Credit card / Apple Pay |
2 | BILLME | Bill-me tender |
Payment system type
| Value | Name | Class |
|---|---|---|
1 | OPCS | Campus card |
2 | CSGOLD | Campus card |
3 | MONETRA | Credit card |
4 | USAEPAY | Credit card |
Transaction type
commerce.retrieveTransactionHistory* → transactions[].transactionType.
| Value | Name | Sign in the UI |
|---|---|---|
1 | debit | - |
3 | deposit | + |
4 | co_delete | - |
These are the only three names in the client. The wrapper docs describe 4 as automated deductions such as expired funds; that is an interpretation of what produces the record, not a label the app has.
Order type
| Value | Meaning |
|---|---|
0 | Pickup |
1 | Delivery |
2 | Dine-in |
Order status
| Value | Name |
|---|---|
1 | PENDING |
2 | MERCHANT_SUBMITTED |
3 | MERCHANT_ACKNOWLEDGED |
4 | PREPARING |
5 | READY |
6 | DELIVERING |
7 | FULFILLED |
8 | USER_CANCELLED |
9 | ADMIN_CANCELLED |
10 | FAILED |
11 | REFUNDED |
Status filters used by the order-history UI:
| Filter | Statuses included |
|---|---|
All | all 11 |
Pending | 1 |
Completed | 2, 3, 4, 5, 6, 7, 11 |
Canceled | 8, 9, 10 |
Notification type
| Value | Name |
|---|---|
1 | EMAIL |
2 | PHONE |
8 | PUSH_NOTIFICATION |
Notification category
| Value | Name | Rendered in bell |
|---|---|---|
1 | order | YES |
2 | account | no |
3 | adminNotice | no |
4 | meal | no |
5 | reward | no |
6 | photoUpload | YES |
7 | automaticDeposit | no |
8 | lowBalance | no |
9 | guestDeposit | no |
10 | walkOut | no |
Notification status
| Value | Name |
|---|---|
1 | NOT_CONFIRMED |
2 | STALE |
3 | CONFIRMED |
4 | INVALID |
Bounce status
| String | Int |
|---|---|
NONE | 1 |
TRANSIENT | 2 |
PERMANENT | 3 |
Photo status
| Value | Name |
|---|---|
0 | PENDING |
1 | ACCEPTED |
2 | REJECTED |
3 | REPLACED |
4 | DELETED |
5 | WORKING (client-only) |
Photo type
| Value | Name | Notes |
|---|---|---|
-2 | CURRENT | Client-only marker for the photo the user is replacing. |
-1 | PROFILE_PENDING | Client-only marker for a local profile photo awaiting upload. |
0 | PROFILE | Profile photo. Uploaded as PENDING, approved by staff. |
1 | GOVT_ID_FRONT | Government ID, front. |
2 | GOVT_ID_BACK | Government ID, back. |
Card type
| Value | Name |
|---|---|
0 | AmericanExpress |
1 | Discover |
2 | MasterCard |
3 | Visa |
4 | Diners |
5 | Dindes (typo in the app) |
Reward level status
| Value | Name | Meaning |
|---|---|---|
0 | locked | Level not reached |
1 | unlocked | Level reached, nothing claimed |
2 | claimed | A reward on this level has been claimed |
3 | received | A reward on this level has been received |
Reward claim status
| Value | Name | Meaning |
|---|---|---|
0 | unearned | Not yet earned |
1 | earned | Available to claim |
2 | claimed | Claimed, ready to scan |
3 | received | Consumed |
Reward opt-in status
| Value | Name |
|---|---|
0 | no |
1 | yes |
Auto-deposit type
| Value | Name |
|---|---|
0 | automaticDepositOff |
1 | timeBased |
2 | lowBalance |
Mobile access response code
| Value | Meaning |
|---|---|
"00" | Success |
Any other value (compared as a string) is an error.
Environment
| Value | Name |
|---|---|
0 | develop |
1 | feature1 |
4 | demo |
5 | production |
prodCanada and prodUK are selected by hostname string, not this enum.
Institution authentication type
Login is described by two fields on the institution record. They are different types and are read by different parts of the app, so a value in one does not imply anything about the other.
institution.authenticationSystemType (number) is the enum the in-app login page reads:
| Value | Name |
|---|---|
1 | HOSTED |
2 | LDAP |
3 | SSO_GENERIC |
4 | CAS |
5 | OKTA |
6 | OKTA_EXT |
institution.authenticationInfo.authenticationType (string) is what decides whether a password form is shown at all. The app tests for "CAS", "SSO_GENERIC" and "OKTA_EXT"; any of those routes login through the hosted browser flow. Any other string, or a missing authenticationInfo, keeps the user in the in-app form.
Credential status
See Mobile Credentials.
| Value | Name |
|---|---|
0 | DISABLED |
1 | AVAILABLE |
3 | CREATED |
5 | REVOKED |
20 | PROVISIONED |
26 | PROCESSING |
Template / issuer status
| Value | Name |
|---|---|
0 | Disabled |
1 | Available |
4 | SuspendRequested |
5 | Suspended |
6 | UnlinkRequested |
7 | DisableRequested |
8 | ResumeRequested |
20 | StatusActive |
Issuer
| Value | Platform |
|---|---|
APPLE | iOS |
HID | Android |
HID_WALLET | Android |
ALLEGION | Android (Google Wallet) |
Exceptions
The exception string in a response is normally {Name}|{detail} or {code}|{detail}. GET Mobile maps the leading token to one of these localized strings (get_common.error.* in en.json).
| Exception | Message |
|---|---|
AlreadyOnPlanException | You are already on the plan selected. |
AuthenticationFailureException | Login failed, please try again. |
AuthenticationFault | Login failed due to a configuration problem. Please try again or contact Support. |
BadPasswordException | The new password must be at least 7 characters, contain one number and cannot be one of your last 4 passwords. |
BadRegistrationConfirmationException | Invalid confirmation code. Please check your code and try again. |
BadResponseException | General error encountered. Please try again or contact support. |
ContentFault | An unexpected error occurred creating screen or notification content, please use About to contact support. |
ContentTemplateException | An unexpected error occurred creating screen or notification content, please use About to contact support. |
EntityConstraintViolationError | A value entered is too long, please shorten and retry. |
InstitutionInactiveException | This institution is currently inactive and is not allowing logins. |
InsufficientFundsException | There are insufficient funds in the selected account |
InvalidCardTypeException | [card_name] is not accepted. Try adding a different card. |
InvalidConfigurationException | General error encountered due to a configuration problem. Please try again or contact support. |
InvalidConfirmationCodeException | The specified confirmation code is not valid. |
InvalidEmailException | The provided email is invalid or not from the required domain. |
InvalidPhoneException | Given phone number is invalid, please use the format: ###-###-#### |
InvalidServiceArgumentException | General error encountered. Please try again or contact support. |
MaxBadPasswordFailureException | Too many incorrect logins. Please reset password and try again. |
MediaAddressException | Invalid address specified for this card. |
MediaAlreadyLostException | The given media is already flagged as lost. |
MediaDeniedException | Transaction denied for specified card. |
MediaExpiredException | The specified card has expired. |
MediaLostException | The specified card has been reported lost. |
MediaNotFoundException | Media or user not found. |
MediaNotLostException | The given media is not flagged as lost. |
MediaSystemPatronNotFoundException | User not found. Please visit your card office. |
MediaValidationException | Invalid card number. |
MediaVerificationCodeException | Your information could not be verified. |
NonZeroChargeBalanceException | You have a non-zero charge balance on a charge tender that doesn't exist in the new plan. |
NoSuchSessionException | Your session has expired. |
NoSuchUserException | The specified user is not valid. |
NoUserInSessionException | Your session has expired. Please login again |
OrderContactInformationException | Please supply a phone number we can reach you at |
OrderDeliveryAddressException | The delivery address is not fully specified or outside the merchant's delivery area |
OrderDeliveryAddressRestriction | Delivery is restricted to on-campus addresses for this merchant |
OrderDeliveryMinimumException | ${raw_error_message} |
OrderFault | An unexpected error occurred, please try again or use About to contact support. |
OrderInvalidException | Your order cannot be accepted due to missing selections or a system error |
OrderMaximumException | ${raw_error_message} |
OrderMenuUnavailableException | The chosen menu is not available at the order time |
OrderMerchantOrderCapacityException | We are at maximum capacity and unable to accept your order at this time, please try again later. |
OrderMinimumException | ${raw_error_message} |
OrderOptionMaximumException | You have exceeded the maximum selections on one of the item options |
OrderOptionMinimumException | You are missing a required selection on one of the item options |
OrderOutsideDeliveryAddress | The delivery address is outside the merchant's delivery area |
OrderPaymentException | There was an unexpected problem submitting payment for your order. Please try again. |
OrderStatusException | The order status cannot be changed |
OrderStoreClosedException | The merchant is closed at the requested order time |
OrderTipException | The Order Tip amount cannot be negative or greater than the order subtotal. |
OrderTypeException | The order type was not supplied or is not supported by this merchant |
PaymentSystemBusinessLogicException | Transaction rejected. Details: ${raw_error_message} |
PaymentSystemGatewayException | An error occurred while communicating with the card office or credit card processor. Please try again or contact Support. |
PlanInvalidException | The plan does not exist. |
RewardsDisabledForUserException | Use of GET Rewards has been disabled for this user. |
StaleEntityVersionException | There was a problem saving your data. Please try again. |
TimeoutException | Request timed out. Please try again later. |
TransactionCountExceededException | You have exceeded the system configured maximum transaction count for the day. |
UnknownSOAException | General error encountered. Please try again or contact support. |
UserAlreadyRegisteredException | The specified user has already registered. |
UserNotAuthorizedException | You do not have the necessary permissions to perform the requested operation. |
UserNotConfirmedException | Your email is not confirmed. To receive another confirmation email, please re-register. |
Registration-specific codes:
| Code | Message |
|---|---|
7001 | A confirmed cashless user already exists and can not be added again |
9505 | Your password contains some weird combination, try another. |
6101 | Cannot find a match for given user information |
Numeric HTTP/gateway codes:
| Code | Message |
|---|---|
9004 | There was an issue with the transaction, user phone number missing and required |
9801 | Invalid Service Argument Exception |
9997 | Timeout error, please try again later |
9999 | Unable to parse response |
4001 | Session not found |
4002 | No user associated with this session |
6100 | There was an issue with your transaction. Contact your institution for more details. |
Ordering error codes
| Code | Enum |
|---|---|
9001 | DELIVERY_ADDRESS_COORDS |
9002 | ORDER_DELIVERY_ITEM_MIN |
9003 | ORDER_TYPE |
9004 | CONTACT_INFO |
9005 | ORDER_ITEM_MIN |
9006 | ORDER_ITEM_MAX |
9007 | ITEM_OPTION_MIN |
9008 | ITEM_OPTION_MAX |
9009 | ORDER_PAYMENT |
9010 | INVALID_ORDER |
9011 | MERCHANT_CLOSED |
9012 | MENU_UNAVAILABLE |
9013 | ORDER_STATUS |
9014 | ORDER_TIP |
9016 | DUPLICATE_ORDER |
9017 | ORDER_CAPACITY |
9023 | NOT_AVAILABLE_SLOTS |
9024 | INVALID_ITEMS_FOR_DUE_TIME |
6001 | INVALID_CARD |
6102 | MEDIA_LOST |
6112 | INSUFFICIENT_FUNDS |
6113 | PAYMENT_SYSTEM_EXCEPTION |
Client-only pseudo-codes:
| Code | Name |
|---|---|
0 Unknown Error | CONNECTION_LOST |
Timeout | CONNECTION_TIMEOUT |
Routes
Patron
plaintext
patron/dashboard
patron/rewards
patron/openmydoor
patron/accounts
patron/accounts/transactions
patron/accounts/add-funds
patron/accounts/add-credit-card
patron/accounts/automatic-deposit
patron/accounts/meal-donations
patron/ordering
patron/ordering/full-menu
patron/ordering/cart
patron/ordering/recent-orders
patron/ordering/saved-addresses
patron/ordering/favorite-merchants
patron/explore
patron/biometric
patron/settings
patron/notificationsGuest
plaintext
guest/dashboard
guest/explore
guest/ordering
guest/deposit
guest/settings
guest/registration
guest/notificationsOrdering sub-routes shared by both profiles:
plaintext
recent-orders
favorite-merchants
saved-addresses
full-menu
cart
menu-category-items
item-detail
address-edit
checkin
item-manual-entryStorage keys
The app persists state on-device under these keys:
| Key | Contents |
|---|---|
get_sessionId | Current user session id (high priority). The system session is never stored. |
isGuestUser | true when logged in as guest |
get_institution | Cached institution record |
get_institutionPhotoKey | Cached institution photo |
get_user | Cached user record (TTL) |
get_user_address | Cached address list |
guestSetting | Guest deposit / registration settings |
cart | In-progress cart (kept 7 days) |
current_environment / overrided_environment | Environment override |
fcm_token | Push token |
cbord_gcs | Analytics/remote config |
userDeniedBiometricPermission | Biometric opt-out |
user_local_profile | Local profile cache |
jwt_token | OmniID JWT |
auth_blob | Mobile-credential authorization blob |
mobile_credential | Cached credential data |
User settings (server-side, via /json/user):
| Setting | Contents |
|---|---|
CashlessKey | CBORD patron key used to build the SOA barcode (numeric, ≤ 32 bits) |
quick_amount | Last deposit amount |
mobileaccess_favorites | Favorited doors |
defaultaddress | Default delivery address |
mobileCredentialID | Credential id |
get.deposit.guest.recipients | Saved guest-deposit recipients (JSON) |
Identifiers
Three different numbers identify a patron. They are not interchangeable.
| Identifier | Where it comes from | Example use |
|---|---|---|
User id (user.id) | user.retrieve — the CBORD user record | userId on orders, deposits, photos |
Patron key (CashlessKey setting) | user.retrieveSetting { "settingName": "CashlessKey" } | Input to SOA barcode generation |
| Display media value | commerce.retrieveCashlessPatronMobileDisplayMediaValue | The ID: label printed on the barcode/access screen |
IMPORTANT
The ID: label is the institution's identifier (verified: a university student ID), not the CBORD patron key. The two have no required relationship. Barcode generation uses the CashlessKey setting — never the displayed label. See SOA Barcode.
Native bridge
window.NativeInterface methods used by the web layer:
| Method | Purpose |
|---|---|
getSessionId | Current session id |
getInstitutionId | Current institution id |
getDestinationPage | Native navigation target |
getUserInfo | User object |
getAcceptedUserPhoto | Approved ID photo |
getAppleWalletInfo | Wallet credential state |
addToAppleWallet | Start Apple Wallet provisioning |
getPatronBarcode | Native barcode (used on Android) |
addUSAePayCreditCard | Native USAePay card entry |
ordersApplePay | Apple Pay for an order |
depositsApplePay | Apple Pay for a deposit |
updateNativeWithRoute | Sync route to native shell |
iOS postMessage handler: window.webkit.messageHandlers.JSListener.postMessage({ promiseId, methodName, ... }). Android calls the method directly on androidInterface.
Native events listened to:
| Event | Purpose |
|---|---|
ApplePayEvent | Apple Pay result URL |
browserFinished | In-app browser closed |
FINISHED | Payment/deposit finished |
appStateChange | Foreground/background |
appUrlOpen | Deep link |
Push notifications and deep links
Push registration
When get.feature.enable_push_notification is "1" and the platform is native, the app registers for push after login:
- Requests notification permission.
- Calls the native push plugin's
register(). - On the
registrationevent, stores the token infcm_tokenand calls/json/usersaveNotificationwith:
json
{
"userId": "{USER_ID}",
"notification": {
"id": "{EXISTING_NOTIFICATION_ID_OR_NULL}",
"type": 8,
"value": "{FCM_OR_APNS_TOKEN}",
"provider": "ios"
},
"sessionId": "{SESSION_ID}"
}type: 8 is PUSH_NOTIFICATION; provider is ios or android. If the user already has a push entry, its id is reused so the record is updated instead of duplicated.
On logout the app calls logoutAndRemoveUserNotification with the same object, clears delivered notifications, and deletes the stored token.
Deep links
appUrlOpen events whose URL contains cbord.com are treated as deep links. The app takes the URL pathname, splits it into segments, and after login navigates to that route (clearing the pending path once used). This lets links such as https://get.cbord.com/.../patron/ordering/... open directly into the app.
Guest deep links are restricted to the guest route set before navigation.
Content domains
| Domain | Categories |
|---|---|
patron-ui | core-ui, mobile-access, rewards, accounts, transactions, location_disclosure_screen, meal_donation, ordering, checkin, login_screen, forgot-password, registration, mobile-credential, deposit, photo_upload, notifications, error_message |
| (root) | month_abbreviated, day-of-week_abbreviated, us_states, us-state_full, error_message, ordering, menu |
Modal button strings: button_cancel, button_retry, button_ok.
Legacy constants
The bundle still contains older web-app endpoints that GET Mobile does not use for its main flows:
| Constant | Value |
|---|---|
ServiceUrl.DEVELOPMENT | https://services.get.dev.cbord.com/GETServices/services |
ServiceUrl.DEMO | http://getdemo.cbord.com/GETServices/services |
ServiceUrl.PRODUCTION | https://services.get.cbord.com/GETServices/services |
BaseUrl.DEVELOPMENT | https://student.dev.cbord.com |
BaseUrl.DEMO | https://student.demo.cbord.com |
BaseUrl.PRODUCTION | https://student.cbord.com |
Telemetry
The app reports product analytics and crashes outside the GETServices API; this traffic does not touch services_url.
| Destination | Behaviour |
|---|---|
PostHog (https://us.i.posthog.com) | Initialised only in production builds. Autocapture and pageviews are off. Session recording is enabled with maskAllInputs: true and text matching .sensitive masked. |
| Sentry | Error reporting with breadcrumbs and a buffer of recent UI click events attached to each report. |
The PostHog project keys are compiled into the bundle. They are publishable client keys, not credentials, but they do identify the app's analytics project.
Method index
A compact index of every method and its parameter shape. See the per-service pages for full request/response documentation.
/json/authentication
| Method | Params |
|---|---|
authenticateSystem | systemCredentials |
authenticateUser | systemCredentials, userCredentials{userName,password,domain,institutionId} |
authenticateGuestUser | same as authenticateUser |
authenticatePIN | systemCredentials, deviceId, pin |
authenticateSessionToken | systemCredentials, sessionToken |
getAuthenticationToken | sessionId |
retrieveExternalAuthenticationToken | tokenType, externalSystem, claimSet, sessionId, institutionId |
retrieveAuthorizationBlob | deviceModel, deviceOSVersion, sessionId, institutionId |
retrievePatronBarcodePayload | sessionId |
/json/user
| Method | Params |
|---|---|
retrieve | sessionId, institutionId |
update | user, forceOverwrite |
changePassword | oldPassword, newPassword |
createPIN | PIN, deviceId |
retrieveSetting | settingName |
saveSetting | settingName, settingValue |
deleteSetting | settingName |
retrieveUserPhoto | photoId |
retrieveUserPhotoList | userId |
retrieveFullUserPhotoList | userId |
retrievePendingOrRejectedUserPhoto | userId |
addUserPhoto | userId, photo |
updateUserPhotoStatus | photoId, status, reason |
retrieveUserAddressList | userId, addressId |
updateUserAddress | address, userId |
deleteUserAddress | addressId, userId |
addressToGeocode | address |
reportCardLost / reportCardFound | sessionId |
updateUserStatus | sessionId |
retrieveUserIdByCashlessFields | institutionId, sessionId, cashlessData{lookupFields} |
requestDeposit | recipientName, recipientEmail, message, depositToAccountId, requestAmount |
saveNotification | userId, notification |
logoutAndRemoveUserNotification | userId, notification |
retrieveAllUserNotifications | userId |
retrieveAutoDepositSettings | userId |
updateAutoDepositSettings | userAutoDepositSettingInfo |
retrieveRegistrationFields | sessionId, institutionId |
register | registrationInfo{institutionId,userName,password,phone,registrationFields{lookupFields}} |
/json/userNotification
| Method | Params |
|---|---|
createUserNotificationLog | title, content, domain, category |
retrieveAll | includeViewed, includeDismissed, includePinned |
retrive | userNotificationLogId |
markUserNotificationLogAsViewed | userNotificationLogId |
markUserNotificationLogAsDismissed | userNotificationLogId |
updatePinnedOnUserNotificationLog | userNotificationLogId, value |
getNotificationLogCount | includeViewed, includeDismissed |
markAllUserNotificationLogAsViewed | — |
/json/commerce
| Method | Params |
|---|---|
retrieveAccounts | — |
deactivateAccount | account fields |
retrieveCashlessPatronMobileDisplayMediaValue | — |
retrieveTransactionHistory | paymentSystemType, queryCriteria |
retrieveTransactionHistoryWithinDateRange | paymentSystemType, queryCriteria |
calculateDepositFee | fromAccountId, toAccountId, amount |
deposit | fromAccountId, toAccountId, fromAccountCvv, amount, cashlessTerminalLocation |
depositForUserFromAnyAccount | userId, fromAccountId, fromAccountCvv, toAccountId, amount, cashlessTerminalLocation |
donate | accountId, amountToDonate |
createAccount | accountInfo |
retrieveAccountsByUser | userId |
retrieveDepositAccountsByUser | userId |
retrieveCreditPaymentMethodsByPaymentSystem | sessionId, paymentSystemId, userId |
retrieveAutoDepositAccountList | userId, paymentType |
getMobileLocations | filters, latitude, longitude, accuracy |
activateMobileLocation | locationId, tranDate, latitude, longitude, accuracy, altitude, altitudeAccuracy, speed, heading, sourceInfo |
/json/institution
| Method | Params |
|---|---|
retrieve | institutionId, optional sessionId |
retrieveByShortName | shortName, optional sessionId |
retrieveInstitutionPhoto | institutionId, optional sessionId |
retrieveLookupList | sessionId |
retrieveAnonymousDepositFields | institutionId, sessionId |
retrieveBuildings | active |
/json/configuration and /json/content
| Method | Params |
|---|---|
retrieveSetting | domain, category, name |
retrieveSettingList | domain, category |
nativeStartup | clientType, clientVersion |
retrieveString | domain, category, name, locale |
retrieveStringList | domain, category, locale |
/json/merchant
| Method | Params |
|---|---|
getMerchants | searchOptions |
getMenuMerchants | searchOptions |
getFavoriteMerchants | excludeNonOrdering |
addFavoriteMerchant | merchantId, notes |
removeFavoriteMerchant | merchantId |
getMerchantSettings | merchantId, domain, category, name |
retrievePickupAddressesInRange | merchantId |
isOutsideMerchantDeliveryArea | merchantId, latitude, longitude |
getMerchantPaymentAccountsWithFilter | merchantId, options, userId |
getDisplayMenu | merchantId, dateTime, orderType, locale, depth |
getDisplayMenus | same as getDisplayMenu |
/json/ordering
| Method | Params |
|---|---|
validateOrder | order |
validateOrderItems | order, validateOrderResult |
validateOrderAddOns | order fields, orderID, itemsToAdd, accountID |
addItemsToOrder | order fields, clientAddItemsID, orderID, itemsToAdd, cvv, accountID |
submitOrder | order, accountId, cvv |
cancelOrder | orderId |
retrieveSuccessfulOrdersList | userId, merchantId, maxReturn |
retrieveOrderList | userId, merchantId, institutionId, startDate, endDate, orderStatuses, maxReturn |
getMerchantOrderSchedule | merchantId, orderType, startDate, endDate |
checkInOrder | orderId, latitude, longitude, checkinBarcode |
/json/rewards
| Method | Params |
|---|---|
retrieveUserRewardTrackInfo | headerOnly |
retrieveUserRewardHistory | rewardTrackId, startDate, endDate, filters |
optUserIntoRewardTrack | trackId, userId |
claimRewardV2 | rewardId |
/json/notification
| Method | Params |
|---|---|
resetPasswordNotification | institutionId, userName, sessionId |
HTTP behavior
| Item | Value |
|---|---|
| Method | Always POST |
| Content type | application/json |
| Accept | application/json |
| Default timeout | 30 000 ms |
| Partner-services timeout | 45 000 ms |
| Success wrapper | { "response": ..., "exception": null } |
| Error wrapper | `{ "response": null, "exception": " |