web ( 3.0.0 )
/
Description
Public Web Page
Request
Response
Examples
Playground
/account
Description
Get User Account HTML Page
Request
Cookies
rr_user
7 Days
User ID
rr_token
7 Days
Login Token
Response
Examples
Playground
/agreement
Description
HTML Page - Agreement Generator
Request
Cookies
rr_user
7 Days
User ID
rr_token
7 Days
Login Token
Search Params
entity
string
-
ID of Entity
doc
string
-
Legal Document ID
patron
string
-
Patron ID
Response
Examples
Playground
/agreement
Description
Get Agreement Document
Request
Search Params
entity
string
-
ID of Entity
doc
string
-
Legal Document ID
patron
string
-
Patron ID
Response
Examples
Playground
/agreement
Description
Create Agreement Record
Request
Search Params
entity
string
-
ID of Entity
doc
string
-
Legal Document ID
patron
string
-
Patron ID
Query Params
datetime
string
-
Computer Generated Date Time Stamp
image
string
-
DOM Generated PNG Image
patron
string
-
Patron ID
Response
Examples
Playground
/broadcast
Description
HTML Page - Broadcasts
Request
Cookies
rr_user
7 Days
User ID
rr_token
7 Days
Login Token
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
program
string
-
ID of Program
Response
Examples
Playground
/broadcast
Description
Get Available Broadcasts
Request
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
program
string
-
ID of Program
Response
Examples
Playground
/broadcast
Description
Create New Broadcasts
Request
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
program
string
-
ID of Program
Query Params
code
string
-
Phone Number or Short Code
program
string
-
ID of Program
Response
Examples
Playground
/code
Description
HTML Page - A list of Codes
Request
Cookies
rr_user
7 Days
User ID
rr_token
7 Days
Login Token
Search Params
entity
string
-
ID of Entity
Response
Examples
Playground
/code
Description
Get Available Numbers
Request
Search Params
entity
string
-
ID of Entity
Query Params
type
-
-
Type of data to lookup
id
-
-
Partial or Full - Phone Number or Short Code
Response
Examples
Playground
/code
Description
Aquire new Phone Number or Short Code
Request
Search Params
entity
string
-
ID of Entity
Query Params
id
number|string
-
Partial or Full - Phone Number or Short Code
Response
Examples
Playground
/code/$id
Description
Release Phone Number or Short Code
Request
URI Params
id
string
-
Phone Number or Short Code
Search Params
entity
string
-
ID of Entity
Query Params
confirmation
number|string
-
confirmation code
Response
Examples
Playground
/code/$id
Description
HTML Page - Details on a Code
Request
Cookies
rr_user
7 Days
User ID
rr_token
7 Days
Login Token
URI Params
id
string
-
Phone Number or Short Code
Search Params
entity
string
-
ID of Entity
Response
Examples
Playground
/code/$id
Description
Enable/Disable use of Phone Number or Short Code
Request
URI Params
id
string
-
Phone Number or Short Code
Search Params
entity
string
-
ID of Entity
Query Params
enable
boolean
-
Enable Phone Number or Short Code
disable
boolean
-
Disable Phone Number or Short Code
Response
Examples
Playground
/dropoff
Description
HTML Page - Dropoff
Request
Cookies
rr_user
7 Days
User ID
rr_token
7 Days
Login Token
Response
Examples
Playground
/entity
Description
List of managed locations HTML Page
Request
Cookies
rr_user
7 Days
User ID
rr_token
7 Days
Login Token
Response
Examples
Playground
/entity
Description
Get a list of entities
Request
Response
Examples
Playground
/entity/$id
Description
HTML Page - Details about the location - label, managers, codes, programs, dropoffs
Request
Cookies
rr_user
7 Days
User ID
rr_token
7 Days
Login Token
URI Params
id
string
-
ID of Entity
Response
Examples
Playground
/entity/$id
Description
Get Entity Details:
label, managers, codes, programs, dropoffs
Request
URI Params
id
string
-
ID of Entity
Response
Examples
Playground
/login
Description
Login HTML Page
Request
Response
Examples
Playground
/login
Description
Send Login Credentials
Request
URI Params
user
string
-
Unique username
pass
string
-
password
code-type
lookup
-
type of 2FA to use
Response
Examples
Playground
/login/verify
Description
Submit Verification Codes
Request
URI Params
code
number
-
Code sent to mobile phone or email or gpg generated
Response
Examples
Playground
/login/verify
Description
Resend Verifcation Codes
Request
Response
Examples
Playground
/manager
Description
HTML Page - A list of Managers & Permissions
Request
Cookies
rr_user
7 Days
User ID
rr_token
7 Days
Login Token
Search Params
entity
string
-
ID of Entity
Response
Examples
Playground
/manager
Description
Get Managers
Request
Search Params
entity
string
-
ID of Entity
Response
Examples
Playground
/manager
Description
Create a Manager - Default enabled
Request
Search Params
entity
string
-
ID of Entity
Query Params
email
-
-
user email
phone
-
-
user phone
permisions
json
-
set permissions
disable
boolean
-
Create a manager but disable the account
Response
Examples
Playground
/manager/$id
Description
Remove / Archive a Manager Account
Request
URI Params
id
string
-
ID of Manger
Search Params
entity
string
-
ID of Entity
Query Params
confirmation
string
-
confirmation code
Response
Examples
Playground
/manager/$id
Description
HTML Page - Details on a Manager Account
Request
Cookies
rr_user
7 Days
User ID
rr_token
7 Days
Login Token
URI Params
id
string
-
ID of Manger
Search Params
entity
string
-
ID of Entity
Response
Examples
Playground
/manager/$id
Description
Update / Enable / Disable - Manager & Permissions
Request
URI Params
id
string
-
ID of Manger
Search Params
entity
string
-
ID of Entity
Query Params
permisions
json
-
set permissions
enable
boolean
-
Enable Manager Account
disable
boolean
-
Disable Manager Account
Response
Examples
Playground
/manager/$id
Description
Get Manager Details
Request
URI Params
id
string
-
ID of Manger
Search Params
entity
string
-
ID of Entity
Response
Examples
Playground
/patron
Description
Get List of Available Patrons
Request
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
program
string
-
ID of Program
Response
Examples
Playground
/patron
Description
Create New Patron / Add New Patron
Request
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
program
string
-
ID of Program
Query Params
mobile
string
-
Mobile Phone Number
Response
Examples
Playground
/patron/$id
Description
Delete Patron from distribution list
Request
URI Params
id
string
-
ID of Patron
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
program
string
-
ID of Program
Query Params
confirmation
number|string
-
confirmation code
Response
Examples
Playground
/patron/$id
Description
HTML Page - Details about the patron
Request
Cookies
rr_user
7 Days
User ID
rr_token
7 Days
Login Token
URI Params
id
string
-
ID of Patron
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
program
string
-
ID of Program
Response
Examples
Playground
/patron/$id
Description
Enable/Disable Patron
Request
URI Params
id
string
-
ID of Patron
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
program
string
-
ID of Program
Query Params
enable
boolean
-
Enable Patron
disable
boolean
-
Disable Patron
Response
Examples
Playground
/patron/$id
Description
Get Patron Details
Request
URI Params
id
string
-
ID of Patron
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
program
string
-
ID of Program
Response
Examples
Playground
/program
Description
HTML Page - A list of programs
Request
Cookies
rr_user
7 Days
User ID
rr_token
7 Days
Login Token
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
Response
Examples
Playground
/program
Description
Get Available Programs
Request
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
Response
Examples
Playground
/program
Description
Create New Program
Request
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
Query Params
id
string
-
The name of the program
Response
Examples
Playground
/program/$id
Description
Release Phone Number or Short Code
Request
URI Params
id
string
-
ID of Program
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
Query Params
confirmation
number|string
-
confirmation code
Response
Examples
Playground
/program/$id
Description
HTML Page - A list of programs
Request
Cookies
rr_user
7 Days
User ID
rr_token
7 Days
Login Token
URI Params
id
string
-
ID of Program
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
Response
Examples
Playground
/program/$id
Description
Enable/Disable Program
Request
URI Params
id
string
-
ID of Program
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
Query Params
enable
boolean
-
Enable Program
disable
boolean
-
Disable Program
Response
Examples
Playground
/program/$id
Description
Get Program Details
Request
URI Params
id
string
-
ID of Program
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
Response
Examples
Playground
/record
Description
Get Available Dropoff Records
Request
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
program
string
-
ID of Program
patron
string
-
ID of Patron
Response
Examples
Playground
/record
Description
Create New Dropoff Record
Request
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
program
string
-
ID of Program
patron
string
-
ID of Patron
Query Params
service
string
-
The name of the company the driver works for
people
number
-
The number of persons dropped off
price
number
-
Compensation given per person
Response
Examples
Playground
/record/$id
Description
Delete Dropoff Record Details
Request
URI Params
id
string
-
ID of Record
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
program
string
-
ID of Program
patron
string
-
ID of Patron
Query Params
confirmation
number|string
-
confirmation code
Response
Examples
Playground
/record/$id
Description
Update Record Details
Request
URI Params
id
string
-
ID of Record
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
program
string
-
ID of Program
patron
string
-
ID of Patron
Query Params
service
string
-
The name of the company the driver works for
people
number
-
The number of persons dropped off
price
number
-
Compensation given per person
Response
Examples
Playground
/record/$id
Description
Get Dropoff Record Details
Request
URI Params
id
string
-
ID of Record
Search Params
entity
string
-
ID of Entity
code
string
-
Phone Number or Short Code
program
string
-
ID of Program
patron
string
-
ID of Patron
Response
Examples
Playground
/recover
Description
Recover User HTML Page
Request
Response
Examples
Playground
/recover
Description
Send Recover Information
Request
URI Params
user
string
-
Unique username
email
string
-
email
mobile
number
-
mobile phone number
Response
Examples
Playground
/recover/verify
Description
Submit Verifcation Codes & New Password
Request
URI Params
pass
string
-
password
code-text
number
-
Code sent to mobile phone
code-email
number
-
Code sent to email
Response
Examples
Playground
/recover/verify
Description
Resend Verifcation Codes
Request
Response
Examples
Playground
/register
Description
Register User HTML Page
Request
Response
Examples
Playground
/register/verify
Description
Submit Verifcation Codes and create user on success
Request
Cookies
rr_user
-
Username reference for verification
Scopes
admin
-
URI Params
code-text
number
-
Code sent to mobile phone
code-email
number
-
Code sent to email
Response
Examples
Playground
/register/verify
Description
Resend Verifcation Codes
Request
Response
Examples
Playground
/user
Description
Create User Account
Request
Cookies
rr_user
10 min
Username reference for verification
URI Params
first
string
-
Given Name
last
string
-
Family Name
user
string
-
Unique username
email
string
-
email
mobile
number
-
mobile phone number
pass
string
-
password
Response
Examples
Playground
/user/$id
Description
Update User Account Data
Request
URI Params
id
string
-
ID of Program
first
string
-
Given Name
last
string
-
Family Name
user
string
-
Unique username
email
string
-
email
mobile
number
-
mobile phone number
pass
string
-
password
Response
Examples
Playground
/user/$id
Description
Get User Account Data
Request
URI Params
id
string
-
ID of Program
Response
Examples
Playground
web ( 2.0.0 )
/
Description
Get API Status
Request
Response
Examples
Playground
/account/{account}/code
Description
Get a list of Account Codes
Request
Response
Examples
Playground
/account/{account}/code
Description
Request a new Account Code
Request
Response
Examples
Playground
/account/{account}/manager
Description
Get a list of Account Managers
Request
Response
Examples
Playground
/account/{account}/manager
Description
Create an Account Manager
Request
Response
Examples
Playground
/code/{code}/program
Description
Get a list of Code Programs
Request
Response
Examples
Playground
/code/{code}/program
Description
Create an new Code Program
Request
Response
Examples
Playground
/code/{code}/program/{program}/manager
Description
Get a list of Program Managers
Request
URI Params
code
number
-
Short Code | Long Code
program
string
-
The word that people will need to text to the code
Response
Examples
Playground
/code/{code}/program/{program}/manager
Description
Create a Program Manager
Request
URI Params
code
number
-
Short Code | Long Code
program
string
-
The word that people will need to text to the code
Response
Examples
Playground
/code/{code}/program/{program}/manager/{mobile}
Description
Locks / Unlocks a Program Manager Account
If search key missing, deletes program manager account
Request
URI Params
code
number
-
Short Code | Long Code
program
string
-
The word that people will need to text to the code
mobile
number
-
Mobile Phone Number
Search Params
lock
boolean
-
Locks the Program Manager Account
unlock
boolean
-
Unlocks the Program Manager Account
Response
Examples
Playground
/code/{code}/program/{program}/manager/{mobile}
Description
Get Program Manager Scopes
Request
URI Params
code
number
-
Short Code | Long Code
program
string
-
The word that people will need to text to the code
mobile
number
-
Mobile Phone Number
Response
Examples
Playground
/code/{code}/program/{program}/manager/{mobile}
Description
Edit a Program Manager Scopes
Request
URI Params
code
number
-
Short Code | Long Code
program
string
-
The word that people will need to text to the code
mobile
number
-
Mobile Phone Number
Query Params
scopes
scopes
-
An array of scopes or an object of scopes
Response
Examples
Playground
/code/{code}/program/{program}/manager/{mobile}
Description
Create a Program Manager
Request
URI Params
code
number
-
Short Code | Long Code
program
string
-
The word that people will need to text to the code
mobile
number
-
Mobile Phone Number
Response
Examples
Playground
/code/{code}/program/{program}/patron
Description
Get a list of Program Subscribers
Request
Response
Examples
Playground
/code/{code}/program/{program}/patron/{mobile}
Description
Get a list checkins for a Program Subscriber
Request
Response
Examples
Playground
/help
Description
Get API Documentation
Request
Response
Examples
Playground
/login
Description
Get Login Screen
Request
Response
Examples
Playground
/login
Description
Submit Credentials
Request
Response
Examples
Playground
/user/{mobile}
Description
Get a User Information
Request
Response
Examples
Playground
/user/{mobile}
Description
Update a User
Request
Response
Examples
Playground
/user/{mobile}
Description
Create a User
Request
Response
Examples
Playground
web ( 1.0.0 )
/
Description
Get API Status
Request
Response
Examples
Playground
/admin
Description
Get List of Admin Users
Request
Response
Examples
Playground
/admin
Description
Create an Admin User
Request
Response
Examples
Playground
/admin/{id}
Description
Disable Admin
Request
Response
Examples
Playground
/admin/{id}
Description
Get Admin Details
Request
Response
Examples
Playground
/admin/{id}
Description
Update Admin field
Request
Response
Examples
Playground
/admin/{id}
Description
Replace Admin Details
Request
Response
Examples
Playground
/help
Description
Get API Documentation
Request
Response
Examples
Playground
/login
Description
Get Login Screen
Request
Response
Examples
Playground
/login
Description
Submit Credentials
Request
Response
Examples
Playground
/manager
Description
Get List of Manager Users
Request
Response
Examples
Playground
/manager
Description
Create a Manager User
Request
Response
Examples
Playground
/manager/{id}
Description
Disable Manager
Request
Response
Examples
Playground
/manager/{id}
Description
Get Manager Details
Request
Response
Examples
Playground
/manager/{id}
Description
Update Manager field
Request
Response
Examples
Playground
/manager/{id}
Description
Replace Manager Details
Request
Response
Examples
Playground
/patron/{id}
Description
Disable Subscriber
Request
Response
Examples
Playground
/patron/{id}
Description
Get Subscriber Details
Request
Response
Examples
Playground
/patron/{id}
Description
Update Subscriber field
Request
Response
Examples
Playground
/patron/{id}
Description
Create a Subscriber
Request
Response
Examples
Playground
/patron/{id}
Description
Replace Subscriber Details
Request
Response
Examples
Playground
/patron/{id}/ride
Description
Get list of drop off dates
Request
Response
Examples
Playground
/patron/{id}/ride
Description
Record Drop Off
Request
Response
Examples
Playground
/patron/{id}/ride/{date}
Description
Remove Drop Off Input
Request
Response
Examples
Playground
/patron/{id}/ride/{date}
Description
Get Drop Off Details
Request
Response
Examples
Playground
/patron/{id}/ride/{date}
Description
Modify Drop Off Details
Request
Response
Examples
Playground
/program
Description
Disable a phone number / short code
Request
Response
Examples
Playground
/program
Description
Get a list of sms phone numbers / short codes
Request
Response
Examples
Playground
/program
Description
Add a new phone number / short code
Request
Response
Examples
Playground
/program/{num}
Description
Disable a code from program
Request
Response
Examples
Playground
/program/{num}
Description
Get a list of sms codes
Request
Response
Examples
Playground
/program/{num}
Description
Add a code to program
Request
Response
Examples
Playground
/program/{num}/{code}
Description
Remove phone number from subscribers
Request
Response
Examples
Playground
/program/{num}/{code}
Description
Get a list of subscribers
Request
Response
Examples
Playground
/program/{num}/{code}
Description
Add phone number to subscribers
Request
Response
Examples
Playground
/user
Description
Get List of Users
Request
Response
Examples
Playground
/user
Description
Create a User
Request
Response
Examples
Playground
/user/{id}
Description
Disable User
Request
Response
Examples
Playground
/user/{id}
Description
Get User Details
Request
Response
Examples
Playground
/user/{id}
Description
Update User field
Request
Response
Examples
Playground
/user/{id}
Description
Replace User Details
Request
Response
Examples
Playground
sms ( 1.0.0 )
$help
Description
Get Help URL
Request
Response
Examples
Playground
$login
Description
Get Login PassCode
Request
Response
Examples
Playground
<passcode> $account create <label>
Description
CREATE = Create New Account
Request
URI Params
label
string
-
Alpha-Numeric Account Name
Response
Examples
Playground
<passcode> $account remove <id>
Description
REMOVE = Disable Account
Request
URI Params
id
string
-
Alpha-Numeric Account ID
Response
Examples
Playground
<passcode> $checkin (edit|delete) <code> <program> <mobile> <date> ; <key>=<value>
Description
EDIT = Modify a patron timestamp and/or data
DELETE = Delete a patron timestamp and data
Request
URI Params
code
number
-
Phone Number or Short Code
program
string
-
Alpha-Numeric Program / Campaign
mobile
number
-
Mobile Phone Number
key
string
-
DataKey
value
string|number
-
DataKey
Response
Examples
Playground
<passcode> $checkin add <code> <program> <mobile> ; <key>=<value>
Description
ADD = Timestamp and add notes to patron in a program
Request
URI Params
code
number
-
Phone Number or Short Code
program
string
-
Alpha-Numeric Program / Campaign
mobile
number
-
Mobile Phone Number
key
string
-
DataKey
value
string|number
-
DataKey
Response
Examples
Playground
<passcode> $code (add|new) <account> <type> <number>
Description
ADD = Request a phone number or short code
NEW = Request a unique phone number or short code
Request
URI Params
account
string
-
Account ID
type
lookup
-
Type of code
number
number
-
Code Number
Response
Examples
Playground
<passcode> $code (lock|unlock|delete) <account> <code>
Description
LOCK = Lock to prevent new programs from being added
UNLOCK = Unlock to add new programs
DELETE = Disable Code and release to system. Will not be able to run programs.
Request
URI Params
account
string
-
Account ID
code
number
-
Short Code | Long Code
Response
Examples
Playground
<passcode> $code list <account> <page>
Description
LIST = List Codes in groups of 10
Request
URI Params
account
string
-
Account ID
page
number
-
Page Number
Response
Examples
Playground
<passcode> $manager (add|edit) <mobile> <account> <scope>
Description
ADD = Add New Manager to Account with permissions.
EDIT = Change Manager permissions on an Account
Request
URI Params
mobile
number
-
Mobile Phone Number
account
string
-
Account ID
scope
string
-
Select A Scope Definition
Response
Examples
Playground
<passcode> $manager (lock|unlock|delete) <mobile> <account>
Description
DELETE = Archive Manager Account
LOCK = Disable Manager Account
UNLOCK = Enable Manager Account
Request
URI Params
mobile
number
-
Mobile Phone Number
account
string
-
Account ID
Response
Examples
Playground
<passcode> $manager view <mobile> <account>
Description
VIEW = Get Manager Account Details
Request
URI Params
mobile
number
-
Mobile Phone Number
account
string
-
Account ID
Response
Examples
Playground
<passcode> $patron (add|remove) <mobile> <code> <program>
Description
ADD = Add Patron to Subscription List
REMOVE = Remove Patron from Subscription List
Request
URI Params
mobile
number
-
Mobile Phone Number
code
number
-
Phone Number or Short Code
program
string
-
Alpha-Numeric Program / Campaign
Response
Examples
Playground
<passcode> $patron list <code> <program> <page>
Description
LIST = List Patrons in groups of 10
Request
URI Params
code
number
-
Short Code | Long Code
program
string
-
Alpha-Numeric Program / Campaign
page
number
-
Page Number
Response
Examples
Playground
<passcode> $program (add|lock|unlock|delete) <program> <code>
Description
ADD = Add a new program to a short/long code.
LOCK = Lock to prevent new patrons from being added
UNLOCK = Unlock to add new patrons
DELETE = Disable Program. Will not be able to run programs.
Request
URI Params
program
string
-
The word that people will need to text to the code
code
number
-
Short Code | Long Code
Response
Examples
Playground
<passcode> $program list <code> <page>
Description
LIST = List Programs in groups of 10
Request
URI Params
code
number
-
Short Code | Long Code
page
number
-
Page Number
Response
Examples
Playground
<passcode> $shout <code> <program> <msg>
Description
LIST = List Patrons in groups of 10
Request
URI Params
code
number
-
Short Code | Long Code
program
string
-
Alpha-Numeric Program / Campaign
msg
string
-
Anything to broadcast to all subscribers
Response
Examples
Playground
<passcode> $user (add|edit) <mobile> ; <key> = <value>
Description
ADD = Create New User
EDIT = Edit User Data
Request
URI Params
mobile
number
-
Mobile Phone Number
key
string
-
DataKey
value
string|number
-
DataKey
Response
Examples
Playground
<passcode> $user view <mobile>
Description
VIEW = Get User Account Details
Request
URI Params
mobile
number
-
Mobile Phone Number