Self-Registration

This is a link that can be added to a website, but is individual for each agency. This link works only for your agency. The agency number at the end of the link determines which agency the information is communicated to for registration and for integration into the roster.

You must have an ‘Agency Administrator’ access to create the self-registration link

To create a Self-Registration

1. Start by clicking the “Menu” button followed by “Access” in the top-right corner of the ReadyOp dashboard.
2. Inside the “Manage Access” dialog, select the “Agencies” tab.
   • This tab may not be present if you have not been granted access to manage agencies.
3. Continue by double clicking on the agency and a “ Modify Agency”dialog will display.
4. On the right side of the modify agency dialog you will find up to 10 additional roster fields that can be added to the Roster. If you would like this information for the new roster field to appear in the self-registration page, make sure to checkmark the box(es) to the right of the roster field. (in the picture attached above, you can see “Employee ID” was checked). Press “Save” when you have finished adding and checking the roster field(s) to save the changes.
5. On the left side of the modify agency dialog you will find the Registration Page, click “Modify Registration Page” and when this opens will look like an email body. Here you are able to add a logo, directions for completing the self registration page, etc. (directions can be given with instructions to fill out both the Email and Phone tabs, or to indicate if phone is textable).
6. When you have finished modifying the Self Registration Page press “Save” to save the

To create the Self Registration link:

1. Start by opening a browser, then open up a new window.
2. Type in your agency name http://youragencyname.readyop.com
3. Add this to the rest of the link /contact/register/agencynumber (this number should be your agency number).
4. After you have finished typing all the information to create the link. You’ll be prompted with the following page as shown below.
5. Press “Continue” and you’ll be taking to the Self Registration page. Fill out the General Information as well as the Phone Numbers and Email Addresses.
6. After you have finished registering, Press “Subscribe” to submit your information and you’ll be prompted with a successful registered dialog.

How to import the Self Registration form

1. Start by opening the “Roster” tab in the ReadyOp dashboard.

• This tab may have been re-named, or you may not have permission to access this tab. Please contact your system administrator for more information on locating the Roster.

2. To the right of ‘Actions’ is the ‘Active’ status dropdown selection.  Open the dropdown and choose ‘Pending’

3. After you have selected “Pending”. You’ll see a list of pending people to be add to the Roster.
4. Continue by checking the box next to the person you would like add to the Roster and choose ‘Approve Selected’.
5. Go to the ‘Actions’ dropdown.  Select “Add Tags”, i.e. ‘New 5/3/19, Volunteer, etc.” This is very useful information that can be added to make searching Self Registration contacts easier once they are imported under the tags in the roster.
6. After you have selected and add a tag to the person. Choose ‘Approve Selected’.
7. You’ll be prompted with a confirmation dialog. Press “Yes” if you would like to add the selected contact(s) to the Roster.
8. You can refresh the screen and go to Roster to see the new imported people.

The Access section provides the capability to manage most configuration information for your agency. Depending on your permission level, Access facilitates managing the Annex, Devices, Groups, Users, SMS Numbers, SMS Gateways and Suppressed Emails.

Users

A user is someone that is allowed to access the ReadyOp platform using a Username and Password. Users are assigned permissions on a per agency basis from within the ReadyOp dashboard system. Users differ from Contacts in that a contact is someone who can be contacted through the ReadyOp system, but may not have access to login and access the system itself. A contact may not even be aware of the ReadyOp system, how it works, or that it even exists.

Creating a User

Users who have been granted permission to create users will be allowed to create other users.

1. Start by clicking the “Menu” button followed by “Access” in the top-right of the ReadyOp dashboard.
2. Inside the Manage Access dialog, select the “Users” tab.
   • This tab may not be present if you have not been granted access to manage users.
3. Continue by clicking the “New User” button in the upper right corner of the dialog.
4. In the “New User” dialog, fill out the relevant information for the new user you’re creating.
   1. Name
      • Should be the user’s full name, i.e. John Doe.
   2. Username
      • Used for authenticating. It must be at least 3 characters in length and cannot contain special characters.
   3. Password
      • Used for authentication. The user will be able to modify this once they login.
   4. Caller ID # 
      • The Caller ID # is the phone number that recipients will see on their phone when receiving a phone call made by this user through the ReadyOp system. i.e. If the Caller ID # were +18132897620, when this user makes a phone call, the receiving person would see the incoming call as coming from +18132897620.
   5. Cell
      • The cell phone this user will be able to use when placing calls. This is not the same as the number which may be associated to the user for reaching them. When this user places a call they’ll be prompted how they (the user) would like to be connected, if a cell phone is provided here, it will be listed as an option.
   6. Desk
      • The desk phone this user will be able to use when placing calls. This is not the same as the number which may be associated to the user for reaching them. When this user places a call they’ll be prompted how they (the user) would like to be connected, if a desk phone is provided here, it will be listed as an option.
   7. Language
      • The user interface language for the user. Currently available options include English and Spanish.
5. In the Agencies tab, you’ll need to select (using the available checkboxes) the Agencies in which this user will be able to login. When selecting an agency, you’ll also need to type in the provided Group box, which user group this user will be placed into. Groups are used to designate the user permissions this user will be assigned in that agency.
   • A group is required on a per agency basis.
   • Every user must be assigned access to at least one agency.
6. In the devices tab, you’ll be able to select (using the available checkboxes) which Devices (iPad, iPhone, Android, etc) this user is permitted to access the system through. You do not need to specify any devices to allow a user to connect using a web browser, as this is enabled by default.
7. When finished, press “Create” to save your new user.

Deleting a User

Users who have been granted permission to delete users will be allowed to delete other users.

1. Start by clicking the “Menu” button followed by “Access” in the top-right of the ReadyOp dashboard.
2. Inside the Manage Access dialog, select the “Users” tab.
   • This tab may not be present if you have not been granted access to manage users.
3. Continue by double clicking on the user you’d like to delete.
4. Inside the “Modify User” dialog, click the “Delete” in the bottom left corner. You cannot delete a user who is also assigned to agencies in which you do not have permission to access.
5. You’ll be prompted with a warning notifying you that deleting a user is a permanent action, are you sure you’d like to continue.
6. To delete the user, press “Yes”, to cancel press “No”.

Modifying a User

Users who have been granted permission to modify users will be allowed to modify other users.

1. Start by clicking the “Menu” button followed by “Access” in the top-right of the ReadyOp dashboard.
2. Inside the Manage Access dialog, select the “Users” tab.
   • This tab may not be present if you have not been granted access to manage users.
3. Continue by double clicking on the user you’d like to modify.
4. In the “Modify User” dialog, fill out the relevant information for the user you’re modifying.
   1. Name
      • Should be the user’s full name, i.e. John Doe.
   2. Username
      • Used for authenticating. It must be at least 3 characters in length and cannot contain special characters.
   3. Password
      • Used for authentication. The user will be able to modify this once they login.
   4. Caller ID # 
      • The Caller ID # is the phone number that recipients will see on their phone when receiving a phone call made by this user through the ReadyOp system. i.e. If the Caller ID # were +18132897620, when this user makes a phone call, the receiving person would see the incoming call as coming from +18132897620.
   5. Cell
      • The cell phone this user will be able to use when placing calls. This is not the same as the number which may be associated to the user for reaching them. When this user places a call they’ll be prompted how they (the user) would like to be connected, if a cell phone is provided here, it will be listed as an option.
   6. Desk
      1. The desk phone this user will be able to use when placing calls. This is not the same as the number which may be associated to the user for reaching them. When this user places a call they’ll be prompted how they (the user) would like to be connected, if a desk phone is provided here, it will be listed as an option.
   7. Language
      • The user interface language for the user. Currently available options include English and Spanish.
   8. SMS
      • In order for this user to be able to receive responses to SMS messages they send using the ReadyOp dashboard, they will need to be assigned a unique phone number for SMS. SMS Numbers can be assigned by the ReadyOp Super Administrator. For more information on assigning an SMS number, contact ReadyOp customer support.
      • A user does not need a unique SMS Number assigned to send messages. By default all users are able to send SMS using the ReadyOp dashboard. This is only required for the user to receive responses through the ReadyOp system.
      • An SMS Number is assigned on a per-user basis, and does not correlate to Contacts (recipients of the messages). This means that only the user needs to have an SMS number assigned to them, not each individual contact this user may be contacting.
5. In the Agencies tab, you can select or de-select (using the available checkboxes) the Agencies in which this user will be able to login. When selecting an agency, you’ll also need to type in the provided Group box, which user group this user will be placed into. Groups are used to designate the user permissions this user will be assigned in that agency.
   • A group is required on a per agency basis.
   • Every user must be assigned access to at least one agency.
6. In the devices tab, you’ll be able to select or de-select (using the available checkboxes) which Devices (iPad, iPhone, Android, etc) this user is permitted to access the system through. You do not need to specify any devices to allow a user to connect using a web browser, as this is enabled by default.
7. When finished, press “Save” to save your changes to the user’s profile.

Agencies

In ReadyOp an agency is used to segregate Contacts, Tabs, Objects, Roles, Teams, News, History, etc, within a given ReadyOp domain into separate Sites. Inside a ReadyOp domain (i.e. domain.readyop.com) there can be many different Agencies. Each agencies information is separate, and users are assigned permissions on a per agency basis. It is possible to have “User A” who has access to agencies 1 & 3 as a “Standard User”, and access to agency 2 as an “Administrator”. While “User B” only has access to Agency 2 as an Administrator. To create new agencies, or modify existing agencies within your ReadyOp domain, please contact ReadyOp customer support for more information.

 Devices

There are several different methods for accessing parts of the ReadyOp platform. While the primary method would be a standard laptop or desktop computer, users also have the ability to access the system using other devices such as Android phones and tablets, as well as iPhones and iPads. Although removing the ability to connect via a standard laptop or desktop computer is not possible, this section provides the ability to permit or remove access to the ReadyOp system on a per device, per user basis.

Creating a Device

Only users who have been assigned the administrative permission to manage devices will be able to create and/or assign new device.

1. Start by clicking the “Menu” button followed by “Access” in the top-right of the ReadyOp dashboard.
2. Inside the Manage Access dialog, select the “Devices” tab.
   • This tab may not be present if you have not been granted access to manage devices.
3. Continue by clicking the “New Device” button in the upper right corner of the dialog.
4. In the “New Device” dialog, fill out the relevant device information.
   1. Type
      • The type of device, currently options include Android, iPhone and iPad.
   2. Name
      • A friendly name used to identify the device. This can be used to make device management easier for you as an administrator.
   3. UUID
      • The UUID (Universally Unique Identifier) can be obtained from the device itself, after launching the ReadyOp application, it’s located at the very bottom of the “Settings” page.
      • This ID is automatically generated when the application is installed on the device, and will change if the application is ever removed and re-installed. It will remain the same through application updates.
5. In the “Users” tab, you’ll need to select which specific users have access to login to this device.
   • This means that if you only granted access to the user “John Doe”, no user other than “John Doe” could login using that specific device.
6. When finished, press the “Create” button to create the new device.

Deleting a Device

Only users who have been assigned the administrative permission to manage devices will be able to delete devices.

1. Start by clicking the “Menu” button followed by “Access” in the top-right of the ReadyOp dashboard.
2. Inside the Manage Access dialog, select the “Devices” tab.
   • This tab may not be present if you have not been granted access to manage devices.
3. Continue by double clicking the device you’d like to delete.
4. Inside the “Update Device” dialog, click the “Delete” in the bottom left corner.
5. You’ll be prompted with a warning notifying you that deleting the device is a permanent action, are you sure you’d like to continue.
6. To delete the device, press “Yes”, to cancel press “No”.

Modifying a Device

Only users who have been assigned the administrative permission to manage devices will be able to modify and/or assign devices.

1. Start by clicking the “Menu” button followed by “Access” in the top-right of the ReadyOp dashboard.
2. Inside the Manage Access dialog, select the “Devices” tab.
   • This tab may not be present if you have not been granted access to manage devices.
3. Continue by double clicking the device you’d like to modify.
4. In the “Modify Device” dialog, fill out the relevant device information.
   1. Type
      • The type of device, currently options include Android, iPhone and iPad.
   2. Name
      • A friendly name used to identify the device. This can be used to make device management easier for you as an administrator.
   3. UUID
      • The UUID (Universally Unique Identifier) can be obtained from the device itself, after launching the ReadyOp application, it’s located at the very bottom of the “Settings” page.
      • This ID is automatically generated when the application is installed on the device, and will change if the application is ever removed and re-installed. It will remain the same through application updates.
5. In the “Users” tab, you’ll need to select which specific users have access to login to this device.
   • This means that if you only granted access to the user “John Doe”, no user other than “John Doe” could login using that specific device.
6. When finished, press the “Update” button to save the devices updated information.

Groups

In ReadyOp groups provide a way of assigning permissions to a subset of users, or even a single user. Each ReadyOp installation comes with the following default groups; Super Administrator, Agency Administrator, Administrator, and Standard User. These 4 default groups are available in every agency and cannot be modified or deleted. Every user within the ReadyOp platform must be assigned to a single user group. Outside of the 4 default groups, new groups can be created with a specified set of permissions, enabling an administrator to setup fine grained access control lists. Groups are assigned a set of permissions, as well as which tabs the users in that group will be able to access, and groups are linked to agencies in which they are relevant.

Creating a Group

Users who have been granted permission to create groups will be allowed to create new groups for agencies and users in which they have access. It is not possible for an administrator to create or manage a group in an agency they do not have access in themselves.

1. Start by clicking the “Menu” button followed by “Access” in the top-right of the ReadyOp dashboard.
2. Inside the “Manage Access” dialog, select the “Groups” tab.
   • This tab may not be present if you have not been granted access to manage groups.
3. Continue by clicking the “New Group” button in the upper right corner of the Manage Access dialog.
4. A New Group dialog will appear. Enter the name for which you’d like to identify this new group.
5. Inside the new group dialog in the “Agencies” tab, select (using the available checkboxes) which agencies this group will be available in.
   1. When selecting each agency, you’ll be prompted with a “Select Tabs” dialog allowing you to specify which tabs inside that particular agency the user will have access to.
      • This allows you to further restrict access by providing a subset of users inside this group access only to specified tabs or sections of information.
      • Tabs that do not have a marked checkbox will not be visible for users in the group.
   2. When creating a new user and assigning them to an agency, only groups assigned to that agency will be available.
      • i.e. Creating a group and selecting only agencies 54 and 160, would not allow you to assign it to a user in any other agencies.
6. In the “Permissions” tab, select (using the available checkboxes) which permissions users assigned to this group will be given.
   • It is not possible to assign permissions to a group if your user profile does not have that permission. i.e. If you are a member of the “Agency Administrator” group, you do not have permission to “Create Agencies”; therefore, you wouldn’t be able to give someone else permission to do so.
7. When you are finished configuring your new group press “Create” to save the new group.

Deleting a Group

Users who have been granted permission to delete groups will be allowed to delete existing groups for agencies and users in which they have access. It is not possible for an administrator to delete a group in an agency they do not have access in themselves.

1. Start by clicking the “Menu” button followed by “Access” in the top-right of the ReadyOp dashboard.
2. Inside the “Manage Access” dialog, select the “Groups” tab.
   • This tab may not be present if you have not been granted access to delete groups.
3. Continue by double clicking on the group you’d like to delete.
   • It is not possible to delete any of the 4 default groups (Super Administrator, Agency Administrator, Administrator, Standard User).
4. Inside the “Modify Group” dialog, click the “Delete” in the bottom left corner.
5. You’ll be prompted with a warning notifying you that deleting a group is a permanent action, are you sure you’d like to continue.
6. To delete the group, press “Yes”, to cancel press “No”.

Modifying a Group

Users who have been granted permission to modify groups will be allowed to modify existing groups for agencies and users in which they have access. It is not possible for an administrator to create or manage a group in an agency they do not have access in themselves.

1. Start by clicking the “Menu” button followed by “Access” in the top-right corner of the ReadyOp dashboard.
2. Inside the “Manage Access” dialog, select the “Groups” tab.
   • This tab may not be present if you have not been granted access to manage groups.
3. Continue by double clicking the group you’d like to modify.
   • It is not possible to modify any of the 4 default groups (Super Administrator, Agency Administrator, Administrator, Standard User).
   • The Name box allows you to change the name of the group.
4. Inside the new Manage access dialog in the “Agencies” tab, select (using the available checkboxes) which agencies this group will be available in.
   1. When selecting each agency, you’ll be prompted with a “Select Tabs” dialog allowing you to specify which tabs inside that particular agency the user will have access to.
      • This allows you to further restrict access by providing a subset of users inside this group access only to specified tabs or sections of information.
      • Tabs that do not have a marked checkbox will not be visible for users in the group.
   2. When creating a new user and assigning them to an agency, only groups assigned to that agency will be available.
      • i.e. Modifying a group and selecting only agencies 54 and 160, would not allow you to assign it to a user in any other agencies.
5. In the “Permissions” tab, select (using the available checkboxes) which permissions users assigned to this group will be given.
   • It is not possible to assign permissions to a group if your user profile does not have that permission. i.e. If you are a member of the “Agency Administrator” group, you do not have permission to “Create Agencies”; therefore, you wouldn’t be able to give someone else permission to do so.
6. When you are finished configuring your group press “Save” to save your changes.

Annex

The Annex is a way of providing auxiliary information related to an agency that users can easily access.

 Categories

Annexes are divided into different user specified “Categories”, each category can have up to 10 user defined fields.

Creating a Category

Only users who have been granted permission to Manage Annex will have this option available. However, all users will be able to access the information provided by the Annex.

1. Start by clicking the “Menu” button followed by “Access” in the top-right of the ReadyOp dashboard.
2. Inside the Manage Access dialog, select the “Annex” tab.
   • This tab may not be present if you have not been granted access to manage the annex.
3. Continue by clicking the “New Category” button in the upper right corner of the dialog.
4. In the “New Category” dialog, fill out the relevant information for the annex category you’re creating.
   • Each category can have up to 10 user defined fields/columns and must have at minimum 4.
5.  Press “Create” to save the new category.

Deleting a Category

Only users who have been granted permission to Manage Annex will have this option available.

1. Start by clicking the “Menu” button followed by “Access” in the top-right of the ReadyOp dashboard.
2. Inside the Manage Access dialog, select the “Annex” tab.
   • This tab may not be present if you have not been granted access to manage the annex.
3. Continue by double clicking on the category you’d like to delete.
4. Inside the “Modify Category” dialog, click the “Delete” in the bottom left corner.
5. You’ll be prompted with a warning notifying you that deleting a category is a permanent action, are you sure you’d like to continue.
6. To continue deleting the category, press “Yes”, to cancel press “No”.

Modifying a Category

Only users who have been granted permission to Manage Annex will have this option available. However, all users will be able to access the information provided by the Annex.

1. Start by clicking the “Menu” button followed by “Access” in the top-right of the ReadyOp dashboard.
2. Inside the Manage Access dialog, select the “Annex” tab.
   • This tab may not be present if you have not been granted access to manage the annex.
3. Continue by double clicking the category you’d like to modify.
4. In the “Modify Category” dialog, modify out the relevant information for the annex category as designed.
   • Each category can have up to 10 user defined fields/columns and must have at minimum 4.
5.  Press “Save” to save your changes.

 Entries

Entries are can be created and imported underneath each individual category.

Creating an Entry

Only users who have been granted permission to Manage Annex will have this option available. However, all users will be able to access the entries provided in the Annex.

1. Start by right clicking in the empty white space on any of the standard dashboard tabs.
2. Select the category for which you’d like to create a new entry.
3. Inside the entry list dialog for the category, click the “Actions” button in the upper left corner, followed by “New Entry”.
4. In the “New Entry” dialog, enter the information for the entry you’d like to create.
   • For more information on the available fields for this particular category see Creating a Category or Modifying a Category.
5. Click “Create” to create your new entry.

Deleting an Entry

Only users who have been granted permission to Manage Annex will have this option available. However, all users will be able to access the entries provided in the Annex.

1. Start by right clicking in the empty white space on any of the standard dashboard tabs.
2. Select the category for which you’d like to delete the entry.
3. Inside the entry list dialog for the category, double click the entry you’d like to delete.
4. Inside the “Detail” dialog, click the “Delete” button in the bottom left corner.
5. You’ll be prompted with a confirmation dialog that deleting an entry is a permanent action, are you sure you’d like to continue.
6. To continue deleting the entry, press “Yes”, to cancel press “No”.

Modifying an Entry

Only users who have been granted permission to Manage Annex will have this option available. However, all users will be able to access the entries provided in the Annex.

1. Start by right clicking in the empty white space on any of the standard dashboard tabs.
2. Select the category for which you’d like to modify the entry.
3. Inside the entry list dialog for the category, double click the entry you’d like to modify.
4. In the “Detail” dialog, enter the information for the entry you’d like to modify.
5. Click “Save” to save changes.

Phone Numbers

The Phone numbers appear automatically for users who have their own SMS gateways ( the gateways read the numbers from the sim cards and the software pulls all the information).

Creating a Phone Numbers

To assign a phone number to users within the ReadyOp system, please contact ReadyOp customer support for more information. In the case that your organization uses their own SMS gateway, you need to contact the Administrator within your agency.

1. Start by clicking the “Menu” button in the top- right of the ReadyOp dashboard.
2. In the drop menu, select “Access” to bring up the manage access dialog.
3. Inside the manage access dialog, you will see the Phone Numbers tab display at the top of the dialog.
4. Press “Phone Numbers” and you will see a list of numbers and who they have been assigned to display.
5. Click the “ New Number” button. An available numbers dialog will appear.
6. Enter the area code and press “Search” to look for the available phone number in your area.
7. Double click the number you’d like to purchase.
8. You’ll be prompted with a confirmation dialog as seen in the screenshot below.

Deleting Phone Numbers

If your organization uses their own SMS gateways, you need to contact the Administrator within your agency. Otherwise, please contact a ReadyOp customer support for more information about deleting a phone number.

1. Start by clicking the “Menu” button in the top-right of the ReadyOp dashboard.
2. In the drop menu, select “Access” to bring up the manage access dialog.
3. Inside the manage access dialog, you will see the Phone Numbers tab display at the top of the dialog.
4. Press “Phone Numbers” and you will see a list of numbers and who they have been assigned to display.
5. Inside the phone numbers double click the number you’d like to delete. A manage phone number dialog will appear.
6. Press the ” Release” button to delete the selected number.
7. You’ll be prompted with a confirmation dialog as seen in the screenshot below.

 SMS Gateways

The SMS Gateway is a physical cellular network device used to facilitate sending and receiving SMS. They provide an interface for the ReadyOp dashboard to communicate with the cellular network.

Creating SMS Gateways

Depending on your permission level, you may or may not be able to create SMS gateways for your agency.

1. Start by clicking the “Menu” button in the top-right of the ReadyOp dashboard.
2. In the drop menu, select “Access” to bring up the manage access dialog.
3. Inside the manage access dialog, you will see the SMS Gateways tab display at the top of the dialog.
4. Press “SMS Gateways” and you will see a list of existing gateways display.
5. Click the “ New Gateway” button. A new SMS gateway dialog will appear.
6. Enter the information for the gateway and press “Create” to create the new SMS Gateway.

Deleting SMS Gateways

Depending on your permission level, you may or may not be able to delete SMS gateways for your agency.

1. Start by clicking the “Menu” button in the top-right of the ReadyOp dashboard.
2. In the drop menu, select “Access” to bring up the manage access dialog.
3. Inside the manage access dialog, you will see the SMS Gateways tab display at the top of the dialog.
4. Press “SMS Gateways” and you will see a list of existing gateways display.
5. Double click the gateway you’d like to delete. A modify SMS gateway dialog will appear.
6. Press the “Delete” button to permanently remove the gateway.
7. You’ll be prompted with a confirmation dialog as seen in the screenshot below

Suppressed Emails

This section contains a list of e-mail addresses that have unsubscribed or bounced. If a recipient of an e-mail from the ReadyOp system clicks the unsubscribe link in the footer of the email, they will be marked as having unsubscribed and any future e-mails sent to these addresses will appear as “Suppressed” in the e-mail history. On occasion you may need to remove a user from the unsubscribed list, if for example they accidentally unsubscribed themselves.

• This tab is only available for Agency Administrators to manage the suppression list.

Any recipient who meets the following criteria is added to the suppression list automatically:

• The recipient unsubscribed themselves using an unsubscribe link in an email.
• The recipient marked one of the emails as spam.
• An email sent to the recipient results in a hard bounce.

They are two different types of email bounces:

• Hard bounce
  • Recipient email address does not exist.
  • Domain name does not exist.
  • Recipient email server has blocked delivery.
• Soft bounce
  • Mailbox is full (over quota).
  • Recipient email server is down or offline.
  • Email message is too large.

Removing suppressed emails

Agency Administrators are granted permission to remove suppressed emails from the suppression list.

If you would like the recipient to start receiving emails from the system again.

1. Start by clicking the “Menu” button in the top-right of the ReadyOp dashboard.
2. In the drop menu, select “Access” to bring up the manage access dialog.
3. Inside the manage access dialog, click the Suppressed Emails tab displayed at the top of the dialog.
4. Double click the email address you’d like to remove from the suppression list. A Manage Suppressed Address dialog will appear.
5. Press the “Remove” button to eliminate the email address from the list of suppressed emails.
6. You’ll be prompted with a confirmation dialog asking you if you would like to remove the email from the suppression list.

Recording a New Alert

1. Start by clicking the “Menu” button in the top-right corner of the ReadyOp dashboard.
2. In the drop down menu, select “Alerts” to bring up the manage alerts dialog.
3. Inside the manage alerts dialog, open the “Actions” menu and select “Record Alert”.
4. A record new alert dialog will appear.  To begin recording, press the red “Record” button in the center of the dialog.  To end the recording, press the red “Stop” button.
   • Alerts can be up to 30 seconds in length.
   • You can playback as well as re-record your new alert as many times as you’d like before saving.
5. When finished, give the alert an easily identifiable name and press “Create Alert”.
   • Once an alert is created it cannot be re-recorded. It can, however, be renamed.

 Renaming Existing Alerts

1. Start by clicking the “Menu” button in the top-right corner of the ReadyOp dashboard.
2. In the drop down menu, select “Alerts” to bring up the manage alerts dialog.
3. Double click the alert you’d like to modify to bring up the “Update Alert” dialog.
   • Not only can you re-name an alert, but you can use this same dialog to replay the alert as many times as you’d like.
4. Here you can enter a new name for the existing alert.
   • Changing the name on an alert will also change all History records that show the alert being sent, to reflect the new name.
5. When you have finished renaming the Alert press “Save” to save the changes.

Importing Pre-Recorded Alerts

1. Start by clicking the “Menu” button in the top-right corner of the ReadyOp dashboard.
2. In the drop down menu, select “Alerts” to bring up the manage alerts dialog.
3. Inside the manage alerts dialog, open the “Actions” menu and select “Import Alert”.
4. In the Import Alert dialog, click “Choose File” to open the file selection menu.
5. Select the file stored on your computer you’d like to use for the alert.
6. Enter an identifiable name for the alert in the input field.
7. When you’re ready to import the new alert, click the “Import” button.

Creating a new TTSA (Text to Speech Alert)

1. Start by clicking the “Menu” button in the top-right corner of the ReadyOp dashboard.
2. In the drop down menu, select “Alerts” to bring up the manage alerts dialog.
3. Inside the manage alerts dialog, open the “Actions” menu and select “Text-to-Speech Alert”.

   

4. In the New Text-to-Speech Alert dialog, start typing the message you would like to send.
   • You can review your message before you send it. Click “Preview” to hear a preview of your alert.
5. Enter an identifiable name for the alert in the input field.
   

   

Deleting Alerts

1. Start by clicking the “Menu” button in the top-right corner of the ReadyOp dashboard.
2. In the drop down menu, select “Alerts” to bring up the manage alerts dialog.
3. Double click the alert you’d like to delete to bring up the “Update Alert” dialog.
   • You can also delete an alert by selecting one or more checkboxes in the alerts list and then pressing the “Actions” button followed by “Delete Selected”
4. Here you’ll be able to delete the alert from the active alerts list.
   • Deleted alerts will still appear in the history records if the alert was previously sent.
5. Once you have chosen the alert you would like to delete. Press “Delete” to remove the alert.
6. You’ll be prompted with a confirmation dialog asking if you’re sure you want to delete the alert.

Deleting Multiple Alerts

1. Start by clicking the “Menu” button in the top right corner of the ReadyOp dashboard.
2. In the drop down menu, select “Alerts” to bring up the manage alerts dialog.
3. At this point, use the checkboxes to select the alerts you’d like to delete.
4. When ready, open the “Actions” menu and choose the “Deleted Selected” option.
   • Deleted alerts will still appear in the history records if the alert was previously sent.
5. You’ll be prompted with a confirmation dialog before deleting the selected alerts.

Sending Alerts

Sending alerts requires an alert to have been pre-recorded. To learn how to create an alert before sending, visit the “Creating Alerts” section above.

• In order to send an alert you’ll need start by identifying the person(s) you’d like to send the alert to. These can be either person’s in an object, or person’s in the roster.
  • Alerts can only be sent to contacts that currently exist in the roster.

Selecting contacts by object or object(s)

1. Start by selecting one or more objects on the dashboard.
   • This can be accomplished by dragging a box from outside the objects, around the objects you’d like to select.
   • In addition, objects can be selected by holding the CTRL key (Windows), or the ⌘ Command key (Mac), and clicking in the whitespace of the objects you’d like to select.
2. Once selected click on any of the contact icons inside the objects to open the communicate dialog.

Selecting contacts inside Objects (Agencies, Roles / Teams)

1. Start by clicking on an object’s title to open the “Manage Object” dialog.
2. Inside this dialog, on the “People” tab you’ll see all the people that belong to the given Agency/ Role / Team. Select the person(s) you’d like to contact by clicking the checkboxes next to their contact options.
3. Once selected, click any of the contact icons to open the communicate dialog.

Selecting contacts through the Roster

1. Open the “Roster” tab to begin selecting people from the roster.
   • If you cannot find the roster tab, it’s possible the tab has been renamed or you do not have permission to access it, contact your Administrator for more information on how to find the Roster tab in your dashboard.
2. Here you can search for persons based on the given contact fields, you can select people by clicking the checkboxes next to their contact option icons.
3. Once selected, click any of the contact icons to open the communicate dialog.

Sending the Alert

1. After you’ve selected the person(s) you’d like to contact and have the communicate dialog open. Select the “Alert” option from the communication type picker in the communicate dialog.
2. After selecting the “Alert” option in the communication type picker and pressing “Continue” you’ll be prompted with the “Send Alert” dialog.
   • Inside this new dialog it’s possible to continue adding more contacts to send the alert. You can click drag contacts in the following locations into this dialog;
     1. The Search -> Tasks/Assets dialog.
     2. From inside a “Manage Object” dialog.
     3. You can drag objects themselves to add their occupants to the list.
     4. From the roster.
3. At this point it is necessary to select an alert you’d like to send. Continue by clicking the “Select Alert” button and pressing “Continue”.
   • You’ll be able to play it back before sending the alert. This can be done right within the “Send Alert” dialog.
4. Once you’ve selected the alert you’d like to send, you’ll have two more options to choose from.
   • Auto dial next number
     • When selected, the system will automatically dial each of the recipients numbers, once, in order until positive acknowledgement is received.
   • Auto delayed retry
     • When selected, the system will automatically dial each recipient a second time every (1-10 minutes). You will have to pick the number of times(1-9) the alert will be sent to the recipient after they did not acknowledge the alert the first time.
5. When you’re ready to send the alert, click the “Send Alert” button in the bottom right corner, and each recipient will be called automatically.
   • Additionally if you’d like the alert to be sent automatically in the future, you can select the “Schedule Alert” button, a schedule alert dialog will display. Enter a name for your scheduled alert and select the date and time you’d like the alert to be delivered. Press the “Schedule Alert” button to send the alert.

Lifecycle of an Alert

Placing a Call

• In order to start a call you’ll need start by identifying the person(s) you’d like to be connected to. These can be either person’s in an object, or person’s in the roster.
• Calls can be placed to both contacts that exist in the roster, as well as manually added numbers.

Selecting contacts by object or object(s)

1. Start by selecting one or more objects on the dashboard.
   • This can be accomplished by dragging a box from outside the objects, around the objects you’d like to select.
   • In addition, objects can be selected by holding the CTRL key (Windows), or the ⌘ Command key (Mac), and clicking in the whitespace of the objects you’d like to select.
2. Once selected click on any of the contact icons inside the objects to open the communicate dialog.

Selecting contacts inside Objects (Agencies, Roles / Teams)

1. Start by clicking on an object’s title to open the “Manage Object” dialog.
2. Inside this dialog, on the “People” tab you’ll see all the people that belong to the given Agency / Role / Team. Select the person(s) you’d like to contact by clicking the checkboxes next to their contact options.
3. Once selected, click any of the contact icons inside the objects to open the communicate dialog.

Selecting contacts through the Roster

1. Open the “Roster” tab to begin selecting people from the roster.
   • If you cannot find the roster tab, it’s possible the tab has been renamed or you do not have permission to access it, contact your Administrator for more information on how to find the Roster tab in your dashboard.
2. Here you can search for persons based on the given contact fields, you can select people by clicking the checkboxes next to their contact option icons.
3. Once selected, click any of the contact icons inside the objects to open the communicate dialog.

Starting the Call

1. After you’ve selected the person(s) you’d like to contact and have the communicate dialog open. Select the “Phone” option from the communication type picker in the bottom left corner. When you’re ready to continue, click the “Continue” button in the bottom right corner.

   

2. You’ll then be presented with following “Call” dialog.

   

   • Inside this new dialog it’s possible to continue adding more contacts to be connected. You can drag and drop contacts from the following locations into this dialog;
     • Search -> Tasks/Assets dialog.
     • From inside a “Manage Object” dialog.
     • You can drag objects themselves to add their primary occupant to the list.
     • From the roster.
     • It is possible to manually specify a phone number of a person you’d like to be connected with by typing their number into the Place a call input box.
   • If you’d like to remove a person from the list of recipients, simply drag and drop their name from the list of recipients outside of the Call dialog.
3. Click on the Caller ID number at the top of the Call dialog to configure your telephony options. This allows you, as the host of the call,  to specify how you would like to be connected. Available options are as follows;
   • My Computer
     • Also known as the Softphone. This connects you into the call via your computer. You’ll need to have configured a microphone in order for the participants to hear you once they have been connected. For more information on configuring a your microphone, see Communication Settings.
   • Cell
     • Connect via your cell phone as setup in your User Profile. This option is unavailable if you have not yet configured your cell phone in your User Profile.
   • Desk
     • Connect via your desk phone as setup in your User Profile. This option is unavailable if you have not yet configured your your phone in your User Profile.
4. After you have chosen the method in which you would like to be connected press the green Call button to begin the call/conference.
   • If you chose to be connected via the “My Computer” option, you should automatically be connected, and the recipients will be dialed automatically. If you chose to be connected via either your cell or desk phone you should receive a phone call to your physical phone/device. Once you answer your phone (either cell or desk) the participants will then be called automatically.
   • As each participant answers the call they will automatically be bridged into the call/conference. Their status in the “Call” dialog will be updated automatically as “Active” and you should hear an audible tone indicating a participant has joined.

Adding Participants

Once a call has started, contacts can be added by the following methods:

Adding contacts by object or object(s)

1. Start by selecting one or more objects on the dashboard.
   • This can be accomplished by dragging a box from outside the objects, around the objects you’d like to select.
   • In addition, objects can be selected by holding the CTRL key (Windows), or the ⌘ Command key (Mac), and clicking in the whitespace of the objects you’d like to select.
2. Once selected drag and drop them into the active call dialog.

Adding contacts inside Objects (Agencies, Roles / Teams)

1. Start by clicking on an object’s title to open the “Manage Object” dialog.
2. Inside this dialog, on the “People” tab you’ll see all the people that belong to the given Agency / Role / Team. Select the person(s) you’d like to contact by clicking the checkboxes next to their contact options.
3. Once selected drag and drop them into the active call dialog.

Adding contacts through the Roster

1. Open the “Roster” tab to begin selecting people from the roster.
   • If you cannot find the roster tab, it’s possible the tab has been renamed or you do not have permission to access it, contact your Administrator for more information on how to find the Roster tab in your dashboard.
2. Here you can search for persons based on the given contact fields, you can select people by clicking the checkboxes next to their contact option icons.
3. Once selected drag and drop them into the active call dialog.

Adding contacts manually by name

The first row in the participants list of the communicate dialog contains a field that allows you to lookup a contact by name. Simply type the name of the contact you’d like to add and when the autocomplete drop down appears, click the contact’s name to add them to the call.

Adding recipients manually by number

The first row of the participants list in the active call dialog contains a field that allows you to directly input the phone number of someone you’d like to call. Simply type the number in the “Place a Call” input box and press the call button to add the recipient to the call.

Disconnecting Participants

To disconnect a participant simply drag and drop the participant from the active call participant list outside of the dialog, they will be automatically disconnected.

Muting/Unmuting Participants

During an active call, you’ll be provided with the options for both muting and unmuting an active participant.

Creating Objects

Before you can begin creating objects you’ll need to enter Designer Mode.

1. Select the Menu button in the upper right corner of the dashboard’s toolbar to open the drop down menu. Choose the Designer Mode option.
2. Once in Designer Mode, select the Menu button again in the upper right corner of the dashboard’s toolbar.
3. The drop down menu will appear. This time, choose “New Object”.
4. A New Object popup dialog will appear in the center of the screen.
5. Fill in the desired information, at this point you are able to specify the new object’s information, including but not limited to the following;
   • Type
     • Specified (Agency/Role, Camera, Team)
   • Tab
     • Which Tab the new object will appear on.
   • Name
     • The name that will identify the new object.
   • Subtitle
     • The name that will be displayed below the object’s name.
   • Occupant
     • The person that will be identified as the primary point of contact for the new object.
   • Weblink
     • A website address
6. Press “Create” when you are finished to create your new object.
   • Objects cannot be created on every type of tab. Some special built-in tabs such as the Roster, Logbook, Tracking, Forms, Dispatch, Files, etc cannot have objects in them.

Moving Objects

1. When in designer mode it’s possible to move an object or objects by clicking in the object and dragging the object around on the canvas. You can also select multiple objects by clicking and dragging on the canvas, or holding the CTRL key or Command key and clicking on multiple objects.

Resizing Objects

1. To resize objects, you follow the same procedures as you would to move an object, however, instead of clicking in the object click on the object’s border, click and hold down while dragging on the bottom right corner of one of the selected objects.

Before you can begin communicating through ReadyOp, you’ll need to change your browser’s permission settings in order to use your computer’s microphone. In addition to allowing or denying access to your microphone and camera, you can also configure which microphone the ReadyOp dashboard will use for communications.

When attempting to make a voice call or Push-to-Talk on a (dispatch) radio channel for the first time, you will receive a browser alert asking to “Allow” microphone access. Click “Allow” to enable access to your computer’s microphone.

To manage your microphone permissions/settings, click on the lock icon to the left of the site’s URL.

Panels are used as a minimalistic approach to providing users with easily accessible auxiliary information. This information can include real time status updates through the Feed, as well as manually logged info through the Journal, and links to outside information or resources.

Feed

The feed is an encrypted real time communications feed that is sent to all online users in that particular agency. Including users logged in through the ReadyOp mobile applications.

Accessing the Feed

1. Start by clicking the “Feed” tab on the right side of the ReadyOp dashboard. 
   • For help locating this tab, contact your system administrator as it may have been re-named.
2. A news feed dialog will display, any messages that have been sent or received within the last 24 hours will appear automatically inside this tab.
3. To send a message, type the message you would like to send in the input box and press enter.
   • This input box may not be available to all users, depending on your user profile and permission level.

Info & Links

The Info & Links are two different sections that work the same way, and they are a way of accessing links to external information/web pages. An administrator can add links to external websites that will be available for every user of that specific agency.

Creating a Link

1. Start by opening the “Info” tab to expand on the right side of the ReadyOp dashboard. 
   • For help locating this tab, contact your system administrator as it may have been re-named.
2. When expanded, click the pencil icon to open the manage links dialog in the upper right hand corner of the info tab.
3. Inside the dialog you’ll find a list of existing web links. Click the “New Link” button to bring up the new link dialog.
4. Enter the link information and press “Create” to save and create the new link.

Deleting a Link

1. Start by opening the “Info” tab on the right side of the ReadyOp dashboard. 
   • For help locating this tab, contact your system administrator as it may have been re-named.
2. Click the pencil icon to open the manage links dialog 
3. Inside the dialog you’ll find a list of existing web links. Double click the link you’d like to delete.
4. Press the “Delete” button to continue, at which point you’ll be prompted one final time with a warning before the link is removed.

Modifying a Link

1. Start by opening the “Info” tab on the right side of the ReadyOp dashboard. 
   • For help locating this tab, contact your system administrator as it may have been re-named.
2. Click the pencil icon to open the manage links dialog. 
3. Inside the dialog you’ll find a list of existing web links. Double click the link you’d like to modify.
4. Change the links information and once complete press “Save” to save your changes.

Journal

The ReadyOp Journal is a way to enter a daily record of events or news. This information is shared with all users who have permission, in the given agency.

Creating an Entry

1. Start by opening the book icon tab on the right side of the ReadyOp Dashboard 
   • For help locating this tab, contact your system administrator as it may have been re-named.
2. Click the pencil icon to open the manage journal dialog 
3. Inside the manage journal dialog, you will find a list of created entries. To continue creating your new entry press the “New Link” button in the upper left corner.
   • News entries are not shared with mobile users on the ReadyOp DT application.
4. Enter the message you’d like to log and press “Create” to create the new entry.
   • Journal entries cannot be modified or deleted once created.

News

The ReadyOp news function is similar to the journal in that you can post various messages and information you’d like to share with other Dashboard users. The primary difference is that in addition to creating news entries an administrator can modify and delete information as well. Like the journal, news entries are not shared with mobile users on the ReadyOp DT application.

Creating an Entry

1. Start by opening the “News” tab on the right side of the ReadyOp dashboard. 
   • For help locating this tab, contact your system administrator as it may have been re-named.
2. Click the pencil icon to open the manage news dialog 
3. Inside the manage news dialog, you’ll find a list of created entries. To continue creating your new entry press the “New Entry” button in the upper left corner.
4. Enter the message you’d like to log and press “Create” to create the new entry.

Deleting an Entry

1. Start by opening the “News” tab on the right side of the ReadyOp dashboard. 
   • For help locating this tab, contact your system administrator as it may have been re-named.
2. Click the pencil icon to open the manage news dialog 
3. Inside the dialog you’ll find a list of existing news entries. Double click the entry you’d like to delete.
4. Press the “Delete” button to continue, at which point you’ll be prompted one final time with a warning before the entry is removed.

Modifying an Entry

1. Start by opening the “News” tab on the right side of the ReadyOp dashboard. 
   • For help locating this tab, contact your system administrator as it may have been re-named.
2. Click the pencil icon to open the manage info dialog. 
3. Inside the dialog you’ll find a list of existing news entries. Double click the link you’d like to modify.
4. Change the entry’s information and once complete press “Save” to save your changes.

ReadyOp has several different types of information that can be searched via the Search feature in the dashboard toolbar. These types include Assets, Tasks, and Objects.

Searching Assets

1. Start by clicking the “Search” option in the ReadyOp dashboard toolbar.
2. Select the “Assets” option from the drop down menu.
3. The asset search dialog will then appear, at this point you are able to search for assets on the dashboard.
   1. Assets are created and managed through the Object (Agency, Role/Team) that they are created under.
   2. It’s possible to use these searched assets to contact the occupant for the Object that owns them.

Searching Tasks

1. Start by clicking the “Search” option in the ReadyOp dashboard toolbar.
2. Select the “Tasks” option from the drop down menu.
3. The task search dialog will then appear, at this point you are able to search for tasks on the dashboard.
   1. Tasks are created and managed through the Object (Agency, Role/Team) that they are created under.
   2. It’s possible to use these searched tasks to contact the occupant for the Object that owns them.

Searching Objects

1. Start by clicking the “Search” option in the ReadyOp dashboard toolbar.
2. Select the “Objects” option from the drop down menu.
3. The object search dialog will then appear, at this point you are able to search for objects on any tab in the dashboard.
   1. It’s possible to use these searched objects to contact the occupant for the given Object or Object(s).

In ReadyOp, contacts are managed through the Roster. Contacts are people with whom you can communicate. There is no limit to the number of contacts you can have in a Roster.  We recommend managing contact information with tags, titles and other information to make finding contacts much easier.

Viewing Contacts

Viewing Contacts is as simple as opening the Roster tab. To view details for a specific Contact, double click on the Contact’s name in the list. Depending on your permission level, you may or may not be able to view/edit this information.

Contacts can be assigned various information such as their Title/Job Duty, Organization, and Tags. All of this information is searchable through the Roster. Online users will have their name and information highlighted in green, as seen in the following screenshot.

Adding Tags

Tags are a very useful added information designed to make searching for Contacts easier. Examples of tags could include “Hazmat”, “K9”, “Neurosurgeon”, etc. In some cases it may necessary to add a specific tag to Contacts to many people.

1. Start by opening the “Roster” tab in the ReadyOp dashboard.
   • This tab may have been re-named, or you may not have permission to access this tab. Please contact your system administrator for more information on locating the Roster.
2. Select one or more contacts in your roster by marking the checkboxes in the first column next to the roster entries.
3. Click the “Actions” button in the upper left corner, followed by the “Add Tags” link to bring up the new contact dialog.
4. Enter the new tag or tags you’d like to have added to the selected contact(s) and press “Add Tags”.
   • When adding tags, it’s recommended to use a comma “,” as a separator. i.e. To add the tags “Doctor” and “Pediatrician”, type “Doctor, Pediatrician”.

Creating Contacts

When creating a contact, it’s possible to create a contact that is visible to only your user, and if you have permission, you can create contact’s that are visible to all users throughout the given agency.

1. Start by opening the “Roster” tab in the ReadyOp dashboard.
   • This tab may have been re-named, or you may not have permission to access this tab. Please contact your system administrator for more information on locating the Roster.
2. Click the “Actions” button in the upper left corner, followed by the “New Contact” link to bring up the new contact dialog.
3. Inside the new contact dialog. Enter the information about the contact.
   • Each contact can have up to 5 e-mail address and phone numbers.
   • In order to send SMS messages to a phone number, that number must have the “Textable” option checked.
   • In order to communicate with other ReadyOp Dashboard users, the contact must be linked to an existing user account.
   • Specify a PIN number if you’d like to require the contact to enter a PIN number when receiving an alert before they are able to hear the message.
4. Press “Create Contact” when you’re ready to save the new contact.

Deleting Contacts

There are two different ways to delete a contact, one at a time, and multiple.

Deleting Multiple Contacts

1. Start by opening the “Roster” tab in the ReadyOp dashboard.
   • This tab may have been re-named, or you may not have permission to access this tab. Please contact your system administrator for more information on locating the Roster.
2. In the list of contacts, select the contact(s) you’d like to delete by marking the checkboxes in the first column next to the roster entries.
3. Click the “Actions” button in the upper left corner followed by the “Delete Selected” option to delete the contact(s).
4. After selecting the delete option. A Confirmation popup box will appear prompting you to confirm that you’d like to permanently delete the selected contacts.

Deleting a Single Contact

1. Start by opening the “Roster” tab in the ReadyOp dashboard.
   • This tab may have been re-named, or you may not have permission to access this tab. Please contact your system administrator for more information on locating the Roster.
2. In the list of contacts, double click the contact you’d like to delete to bring up the manage contact dialog.
3. Inside the manage contact dialog. Press the “Delete” button to continue.
4. After selecting the delete option. A Confirmation popup box will appear prompting you to confirm that you’d like to permanently delete the selected contact.

Exporting Contacts

Contacts can be exported from the ReadyOp Dashboard in XLXS format (Microsoft Excel 2007).

Exporting All Contacts

1. Start by opening the “Roster” tab in the ReadyOp dashboard.
   • This tab may have been re-named, or you may not have permission to access this tab. Please contact your system administrator for more information on locating the Roster.
2. Click the “Actions” button in the upper left corner followed by the “Export Contacts”.
3. Contacts can then be exported by selecting either “Export All”, as well as “Export Filtered” or “Export Selected”.
   • The Export Filtered option will appear when you’ve searched to filter the roster by one or more of its fields.
   • The Export Selected option will appear if you’ve specifically selected one or more roster entries.
4. Contacts are exported into the same file format in which they can be imported.
   • The exported list will also contain a column of Contact ID numbers, these numbers are used to reference existing contacts so that an import of a changed roster spreadsheet can be used to update existing roster entries.

Importing Contacts

Contacts can be imported from XLS, XLXS or CSV to create new contacts or update existing contacts. When importing a list of contacts, the order of column’s is not important, as long as the column names in the header row are spelled correctly.

1. Start by opening the “Roster” tab in the ReadyOp dashboard.
   • This tab may have been re-named, or you may not have permission to access this tab. Please contact your system administrator for more information on locating the Roster.
2. Click the “Actions” button in the upper left corner followed by the “Import Contacts” option.
3. Choose the file stored in your computer with the contacts information.
   • To obtain a copy of the file format for importing contact’s, see “Exporting Contacts”.
4. Before you’re finished importing the contacts, you’ll be prompted with a review dialog displaying all the contacts to be added/modified.
   • Contact’s that were exported and re-imported will be automatically matched based on their Contact ID, and updated.
   • If a contact in the import list doesn’t have a Contact ID specified, or the Contact ID doesn’t exist, it’l be created as a new entry

Request Contact Update

An Update Request is a great way to get a quick update from people who are included in the Roster.

• Update requests can be sent to any valid email address in the Roster.
• When you send an update request, the recipient will receive an email with a link that they can click to edit specific data without signing in to ReadyOp.

Requesting Contact(s) Update

1. Start by opening the “Roster” tab in the ReadyOp dashboard.
   • This tab may have been re-named, or you may not have permission to access this tab. Please contact your system administrator for more information on locating the Roster.
2. Select the contact(s) you would like to send the request.
3. Click the “Actions” button in the upper left corner followed by “Request Update” to bring up the self request dialog.
   • At this point you can drag and drop more people into the dialog before sending the request.
4. Press “Send Request” when you are ready to send the request.
5. You’ll be prompted with a confirmation dialog. Press “Yes” if you would like to send the request or “No” to cancel it.

Additional Roster Columns

If you have been granted Agency Administrator rights, you are enable to add up to 10 custom columns to your Roster to have more information on each contact, i.e. employee numbers, address, city, State, Zip Code, Contributor amount, training completed, special skills, etc.

1. Start by clicking the “Menu” button followed by “Access” in the top-right of the ReadyOp dashboard.
2. Inside the Manage Access dialog, select the “Agencies” tab.
   • This tab may not be present if you have not been granted access to manage agencies.
3. Continue by double clicking on your agency. A Modify Agency dialog will display with all the additional columns you can add to the right of the box.
   • Note: All the columns will appear in the order they were entered. If changes are made at later date and a column is changed, the prior information for this column for each individual will also be deleted.
4. After you have entered the new Roster field name. Press “Save”  and the new column headers will be added to the Roster.
   • The data in the custom columns will be importable, exportable as well as sortable and searchable in the same way as the built in roster data fields.

The ReadyOp Dashboard’s secure link provides secure encrypted end to end communications between two or more users of the ReadyOp system. This provides users with the ability to securely communicate using chat as well as audio and video conferencing. In addition, it provides encrypted file transfer, allowing even sensitive files to be shared between users.

Starting a Secure Link

To start a secure link conversation with other users;

1. Start by selecting the person or persons you’d like to communicate with.
   •  People can be selected from several different sources, whether it be in the roster, inside an object/role/team on one of the dashboard’s tabs, or even through the search feature.
2. Continue by clicking the secure chat icon. 
3. A communicate dialog will appear allowing you to continue adding people to the secure link before you actually create it.
   • At this point it’s possible to drag and drop more people into the conversation before you begin.
   • It’s also possible to manually add people by searching for their name using the Name input field at the top of the Communicate dialog.
4. To start your secure conversation, continue by pressing the “Continue” button in the bottom right-corner of the dialog.

Sending files

To send a file through the secure link;

1. Start by pressing the “Upload File” link in the upper-right corner of the secure chat dialog.
2. A file selection dialog will appear, at which point you can easily select a file you’d like to transmit.
   • Sent files are saved in the history and can be downloaded even after the conversation has ended. This allows you to send a message and an attachment to another user who may be offline, when the user logs in they’ll be able to retrieve your messages and file from their history.

Audio/Video conferencing

To start an audio/video conference;

1. Start by selecting the person or persons you’d like to communicate with.
   • People can be selected from several different sources, whether it be in the roster, inside an object/role/team on one of the Dashboard’s tabs, or even through the search feature.
2. Click the secure chat icon  to start the secure conversation.
3. A communicate dialog will appear allowing you to continue adding people to the secure link before you actually start it.
   • At this point it’s possible to drag and drop more people into the conversation before you begin.
   • It’s also possible to manually add people by searching for their name using the Name input field at the top of the Communicate dialog.
4. Click the “Continue” button in the bottom-right corner of the communicate dialog.
5. A secure chat dialog will appear, press the “Call” button in the bottom left-corner. This will begin calling the other participants.
   • Once they’ve answered you’ll have two new buttons for enabling and disabling your microphone and camera.
   • To view another user’s video feed, simply double click on their name in the list of participants in the left side of the secure link dialog. As long as they’ve enabled their camera, you’ll be able to see their video feed.

*Only the person who started the secure link (the Host) is able to start a video/audio conference. The option will not be available for individual participants.

Adding/Removing Participants

To add one or more participants;

1. Start by selecting the person(s) you’d like to add, as if you were going to create a new secure chat.
2. Once you’ve made your selection(s), simply drag and drop the selected people into the secure link dialog.
   • To remove a person, drag their name from the participants list and drop them out of the dialog.

*Only the person who started the secure link (the host) is able to add or remove participants.

Sending text messages

To start sending text messages to other users;

1. Start by selecting the person or persons you’d like to communicate with.
   1. People can be selected from several different sources, whether it be in the roster, inside an object/role/team on one of the Dashboard’s tabs, or even through the search feature.
2. Continue by clicking the text message icon. 
3. A communication dialog will appear allowing you to continue adding people to the text messages before you actually create it.
   1. At this point it’s possible to drag and drop more people into the text message before you begin.
4. To start sending your text message, continue by pressing the “Continue” button in the bottom right-corner of the dialog.
5. A SMS dialog will appear;
   1. You’ll see a box in the bottom right section with the label “Type your message here, press enter to send.” It’s in this box you can type what you’d like to send to the other participants, and press enter to send your message. Messages are securely transmitted and stored in the history for later reference.

The Status Display is always visible and will indicate the user name as well as your user group. (Standard User, Administrator, Super Administrator, etc). The Status Display is shown in the upper-left corner of the dashboard and will always indicate your online/offline status.

Note: In certain situations, it is possible to login to ReadyOp and while working with the system become offline due to external conditions such as a loss of Internet or network connection or a firewall issue. Such changes in your network connectivity will be reflected in the Status Display.

Sending a Unified Notification

The Unified Notification feature provides a seamless integration of multiple communication methods that normally must be done on an individual basis. This feature combines e-mail, SMS and recorded voice alerts into a single, easily accessible interface.

To send a Unified Notification to your contacts;

1. Start by selecting the person or persons you’d like to communicate with.
   • People can be selected from several different sources, whether it be in the roster, inside an object/role/team on one of the Dashboard’s tabs, or even through the search feature.
2. Continue by clicking any of the communications icons next to one of the contacts.
3. A communicate dialog will appear allowing you to continue adding people before you continue to send it.
   • At this point it’s possible to drag and drop more people into the communicate dialog before you begin.
4. Change the communication method in the drop down picker to “Unified Notification” and press the “Continue” button to proceed.

   

5. Once the Unified Notification dialog has appeared you will need to use the corresponding checkboxes above the contact list to select the types of communications you would like to send (SMS, Voice, Email)

   

6. On the right size of the dialog you’ll need to use the provided text area to type the message you would like to send to the selected contacts.
   • If you’ve checked the Voice option, your message will automatically be converted to voice using our Text-To-Speech feature. You can preview the recording by using the Preview button.

   

7. When you’re ready to send the notification, simply press the “Send Notification” button and your notification will be queued and sent automatically in the background.

ReadyOp’s tracking feature makes it simple to manage your organizations valuable assets, your employees / users. This allows you to instantly locate any one of your users who are connected via our ReadyOp DT application for smartphones and tablets. ReadyOp uses Maps as a management tool, people are shown on a Map, making it easy to assign jobs to the nearest available user part of the group/agency. By getting real-time visibility into where teams are and what jobs they are doing, work can be scheduled in a smarter, more efficient way.

To locate any of the users connected to the ReadyOp DT application:

1. Start by clicking the “Tracking” tab on the ReadyOp dashboard.
   • The tab may have been renamed or disabled. For help locating the Tracking tab contact your system administrator.
2. You’ll see a list of existing users that have logged in, through the ReadyOp DT application, on the left side. Select the user(s) you’d like to locate on the map by marking the checkboxes.
3. A pin will appear for each of the selected users on the map.
   • To view details about a specific pin, simply click the pin on the map.

Entering designer mode is required before you can create or modify tabs, as well as creating, moving or resizing objects. You can enter or exit designer mode by selecting either “Enable Designer” or “Disable Designer” from the toolbar Menu.

The user profile allows you to update your own user’s information. Here you can update your name, phone numbers, e-mail address as well as password and caller id. You can also use the user profile to view which agencies you have access to as well as which devices you’re authorized to login through.

To access the manage user profile dialog click “Menu” in the upper right corner of the ReadyOp toolbar. From the menu select “Profile”.

Profile Fields:

Configuring your Caller ID #

The Caller ID # is the phone number that recipients will see when you call them via the ReadyOp system. For example; if your Caller ID was configured as +18132897620, when you make a phone call via ReadyOp, the receiving person would receive an incoming call from +18132897620.

How to change a Caller ID #

1. Start by clicking the “Menu” followed by “Update Profile” in the top-right of the ReadyOp dashboard.
2. Use the “Caller ID #” input box to enter the Caller ID number you’d like to use.
3. When finished press “Save” to save the new number.

How to validate a Caller ID

Due to FCC regulations, your Caller ID number will need to be a number you can verify. This means you must be able to receive and answer phone calls at the phone number specified. It is not possible to change your Caller ID number to a number you are unable to verify. Once you save your profile, you’ll be prompted instructions that will walk you through the Caller ID verification process.

1. After saving your profile settings, if your Caller ID number has not yet been verified, you’ll be prompted with the following dialog.

2. 

   The verification window will walk you through the process of verifying your Caller ID. To begin the process, press Continue.

3. After pressing Continue the dialog will change and give you a random 6 digit numeric code.

4. 

5. You’ll also receive a phone call at the number you provided. You’ll need to answer the phone call and when prompted, enter the number displayed in the verification dialog.
6. The automated voice should acknowledge you entered the code correctly and your Caller ID is now properly configured and verified once you hang up.

ReadyOp’s tabs allow administrators to easily segregate different parts of their dashboard into different sections. Objects can easily be added to tabs and arranged however an organization may want the data to be presented.

Creating a Tab

1. Modifying a tab first requires you to be in “Designer Mode”. To toggle designer mode on or off, start by clicking “Menu” in the upper right corner of the dashboard’s toolbar.
2. In the menu drop down, select “Enable Designer” to enable designer mode.
3. Once enabled, a new tab icon will appear after the last tab on your dashboard.  Clicking this icon will bring up the new tab dialog.

Tab Information

A couple pieces of information are used to identify tabs and make life easier on your users. Explanations are as follows;

• Name
  • This is the name that appears in the clickable tab itself, the part that user’s click on to open the tab’s content.
• Title
  • The title is displayed in a large font on the tab after a user has opened it. This doesn’t have to be the same as the tab name itself. For example, the tabs name could be “HICS”, while the tab’s title could be “Bravo County Hospitals”.
• Subtitle
  • Subtitles are displayed under the title when viewing the tab. Given the previous example, an appropriate subtitle may be “Hospital Incident Command Structure”.
• Date
  • The date is a user defined field.

Updating a Tab

1. Updating an existing tab first requires you to be in “Designer Mode”.
2. To toggle designer mode on or off, start by clicking “Menu” in the upper right corner of the dashboard’s toolbar.
3. In the menu drop down, select “Enable Designer” to enable designer mode.
4. Once enabled, you’ll be able to right click on any of the tabs on your dashboard that you’d like to modify and select the “Modify” option. This will then bring up the “Modify” tab dialog.

Deleting a Tab

1. Deleting an existing tab first requires you to be in “Designer Mode”.
2. To toggle designer mode on or off, start by clicking “Menu” in the upper right corner of the dashboard’s toolbar.
3. In the menu drop down, select “Enable Designer” to enable designer mode.
4. Once enabled, you’ll be able to right click on any of the tabs on your dashboard that you’d like to delete and select the “Delete” option.
   Warning: Deleting a tab is permanent and will remove all objects on the tab.
   
5. You’ll be prompted with a confirmation dialog asking if you’re sure you want permanently delete the alert.

The ReadyOp dispatch/radios facilitates secure communications between radios channels as well as dashboard to dashboard, it makes it easy to access and reach people within your organization when they’ve logged in through the ReadyOp system as well as when they are connected via land mobile radio systems (for more information on connecting to land mobile radios, see the AudioMate 360).

Creating a Radio

1. Start by opening the Radios/Dispatch tab.
   • This tab may not be present if you have not been granted access to manage radios.
2. Click “New Radio” in the upper-left corner of the dispatch tab to bring up the new radio dialog.
3. In the new radio dialog enter the desired details for your new radio and press “Create” to save the new radio.
   • Creating a radio will make it by default available only to Super Administrators. You can add permission to access the radio channel by modifying the radio after it has been created.

Field	Explanation
Name	The name of the radio as you’d like it to appear on the radio itself and in the list of available radios
Identifier	Used similarly to a username, this allows you to configure an AM360 to authenticate and connect to the radio channel.
Key	Similar to a password, this allows you to configure an AM360 to authenticate and connect to the radio channel.

Deleting a Radio

1. Start by either double clicking the radio you’d like to delete from the list of existing radios on the left side of the dispatch tab or by clicking on the underlined name of the object on one of the active radios.
2. In the Manage Radio dialog, click the “Delete” button to delete the radio. You’ll then be prompted with a confirmation dialog for which you’ll have to confirm you want to permanently delete the radio channel.
   • When a radio is deleted it is removed for all users.

Showing a Radio

•  Drag and drop the radio from the list of radios in the left pane into the dispatch tab’s active radio space.
  • Showing a radio only applies to your particular user profile and does not affect other users.

Hiding a Radio

• Right click the radio you’d like to hide and select the “Hide” option.
  • In addition, you can select multiple radios by dragging a box in the active dispatch area around the radio objects you’d like to hide, or by holding the CTRL (for Windows) or Command ⌘ (for OSX) key and clicking the radios you’d like to select.
  • Hiding a radio only applies to your particular user profile and does not affect other users.

Making a Radio Active or Inactive

• To activate/deactivate a radio press the power symbol in the bottom right corner of the radio. This will toggle the radio channel between active or inactive.
  • Radios that are inactive will not have history automatically appear in the history pane, and you will not see any indications of audio transmissions until activated.
  • This only applies to your particular user profile and does not affect other users.

Volume

The volume bar is located on the left side of the PTT button in a vertical direction of the radio box. It can be adjusted for higher or lower to change the volume of audio in the radio channel. This only applies to your user profile and does not affect other users.

Balance

The balance bar is located under the PTT button in a horizontal direction of the radio box. It is used to move the audio further to either the left or right speaker. For example, you could adjust one channel all the way to the left speaker, and one all the way to the right speaker and audio from one channel would only play out the left speaker and audio from the other would only play out the right speaker. This only applies to your user profile and does not affect other users.

Mute/Unmute

 Clicking the mute icon in the bottom right corner of a radio channel will allow you to toggle the radio channel between muted and un-muted. While muted, audio will not be transmitted to your client, however, real time history information as well as visual indications of channel traffic will still appear.

Status Indicator

 The status indicator allows you to easily check whether or not a radio gateway (AM360) is connected (if a radio gateway has been configured for the channel). It will show a red network indicator icon if the gateway is not currently connected to the system and a green network indicator icon if the gateway is currently connected.

Permissions

Channel permissions allows you to define which user groups or roles permission to view, listen only or listen and talk on various radio channels. By default when a channel is created only the Super Administrator has access to view as well as listen and talk on the channel.

Granting Permission

The default group cannot be deleted or modified. If your user profile permits access, you will be able to manage which groups can view, listen only or listen and talk on a particular channel.

Inside the dispatch tab;

1. If the radio hasn’t been dragged from the dispatch list to the dispatch/radios dashboard. Double click the radio you’d like to change the permissions for from the existing list of radios.
   • If the radio is on the dispatch/radios dashboard. Left-click on the radio’s underlined name to open it.
2. Inside the Manage Radio dialog, select “Add Groups” to bring up the Add Groups dialog.
3. Select the group(s) you’d like to add by marking the checkbox next to their name.
4. Click the “Add Groups” button, to add the selected group(s).
   • By default groups are added with the listen only permission.
5. To allow users in a particular group to talk on the radio channel, you’ll need to change the access level using the picker in the permissions list.
   • If a group has not been added to the list, the radio will not be visible or even appear to exist for users in those groups.

Revoking Permission

The default group cannot be modified. If your user profile permits access, you will be able to manage which groups can view, listen or listen and talk on a particular channel.

1. Inside the dispatch tab;
   • If the radio hasn’t been dragged from the dispatch list to the dispatch/radios dashboard. Double click the radio you’d like to change the permissions for from the existing list of radios.
   • If the radio is on the dispatch/radios dashboard. Left-click on the radio’s underlined name to open it.
2. In the Manage Radio dialog, left-click the “delete” icon next to the group to remove access for the group.
   • To simply restrict access to listen only instead of removing access for a group you can use the picker in the permissions list.
3. To save your changes, press “Save”.
   • Changing a groups access may require the users in the group to logout and log back in before the change takes effect.

The File Manager allows users access and distribute shared files in a way similar to windows shared folders.

Creating a Folder

1. Open the “Files” tab in the top of the dashboard.
2. Right-click on any of the empty spaces under “Name” in the files or left click on the “New Folder” button in the top left corner of the dashboard.
3. A new folder tab will appear.
4. Left-click the “New Folder” tab to create a new folder.

Note: An untiled folder will be created first for you to rename it later.

Renaming a Folder

1. Right-click the “Untiled Folder” and you’ll see a rename option appear.
2. To rename the file, left-click “Rename”.
3. The untitled folder will be highlighted in blue and you’d be able to rename the file.
4. After typing the name, press enter to rename the file.

Deleting a Folder

1. Right-click the file you’d like to delete and you will see a delete option appear.
2. To delete the file, left-click “Delete” and the file would be deleted.

Forms

ReadyOp forms allow you or any of your users with administrative rights to create and design your own electronic forms for surveys, reporting, etc. A form can be designed for one time use (such as an election ballot, event registration, event feedback) or can be used on an ongoing basis (such as “See something, say something,” incident report, daily/weekly status reports).

Recipients can be anyone in the Roster – they do not need to have User credentials.  The forms can be completed and sent securely from a user’s laptop or smartphone.

Creating or Modifying a Form

1. Start by selecting the “Forms” tab at the top of the ReadyOp dashboard.
   • This tab may not be present if you have not been granted access to manage the forms.
   • After a form has been saved and published, it can be accessed directly from the Forms tab.
   • A link to the form can be emailed to a single or group of recipients for their one time or ongoing use.
2. Once you’re in the forms tab the window will be divided into two sections.
   • On the left side of the window will be a list of any already created/existing forms, as well as an an action toolbar above the list.
   • The right hand side will show the form preview window, when you initially load the forms tab this side should be empty/blank.
3. To create a new form, click the “Actions” button in the left side toolbar and continue by selecting “New Form”, then continue to step 5.
4. To modify an existing form, find the already existing form in the list of available forms an double click on the entry. Note: You cannot modify a form once it has been published.
5. The left side of the forms tab (that previously showed a list of existing forms) will be replaced with buttons for each type of element you can add to your form.

Configuring a form’s settings

Before you begin adding fields to your form, you’ll want to give your form a title. You may also want to change the logo that appears in the top left of the form, or add a description or other instructions to the top of the form/heading.

To configure a form’s settings:

1. In the right half of the window, you should see a preview of your new/existing form. Left click on the forms heading to bring up the configuration options for the form itself.

   

2. After clicking the form heading the left side of the Forms window should change to now have the following configuration options;
   1. Form Name
      • The name you would like to give to the form, this is also the bold heading displayed at the top of the form.
   2. Description
      • A brief description of the form, or form instructions. The description is displayed below the form name/heading and logo.
   3. Logo
      • If you’d like to use your organizations logo or a custom image to display in the top left of the form with the form name/heading you can upload it here.
   4. Email on Completion
      • When configured, when a user completes a new form entry, a notification e-mail will automatically be sent to the e-mail or (comma separated) e-mail addresses provided. The notification e-mail will include the name of the form and a PDF copy of the submitted form entry.

Adding a form element

On the left side of the forms tab you should have several different element choices you can chose from to add to your form. If you don’t see this window, ensure you are on the “Build” sub tab.

To add a field to the form, click the corresponding button for that element in the build tab. The following is a list of the available field types and their configuration options.

1. Single Line Text
   • A single-line text field can accommodate just a few words in a single line of text, such as a name, phone number or brief description.
   • Configuration options specific to this field:
     1. Range (min and max character length)
        • You can specify a required minimum or maximum (min-max) number of characters a user can type into the field. For example, if the range were 100 (min) to 500 (max) a user would not be able to input less than 100 characters or more than 500 characters.
2. Multi Line Text
   • This option to provide a text field that allows for long comments or descriptions that can span several lines.
   • Configuration options specific to this field:
     1. Range (min and max character length)
        • You can specify a required minimum or maximum (min-max) number of characters a user can type into the field. For example, if the range were 100 (min) to 500 (max) a user would not be able to input less than 100 characters or more than 500 characters.
3. Multiple Choice
   • Closed-ended field type where people can select only one answer from a list of choices.
   • Configuration options specific to this field:
     1. Choices
        • This is where you can define the options/choices users are able to select from when filling out this field. You can use the radio/checkbox next to the text input/choice that you would like to have selected by default.
     2. Arrangement
        • One Column
          • Choices will be arranged in a single column with each choice on a new line by itself.
        • Two Column
          • Choices will be arranged into three horizontal columns from left to right.
        • Three Column
          • Choices will be arranged into three horizontal columns from left to right.
        • Side by Side
          • Choices will be listed inline with each other, spanning a new line when necessary.
4. Section Break
   • A section break allows you add paragraphs of text to your form. This field type doesn’t collect any data, but it allows you to add headings and descriptive text anywhere in a form to provide more context or to break a form in to sections.
   • Configuration options specific to this field:
     1. Description
        • The text or instructions you’d like to appear in the section break. This can be a single line, or span several lines/paragraphs.
5. Number
   • The number field restricts user input to numbers only.
   • Configuration options specific to this field:
     1. Range (min and max value)
        • You can specify a limited range of values (min-max) a user can type in the field. For example, if the range were 100 (min) to 500 (max) a user would not be able to enter any value less than 100 or greater than 500.
6.  Checkboxes
   • Checkboxes give users the ability to select from a set of options. Similar to the Multiple Choice field, however, users may select more than one option.
   • Configuration options specific to this field:
     1. Choices
        • This is where you can define the options/choices users are able to select from when filling out this field. You can use the checkbox next to each text input to specify whether the option is checked, or unchecked, by default.
7. Dropdown
   • A dropdown allows the user to choose one option from a specified list. When a drop-down list is inactive, it displays a single (selected) value. When activated, it displays (drops down) a list of values, from which the user may select one.
   • Configuration options specific to this field:
     1. Choices
        • This is where you can define the options/choices users are able to select from when filling out this field. You can use the radio/checkbox next to the text input/choice that you would like to have selected by default.
8. Page Break
   • A page break controls the form layout by allowing you to break the form into several pages. This does not affect how users fill out a form using ReadyOp, however, when exporting a form to a PDF or printing a form, anywhere there is a page break will be separated into a new page in the printout/PDF.
9. Name
   • Similar to a text field except it allows you to gather a person’s name in a single field.
   • Configuration options specific to this field:
     1. Name Format
        • Basic
          • The field will ask for only a First and Last name.
        • Extended
          • The field will ask for Title, First, Middle, Last, and Suffix
   • When exporting submitted forms to Excel, name fields will be displayed together in a single column.
10. Email
    • Similar to a text field except it allows you to gather a user’s e-mail address. This field will not allow a user to input a value that is not a properly formatted e-mail address.
11. Date
    • The date field allows users to input a date and additionally provides them with a date selection picker.
    • Configuration options specific to this field:
      1. Date Format
         • MM/DD/YYYY
           • The field will prompt users to enter in the date as the two digit month, followed by the two digit day and lastly the 4 digit year.
         • DD/MM/YYY
           • The field will prompt users to enter in the date as the two digit day, followed by the two digit month and lastly the 4 digit year.
12. Time
    • The time field allows users to input a time and additionally provides them with a time selection picker.
    • Configuration options specific to this field:
      1. Time Format
         • HH:MM AA
           • The field will prompt users to enter in the time using two digits for the hours, and 2 digits for the minutes. It will also provide a dropdown to specify either AM or PM.
         • DD/MM/YYY
           • The field will prompt users to enter in the time using two digits for the hours, 2 digits for the minutes, and lastly 2 digits for the seconds. It will also provide a dropdown to specify either AM or PM.
13. Attachment
    • This field allows you to request that users upload a file/document/image when they are filling out a form.
    • Configuration options specific to this field:
      1. Range (min and max value)
         • You can specify a limited range of file sizes (min-max) a user can type in the field. For example, if the range were 1 (min) to 5 (max) a user would not be able to upload any files less than 1MB or larger than 5 MB.
      2. Accept File Types
         • You can use this option to limit users to only allow specific types of files to be uploaded. You can specify either the file extension(s) or file mime type(s).
         • For example, to only allow GIF, JPEG and PNG images to be uploaded you could specify either ‘gif, png, jpg, jpeg’ or ‘image/gif, image/png, image/jpeg’
         • To allow a file of any type to be uploaded, simply use a asterisk option ‘*’
14. Weblink
    • A weblink field allows you to provide a clickable link to an external resource for users filling out your form. This field does not collect any data.
    • Configuration options specific to this field:
      1. Weblink
         • The URL to the external resource you’d like to provide to users filling out the form.
15. Image
    • Allows you to upload an image that will be embedded directly into the form itself. Users will see this image directly on form itself, this field does not collect any data from users.
    • Configuration options specific to this field:
      1. Image
         • Use this file input field to upload the image you’d like to appear in your form. You can only upload GIF, PNG, or JPEG images.
16. GPS
    • This field will provide a button labeled “Get Position”. When users are filling out your form they can hit this button to log their current physical GPS coordinates (both latitude and longitude).

Common configuration options

The following is a list of configuration options that are common to multiple different field types.

1. Field Label
   • A descriptive text/label displayed in bold above a given field/element.
2. Grid Size
   • This is the amount of horizontal space this form element should occupy. An element with a grid size of 1 will take up one third of the forms width, grid size of 2 will occupy two thirds of horizontal space. Lastly, a grid size of 3 will span the entire form horizontally.
   • If the field also has a Field Size parameter, the grid size cannot be smaller than the field size’s width.
3. Validation
   • If set to Optional, this field will not be required to be filled out when submitting a form. If set to required, users who are filling out this form will not be able to submit the form if this field is left blank.
4. Indexed
   • Whether or not this field’s values should be searchable when browsing submitted form entries.
5. Field Size
   • For dropdowns, text fields, etc. This allows you to specify the width of the input field itself.

Sending a Form

1. After you’ve selected the person(s) you’d like to contact and have the communicate dialog open. Select the “Send Form” option from the communication type picker in the communicate dialog.
2. After selecting the “Send Form” option in the communication type picker and pressing “Continue” you’ll be prompted with the “Send Form” dialog.
3. Inside this new dialog it’s possible to continue adding more contacts to send the form. You can click and drag contacts in the following locations into this dialog;
   • The Search -> Tasks/Assets dialog.
   • From inside a “Manage Object” dialog.
   • You can drag objects themselves to add their occupants to the list.
   • From the roster.
4. At this point it is necessary to select the form you’d like to send by clicking the “Select Form” button.
5. Once you’ve selected the form, continue by pressing “Select Form” and a Send Form dialog will appear.
   • Inside this dialog you’ll need to type a descriptive email subject for the form.
   • The email subject cannot be less than 16 characters and must contain at least three words. An error will be displayed if these requirements are not followed.
6. In the top right corner of the send form dialog you’ll have to specify the date on which the form will expire.
   • You can arrange for a form to be expired in a week, month(s) or year(s) from the date the form was created.
   • Also in the send form dialog, you’ll have two options to choose from;
     • Single use/submission
       • A recipient can only fill out the form once.
     • Multiple use/submissions
       • There are no limits to the numbers of times recipients can fill out the form.
7. When you’re ready to send the form, press the “Send Form” button in the bottom right corner and you’ll be prompted with the following dialog;

• Press “Yes” if you would like to send the form and press “No” to cancel.
  • After the form was sent the recipients will receive an email with a message from ReadyOp as the one shown below.
  • In order to ensure you’ll keep receiving emails from the ReadyOp system in the future, don’t click the unsubscribe button located at the bottom of the message.

Making an Icon on a mobile device

Before adding the Icon to your mobile device. You will need to send the form to your phone via e-mail through ReadyOp. See Sending a Form in the previous section for instructions on how to send a form, be sure to select the Multiple use/submissions option when sending the form.

Adding an icon to an Android device

Once the form has been received in an email on your device:

1. Click the link to open the form
2. Tap on the three vertical dots in the top right hand corner of your screen
3. Select the “Add to Home Screen” option
4. When prompted, give the new icon a meaningful name
5. Press “Add” and it will then appear on your device with your other application icons

Adding an icon to an iOS device

Once the form has been received in an email on your device:

1. Click the link to open the form
2. Tap the center icon at the bottom of your screen (a box with an up arrow)
3. Scroll through the new options menu by swiping the icons to the left or right
4. Select the “Add to Home Screen” option
5. When prompted, give the new icon a meaningful name
6. Press “Add” and it will then appear on your device with your other application icons

All types of communication sent from ReadyOp are logged in the history including SMS, alerts, chats, calls and e-mails. As well as all changes to objects. The history provides a method to access this logged information. All users who have access to the ReadyOp dashboard have access to their own history, and administrators have access to view the history for all users.

Searching history

1. Start by clicking the “Search” option in the upper-left corner of the dashboard’s toolbar.
2. Select “History” option from the drop down menu.
3. The history dialog will then appear, at this point you are able to search for history on the dashboard.
4. Click on the specific tab in the history dialog you’d like to search for( Alerts, Calls, Emails, Logins, Objects, Radios, SMS).
   • History can be searched by selecting a specific date.
   • Administrators has permission to view all history for all users.

Exporting History

Exporting a specific event detail

When exporting a specific event’s detail, the exported file is saved in the Adobe PDF format and will require Adobe PDF Reader to view the exported file.

1. After opening the history dialog. Click on the tab you’d like to see.
2. Double click on the specific event.
3. You’ll see a “Chat Detail” dialog appear with the event detail you selected.
4. Click “Export PDF”  to export the event.

Exporting a list of events

When exporting a list of events the exported records are saved in the XLSX file format and require Microsoft Excel (Windows) or Numbers (Mac OSX) to view.

1. After opening the history dialog. Click on the tab you’d like to see.
2. You can select a specific date or dates, by selecting from the date range filter in the top of the history dialog before you export the list.
3. Click ” Export CSV” to export the list of events.

The logbook allows you to document and track ongoing cases or events and their updates. When a user creates a case, other users are then able post comments/updates to that event, as long as the case remains open. This provides users with a running record of events in real time, as well as the ability to coordinate and communicate faster when sharing information between multiple persons, groups and agencies.

Creating a Case

1. Start by clicking the “Logbook” tab on ReadyOp dashboard.
   • The Logbook can be disabled as well as renamed. For more information on locating the tab, please contact your system administrator.
2. Inside the Logbook tab, select the “New case” button in the upper-left corner.
3. The new case dialog will appear. Enter the case information and press “Create” to save the new case.
   • Cases cannot be deleted, and by default they created in the “Open” status. However, Administrators have the ability to archive cases, which will hide them from view.

Posting Comments

1. Start by clicking the “Logbook” tab on the ReadyOp dashboard.
   • The Logbook can be disabled as well as renamed. For more information on locating the tab, please contact your system administrator.
2. Left-click on one of the existing cases in the case list to open the case detail.
3. Click on the empty box in the “New Comment” section.
4. Type the comment/update you’d like to post to the case and press “Submit” to save your new comment.
   • Users with the “Update Cases” permission are able to open/close cases.
   • Files can be attached when submitting comments to a case.
   • All case detail can be exported to a PDF format.
   • Comments cannot be deleted or modified once submitted.

Login

In order to access the ReadyOp Dashboard you will first need to login. The website address and User credentials for login (Username and password) are assigned by system administrators. When accessing your ReadyOp dashboard site you will be prompted with the following login screen.  Enter your Username and password as assigned by your system administrator.

Multiple Agencies

If your user profile has been given access to more than a single agency, you will then be prompted to select which agency you’d like to access for this login session.  System administrators determine User access if there are multiple agencies.

ReadyOp is an innovative approach to interoperable communications based on lessons learned in the field with actual first responders, airports, mass transit, government agencies, hospitals and corporations. ReadyOp is a secure, web-based platform initially developed for incident and emergency planning, immediate access to information, and fast, flexible and efficient communications. ReadyOp integrates multiple databases and a communications platform for fast, efficient access to information, as well as the ability to plan, coordinate, direct and communicate with multiple persons, groups and agencies.  ReadyOp provides a single location for planning, response, communication and documentation of personnel, assets and activities during both training and actual incidents and emergencies.

ReadyOp is a web-based platform.  There is no initial installation of ReadyOp software required prior to use on a computer or laptop.   Minimum system requirements are listed in the next section in this manual.  In order to use ReadyOp, a user must have the following:

• A computer or laptop that is currently connected to the Internet,
• A Web browser such as Firefox, Chrome, Safari or Internet Explorer 10 or newer.
• A Username and password (usually issued by the organization’s person in charge for ReadyOp for that group,

Your ReadyOp administrator or engineer will setup your devices for communication within ReadyOp. You may elect to make access to ReadyOp easier and more immediate by:

• Creating a desktop shortcut to ReadyOp workspace,
• Adding ReadyOp to the favorites folder of your web browser,
• Adding a shortcut to ReadyOp to the links bar in your browser, and/or
• Making ReadyOp your home page within the browser.

Methods for accomplishing these are operating system and browser specific and are not covered in this Manual. Consult your local network administrator for instructions.

Minimum Requirements

User Host/Platform

• A Microsoft Windows Vista or later computer system
• An Apple MacOS or later computer system

Web Browsers

• Google Chrome 80+
• Microsoft Edge 80+
• Firefox 74+
• Opera 67+
• Safari 13.1+

Proxies

• If your organization uses a proxy please add *.readyop.com to the respective list per user.

Connection

• An active connection to the internet via direct connection, Wi-Fi, cellular via 3G or better network, satellite, and/or a connection to an intranet (for customers with a local installation).

Client Network Requirements

1. HTTP/HTTPS protocol to destination ports 80 and 443 at [site].readyop.com
2. Microphone and Camera enabled (for dispatch audio, and audio/video calling)
3. Access allowed to *.readyop.com

Radio Gateways Supported

1. AudioMate 360 (AM360)

Latest Radio Gateway Firmware Release

• Gen 1 & 2 — 2.1.2
• Gen 3 — 3.0.7

Radio Gateway Network Requirements

• Hosted Clients
  • HTTP/HTTPS protocol to destination ports 80 & 443 at [site].readyop.com

• Local Installations
  • HTTP/HTTPS protocol to destination ports 80, 443, & 8080 on your principal communications/media server

Android Clients

• ReadyOp DT
• ReadyOp Forms

iOS Clients

• ReadyOp DT
• ReadyOp Forms

E-mail Support

Most ReadyOp user questions should be answered in this Manual.  If you have specific questions that are not addressed in this Manual, please contact our Client Support Department at the following address: support@readyop.com.

Telephone Support

ReadyOp provides telephone support, if you cannot find the answers you need in this manual, please call our support line at +1 (813) 289-7620.

On-site Support

While most problems can be resolved through this Manual or telephone support, on-site support may be purchased as a ReadyOp On-site Support Package.  Please contact Telephone Support to purchase or arrange for a ReadyOp support representative visit your site.

The ReadyOp REST API allows developers to query and manage data about your ReadyOp agencies such as, contacts, users, etc. The ReadyOp API is based on basic REST principles making it very easy to develop, and test applications. To make things even easier, you can even use your browser to access the URL’s and use almost any HTTP client in any programming language to create your application with the API.

All URLs referenced in the documentation have the following base in which you should replace [sitename] with your ReadyOp site name:
https://[Site Name].readyop.com/api/2013-12-01/
The ReadyOp REST API is only accessible over HTTPS. For maximum security, unencrypted HTTP is not supported.

About REST (REpresentational State Transfer)

We designed the ReadyOp API based on the basic principles of REST. From Wikipedia:

REST’s proponents argue that the Web’s scalability and growth are a direct result of a few key design principles:

• Application state and functionality are divided into resources
• Every resource is uniquely addressable using a universal syntax for use in hypermedia links
• All resources share a uniform interface for the transfer of state between client and resource, consisting of
  • A constrained set of well-defined operations
  • A constrained set of content types, optionally supporting code on demand
• A protocol which is:
  • Client-server
  • Stateless
  • Cacheable
  • Layered

REST’s client/server separation of concerns simplifies component implementation, reduces the complexity of connector semantics, improves the effectiveness of performance tuning, and increases the scalability of pure server components. Layered system constraints allow intermediaries-proxies, gateways, and firewalls-to be introduced at various points in the communication without changing the interfaces between components, thus allowing them to assist in communication translation or improve performance via large-scale, shared caching.

REST enables intermediate processing by constraining messages to be self-descriptive: interaction is stateless between requests, standard methods and media types are used to indicate semantics and exchange information, and responses explicitly indicate cacheability.

If you’re looking for more information about RESTful web services, the O’Reilly RESTful Web Services book is excellent.

Retrieve the details about a specific alert recording.

HTTP GET

GET /api/2013-12-01/Alerts/[Agency ID]/recordings/[Recording ID]

Example Request

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Alerts/[Agency ID]/recordings/[Recording ID] \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2018-10-11T15:43:52+00:00",
    "recording": [
        {
            "Recording ID": 123,
            "Name": "Test Voice",
            "Duration": 1,
            "User ID": 1,
            "Created": 1402324559,
            "Status": "Active",
            "File": {
                "Name": "64.wav",
                "Data": "UklGRj6MAABXQVZF..."
            }
        }
    ]
}

Import/create a new alert recording

HTTP POST

POST /api/2013-12-01/Alerts/[Agency ID]/recordings
You must POST the following to import/create a new alert recording.

You must POST one the following (but not both) to import/create a new alert recording.

Example Request

$ curl -XPOST https://[Site Name].readyop.com/api/2013-12-01/Contacts/[Agency ID] \
-d "User_ID=7" \
-d "Name=Test%20Alert" \
-d "File=@path/to/file.wav"
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2018-11-02T21:35:01+00:00",
    "recording": {
        "Recording ID": 123,
        "Name": "Test Alert"
    }
}

Retrieve a list of existing alert recordings.

HTTP GET

GET /api/2013-12-01/Alerts/[Agency ID]/recordings
Returns a list of existing alert recordings.

Example Request

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Alerts/[Agency ID]/recordings \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2018-10-11T15:43:52+00:00",
    "recordings": [
        {
            "Recording ID": 123,
            "Name": "Test alert",
            "Duration": 5,
            "User ID": 123,
            "Created": 1402324559,
            "Status": "Active"
        }
    ],
    "results": 1,
    "pages": 1,
    "page": 0,
    "page_start": 0,
    "page_end": 0,
    "page_size": 100
}

Create a new contact and return it’s instance resource.

HTTP POST

POST /api/2013-12-01/Contacts/[Agency ID]
You must POST at least the following to create a new contact.

You may also set the following information when creating your new contact. We recommend providing as much information as possible to make interacting with your contact’s as easy as possible.

Example Request

$ curl -XPOST https://[Site Name].readyop.com/api/2013-12-01/Contacts/[Agency ID] \
-d "Custom_ID=AZ123" \
-d "First=John" \
-d "Last=Doe" \
-d "Organization=My%20Company" \
-d "Title=Chief%20of%20Awesome" \
-d "Tags=Pizza%2C%20Beer%2C%20Hazmat" \
-d "Objects[]=1234" \
-d "Objects[]=5678" \
-u "[API Account ID]:[API Token]"

Request Result

{
"Contact ID": 106752,
"Agency ID": 1,
"Agencies": {
1
},
"Custom ID": "AZ123",
"User ID": "",
"Owner ID": "",
"Status": "Active",
"First": "John",
"Last": "Doe",
"Organization": "My Company",
"Tags": "Pizza, Beer, Hazmat",
"Title": "Chief of Awesome",
"PIN": "",
"Custom 1": "",
"Custom 2": "",
"Custom 3": "",
"Custom 4": "",
"Custom 5": "",
"Custom 6": "",
"Custom 7": "",
"Custom 8": "",
"Custom 9": "",
"Custom 10": "",
"Phones": [],
"Emails": [],
"Objects": [
1234,
5678
]
}

Permanently mark as contact as Deleted.

HTTP DELETE

DELETE /api/2013-12-01/Contacts/[Agency ID]/[Contact ID]

Example Request

$ curl -XDELETE https://[Site Name].readyop.com/api/2013-12-01/Contacts/[Agency ID]/[Contact ID] \
-u "[API Account ID]:[API Token]"

Request Result

{
    "Contact ID": "86369",
    "Status": "Deleted"
}

Get an existing contact resource.

HTTP GET

GET /api/2013-12-01/Contacts/[Agency ID]/[Contact ID]
Returns information for the given Contact ID in the given Agency ID

Example Request

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Contacts/[Agency ID]/[Contact ID] \
-u "[API Account ID]:[API Token]"

Request Result

{
    "Contact ID": 106752,
    "Agency ID": 1,
    "Agencies": [
        1,
        2
    ],
    "Custom ID": "AZ123",
    "User ID": "",
    "Owner ID": "",
    "Status": "Active",
    "First": "John",
    "Last": "Doe",
    "Organization": "My Company",
    "Tags": "Pizza, Beer, Hazmat",
    "Title": "Chief of Awesome",
    "PIN": "",
    "Custom 1": "Custom agency field data 1",
    "Custom 2": "Custom agency field data 2",
    "Custom 3": "Custom agency field data 3",
    "Custom 4": "Custom agency field data 4",
    "Custom 5": "Custom agency field data 5",
    "Custom 6": "Custom agency field data 6",
    "Custom 7": "Custom agency field data 7",
    "Custom 8": "Custom agency field data 8",
    "Custom 9": "Custom agency field data 9",
    "Custom 10": "Custom agency field data 10",
    "Phones": [],
    "Emails": [],
    "Objects": []
}

Update an existing contact’s information by replacing all included fields with the values in the request and clearing the value for any unspecified fields. Or optionally update only the fields specified by sending the ‘Update’ parameter.

HTTP POST

POST /api/2013-12-01/Contacts/[Agency ID]/[Contact ID]
You must POST at least the following to update a contact.

You may also set the following information when updating a contact. We recommend providing as much information as possible to make interacting with your contact’s as easy as possible.

Example Request

$ curl -XPOST https://[Site Name].readyop.com/api/2013-12-01/Contacts/[Agency ID]/[Contact ID] \
    -d "First=Alexander" \
    -d "Last=Graham" \
    -d "Phone_0_Number=+12223334444" \
    -d "Phone_0_Textable=Y" \
    -d "Phone_0_Type=Cell" \
    -d "Phone_1_Number=+13334445555" \
    -d "Phone_1_Textable=N" \
    -d "Phone_1_Type=Desk" \
    -d "Email_0_Address=alexander@email.com" \
    -d "Email_0_Type=Work" \
    -d "Objects[]=1234" \
    -d "Objects[]=5678" \
    -u "[API Account ID]:[API Token]"

Request Result

{
    Contact ID: 86369,
    Agency ID: 1,
    Agencies: [
        1,
        2
    ],
    Custom ID: "",
    User ID: 228,
    Owner ID: "",
    Status: "Active",
    First: "Alexander",
    Last: "Grahm",
    Organization: "",
    Tags: "",
    Title: "",
    PIN: "",
    Custom 1: "",
    Custom 2: "",
    Custom 3: "",
    Custom 4: "",
    Custom 5: "",
    Custom 6: "",
    Custom 7: "",
    Custom 8: "",
    Custom 9: "",
    Custom 10: "",
    Phones: [
        {
            Number: "+13204563470",
            Textable: "Y",
            Type: "Cell"
        },
        {
            Number: "+3159773",
            Textable: "N",
            Type: "Desk"
        }
    ],
    Emails: [
        {
            Address: "alexander@hotmail.com",
            Type: "Work"
        }
    ],
    Objects: [
        1234,
        5678
    ]
}

A Contact resource represents a single contact within a given agency. This may be a contact in either the “Pending” or “Active” status and may even include deleted contacts. The Contacts list resource represents a set of contact’s in a given agency.

HTTP GET

GET /api/2013-12-01/Contacts/[Agency ID]
Returns a list of contact’s for a given [Agency ID].

Paging

Paging can be accomplished by passing the Page request parameter. By default only 100 contacts are returned per request. You can use the Page_Size request parameter to specify up to 10,000 contacts per request.

List Filters

The following list of parameters are available to help limit or filter the records returned. All parameters are case sensitive.

Example Request

Fetch the entire list.

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Contacts/[Agency ID] \
    -u "[API Account ID]:[API Token]"

Request Result

{
    "Total_Results": 20462,
    "Pages": 205,
    "Page": 0,
    "Page_Start": 0,
    "Page_End": 99,
    "Page_Size": 100,
    "Contacts": [
        {
            "Contact ID": 106752,
            "Agency ID": 1,
            "Agencies": [
                1
            ],
            "Custom ID": "AZ123",
            "User ID": 5,
            "Owner ID": 3123,
            "Status": "Active",
            "First": "John",
            "Last": "Doe",
            "Organization": "Emergency Fire Rescue",
            "Tags": "Fire, Hazmat, Doctor",
            "Title": "Chief",
            "PIN": "1234",
            "Custom 1": "Custom agency field data 1",
            "Custom 2": "Custom agency field data 2",
            "Custom 3": "Custom agency field data 3",
            "Custom 4": "Custom agency field data 4",
            "Custom 5": "Custom agency field data 5",
            "Custom 6": "Custom agency field data 6",
            "Custom 7": "Custom agency field data 7",
            "Custom 8": "Custom agency field data 8",
            "Custom 9": "Custom agency field data 9",
            "Custom 10": "Custom agency field data 10",
            "Phones": [
                {
                    "Number": "+1333444555",
                    "Textable": "Y",
                    "Type": "Cell"
                },
                {
                    "Number": "+1222333444",
                    "Textable": "N",
                    "Type": "Desk"
                }
            ],
            "Emails": [
                {
                    "Address": "no@email.com",
                    "Type": "Work"
                }
            ],
            "Objects": [
                1234,
                5678
            ]
        }, ...
    ]
}

Example Request

Show only those contact’s who’s Tags field contains the tag “Hazmat”.

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Contacts/[Agency ID] \
    -d "Tags=Hazmat" \
    -u "[API Account ID]:[API Token]"

Request Result

{
    "Total_Results": 312,
    "Pages": 4,
    "Page": 0,
    "Page_Start": 0,
    "Page_End": 99,
    "Page_Size": 100,
    "Contacts": [
        {
            "Contact ID": "106752",
            "Custom ID": "AZ123",
            "User ID": "5",
            "Owner ID": "3123",
            "Status": "Active",
            "First": "John",
            "Last": "Doe",
            "Organization": "Emergency Fire Rescue",
            "Tags": "Fire, Hazmat, Doctor",
            "Title": "Chief",
            "PIN": "1234",
            "Custom 1": "Custom agency field data 1",
            "Custom 2": "Custom agency field data 2",
            "Custom 3": "Custom agency field data 3",
            "Custom 4": "Custom agency field data 4",
            "Custom 5": "Custom agency field data 5",
            "Custom 6": "Custom agency field data 6",
            "Custom 7": "Custom agency field data 7",
            "Custom 8": "Custom agency field data 8",
            "Custom 9": "Custom agency field data 9",
            "Custom 10": "Custom agency field data 10",
            "Phones": [
                {
                    "Number": "+1333444555",
                    "Textable": "Y",
                    "Type": "Cell"
                },
                {
                    "Number": "+1222333444",
                    "Textable": "N",
                    "Type": "Desk"
                }
            ],
            "Emails": [
                {
                    "Address": "no@email.com",
                    "Type": "Work"
                }
            ],
            "Objects": [
                1234
            ]
        }, ...
    ]
}

HTTP POST

POST /api/2013-12-01/Alerts/[Agency ID]/schedule
You must POST at least the following to send a voice alert.

Additionally you must POST at a minimum either an array of Contacts and/or an array of Topics and/or an array of Objects.

If you’re providing a list of contacts, each contact in the Contacts list should include the following fields:

Example Request

$ curl -XPOST https://[Site Name].readyop.com/api/2013-12-01/Alerts/[Agency ID]/schedule \
-d "Attempts=1" \
-d "Delay=1" \
-d "Persistent=0" \
-d "Recording_ID=123" \
-d "User_ID=321" \
-d "Contacts[0][Contact_ID]=1234" \
-d "Contacts[0][Phone]=0" \
-d "Topics[0]=test-topic \
-d "Objects[0]=4321 \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2018-11-10T14:58:01+00:00",
    "alert": {
        "Alert ID": 409
    }
}

Rename an existing alert recording.

HTTP PUT

PUT /api/2013-12-01/Alerts/[Agency ID]/recordings/[Recording ID]
You must PUT the following parameters to rename an alert recording.

Example Request

$ curl -XPUT https://[Site Name].readyop.com/api/2013-12-01/Alerts/[Agency ID]/recordings/[Recording ID] \
-d "Name=New%20Alert%20Name" \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2018-11-02T21:35:01+00:00",
    "recording": {
        "Recording ID": 123,
        "Name": "New Alert Name"
    }
}

Get the details about a sent e-mail.

HTTP GET

GET /api/2013-12-01/Email/[Email ID]
Returns information for the given Email ID.

Example Request

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Email/[Email ID] \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2015-09-21T16:08:10+00:00",
    "email": {
        "Email ID": 941,
        "Agency ID": 54,
        "Sent": 1574122365,
        "Subject": "Test email",
        "Body": "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\" \"http://www.w3.org/TR/REC-html40/loose.dtd\">\n<html><body>This is a test e-mail.</body></html>\n",
        "From": {
            "User ID": 1,
            "Name": "John Doe",
            "Email": "support@readyop.com"
        },
        "Recipients": [
            {
                "Recipient ID": 16177,
                "Contact ID": 5211755,
                "Name": "John Doe",
                "Status": "Delivered",
                "Email": "john@readyop.com"
            }
        ]
    }
}

Get the status details for a specific recipient that was sent an e-mail.

HTTP GET

GET /api/2013-12-01/Email/Recipient/[Recipient ID]
Returns information for the given Recipient ID.

Example Request

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Email/Recipient/[Recipient ID] \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2015-09-21T16:08:10+00:00",
    "recipient": {
        "Recipient ID": 16177,
        "Email ID": 941,
        "Contact ID": 5211755,
        "Name": "John Doe",
        "Status": "Delivered",
        "Email": "john@readyop.com",
        "Agency ID": 54,
        "Audit": [
            {
                "Audit ID": 52133,
                "Status": "Queued",
                "Time": 1574122365
            },
            {
                "Audit ID": 52134,
                "Status": "Sent",
                "Time": 1574122368
            },
            {
                "Audit ID": 52135,
                "Status": "Delivered",
                "Time": 1574122368,
                "Detail": {
                    "Timestamp": "2019-11-19T00:12:48.875Z",
                    "Proccessing Time": 1092,
                    "SMTP Response": "250 2.0.0 OK  1574122368 n27si12988209qta.87 - gsmtp",
                    "Reporting MTA": "a44-114.smtp-out.amazonses.com"
                }
            }
        ]
    }
}

The Email list resource represents e-mails that have been sent in a given agency.

HTTP GET

GET /api/2013-12-01/Emails/[Agency ID]
Returns a list of sent emails for the given [Agency ID].

Paging

Paging can be accomplished by passing the page request parameter. By default only 100 objects are returned per request. You can use the page_size request parameter to specify up to 10,000 objects per request.

List Filters

The following list of parameters are available to help limit or filter the records returned. All parameters are case sensitive.

Example Request

Fetch the entire list.

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Emails/[Agency ID] \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2015-09-21T15:39:22+00:00",
    "objects": [
        {
            "Email ID": 1,
            "Sent": 1407266196,
            "Subject": "Test",
            "From": {
                "User ID": 1,
                "Name": "John Doe",
                "Email": "john@readyop.com"
           }
        }
    ],
    "results": 1,
    "pages": 1,
    "page": 0,
    "page_start": 0,
    "page_end": 0,
    "page_size": 100
}

HTTP POST

POST /api/2013-12-01/Email/[Agency ID]
You must POST at least the following to send an e-mail.

Additionally you must POST at a minimum either an array of Contacts and/or an array of Topics and/or an array of Objects.

If you’re providing a list of contacts, each contact in the Contacts list should include the following fields:

Optionally you may POST an array of Attachments

If you’re providing a list of attachments, each attachment in the Attachments list should include the following fields:

Example Request

$ curl -XPOST https://[Site Name].readyop.com/api/2013-12-01/Email/[Agency ID] \
-d "From_Name=John%Doe" \
-d "From_Email=john.doe@email.com" \
-d "Subject=This%20is%20a%20test%20email%20from%20the%api" \
-d "Body=This%20is%20just%20a%20test" \
-d "Contacts[0][Contact_ID]=1234" \
-d "Contacts[0][Email]=0" \
-d "Topics[0]=test-topic \
-d "Objects[0]=4321 \
-d "Attachments[0][Name]="My-File.jpg" \
-d "Attachments[0][Data]="R0lGODlhAQABAID/AMDAwAAAACH5BAEAAAAALAAAAAABA‌​AEAAAICRAEA" \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2017-02-27T19:32:45+00:00",
    "email": {
        "Email ID": 820
    }
}

Get an existing form resource.

HTTP GET

GET /api/2013-12-01/Forms/[Agency ID]/[Form ID]
Returns information for the given Form ID in the given Agency ID

Example Request

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Forms/[Agency ID]/[Object ID] \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2020-07-07T21:20:04+00:00",
    "form": {
        "Form ID": 282,
        "Name": "My Test Form",
        "Description": "Form description / summary goes here!",
        "Fields": [
            {
                "Type": "name",
                "Name": "First & Last Name",
                "Format": "FL"
            },
            {
                "Type": "date",
                "Name": "Date of Birth",
                "Format": "MM/DD/YYYY"
            },
            {
                "Type": "email",
                "Name": "Email Address"
            }, ...
        ]
    }
}

A Form resource represents a single form within a given agency. This may be a form in either the “Draft” or “Published” status and may even include deleted forms. The Form list resource represents a set of forms in a given agency.

HTTP GET

GET /api/2013-12-01/Forms/[Agency ID]

Returns a list of forms for a given [Agency ID].

Paging

Paging can be accomplished by passing the Page request parameter. By default, only 100 forms are returned per request. You can use the Page_Size request parameter to specify up to 10,000 forms per request.

List Filters

The following list of parameters are available to help limit or filter the records returned. All parameters are case sensitive.

Example Request

Fetch the entire list.

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Forms/[Agency ID] \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2020-01-15T22:39:58+00:00",
    "users": [
        {
            "Form ID": "1234",
            "Created": 1593962058,
            "Creator": {
                "User ID": 1234,
                "Name": "John Doe"
            },
            "Description": "Test Form Description",
            "Name": "Test Form",
            "Status": "Published"
        }, ...
    ],
    "results": 123,
    "pages": 2,
    "page": 1,
    "page_start": 100,
    "page_end": 122,
    "page_size": 100
}

Example Request

Show only those forms where the Name field begins with “Test”.

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Forms/[Agency ID] \
-d "Name=Test%" \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2020-01-15T22:39:58+00:00",
    "users": [
        {
            "Form ID": "1234",
            "Created": 1593962058,
            "Creator": {
                "User ID": 1234,
                "Name": "John Doe"
            },
            "Description": "Test Form Description",
            "Name": "Test Form",
            "Status": "Published"
        }, ...
    ],
    "results": 123,
    "pages": 2,
    "page": 1,
    "page_start": 100,
    "page_end": 122,
    "page_size": 100
}

An Entry resource represents a single entry (submission) for a specific form within a given agency. This may be an entry in either the “Submitted”, “Archived”, or “Deleted” status. The Entries list resource represents a set of entries for a specific form in a given agency.

HTTP GET

GET /api/2013-12-01/Forms/[Agency ID]/[Form ID]/entries

Returns a list of forms for the given [Form ID] and [Agency ID].

Paging

Paging can be accomplished by passing the Page request parameter. By default, only 100 forms are returned per request. You can use the Page_Size request parameter to specify up to 10,000 forms per request.

List Filters

The following list of parameters are available to help limit or filter the records returned. All parameters are case sensitive.

Example Request

Fetch the entire list.

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Forms/[Agency ID]/[Form ID]/entries \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2020-07-07T21:24:07+00:00",
    "entries": [
        {
            "Entry ID": 4321,
            "Submitted": 1583810247,
            "Submitter": {
                "User ID": 1,
                "Name": "John Smith",
                "Type": "User"
            },
            "Status": "Submitted",
            "Updated": 1583810247,
            "Data": [
                {
                    "type": "name",
                    "name": "Name",
                    "value": [
                        "Jane",
                        "Doe"
                    ],
                    "format": "FL"
                },
                {
                    "type": "date",
                    "name": "Date of Birth",
                    "value": "12/30/1991",
                    "format": "MM/DD/YYYY"
                },
                {
                    "type": "email",
                    "name": "Email Address",
                    "value": "no@email.com"
                }, ...
            ]
        }, ...
    ],
    "results": 26,
    "pages": 1,
    "page": 0,
    "page_start": 0,
    "page_end": 25,
    "page_size": 100
}

HTTP POST

POST /api/2013-12-01/SMS/[Agency ID]
You must POST at least the following to send an SMS.

Additionally you must POST at a minimum either an array of Contacts and/or an array of Topics and/or an array of Objects.

If you’re providing a list of contacts, each contact in the Contacts list should include the following fields:

Example Request

$ curl -XPOST https://[Site Name].readyop.com/api/2013-12-01/SMS/[Agency ID] \
-d "From_Name=John%Doe" \
-d "Body=This%20is%20just%20a%20test" \
-d "Contacts[0][Contact_ID]=1234" \
-d "Contacts[0][Phone]=0" \
-d "Topics[0]=test-topic \
-d "Objects[0]=4321 \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2017-02-27T19:32:45+00:00",
    "sms": {
        "Thread ID": 820,
        "Message ID": 3123
    }
}

The Tabs list resource represents a set of tabs in a given agency. This can include both active and/or deleted tabs.

HTTP GET

GET /api/2013-12-01/Tabs/[Agency ID]
Returns a list of tabs for the given [Agency ID].

Paging

Paging can be accomplished by passing the page request parameter. By default only 100 tabs are returned per request. You can use the page_size request parameter to specify up to 10,000 tabs per request.

List Filters

The following list of parameters are available to help limit or filter the records returned. All parameters are case sensitive.

Example Request

Fetch only active tabs.

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Tabs/[Agency ID] \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2019-01-31T19:51:14+00:00",
    "tabs": [
        {
            "Tab ID": 23,
            "Status": "Active",
            "Name": "Main Dashboard",
            "Subtitle": "",
            "Date": "2019-01-31",
            "Color": "Green"
        },
    ], ...],
    "results": 12,
    "pages": 1,
    "page": 0,
    "page_start": 0,
    "page_end": 11,
    "page_size": 100
}

Get the details for a specific notification topic.

HTTP GET

GET /api/2013-12-01/Topics/[Agency ID]/[Topic Name]
Returns information for the given Topic Name for the given Agency ID

Example Request

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Topics/[Agency ID]/[Topic Name] \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2015-09-21T16:08:10+00:00",
    "topic": {
        "Name":'my-topic-name',
        "Agency ID": 54,
        "Contacts": [
            3858158,
            3858159
        ],
        "Objects": [
            2042,
            9932
        ]
    }
}

Retrieve a list of existing notification topics.

HTTP GET

GET /api/2013-12-01/Topics/[Agency ID]
Returns a list of existing notification topics.

Example Request

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Topics/[Agency ID] \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2018-10-11T15:43:52+00:00",
    "topics": [
        {
            "Name": "test",
            "Agency ID": 54,
        }
    ],
    "results": 1,
    "pages": 1,
    "page": 0,
    "page_start": 0,
    "page_end": 0,
    "page_size": 100
}

Topics are used to group contacts and objects (which may contain one or more contacts) to make sending notifications/alerts to groups of people about a specific topic more convenient.

HTTP PUT

PUT /api/2013-12-01/Topics/[Agency ID]/[Topic Name]/subscribe
You must PUT at a minimum either an array of Contacts or an array of Objects.

Example Request

$ curl -XPUT https://[Site Name].readyop.com/api/2013-12-01/Topics/[Agency ID]/[Topic Name]/subscribe -d "Contacts[]=1234" -d "Contacts[]=4321" -d "Objects[]=5678" \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2015-09-21T15:39:22+00:00"
}

Unsubscribe the given contacts and/or objects from the specified topic.

HTTP PUT

PUT /api/2013-12-01/Topics/[Agency ID]/[Topic Name]/unsubscribe
You must PUT at a minimum either an array of Contacts or an array of Objects.

Example Request

$ curl -XPUT https://[Site Name].readyop.com/api/2013-12-01/Topics/[Agency ID]/[Topic Name]/unsubscribe -d "Contacts[]=1234" -d "Contacts[]=4321" -d "Objects[]=5678" \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2015-09-21T15:39:22+00:00"
}

Create a new object and return its instance resource.

HTTP POST

POST /api/2013-12-01/Objects/[Agency ID]
You must POST at least the following to create a new object.

You may also set the following information when creating your new object.

Example Request

$ curl -XPOST https://[Site Name].readyop.com/api/2013-12-01/Objects/[Agency ID] \
-d "Border=Red" \
-d "Contact ID=3858158" \
-d "Indicator=Green" \
-d "Name=My%20Object" \
-d "Subtitle=Object%20Subtitle" \
-d "Tab ID=23" \
-d "Type=Group" \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2019-01-31T19:12:46+00:00",
    "object": {
        "Object ID": 13310
    }
}

Get an existing object resource.

HTTP GET

GET /api/2013-12-01/Object/[Agency ID]/[Object ID]
Returns information for the given Object ID in the given Agency ID

Example Request

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Object/[Agency ID]/[Object ID] \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2015-09-21T16:08:10+00:00",
    "object": {
        "Object ID": 497,
        "Tab ID": 1,
        "Contact ID": null,
        "Created": 1351641718,
        "Status": "Active",
        "Type": "Role",
        "Name": "Orlando Police Dept",
        "Subtitle": "",
        "Tags": "",
        "Color": "Black",
        "Indicator": "Green",
        "Weblink": "http://www.google.com"
    }
}

The Objects list resource represents a set of objects in a given agency. This can include both active and/or deleted objects.

HTTP GET

GET /api/2013-12-01/Objects/[Agency ID]
Returns a list of objects for the given [Agency ID].

Paging

Paging can be accomplished by passing the page request parameter. By default only 100 objects are returned per request. You can use the page_size request parameter to specify up to 10,000 objects per request.

List Filters

The following list of parameters are available to help limit or filter the records returned. All parameters are case sensitive.

Example Request

Fetch the entire list.

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Objects/[Agency ID] \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2015-09-21T15:39:22+00:00",
    "objects": [
        {
            "Object ID": 497,
            "Tab ID": 1,
            "Contact ID": null,
            "Created": 1351641718,
            "Status": "Active",
            "Type": "Role",
            "Name": "Orlando Police Dept",
            "Subtitle": "",
            "Tags": "Hazmat, K9 Team",
            "Color": "Black",
            "Indicator": "Green",
            "Weblink": "http://www.google.com"
        }
    ], ...],
    "results": 235,
    "pages": 3,
    "page": 0,
    "page_tart": 0,
    "page_end": 99,
    "page_size": 100
}

Example Request

Show only those objects who’s Tags field contains the tag “Hazmat”.

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Objects/[Agency ID] \
-d "Tags=Hazmat" \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2015-09-21T15:28:26+00:00",
    "objects": [
        {
            "Object ID": 497,
            "Tab ID": 1,
            "Contact ID": null,
            "Created": 1351641718,
            "Status": "Active",
            "Type": "Role",
            "Name": "Orlando Police Dept",
            "Subtitle": "",
            "Tags": "Hazmat, K9 Team",
            "Color": "Black",
            "Indicator": "Green",
            "Weblink": "http://www.google.com"
        }
    ],
    "results": 1,
    "pages": 1,
    "page": 0,
    "page_start": 0,
    "page_end": 0,
    "page_size": 100
}

Create a new user and return its instance resource.

HTTP POST

POST /api/2013-12-01/Users
You must POST at least the following to create a new user.

You may also set the following information when creating your new user. We recommend providing as much information as possible to make interacting with your users as easy as possible.

Example Request

$ curl -XPOST https://[Site Name].readyop.com/api/2013-12-01/Users \
-d "Username=JohnD" \
-d "Name=John Doe" \
-d "Password=P@ssw0rd1" \
-d "Agencies[0][Agency_ID]=1" \
-d "Agencies[0][Group_ID]=2" \
-d "Caller_ID=18132897620" \
-d "Cell=18132897620" \
-d "Language=en" \
-d "Email=john@readyop.com" \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2020-01-15T22:40:04+00:00",
    "user": {
        "User ID": 416
    }
}

Permanently mark as user as Deleted.

HTTP DELETE

DELETE /api/2013-12-01/Users/[User ID]

Example Request

$ curl -XDELETE https://[Site Name].readyop.com/api/2013-12-01/Users/[User ID] \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2020-01-15T22:40:11+00:00"
}

Get an existing user resource.

HTTP GET

GET /api/2013-12-01/Users/[User ID]
Returns information for the given User ID in your site.

Example Request

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Users/[User ID] \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2020-01-15T22:39:54+00:00",
    "user": {
        "2FA": "Disabled",
        "Agencies": [
            {
                "Agency ID": 1,
                "Group": {
                    "Group ID": 2,
                    "Name": "Agency Administrator"
                }
            }, ...
        ],
        "Caller ID": {
            "Number": 18132897620,
            "Verified": "Y"
        },
        "Cell": null,
        "Desk": 18132897620,
        "Email": "john@readyop.com",
        "Language": 'en',
        "Name": "John Doe",
        "Status": "Active",
        "User ID": 123,
        "Username": "JohnD"
    }
}

Update an existing users information by replacing all included fields with the values in the request.

HTTP PATCH

PATCH /api/2013-12-01/Users/[User ID]
You must PATCH at least one of the following to update a user.

Example Request

$ curl -XPOST https://[Site Name].readyop.com/api/2013-12-01/Users/[User ID] \
-d "Name=John Doe" \
-d "Agencies[0][Operation]=add" \
-d "Agencies[0][Agency_ID]=1" \
-d "Agencies[0][Group_ID]=2" \
-d "Agencies[1][Operation]=modify" \
-d "Agencies[1][Agency_ID]=21" \
-d "Agencies[1][Group_ID]=4" \
-d "Agencies[3][Operation]=delete" \
-d "Agencies[3][Agency_ID]=5" \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2020-01-15T23:28:36+00:00",
    "user": {
        "user": {
            "2FA": "Disabled",
            "Agencies": [
                {
                    "Agency ID": 1,
                    "Group": {
                        "Group ID": 2,
                        "Name": "Agency Administrator"
                    }
                },
                {
                    "Agency ID": 21,
                    "Group": {
                        "Group ID": 4,
                        "Name": "Standard User"
                    }
                }, ...
            ],
            "Caller ID": {
                "Number": 18132897620,
                "Verified": "Y"
            },
            "Cell": null,
            "Desk": 18132897620,
            "Email": "john@readyop.com",
            "Language": 'en',
            "Name": "John Doe",
            "Status": "Active",
            "User ID": 123,
            "Username": "JohnD"
        }
    }
}

A User resource represents a single user within a given site. This may be a contact in either the “Deleted” or “Active” status. The User list resource represents a set of users in a given site.

HTTP GET

GET /api/2013-12-01/Users
Returns a list of users for your site.

Paging

Paging can be accomplished by passing the Page request parameter. By default, only 100 users are returned per request. You can use the Page_Size request parameter to specify up to 10,000 users per request.

List Filters

The following list of parameters are available to help limit or filter the records returned. All parameters are case sensitive.

Example Request

Fetch the entire list.

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Users \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2020-01-15T22:39:58+00:00",
    "users": [
        {
            "2FA": "Enabled",
            "Caller ID": 18132897620,
            "Cell": null,
            "Desk": 18132897620,
            "Email": 'john@readyop.com',
            "Language": 'en',
            "Name": "John Doe",
            "Status": "Active",
            "User ID": 1234,
            "Username": "JohnD"
        }, ...
    ],
    "results": 123,
    "pages": 2,
    "page": 1,
    "page_start": 100,
    "page_end": 122,
    "page_size": 100
}

Example Request

Show only those users who’s Name field begins with “John”.

$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Users \
-d "Name=John%" \
-u "[API Account ID]:[API Token]"

Request Result

{
    "code": 0,
    "status": 200,
    "detail": "Success",
    "timestamp": "2020-01-15T22:39:58+00:00",
    "users": [
        {
            "2FA": "Enabled",
            "Caller ID": 18132897620,
            "Cell": null,
            "Desk": 18132897620,
            "Email": 'john@readyop.com',
            "Language": 'en',
            "Name": "John Doe",
            "Status": "Active",
            "User ID": 1234,
            "Username": "JohnD"
        }, ...
    ],
    "results": 123,
    "pages": 2,
    "page": 1,
    "page_start": 100,
    "page_end": 122,
    "page_size": 100
}