Skip to content

Reference ​

Enums, exception names, route trees, storage keys, and other constants used by GET Mobile 5.1.20.

Enums ​

Account type ​

ValueNameMeaning
1MEALSMeal plan (swipes / meal points)
2CHARGECharge account (paid later)
3DECLINING_BALANCEPrepaid declining balance
4APPLEPAYApple Pay funding source

Payment category ​

ValueNameMeaning
1CREDITCredit card / Apple Pay
2BILLMEBill-me tender

Payment system type ​

ValueNameClass
1OPCSCampus card
2CSGOLDCampus card
3MONETRACredit card
4USAEPAYCredit card

Transaction type ​

commerce.retrieveTransactionHistory* → transactions[].transactionType.

ValueNameSign in the UI
1debit-
3deposit+
4co_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 ​

ValueMeaning
0Pickup
1Delivery
2Dine-in

Order status ​

ValueName
1PENDING
2MERCHANT_SUBMITTED
3MERCHANT_ACKNOWLEDGED
4PREPARING
5READY
6DELIVERING
7FULFILLED
8USER_CANCELLED
9ADMIN_CANCELLED
10FAILED
11REFUNDED

Status filters used by the order-history UI:

FilterStatuses included
Allall 11
Pending1
Completed2, 3, 4, 5, 6, 7, 11
Canceled8, 9, 10

Notification type ​

ValueName
1EMAIL
2PHONE
8PUSH_NOTIFICATION

Notification category ​

ValueNameRendered in bell
1orderYES
2accountno
3adminNoticeno
4mealno
5rewardno
6photoUploadYES
7automaticDepositno
8lowBalanceno
9guestDepositno
10walkOutno

Notification status ​

ValueName
1NOT_CONFIRMED
2STALE
3CONFIRMED
4INVALID

Bounce status ​

StringInt
NONE1
TRANSIENT2
PERMANENT3

Photo status ​

ValueName
0PENDING
1ACCEPTED
2REJECTED
3REPLACED
4DELETED
5WORKING (client-only)

Photo type ​

ValueNameNotes
-2CURRENTClient-only marker for the photo the user is replacing.
-1PROFILE_PENDINGClient-only marker for a local profile photo awaiting upload.
0PROFILEProfile photo. Uploaded as PENDING, approved by staff.
1GOVT_ID_FRONTGovernment ID, front.
2GOVT_ID_BACKGovernment ID, back.

Card type ​

ValueName
0AmericanExpress
1Discover
2MasterCard
3Visa
4Diners
5Dindes (typo in the app)

Reward level status ​

ValueNameMeaning
0lockedLevel not reached
1unlockedLevel reached, nothing claimed
2claimedA reward on this level has been claimed
3receivedA reward on this level has been received

Reward claim status ​

ValueNameMeaning
0unearnedNot yet earned
1earnedAvailable to claim
2claimedClaimed, ready to scan
3receivedConsumed

Reward opt-in status ​

ValueName
0no
1yes

Auto-deposit type ​

ValueName
0automaticDepositOff
1timeBased
2lowBalance

Mobile access response code ​

ValueMeaning
"00"Success

Any other value (compared as a string) is an error.

Environment ​

ValueName
0develop
1feature1
4demo
5production

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:

ValueName
1HOSTED
2LDAP
3SSO_GENERIC
4CAS
5OKTA
6OKTA_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.

ValueName
0DISABLED
1AVAILABLE
3CREATED
5REVOKED
20PROVISIONED
26PROCESSING

Template / issuer status ​

ValueName
0Disabled
1Available
4SuspendRequested
5Suspended
6UnlinkRequested
7DisableRequested
8ResumeRequested
20StatusActive

Issuer ​

ValuePlatform
APPLEiOS
HIDAndroid
HID_WALLETAndroid
ALLEGIONAndroid (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).

ExceptionMessage
AlreadyOnPlanExceptionYou are already on the plan selected.
AuthenticationFailureExceptionLogin failed, please try again.
AuthenticationFaultLogin failed due to a configuration problem. Please try again or contact Support.
BadPasswordExceptionThe new password must be at least 7 characters, contain one number and cannot be one of your last 4 passwords.
BadRegistrationConfirmationExceptionInvalid confirmation code. Please check your code and try again.
BadResponseExceptionGeneral error encountered. Please try again or contact support.
ContentFaultAn unexpected error occurred creating screen or notification content, please use About to contact support.
ContentTemplateExceptionAn unexpected error occurred creating screen or notification content, please use About to contact support.
EntityConstraintViolationErrorA value entered is too long, please shorten and retry.
InstitutionInactiveExceptionThis institution is currently inactive and is not allowing logins.
InsufficientFundsExceptionThere are insufficient funds in the selected account
InvalidCardTypeException[card_name] is not accepted. Try adding a different card.
InvalidConfigurationExceptionGeneral error encountered due to a configuration problem. Please try again or contact support.
InvalidConfirmationCodeExceptionThe specified confirmation code is not valid.
InvalidEmailExceptionThe provided email is invalid or not from the required domain.
InvalidPhoneExceptionGiven phone number is invalid, please use the format: ###-###-####
InvalidServiceArgumentExceptionGeneral error encountered. Please try again or contact support.
MaxBadPasswordFailureExceptionToo many incorrect logins. Please reset password and try again.
MediaAddressExceptionInvalid address specified for this card.
MediaAlreadyLostExceptionThe given media is already flagged as lost.
MediaDeniedExceptionTransaction denied for specified card.
MediaExpiredExceptionThe specified card has expired.
MediaLostExceptionThe specified card has been reported lost.
MediaNotFoundExceptionMedia or user not found.
MediaNotLostExceptionThe given media is not flagged as lost.
MediaSystemPatronNotFoundExceptionUser not found. Please visit your card office.
MediaValidationExceptionInvalid card number.
MediaVerificationCodeExceptionYour information could not be verified.
NonZeroChargeBalanceExceptionYou have a non-zero charge balance on a charge tender that doesn't exist in the new plan.
NoSuchSessionExceptionYour session has expired.
NoSuchUserExceptionThe specified user is not valid.
NoUserInSessionExceptionYour session has expired. Please login again
OrderContactInformationExceptionPlease supply a phone number we can reach you at
OrderDeliveryAddressExceptionThe delivery address is not fully specified or outside the merchant's delivery area
OrderDeliveryAddressRestrictionDelivery is restricted to on-campus addresses for this merchant
OrderDeliveryMinimumException${raw_error_message}
OrderFaultAn unexpected error occurred, please try again or use About to contact support.
OrderInvalidExceptionYour order cannot be accepted due to missing selections or a system error
OrderMaximumException${raw_error_message}
OrderMenuUnavailableExceptionThe chosen menu is not available at the order time
OrderMerchantOrderCapacityExceptionWe are at maximum capacity and unable to accept your order at this time, please try again later.
OrderMinimumException${raw_error_message}
OrderOptionMaximumExceptionYou have exceeded the maximum selections on one of the item options
OrderOptionMinimumExceptionYou are missing a required selection on one of the item options
OrderOutsideDeliveryAddressThe delivery address is outside the merchant's delivery area
OrderPaymentExceptionThere was an unexpected problem submitting payment for your order. Please try again.
OrderStatusExceptionThe order status cannot be changed
OrderStoreClosedExceptionThe merchant is closed at the requested order time
OrderTipExceptionThe Order Tip amount cannot be negative or greater than the order subtotal.
OrderTypeExceptionThe order type was not supplied or is not supported by this merchant
PaymentSystemBusinessLogicExceptionTransaction rejected. Details: ${raw_error_message}
PaymentSystemGatewayExceptionAn error occurred while communicating with the card office or credit card processor. Please try again or contact Support.
PlanInvalidExceptionThe plan does not exist.
RewardsDisabledForUserExceptionUse of GET Rewards has been disabled for this user.
StaleEntityVersionExceptionThere was a problem saving your data. Please try again.
TimeoutExceptionRequest timed out. Please try again later.
TransactionCountExceededExceptionYou have exceeded the system configured maximum transaction count for the day.
UnknownSOAExceptionGeneral error encountered. Please try again or contact support.
UserAlreadyRegisteredExceptionThe specified user has already registered.
UserNotAuthorizedExceptionYou do not have the necessary permissions to perform the requested operation.
UserNotConfirmedExceptionYour email is not confirmed. To receive another confirmation email, please re-register.

Registration-specific codes:

CodeMessage
7001A confirmed cashless user already exists and can not be added again
9505Your password contains some weird combination, try another.
6101Cannot find a match for given user information

Numeric HTTP/gateway codes:

CodeMessage
9004There was an issue with the transaction, user phone number missing and required
9801Invalid Service Argument Exception
9997Timeout error, please try again later
9999Unable to parse response
4001Session not found
4002No user associated with this session
6100There was an issue with your transaction. Contact your institution for more details.

Ordering error codes ​

CodeEnum
9001DELIVERY_ADDRESS_COORDS
9002ORDER_DELIVERY_ITEM_MIN
9003ORDER_TYPE
9004CONTACT_INFO
9005ORDER_ITEM_MIN
9006ORDER_ITEM_MAX
9007ITEM_OPTION_MIN
9008ITEM_OPTION_MAX
9009ORDER_PAYMENT
9010INVALID_ORDER
9011MERCHANT_CLOSED
9012MENU_UNAVAILABLE
9013ORDER_STATUS
9014ORDER_TIP
9016DUPLICATE_ORDER
9017ORDER_CAPACITY
9023NOT_AVAILABLE_SLOTS
9024INVALID_ITEMS_FOR_DUE_TIME
6001INVALID_CARD
6102MEDIA_LOST
6112INSUFFICIENT_FUNDS
6113PAYMENT_SYSTEM_EXCEPTION

Client-only pseudo-codes:

CodeName
0 Unknown ErrorCONNECTION_LOST
TimeoutCONNECTION_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/notifications

Guest ​

plaintext
guest/dashboard
guest/explore
guest/ordering
guest/deposit
guest/settings
guest/registration
guest/notifications

Ordering 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-entry

Storage keys ​

The app persists state on-device under these keys:

KeyContents
get_sessionIdCurrent user session id (high priority). The system session is never stored.
isGuestUsertrue when logged in as guest
get_institutionCached institution record
get_institutionPhotoKeyCached institution photo
get_userCached user record (TTL)
get_user_addressCached address list
guestSettingGuest deposit / registration settings
cartIn-progress cart (kept 7 days)
current_environment / overrided_environmentEnvironment override
fcm_tokenPush token
cbord_gcsAnalytics/remote config
userDeniedBiometricPermissionBiometric opt-out
user_local_profileLocal profile cache
jwt_tokenOmniID JWT
auth_blobMobile-credential authorization blob
mobile_credentialCached credential data

User settings (server-side, via /json/user):

SettingContents
CashlessKeyCBORD patron key used to build the SOA barcode (numeric, ≤ 32 bits)
quick_amountLast deposit amount
mobileaccess_favoritesFavorited doors
defaultaddressDefault delivery address
mobileCredentialIDCredential id
get.deposit.guest.recipientsSaved guest-deposit recipients (JSON)

Identifiers ​

Three different numbers identify a patron. They are not interchangeable.

IdentifierWhere it comes fromExample use
User id (user.id)user.retrieve — the CBORD user recorduserId on orders, deposits, photos
Patron key (CashlessKey setting)user.retrieveSetting { "settingName": "CashlessKey" }Input to SOA barcode generation
Display media valuecommerce.retrieveCashlessPatronMobileDisplayMediaValueThe 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:

MethodPurpose
getSessionIdCurrent session id
getInstitutionIdCurrent institution id
getDestinationPageNative navigation target
getUserInfoUser object
getAcceptedUserPhotoApproved ID photo
getAppleWalletInfoWallet credential state
addToAppleWalletStart Apple Wallet provisioning
getPatronBarcodeNative barcode (used on Android)
addUSAePayCreditCardNative USAePay card entry
ordersApplePayApple Pay for an order
depositsApplePayApple Pay for a deposit
updateNativeWithRouteSync 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:

EventPurpose
ApplePayEventApple Pay result URL
browserFinishedIn-app browser closed
FINISHEDPayment/deposit finished
appStateChangeForeground/background
appUrlOpenDeep link

Push registration ​

When get.feature.enable_push_notification is "1" and the platform is native, the app registers for push after login:

  1. Requests notification permission.
  2. Calls the native push plugin's register().
  3. On the registration event, stores the token in fcm_token and calls /json/user saveNotification with:
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.

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 ​

DomainCategories
patron-uicore-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:

ConstantValue
ServiceUrl.DEVELOPMENThttps://services.get.dev.cbord.com/GETServices/services
ServiceUrl.DEMOhttp://getdemo.cbord.com/GETServices/services
ServiceUrl.PRODUCTIONhttps://services.get.cbord.com/GETServices/services
BaseUrl.DEVELOPMENThttps://student.dev.cbord.com
BaseUrl.DEMOhttps://student.demo.cbord.com
BaseUrl.PRODUCTIONhttps://student.cbord.com

Telemetry ​

The app reports product analytics and crashes outside the GETServices API; this traffic does not touch services_url.

DestinationBehaviour
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.
SentryError 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 ​

MethodParams
authenticateSystemsystemCredentials
authenticateUsersystemCredentials, userCredentials{userName,password,domain,institutionId}
authenticateGuestUsersame as authenticateUser
authenticatePINsystemCredentials, deviceId, pin
authenticateSessionTokensystemCredentials, sessionToken
getAuthenticationTokensessionId
retrieveExternalAuthenticationTokentokenType, externalSystem, claimSet, sessionId, institutionId
retrieveAuthorizationBlobdeviceModel, deviceOSVersion, sessionId, institutionId
retrievePatronBarcodePayloadsessionId

/json/user ​

MethodParams
retrievesessionId, institutionId
updateuser, forceOverwrite
changePasswordoldPassword, newPassword
createPINPIN, deviceId
retrieveSettingsettingName
saveSettingsettingName, settingValue
deleteSettingsettingName
retrieveUserPhotophotoId
retrieveUserPhotoListuserId
retrieveFullUserPhotoListuserId
retrievePendingOrRejectedUserPhotouserId
addUserPhotouserId, photo
updateUserPhotoStatusphotoId, status, reason
retrieveUserAddressListuserId, addressId
updateUserAddressaddress, userId
deleteUserAddressaddressId, userId
addressToGeocodeaddress
reportCardLost / reportCardFoundsessionId
updateUserStatussessionId
retrieveUserIdByCashlessFieldsinstitutionId, sessionId, cashlessData{lookupFields}
requestDepositrecipientName, recipientEmail, message, depositToAccountId, requestAmount
saveNotificationuserId, notification
logoutAndRemoveUserNotificationuserId, notification
retrieveAllUserNotificationsuserId
retrieveAutoDepositSettingsuserId
updateAutoDepositSettingsuserAutoDepositSettingInfo
retrieveRegistrationFieldssessionId, institutionId
registerregistrationInfo{institutionId,userName,password,phone,registrationFields{lookupFields}}

/json/userNotification ​

MethodParams
createUserNotificationLogtitle, content, domain, category
retrieveAllincludeViewed, includeDismissed, includePinned
retriveuserNotificationLogId
markUserNotificationLogAsVieweduserNotificationLogId
markUserNotificationLogAsDismisseduserNotificationLogId
updatePinnedOnUserNotificationLoguserNotificationLogId, value
getNotificationLogCountincludeViewed, includeDismissed
markAllUserNotificationLogAsViewed—

/json/commerce ​

MethodParams
retrieveAccounts—
deactivateAccountaccount fields
retrieveCashlessPatronMobileDisplayMediaValue—
retrieveTransactionHistorypaymentSystemType, queryCriteria
retrieveTransactionHistoryWithinDateRangepaymentSystemType, queryCriteria
calculateDepositFeefromAccountId, toAccountId, amount
depositfromAccountId, toAccountId, fromAccountCvv, amount, cashlessTerminalLocation
depositForUserFromAnyAccountuserId, fromAccountId, fromAccountCvv, toAccountId, amount, cashlessTerminalLocation
donateaccountId, amountToDonate
createAccountaccountInfo
retrieveAccountsByUseruserId
retrieveDepositAccountsByUseruserId
retrieveCreditPaymentMethodsByPaymentSystemsessionId, paymentSystemId, userId
retrieveAutoDepositAccountListuserId, paymentType
getMobileLocationsfilters, latitude, longitude, accuracy
activateMobileLocationlocationId, tranDate, latitude, longitude, accuracy, altitude, altitudeAccuracy, speed, heading, sourceInfo

/json/institution ​

MethodParams
retrieveinstitutionId, optional sessionId
retrieveByShortNameshortName, optional sessionId
retrieveInstitutionPhotoinstitutionId, optional sessionId
retrieveLookupListsessionId
retrieveAnonymousDepositFieldsinstitutionId, sessionId
retrieveBuildingsactive

/json/configuration and /json/content ​

MethodParams
retrieveSettingdomain, category, name
retrieveSettingListdomain, category
nativeStartupclientType, clientVersion
retrieveStringdomain, category, name, locale
retrieveStringListdomain, category, locale

/json/merchant ​

MethodParams
getMerchantssearchOptions
getMenuMerchantssearchOptions
getFavoriteMerchantsexcludeNonOrdering
addFavoriteMerchantmerchantId, notes
removeFavoriteMerchantmerchantId
getMerchantSettingsmerchantId, domain, category, name
retrievePickupAddressesInRangemerchantId
isOutsideMerchantDeliveryAreamerchantId, latitude, longitude
getMerchantPaymentAccountsWithFiltermerchantId, options, userId
getDisplayMenumerchantId, dateTime, orderType, locale, depth
getDisplayMenussame as getDisplayMenu

/json/ordering ​

MethodParams
validateOrderorder
validateOrderItemsorder, validateOrderResult
validateOrderAddOnsorder fields, orderID, itemsToAdd, accountID
addItemsToOrderorder fields, clientAddItemsID, orderID, itemsToAdd, cvv, accountID
submitOrderorder, accountId, cvv
cancelOrderorderId
retrieveSuccessfulOrdersListuserId, merchantId, maxReturn
retrieveOrderListuserId, merchantId, institutionId, startDate, endDate, orderStatuses, maxReturn
getMerchantOrderSchedulemerchantId, orderType, startDate, endDate
checkInOrderorderId, latitude, longitude, checkinBarcode

/json/rewards ​

MethodParams
retrieveUserRewardTrackInfoheaderOnly
retrieveUserRewardHistoryrewardTrackId, startDate, endDate, filters
optUserIntoRewardTracktrackId, userId
claimRewardV2rewardId

/json/notification ​

MethodParams
resetPasswordNotificationinstitutionId, userName, sessionId

HTTP behavior ​

ItemValue
MethodAlways POST
Content typeapplication/json
Acceptapplication/json
Default timeout30 000 ms
Partner-services timeout45 000 ms
Success wrapper{ "response": ..., "exception": null }
Error wrapper`{ "response": null, "exception": "