General Terms

• Direct Inward Dialing (DID): A direct line to the person, no extensions.
• Single Sign On (SSO): A session and user authentication service that permits a user to use one set of login credentials (e.g., name and password) to access multiple applications.
• Poll (Interactive Voice Response/IVR): A technology that allows a computer to interact with humans through the use of voice and DTMF tones input via a keypad to answer a set of questions presented to the caller.
• SMS/TXT: (Short Message Service) This is a text message sent to a cell phone or other device.
• Text to Speech (TTS): A computer-generated voice that reads the body of the message to you.
• Network: CivicReady creates specific URLs for each client to access their CivicReady System.
• Location (Campus): A client's network can segregate by location, which allows the administrators more control of the user and group data within a specific location.
• Group: A specific list of recipients. 
• Administrators: Supervise and have direct control over the Network (Network Admins) or Groups (Group Admins).
• Users: The recipients of the messages the system generates.
• Post: The action of creating a message to a group or groups or users.

API Terms

• REST API: The Industry-recognized style of API that CivicReady uses.
• XML (Extensible Markup Language): The coding language that submits the API request.
• JSON (JavaScript Object Notation): An open-standard format that uses human-readable text to transmit data objects consisting of attribute–value pairs. It is the most common data format for asynchronous browser/server communication, largely replacing XML, and is used by AJAX.  
• Root Tag: A set of data for a particular request that starts with a beginning tag and ends with a closing tag. The data between the beginning tag and the ending tag is one set of data ie: one member, or one message.
  • Example of one tag for the membership import:   
    <user>(Root tag/beginning tag) 
    <firstName>CivicReady1000</firstName>(child tag)
    <lastName>Test1000</lastName>(child tag)
    <email>rgtst1000@mailinator.com</email>(child tag) 
    <userID>rgtst1000</userID>(child tag) 
    <phone>1234567890 </phone>(child tag) 
    <groupID>xxxxxx</groupID>(child tag) 
    <databaseID>dbrgtst1000</databaseID>(child tag) 
    </user>(Root tag/closing tag)
• Child Tag: Data between the beginning and ending tag (Root Tag). In the above example the required membership import format - first name, last name, email, user id, phone number, group id, and database comprises the child tags.
• Messaging Endpoint(s): The communication method where the user will receive the message. The Messaging API uses Messaging Endpoints. If there is a value other than 1 for the endpoint, or the endpoint is not in the request, that communication method will not be in the notification.
  • Messaging endpoints include:
    • <mail>1</mail>
    • <sms>1</sms>
    • <tts>1</tts>
    • <fb>1</fb>
• Service (API Service): A set of requests to perform a desired function.
  • Services include:
    • Membership API
    • Messaging API
    • Managing Groups
• Request: A specific command to complete a desired task.
  • Requests include:
    • Membership Import
    • Retrieving data
    • Creating Groups
    • Purging Groups
    • Deleting Groups
    • Messaging
    • Others

Resources