| Info |
|---|
If there are any questions that this document does not answer or are left unclear, send an email with your questions to support@laundrycard.com |
...
| Field Name | Type | Description | Notes |
|---|---|---|---|
| ID | int | Machine Rec ID | |
| LocationID | int | Location Rec ID | |
| MachNo | string | Machine number | |
| Label | string | Machine label | |
| EquipID | int | Equipment Rec ID | |
| Status | int | Machine status code | 0 = Machine offline |
| Enabled | bool | Machine enabled | |
| VendAllowed | bool | Machine vend allowed | |
| UserActive | bool | User is active on machine | |
| FinishTime | DateTime | Estimated finish time (UTC) | |
| Price | Decimal | Current start price | |
| Model | string | Model number | |
| SerialNumber | string | Serial number | |
| InServiceDate | DateTime | In-Service date (UTC) | |
| LastServiceDate | DateTime | Last service date (UTC) | |
| Notes | string | Machine notes | |
| PairedMachineID | int | Paired Machine Rec ID | null = no pair |
| int | Pocket Configuration | null = no pocket configuration 1 = Top pocket 2 = Bottom pocket | |
| WifiAffinity | int | Reader wifi affinity index | null = None assigned 1-4 = Assigned affinity |
...
| Name | Type | Description | Notes |
|---|---|---|---|
| Label | string | Machine label | Limited to 32 characters |
| Model | string | Model number | Limited to 50 characters |
| SerialNumber | string | Serial number | Limited to 50 characters |
| InServiceDate | DateTime | In-Service date (UTC) | Needs to be in ISO 8601 format YYYY-MM-DDThh:mm:ss |
| LastServiceDate | DateTime | Last service date (UTC) | |
| Enabled | bool | Machine enabled | |
| Notes | string | Machine notes |
See example requests below:
...
| Field Name | Type | Description | Notes |
|---|---|---|---|
| ID | long | Transaction Rec ID | |
| RdrTransID | int | Reader transaction ID | |
| AccountID | int | SysConfig Account ID | |
| DateTime | DateTime | Transaction time (UTC) | |
| TransType | int | Transaction type | |
| TransSubType | int | Transaction sub-type | Transaction Types & SubTypes |
| LocationID | int | Location Rec ID | |
| MachNo | int | Machine number | |
| CashAmount | Decimal | Amount of cash | |
| CreditCardNumber | string | Credit card number (last 4 digits) | May be NULL if card type NOT credit |
| CreditCardAmount | Decimal | Amount spent on credit card | |
| LoyaltyCardNumber | string | Loyalty card number | May be NULL if card type NOT loyalty |
| BalanceAmount | Decimal | Change in balance | |
| BonusAmount | Decimal | Change in bonus | |
| LoyaltyPoints | int | Change in loyalty points | |
| FreeStarts | int | Change in free starts | |
| NewBalance | Decimal | New loyalty balance after transaction | |
| NewBonus | Decimal | New loyalty bonus after transaction | |
| AdditionalInfo | string | Additional info | |
| UserAccountID | int | UserAccount Rec ID | |
| CreditCardName | string | Name on credit card | May be NULL if card type NOT credit |
| EmployeeUserID | int | Employee User Rec ID | |
| NewFreeStarts | int | New Free Starts after transaction | |
| NewLoyaltyPoints | int | New Loyalty Points after transaction | |
| RootTransactID | long | Root Transaction Rec ID | |
| UnfundedAmount | Decimal | Unfunded amount |
...
GET https://m.fascard.com/api/User
User Info for current user
GET https://m.fascard.com/api/User/{userID}?AccountID={accountID}
User details of specified user. The UserID is obtained from UserAccount or Account.
Requirements: Account Admin or 'User Manager' privilege
| Field Name | Type | Description | Notes |
|---|---|---|---|
| EmailAddress | string | Email address | |
| VerifyCode | string | Verification code | |
| Password | string | User password | |
| Name | string | User name | |
| Addr1 | string | Address #1 | |
| Addr2 | string | Address #2 | |
| City | string | City | |
| State | string | State | |
| ZipCode | string | Zip code | |
| MobilePhone | string | Mobile phone | |
| Birthday | DateTime | Birthday | May be NULL if n/a |
| NewUser | bool | True if new user | |
| NotifyCycleComplete | bool | True to send email when cycle is nearly complete | |
| Language | string | User's preferred language | "en" = English "es" = Spanish |
| UserID | int | User Rec ID | |
| AllowEmailEdit | bool | True if user is not yet validated and thus capable of modifying email | |
| EmailVerifyRequest | bool | Set True to request verification email | Only used for unverified email (AllowEmailEdit=True) |
POST https://m.fascard.com/api/User/{userID}?AccountID={accountID}
Edit details of specified user. The UserID is obtained from UserAccount or Account.
Requirements: Account Admin or 'User Manager' privilege
DELETE https://m.fascard.com/api/User
Remove all personal details and login credentials for current user
...