API Documentation

Operoo API

Operoo offers a Web API that allow organisations to retrieve information about their accounts such as profiles, groups and carers. Just sign in as a group administrator and follow the steps below.

Sign in

Generating an API Access Token

Each API call requires authentication. You must send the API key parameters on each of your API calls

After you login as a Group Administrator, go to Tools > Organisation Settings in the navigation menu. Click on Generate API Access Token on left menu to generate an API Access Key.

Once you have generated an API key, you can see it by clicking Show API Access Token at the bottom of Group settings.



If you feel your API key has been compromised, you can change the Access Token by clicking on Regenerate API Access Token.

Manage IP addresses for API access

For enhanced security, API access requests to the Operoo system are limited to white-listed IP addresses.

To allow requests from a particular IP, Group Administrators have to add the IP address of the computer to the allowed list by going to Tools > Organisation Settings > Manage IP addresses. Once you click the link, you will see a screen very similar to the one below where you will be able to white-list (allow) requests from trusted IP addresses.

The IP address of the computer that was initially used to generate the initial API token will automatically be added to the white-list but can be modified as necessary.

Query parameter definitions

The default URI format for all requests to the Operoo API. A successful (authenticated) response will always return the organization name.

https://groups.operoo.com/api/v1/groups?api_access_token=API_ACCESS_TOKEN

Options

Options can be passed via the URL in API request.

Name Default Value Definition
profile_request false When profile_request=true, it fetches all the profile requests of organization
group false When group=true, it renders all the groups of organization
group_carer false When group_carer=true, it fetches all the carers of organization
external_group false When external_group=true, it fetches all the external groups of organization
external_profile_request false When external_profile_request=true, it fetches all the external profile requests of organization
profile true When profile=true, it fetches all the shared consented profiles of organization
Example query 
https://groups.operoo.com/api/v1/groups?api_access_token=API_ACCESS_TOKEN&profile_request=true&group=true&group_carer=true&profile=true
Response for the query when all of the options are true
{
  "responseCode":100,
  "errors":[],
  "organization":
    {"name":"La Trobe University","admin_name":"John Smith","admin_email":"someemail@yahoo.com",
     "website":"https://www.caremonkey.com","mailing_address":"41 Stewart St, Richmond, Victoria",
     "admin_title":"Administrator","timezone":"Melbourne"
    },
  "profile_requests":
    [
      {"id":1015,"name":"Yo Boswelliana","email":"paramagnet@rapidgroups.com","mobile_number":"9494949494","user_request_id":"10525"},
      {"id":1016,"name":"Womanhead Bedlamitish","email":"jose@rapidgroups.com","mobile_number":"4367512 349","user_request_id":""},
      {"id":1018,"name":"Martin Howell","email":"mph@caremonkey.com","mobile_number":"0415947543","user_request_id":""},
      {"id":1035,"name":"John Smith","email":"albert@caremonkey.com","mobile_number":"0415947543","user_request_id":"3526"},
      {"id":1036,"name":"John Neuman","email":"bash@caremonkey.com","mobile_number":"0415947543","user_request_id":"2351"},
      {"id":1039,"name":"Frank Walker","email":"john.doe@yahoo.com","mobile_number":"0415947543","user_request_id":""},
      {"id":1042,"name":"Nonimbricating Squattish","email":"mph+sussexite@caremonkey.com","mobile_number":"","user_request_id":"2562"},
      {"id":1047,"name":"Nocole Swan","email":"dahal_bsd@yahoo.com","mobile_number":"0415947543","user_request_id":""},
      {"id":1050,"name":"Marree Barmote","email":"mph+janizary@caremonkey.com","mobile_number":null,"user_request_id":"3254"},
    {"id":1051,"name":"Jackob Black","email":"paramagnet@rapidgroups.com","mobile_number":"9494949494","user_request_id":""}
    ],
  "groups":
    [
      {"id":251,"name":"All Carers (automatic)"},
      {"id":35,"name":"Year 7B"},
      {"id":43,"name":"new group"},
      {"id":25,"name":"Year 7A"},
      {"id":150,"name":"56"},
      {"id":46,"name":"year 78"},
      {"id":231,"name":"Wednesday Evening"},
      {"id":172,"name":"Tuesday Night"}
   ],
  "group_carers":
    [
      {"id":47,"name":"Stephanian Gonochoristic","email":"coppin@rapidgroups.com","mobile_number":null},
      {"id":48,"name":"Wondercraft Pipit","email":"nonentry@rapidgroups.com","mobile_number":null},
      {"id":49,"name":"Vaporing Organochordium","email":"thiosulphonic@rapidgroups.com","mobile_number":null},
      {"id":50,"name":"John Smith","email":"paramagnet@rapidgroups.com","mobile_number":"9494949494"},
      {"id":51,"name":"Womanhead Bedlamitish tii","email":"jose@rapidgroups.com","mobile_number":""},
      {"id":52,"name":"Fred Beqa","email":"fred@rapidgroups.com","mobile_number":""},
      {"id":53,"name":"Joel Westley","email":"joel@caremonkey.com","mobile_number":null},
      {"id":17,"name":"John Smith","email":"test@gmail.com","mobile_number":"3934934"}
    ],
  "profiles":
    [
    {"id":59,"gender":"Male","email":"","home_phone":"90879079","work_phone":"","mobile_phone":"","street":"saviour road","city":"Melbourne","state":"victoria","country":"Australia","zip":"3024","swimming_ability_string":"Weak swimmer (less than 50 metres)","transfusions_allowed":false,"user_id":1,"created_at":"2016-01-07T03:50:55.197Z","updated_at":"2016-01-07T03:50:57.606Z","birth_day":10,"birth_month":1,"birth_year":2000,"wears_glasses":false,"wears_contacts":false,"paracetamol_allowed":false,"has_ambulance_cover":false,"ambulance_cover_details":null,"has_private_cover":false,"private_cover_details":null,"has_medicare_cover":false,"medicare_cover_details":null,"profile_type":"snapshot","original_profile_id":54,"avatar_file_name":"e8ccd30d055a50518d1f5b5505275e66f9acaf12.jpg","avatar_content_type":"image/jpeg","avatar_file_size":142139,"avatar_updated_at":"2016-01-07T03:50:55.714Z","last_tetanus_immunisation":"Never/Unknown","consented_at":"2016-01-07T03:50:54.916Z","travel_sickness":"false","sleep_walking":"false","phobia":"false","migrains":"false","skin_condition":"false","fainting":"false","asthma":"true","diabetes":"false","fits_of_any_type":"false","muscle_problems":"false","bleeding_disorder":"false","heart_condition":"false","sight_impairment":"false","hearing_impairment":"false","relationship_name_of_owner":"Father","name":"Muhammad Ahmed","first_name":"Muhammad","last_name":"Ahmed","updating_in_flow":false,"dietary_requirements":"false","allergies":"false","consented_by_name":"Martin Howell","prefered_first_name":"Ahmed","shared_profile_group_photo_last_updated_at":null,"anaphylaxis":"false","mental_illness":"false","anorexia":"false","last_confirmed_time":"2015-12-22T05:51:40.337Z","reupdate_reminder_last_sent":null,"medicare_expiry":null,"medicare_position_number":null,"medicare_attachment_file_name":null,"medicare_attachment_content_type":null,"medicare_attachment_file_size":null,"medicare_attachment_updated_at":null,"cached_sortable_name":"ahmedmuhammad","medical_summary":"Synchronised from CareMonkey.  Last changed: 07 January 2016 02:50pm AEDT\nOne Medical Condition\n---------------------------------------------------------\nCondition: Asthma (risk level: Medium)\n    Use inhaler only when needed\n    Uploaded attachment: https://groups.operoo.com/profiles/59/safety_alerts/2/attachment\n    Medication Required: No\n\n","signature_image_url":"https://groups.operoo.com/api/v1/groups/profile_signature?api_access_token=API_ACCESS_TOKEN&profile_id=59","user_request_id":"10005","blood_group":"O+",
      "medical_contacts":
        [
          {"id":107,"original_profile_contact_id":94,"email":null,"mobile_phone":"","home_phone":null,"relationship_name":"Doctor","profile_id":59,"created_at":"2016-01-07T03:50:59.430Z","updated_at":"2016-01-07T03:50:59.436Z","work_phone":"98797879","name":"Dr. Saba Nazir","position":1,"address":"","user_id":null}
        ],
      "emergency_contacts":
        [
          {"id":106,"original_profile_contact_id":92,"email":"","mobile_phone":"98797979","home_phone":"","relationship_name":"Mother","profile_id":59,"created_at":"2016-01-07T03:50:59.419Z","updated_at":"2016-01-07T03:50:59.425Z","work_phone":"","name":"Suman Siddiquie","position":1,"address":null,"user_id":null},
          {"id":105,"original_profile_contact_id":93,"email":"email@gmail.com","mobile_phone":"98786789","home_phone":"","relationship_name":"Father","profile_id":59,"created_at":"2016-01-07T03:50:59.329Z","updated_at":"2016-01-07T03:50:59.413Z","work_phone":"","name":"Martin Howell","position":2,"address":null,"user_id":1}
        ],
      "safety_alerts":
        [
          {"id":2,"profile_id":59,"created_at":"2016-01-07T03:50:58.724Z","updated_at":"2016-01-07T03:50:59.305Z","safety_alert_type":"snapshot","original_safety_alert_id":1,"name":"Asthma","human_risk_level":"Medium","medication_required":false,"medication":null,"confirmed":true,"description":"Use inhaler only when needed","file_url":"https://s3-ap-southeast-2.amazonaws.com/caremonkey-syd-dev/safety_alerts/2/155c342a88ee2c7520286fcd38884a72169b1da4.pdf?1452138658","file_content_type":"application/pdf","file_file_size":34581,"file_updated_at":"2016-01-07T03:50:58.891Z","epipen_expiry":null,"require_epipen":null}
        ]
    },
    {"id":61,"gender":"Male","email":"parents2-email@gmail.com","home_phone":"","work_phone":"","mobile_phone":"0402319258","street":"arbour boulevard","city":"melbourne","state":"victoria","country":"Australia","zip":"3023","swimming_ability_string":"Cannot swim","transfusions_allowed":false,"user_id":2,"created_at":"2016-01-07T05:26:44.521Z","updated_at":"2016-01-07T05:26:44.521Z","birth_day":11,"birth_month":1,"birth_year":2013,"wears_glasses":false,"wears_contacts":false,"paracetamol_allowed":false,"has_ambulance_cover":false,"ambulance_cover_details":null,"has_private_cover":false,"private_cover_details":null,"has_medicare_cover":false,"medicare_cover_details":null,"profile_type":"snapshot","original_profile_id":3,"avatar_file_name":null,"avatar_content_type":null,"avatar_file_size":null,"avatar_updated_at":null,"last_tetanus_immunisation":"Never/Unknown","consented_at":"2016-01-07T05:26:43.713Z","travel_sickness":"false","sleep_walking":"false","phobia":"false","migrains":"false","skin_condition":"false","fainting":"false","asthma":"false","diabetes":"false","fits_of_any_type":"false","muscle_problems":"false","bleeding_disorder":"false","heart_condition":"false","sight_impairment":"false","hearing_impairment":"false","relationship_name_of_owner":"Father","name":"Muhammad Sikandar","first_name":"Muhammad","last_name":"Sikandar","updating_in_flow":false,"dietary_requirements":"false","allergies":"false","consented_by_name":"Bilal Ahmed","prefered_first_name":"","shared_profile_group_photo_last_updated_at":null,"anaphylaxis":"false","mental_illness":"false","anorexia":"false","last_confirmed_time":"2015-10-15T05:22:48.514Z","reupdate_reminder_last_sent":null,"medicare_expiry":null,"medicare_position_number":null,"medicare_attachment_file_name":null,"medicare_attachment_content_type":null,"medicare_attachment_file_size":null,"medicare_attachment_updated_at":null,"cached_sortable_name":"sikandarmuhammad","medical_summary":"Synchronised from CareMonkey.  Last changed: 07 January 2016 04:26pm AEDT\nNo Medical Conditions\n","signature_image_url":"https://groups.operoo.com/api/v1/groups/profile_signature?api_access_token=API_ACCESS_TOKEN&profile_id=61","user_request_id":"5657","blood_group":"Unknown",
      "medical_contacts":
        [
          {"id":115,"original_profile_contact_id":10,"email":null,"mobile_phone":"","home_phone":null,"relationship_name":"Doctor","profile_id":61,"created_at":"2016-01-07T05:26:44.594Z","updated_at":"2016-01-07T05:26:44.599Z","work_phone":"987987908708","name":"aftab aslam","position":0,"address":"","user_id":null}
        ],
      "emergency_contacts":
        [
          {"id":114,"original_profile_contact_id":7,"email":"parents2-email@gmail.com", "mobile_phone":"0402319258","home_phone":"","relationship_name":"Father", "profile_id":61, "created_at":"2016-01-07T05:26:44.583Z","updated_at":"2016-01-07T05:26:44.589Z","work_phone":"","name":"Bilal Ahmed", "position":0, "address":null, "user_id":2},
          {"id":113,"original_profile_contact_id":9,"email":"parents-email@gmail.com", "mobile_phone":"04228789798","home_phone":"","relationship_name":"Wife","profile_id":61,"created_at":"2016-01-07T05:26:44.571Z","updated_at":"2016-01-07T05:26:44.578Z","work_phone":"","name":"Rahila Parveen","position":1,"address":null,"user_id":null}
        ],
      "safety_alerts":[]
    },
    {"id":64,"gender":"Female","email":"","home_phone":"87896868","work_phone":"","mobile_phone":"","street":"Jhapal","city":"Faisalabad","state":"Punjab","country":"Australia","zip":"2000","swimming_ability_string":"Cannot swim","transfusions_allowed":false,"user_id":2,"created_at":"2016-01-29T09:04:46.743Z","updated_at":"2016-01-29T09:04:46.743Z","birth_day":15,"birth_month":6,"birth_year":2010,"wears_glasses":false,"wears_contacts":false,"paracetamol_allowed":false,"has_ambulance_cover":false,"ambulance_cover_details":null,"has_private_cover":false,"private_cover_details":null,"has_medicare_cover":false,"medicare_cover_details":null,"profile_type":"snapshot","original_profile_id":62,"avatar_file_name":null,"avatar_content_type":null,"avatar_file_size":null,"avatar_updated_at":null,"last_tetanus_immunisation":"2014","consented_at":"2016-01-29T09:04:46.586Z","travel_sickness":"false","sleep_walking":"false","phobia":"false","migrains":"false","skin_condition":"false","fainting":"false","asthma":"true","diabetes":"false","fits_of_any_type":"false","muscle_problems":"false","bleeding_disorder":"false","heart_condition":"false","sight_impairment":"false","hearing_impairment":"false","relationship_name_of_owner":"Uncle","name":"Aoorab Fatima","first_name":"Aoorab","last_name":"Fatima","updating_in_flow":false,"dietary_requirements":"false","allergies":"false","consented_by_name":"Bilal Ahmed","prefered_first_name":"","shared_profile_group_photo_last_updated_at":null,"anaphylaxis":"false","mental_illness":"false","anorexia":"false","last_confirmed_time":null,"reupdate_reminder_last_sent":null,"medicare_expiry":null,"medicare_position_number":null,"medicare_attachment_file_name":null,"medicare_attachment_content_type":null,"medicare_attachment_file_size":null,"medicare_attachment_updated_at":null,"cached_sortable_name":"fatimaaoorab","medical_summary":"Synchronised from CareMonkey.  Last changed: 29 January 2016 08:04pm AEDT\nOne Medical Condition\n---------------------------------------------------------\nCondition: Asthma (risk level: Low)\n    just let her breath for a while - deep breaths\n    Uploaded attachment: https://groups.operoo.com/profiles/64/safety_alerts/7/attachment\n    Medication Required: No\n\n","signature_image_url":"https://groups.operoo.com/api/v1/groups/profile_signature?api_access_token=API_ACCESS_TOKEN&profile_id=64","user_request_id":"10001","blood_group":"Unknown",
      "medical_contacts":
        [
          {"id":129,"original_profile_contact_id":120,"email":null,"mobile_phone":"","home_phone":null,"relationship_name":"Doctor","profile_id":64,"created_at":"2016-01-29T09:04:53.668Z","updated_at":"2016-01-29T09:04:53.675Z","work_phone":"987987908708","name":"aftab aslam","position":0,"address":"","user_id":null}
        ],
      "emergency_contacts":
        [
          {"id":128,"original_profile_contact_id":119,"email":"parents2-email@gmail.com","mobile_phone":"0402319258","home_phone":"","relationship_name":"Father","profile_id":64,"created_at":"2016-01-29T09:04:53.659Z","updated_at":"2016-01-29T09:04:53.664Z","work_phone":"","name":"Bilal Ahmed","position":0,"address":null,"user_id":2},
          {"id":127,"original_profile_contact_id":116,"email":"parents2-email@gmail.com","mobile_phone":"0402319258","home_phone":"","relationship_name":"Uncle","profile_id":64,"created_at":"2016-01-29T09:04:53.648Z","updated_at":"2016-01-29T09:04:53.654Z","work_phone":"","name":"Bilal Ahmed","position":1,"address":null,"user_id":2},
          {"id":126,"original_profile_contact_id":118,"email":"parents2-email@gmail.com","mobile_phone":"0402319258","home_phone":"","relationship_name":"Uncle","profile_id":64,"created_at":"2016-01-29T09:04:53.637Z","updated_at":"2016-01-29T09:04:53.644Z","work_phone":"","name":"Bilal Ahmed","position":2,"address":null,"user_id":2},
          {"id":125,"original_profile_contact_id":117,"email":"parents-email@gmail.com","mobile_phone":"04228789798","home_phone":"","relationship_name":"Wife","profile_id":64,"created_at":"2016-01-29T09:04:53.567Z","updated_at":"2016-01-29T09:04:53.632Z","work_phone":"","name":"Rahila Parveen","position":3,"address":null,"user_id":null}],
        "safety_alerts":
          [
            {"id":7,"profile_id":64,"created_at":"2016-01-29T09:04:46.918Z","updated_at":"2016-01-29T09:04:53.546Z","safety_alert_type":"snapshot","original_safety_alert_id":6,"name":"Asthma","human_risk_level":"Low","medication_required":false,"medication":null,"confirmed":true,"description":"just let her breath for a while - deep breaths","file_url":"https://s3-ap-southeast-2.amazonaws.com/caremonkey-syd-dev/safety_alerts/7/a531a52da6a50137175634111d0571a834cc0769.pdf?1454058289","file_content_type":"application/pdf","file_file_size":341026,"file_updated_at":"2016-01-29T09:04:49.035Z","epipen_expiry":null,"require_epipen":null}
          ]
    },
}

Working with Hierarchies

Any of the following calls can be made with an optional group_id parameter, which will allow you to specify which independent group you wish to make the call for. If this parameter is not passed, the group that generated the API key will be used.

Example query 
https://groups.operoo.com/api/v1/groups?api_access_token=API_ACCESS_TOKEN&profile_request=true&group_id=14

The above would return all profile requests for group 14, as long as the API Access Token belongs to either group 14, or to an independent group above group 14 in the hierarchy tree.

Response Code Summary

Response Code Description
100 Success
101 Token not found
102 Invalid token
103 Token doesn't belong to master group
104 IP is not allowed to access the API
105 Problem saving a group
106 Group parameter is not present
107 Group not found with this id
108 Problem deleting a group
109 Group can't be deleted until it is empty
110 Carer parameter is not present
111 Carer already exists in Group
112 Problem saving group carer
113 Carer not found with this id
114 Problem deleting a group carer
115 Profile Request parameter is not present
116 Problem saving profile request
117 Profile Request not found with this id
118 Problem deleting profile request
119 External group parameter is not present
120 Problem saving external group
121 External Group not found with this id
122 Problem deleting external group
123 External profile request parameter is not present
124 Problem saving external profile request
125 External profile request not found with this id
126 Problem deleting external profile request
127 Problem deleting the admin
128 Administrator already exists in Group
129 Administrator not found with this id
130 Problem Importing Group Carer
131 Invalid admin parameters
132 admin_email parameter is not present
133 Cannot assign admins to subgroups
134 Administrator already exists in Group Hierarchy
135 Log description is empty
150 Invalid Enquiry
151 You can not delete an eForm until it is empty
152 parent_id must be within your hierarchy
400 Object Not Found

Manage Groups

Retrieve group details (HTTP GET to Group)

To retrieve full list of existing groups, send a GET request with option group=true 

https://groups.operoo.com/api/v1/groups?api_access_token=API_ACCESS_TOKEN&group=true

Example Response
{
  "responseCode":100,
  "errors":[],
  "organization":
    {"name":"La Trobe University","admin_name":"John Smith","admin_email":"someemail@yahoo.com",
     "website":"https://www.caremonkey.com","mailing_address":"41 Stewart St, Richmond, Victoria",
     "admin_title":"Administrator","timezone":"Melbourne"
    },
"groups":
    [
      {"id":251,"name":"All Carers (automatic)"},
      {"id":35,"name":"Year 7B"},
      {"id":43,"name":"new group"},
      {"id":25,"name":"Year 7A"},
      {"id":150,"name":"56"},
      {"id":46,"name":"year 78"},
      {"id":231,"name":"Wednesday Evening"},
      {"id":172,"name":"Tuesday Night"}
   ]
}

Add a new Group (HTTP POST to Groups)

To make a new group, send a POST request in the following format.

create_url = "https://groups.operoo.com/api/v1/groups?api_access_token=API_ACCESS_TOKEN"
response = HTTParty.post(create_url, :body => {:group => {:name => "Language Class" }}, :timeout => 55)
Example Response
{"errors"=>[], "responseCode"=>100}

Retrieve a specific (Sub) Group (HTTP GET to Groups)

Retrieve the details for a single, (sub) group, specified by its ID.
If you wish to look up the group using your own customer-integration-specific ID, then pass in integration_group=true, along with that ID. 

groups_url = "https://groups.operoo.com/api/v1/groups/{group_id}?api_access_token=API_ACCESS_TOKEN"
response = HTTParty.get(groups_url, :timeout => 55)
Example Success Response
{
    responseCode: 100,
    errors: [ ],
    organization: {
        id: 2,
        name: "Blackburn Bowling",
        admin_name: "Martin Howell",
        admin_email: "mph@howell.com.au",
        website: "",
        mailing_address: "",
        admin_title: "",
        timezone: "Melbourne",
        integration_year: null,
        integration_semester: null,
        sync_medical_details: false,
        sync_contact: null,
        sync_pre_enrolment: false
    },
    group: {
        id: 5,
        name: "Sample Group name",
        created_at: "2016-03-18T06:00:30.060Z",
        updated_at: "2016-06-07T06:41:38.277Z",
        integration_group_id: "bowling123"
    }
}

Example Failed Response
{"errors"=>["Group not found with this id"], "responseCode"=>107}

Modify an existing Group (HTTP PATCH to Groups)

Modifying a group requires a group_id to be passed in with the request. 

update_url = "https://groups.operoo.com/api/v1/groups/group_id?api_access_token=API_ACCESS_TOKEN"
response = HTTParty.patch(update_url, :body => {:group => {:name => "Language Club" }}, :timeout => 55)
Example Response
{"errors"=>["Group not found with this id"], "responseCode"=>107}

Delete a Group (HTTP DELETE to Groups)

Deleting a group requires a group_id to be passed in with the request. 

  delete_url = "https://groups.operoo.com/api/v1/groups/group_id?api_access_token=API_ACCESS_TOKEN"
  response = HTTParty.delete(delete_url, :timeout => 55)
Example Response
{"errors"=>["Group not found with this id"], "responseCode"=>107}
{"errors"=>[], "responseCode"=>100}

Getting Profiles for a Given Group

A list of profiles that are contained in a given group can be retreived by sending a GET request to the URL below, and providing a group id in the url. 

fetch_url = "https://groups.operoo.com/api/v1/groups/:id/members?api_access_token=API_ACCESS_TOKEN"
response = HTTParty.get(fetch_url, :timeout => 55)

Adding Profiles to a Group

Profiles can be added to a group by making a PUT or POST call to the URL below, and passing in a list of profile ids.

PUT call - will add and remove profiles to/from the group until the profiles in the group match the list of profile ids provided
POST call - will add members to the group provided 

update_url = "https://groups.operoo.com/api/v1/groups/:id/members?api_access_token=API_ACCESS_TOKEN"
response = HTTParty.put(update_url, :body => {:group => {:profile_ids => [1,2,14,36] }}, :timeout => 55)

Profiles can also be added to a group using the integration_group_id that was set when creating the member, by changing the URL for this PUT call slightly, as below. 

update_url = "https://groups.operoo.com/api/v1/groups/:id/integration_members?api_access_token=API_ACCESS_TOKEN"
response = HTTParty.put(update_url, :body => {:group => {:integration_profile_ids => ["def1","abc2","abc14","def36"] }}, :timeout => 55)

Injury report for Group

To list all the incidents/injuries for a group requires a GET call to `group/incidents` as follows: 

  delete_url = "https://groups.operoo.com/api/v1/groups/incidents?api_access_token=API_ACCESS_TOKEN"
  response = HTTParty.delete(delete_url, :timeout => 55)
Example Response
{
  responseCode: 100,
  errors: [ ],
  members: [
            {
              id: 26,
              name: "Hamza Riaz",
              incidents: [
                {
                  id: 1,
                  competition_age_group: "U/12",
                  reason_for_presentation: "New injury",
                  description: "injury",
                  injury_type: "Bleeding",
                  cause_of_injury: "Collision with fixed object / ground",
                  treatment_plan: "Bleeding controlled, Dressing, Wound dressing",
                  medication_given: "",
                  contributing_factors: "",
                  has_protective_equipment: true,
                  status: "Assisted",
                  injury_activity_location: "Training",
                  location: "Melbourne",
                  action: "Referred for further assessment before return to activity",
                  referral: "Referred to Doctor",
                  sports_trainer_name: "Andrew ",
                  sports_trainer_id: "88998",
                  occurred_date: "2015-12-07",
                  occurred_time: "3:00pm",
                  return_date: "2015-12-14",
                  cm_marked_image_url: "https://groups.operoo.com/incidents/1/marked_body_attachment"
                }
              ]
            }
         ]
}

Creating Groups in a Hierarchy

There are two types of groups in a Operoo hierarchy.
Independent Group are considered to be thier own entity, and will have their own settings, profiles, carers and eforms.
Sub Group are a grouping of profiles within an independent group.

You can create a sub group by sending a POST request to 'groups/:id/sub_groups' as follows:

  create_url = "https://groups.operoo.com/api/v1/groups/:id/sub_groups?api_access_token=API_ACCESS_TOKEN"
  create_request_parameters = :group => {:name => "Year 7", :integration_group_id => "ABC123"},
  response = HTTParty.post(create_url, :body => create_request_parameters, :timeout => 55)

You can create an independent group by sending a POST request to 'groups/:id/independent_groups' as follows:

  create_url = "https://groups.operoo.com/api/v1/groups/:id/independent_groups?api_access_token=API_ACCESS_TOKEN"
  create_request_parameters = :group => {:name => "The International School of Excellence", :integration_group_id => "SCH001"},
  response = HTTParty.post(create_url, :body => create_request_parameters, :timeout => 55)

Parameters for both of the above calls
  • name - The name of the new group
  • integration_group_id (optional) - An identifier that can be used to keep groups in sync with an external system

Manage Carers

Retrieve carer details (HTTP GET to Group_carers)

To retrieve full list of existing carers, send a GET request to `group_carers` as follows: 

https://groups.operoo.com/api/v1/group_carers?api_access_token=API_ACCESS_TOKEN

Example Response
[{
    id: 1,
    name: "John Smith",
    email: "jsmith@caremonkey.com",
    created_at: "2015-10-14T05:04:47.332Z",
    image_url: "FULL_IMAGE_URL",
    mobile_number: "0404040404",
    has_access_to_all_profiles: true
  },
  {
    id: 2,
    name: "Martin Howell",
    email: "mph@howell.com.au",
    created_at: "2015-11-18T05:49:32.806Z",
    image_url: "FULL_IMAGE_URL",
    mobile_number: "98786789",
    has_access_to_all_profiles: null
  }]

Add a new Carer (HTTP POST to Group_carers)

To add a new carer, send a POST request in the following format: 

group_parameters = {:name => "Simba Josh", :email => "simba.josh@gmail.com", :mobile_number => "9494595495" }
create_url = "https://groups.operoo.com/api/v1/group_carers?api_access_token=API_ACCESS_TOKEN"
response = HTTParty.post(create_url, :body => {:group_carer => group_parameters}, :timeout => 55)

Example Response
{"errors"=>[], "responseCode"=>100}

Modify a Carer (HTTP PATCH to Group_carers)

To update an existing carer, send a PATCH request with group_carer_id in the following format: 

group_parameters = {:name => "Simba Joe", :email => "simba.josh@gmail.com", :mobile_number => "5244233" }
update_url = "https://groups.operoo.com/api/v1/group_carers/group_carer_id?api_access_token=API_ACCESS_TOKEN"
response = HTTParty.patch(update_url, :body => {:group_carer => group_parameters}, :timeout => 55)

Example Response
{"errors"=>[], "responseCode"=>100}
{"errors":["Carer paramter is not present"],"responseCode":110}
{"errors":["Carer not found with this id"],"responseCode":113}

Delete a (HTTP DELETE to Group_carers)

To delete an existing carer, send a DELETE request with group_carer_id in the following format: 

 delete_url = "https://groups.operoo.com/api/v1/group_carers/group_carer_id?api_access_token=API_ACCESS_TOKEN"
 response = HTTParty.delete(delete_url, :timeout => 55)

Example Response
{"errors"=>["Carer not found with this id"], "responseCode"=>113}
{"errors"=>[], "responseCode"=>100}

Manage eForm Enquiries

Retrieve all eForms (HTTP GET to Enquiries)

To retrieve full list of existing eForms, send a GET request to Enquiries 

https://groups.operoo.com/api/v1/enquiries?api_access_token=API_ACCESS_TOKEN

Example Response
{"responseCode":100,
  "errors":[],
  "enquires":
    {"name":"La Trobe University","admin_name":"John Smith","admin_email":"someemail@yahoo.com",
     "website":"http://www.caremonkey.com","mailing_address":"41 Stewart St, Richmond, Victoria",
     "admin_title":"Administrator","timezone":"Melbourne"
    },
  "external_groups":[
    {"id":1,"group_name":"Sunday Morning"},
    {"id":2,"group_name":"Football Club"},
    {"id":3,"group_name":"Class 7"}
  ]
}

Retrieve eForm details by id (HTTP GET to Enquiries)

To retrieve a specific eForm, send a GET request to Enquiries 

https://groups.operoo.com/api/v1/enquiries/#{enquiry_id}?api_access_token=#{API_ACCESS_TOKEN}

Example Response
{ "errors":[],
  "responseCode":100,
  "enquiry":
    {"parent_id":1,
    "id":5,
    "name":"Year 7 Camp",
    "created_at":"2015-12-01T06:53:28.843Z",
    "updated_at":"2015-12-01T06:53:28.843Z",
    "owner_id":1,
    "timezone":"Melbourne",
  ...}
}

Update eForm details by id (HTTP PATCH to Enquiries)

To update a specific eForm, send a PATCH request to Enquiries 

patch_params = {member_id: 2}
patch_url = "https://groups.operoo.com/api/v1/enquiries/#{enquiry_id}?api_access_token=#{API_ACCESS_TOKEN}"
response = HTTParty.patch(patch_url, body: patch_params, timeout: 55)

Example Response
{ "errors"=>["Unable to find member, is the id correct?"], "responseCode"=>154}
{ "errors":[], "responseCode":100 }

Add New eForm (HTTP POST to Enquiries)

Create a new eform by sending a POST request in the following format: 

create_request_parameters = {name: "Year 7 Camp", enquiryType: "excursion"}
create_url = "https://groups.operoo.com/api/v1/enquiries?api_access_token=#{API_ACCESS_TOKEN}"
response = HTTParty.post(create_url, body: create_request_parameters, timeout: 55)
Example Response
{"errors"=>[],
 "responseCode"=>100,
 "enquiry"=>
  {"id"=>5,
   "name"=>"Year 7 Camp",
   "created_at"=>"2015-12-01T06:53:28.843Z",
   "updated_at"=>"2015-12-01T06:53:28.843Z",
   "owner_id"=>1,
   "timezone"=>"Melbourne",
...}
}

Delete an eForm Request (HTTP DELETE to enquiries)

To delete an existing profile request, send a DELETE request with member_id in the following format: 

 delete_url = "https://groups.operoo.com/api/v1/enquiries/#{enquiry_id}?api_access_token=#{API_ACCESS_TOKEN}"
 response = HTTParty.delete(delete_url, :timeout => 55)
Example Responses
{"errors"=>["Enquiry not found"], "responseCode"=>154}

{"errors"=>[], "responseCode"=>100}

Manage Profile Requests

Retrieve all profile requests (HTTP GET to Profile_request)

To retrieve full list of existing profile requests, send a GET request with option profile_request=true 

https://groups.operoo.com/api/v1/groups?api_access_token=API_ACCESS_TOKEN&profile_request=true

Example Response
{
  "responseCode":100,
  "errors":[],
  "organization":
    {"name":"La Trobe University","admin_name":"John Smith","admin_email":"someemail@yahoo.com",
     "website":"https://www.caremonkey.com","mailing_address":"41 Stewart St, Richmond, Victoria",
     "admin_title":"Administrator","timezone":"Melbourne"
    },
  "profile_requests":
    [
      {"id":1015,"name":"Yo Boswelliana","email":"paramagnet@rapidgroups.com","mobile_number":"9494949494","user_request_id":"10525","is_managed_locally":false,"is_complete":false},
      {"id":1016,"name":"Womanhead Bedlamitish","email":"jose@rapidgroups.com","mobile_number":"4367512 349","user_request_id":"","is_managed_locally":false,"is_complete":false},
      {"id":1018,"name":"Martin Howell","email":"mph@caremonkey.com","mobile_number":"0415947543","user_request_id":"","is_managed_locally":false,"is_complete":false},
      {"id":1035,"name":"John Smith","email":"albert@caremonkey.com","mobile_number":"0415947543","user_request_id":"3526","is_managed_locally":false,"is_complete":false},
      {"id":1036,"name":"John Neuman","email":"bash@caremonkey.com","mobile_number":"0415947543","user_request_id":"2351","is_managed_locally":false,"is_complete":false},
      {"id":1039,"name":"Frank Walker","email":"john.doe@yahoo.com","mobile_number":"0415947543","user_request_id":"","is_managed_locally":false,"is_complete":false},
      {"id":1042,"name":"Nonimbricating Squattish","email":"mph+sussexite@caremonkey.com","mobile_number":"","user_request_id":"2562","is_managed_locally":false,"is_complete":false},
      {"id":1047,"name":"Nocole Swan","email":"dahal_bsd@yahoo.com","mobile_number":"0415947543","user_request_id":"","is_managed_locally":false,"is_complete":false},
      {"id":1050,"name":"Marree Barmote","email":"mph+janizary@caremonkey.com","mobile_number":null,"user_request_id":"3254","is_managed_locally":false,"is_complete":false},
    {"id":1051,"name":"Jackob Black","email":"paramagnet@rapidgroups.com","mobile_number":"9494949494","user_request_id":""}
    ]
}

To retrieve profile requests along with private notes, send a profile_request with private_notes=true 

https://groups.operoo.com/api/v1/groups?api_access_token=API_ACCESS_TOKEN&profile_request=true&private_notes=true

Example Response
{
  "responseCode":100,
  "errors":[],
  "organization":
    {"name":"La Trobe University","admin_name":"John Smith","admin_email":"someemail@yahoo.com",
     "website":"https://www.caremonkey.com","mailing_address":"41 Stewart St, Richmond, Victoria",
     "admin_title":"Administrator","timezone":"Melbourne"
    },
  "profile_requests":
    [
      {"id":1015,"name":"Yo Boswelliana","email":"paramagnet@rapidgroups.com","mobile_number":"9494949494","user_request_id":"10525","is_managed_locally":false,"is_complete":false},
      {"id":1016,"name":"Womanhead Bedlamitish","email":"jose@rapidgroups.com","mobile_number":"4367512 349","user_request_id":"","is_managed_locally":false,"is_complete":false},
      {"id":1018,"name":"Martin Howell","email":"mph@caremonkey.com","mobile_number":"0415947543","user_request_id":"","is_managed_locally":false,"is_complete":false},
      {"id":1035,"name":"John Smith","email":"albert@caremonkey.com","mobile_number":"0415947543","user_request_id":"3526","is_managed_locally":false,"is_complete":false},
      {"id":1036,"name":"John Neuman","email":"bash@caremonkey.com","mobile_number":"0415947543","user_request_id":"2351","is_managed_locally":false,"is_complete":false},
      {"id":1039,"name":"Frank Walker","email":"john.doe@yahoo.com","mobile_number":"0415947543","user_request_id":"","is_managed_locally":false,"is_complete":false},
      {"id":1042,"name":"Nonimbricating Squattish","email":"mph+sussexite@caremonkey.com","mobile_number":"","user_request_id":"2562","is_managed_locally":false,"is_complete":false},
      {"id":1047,"name":"Nocole Swan","email":"dahal_bsd@yahoo.com","mobile_number":"0415947543","user_request_id":"","is_managed_locally":false,"is_complete":false},
      {"id":1050,"name":"Marree Barmote","email":"mph+janizary@caremonkey.com","mobile_number":null,"user_request_id":"3254","is_managed_locally":false,"is_complete":false
	private_notes: [
	{
	  id: 3,
	  description: "another private note for Marree Barmote",
	  created_at: "2016-02-05T01:09:43.852Z",
	  updated_at: "2016-02-05T01:09:43.852Z",
	  user_id: 1
	},
	{
	  id: 1,
	  description: "arrogant kid... careful",
	  created_at: "2016-02-04T23:48:56.950Z",
	  updated_at: "2016-02-05T01:09:05.871Z",
	  user_id: 2
	}]
    },
      {"id":1051,"name":"Jackob Black","email":"paramagnet@rapidgroups.com","mobile_number":"9494949494","user_request_id":""}
    ]
}

Add New Profile Request (HTTP POST to profile_request)

To add a new profile request (e.g. for group 123), send a POST request in the following format: 

profile_request_parameters = {:first_name => "Jack", :last_name => "Swan", :request_email => "jack.swan@gmail.com", :notification_only_email => "jack.swan+notifications@gmail.com", :request_mobile_number => "9494595495", :user_request_id => "433434" }
create_url = "https://groups.operoo.com/api/v1/members?group_id=123&api_access_token=API_ACCESS_TOKEN"
response = HTTParty.post(create_url, :body => {:member => profile_request_parameters}, :timeout => 55)
Example Response
{"errors"=>[], "responseCode"=>100}

Update A Profile Request (HTTP PATCH to profile_request)

To update an existing profile request, send a PATCH request with member_id in the following format. 

profile_request_parameters = {:first_name => "John", :last_name => "Swan", :request_email => "john.swan@gmail.com", :notification_only_email => "jack.swan+notifications@gmail.com", :request_mobile_number => "4455", :user_request_id => "43" }
update_url = "https://groups.operoo.com/api/v1/members/1508?group_id=123&api_access_token=API_ACCESS_TOKEN"
@response = HTTParty.patch(update_url, :body => {:member => profile_request_parameters}, :timeout => 55)
Example Response
{"errors"=>["Request mobile number is not long enough"], "responseCode"=>116}

Delete a Profile Request (HTTP DELETE to profile_request)

To delete an existing profile request, send a DELETE request with member_id in the following format: 

 delete_url = "https://groups.operoo.com/api/v1/members/member_id?group_id=123&api_access_token=API_ACCESS_TOKEN"
 response = HTTParty.delete(delete_url, :timeout => 55)
Example Response
{"errors"=>["Profile Request not found with this id"], "responseCode"=>117}
{"errors"=>[], "responseCode"=>100}

Integration Member ID

As well as the parameters supplied in the PATCH and POST methods above, there is also the optional parameter integration_member_id which can be used when creating more complex synchronisations between Operoo and external systems. If entered upon creation, or via update, this integration_member_id can then be used in place of the regular member id when making certain API calls.

Manage External Groups

Retrieve external groups (HTTP GET to external_group)

To retrieve full list of existing external groups, send a GET request with option external_group=true 

https://groups.operoo.com/api/v1/groups?api_access_token=API_ACCESS_TOKEN&external_group=true

Example Response
{
  "responseCode":100,
  "errors":[],
  "organization":
    {"name":"La Trobe University","admin_name":"John Smith","admin_email":"someemail@yahoo.com",
     "website":"http://www.caremonkey.com","mailing_address":"41 Stewart St, Richmond, Victoria",
     "admin_title":"Administrator","timezone":"Melbourne"
    },
  "external_groups":[
    {"id":1,"group_name":"Sunday Morning"},
    {"id":2,"group_name":"Football Club"},
    {"id":3,"group_name":"Class 7"}
  ]
}

Add a new Group (HTTP POST to External Group)

To make a new external group, send a POST request in the following format.

create_url = "https://groups.operoo.com/api/v1/external_groups?api_access_token=API_ACCESS_TOKEN"
response = HTTParty.post(create_url, :body => {:external_group_params => {:group_name => "External Group"}})
Example Response
{"errors"=>[], "responseCode"=>100}

Modify an existing External Group (HTTP PATCH to External Group)

Modifying a group requires a external_group_id to be passed in with the request. 

update_url = "https://groups.operoo.com/api/v1/external_groups/2?api_access_token=API_ACCESS_TOKEN"
response = HTTParty.patch(update_url, :body => {:external_group_params => {:group_name => "My Testing external Group"}})
Example Response
{"errors"=>["External Group not found with this id"], "responseCode"=>121}

Delete an External Group (HTTP DELETE to External Group)

Deleting an external group requires a external_group_id to be passed in with the request. 

delete_url = "https://groups.operoo.com/api/v1/external_groups/22?api_access_token=API_ACCESS_TOKEN"
response = HTTParty.delete(delete_url, :timeout => 55)
Example Response
{"errors"=>["External Group not found with this id"], "responseCode"=>121}
{"errors"=>[], "responseCode"=>100}

Manage External Profile Requests

Retrieve all external profile requests (HTTP GET to external_profile_request)

To retrieve full list of existing profile requests, send a GET request with option external_profile_request=true 

https://groups.operoo.com/api/v1/groups?api_access_token=API_ACCESS_TOKEN&external_profile_request=true

Example Response
{
  "responseCode":100,
  "errors":[],
  "organization":
    {"name":"La Trobe University","admin_name":"John Smith","admin_email":"someemail@yahoo.com",
     "website":"https://www.caremonkey.com","mailing_address":"41 Stewart St, Richmond, Victoria",
     "admin_title":"Administrator","timezone":"Melbourne"
    },
  "external_profile_requests":
    [
      {"id":1,"student_first_name":"Joel","student_last_name":"Westley","student_middle_name":null,"student_preferred_first_name":null,"email":"joel@gmail.com","mobile_number":"439994934"},
      {"id":2,"student_first_name":"Tony","student_last_name":"Abott","student_middle_name":null,"student_preferred_first_name":null,"email":"tony.abott@caremonkey.com","mobile_number":"49499595"},
      {"id":3,"student_first_name":"Joel","student_last_name":"Westley","student_middle_name":null,"student_preferred_first_name":null,"email":"joel@gmail.com","mobile_number":"439994934"}
    ]
}

Add New External Profile Request (HTTP POST to external_profile_request)

To add a new external profile request send a POST request in the following format: 

external_profile_request_params = {:student_first_name => "Greg", :student_middle_name => "J", :student_last_name => "Sanduk", :email => "ddd@gmail.com", :mobile_number => "3499439934"}
create_url = "https://groups.operoo.com/api/v1/external_members?api_access_token=API_ACCESS_TOKEN"
response = HTTParty.post(create_url, :body => {:external_profile_request => external_profile_request_params})
Example Response
{"errors"=>[], "responseCode"=>100}

Update an External Profile Request (HTTP PATCH to external_profile_request)

To update an existing external profile request, send a PATCH request with external_member_id in the following format. 

external_profile_request_params = {:student_first_name => "Ted", :student_last_name => "Jun", :email => "ddd@gmail.com", :mobile_number => "3499439934"}
update_url = "https://groups.operoo.com/api/v1/external_members/external_member_id?api_access_token=API_ACCESS_TOKEN"
response = HTTParty.patch(update_url, :body => {:external_profile_request => external_profile_request_params})
Example Response
{"errors"=>[], "responseCode"=>100}

Delete an Existing Profile Request (HTTP DELETE to external_profile_request)

To delete an existing external profile request, send a DELETE request with external_member_id in the following format: 

 delete_url = "https://groups.operoo.com/api/v1/external_members/external_member_id?api_access_token=API_ACCESS_TOKEN"
 response = HTTParty.delete(delete_url, :timeout => 55)
Example Response
{"errors"=>["External profile request not found with this id"], "responseCode"=>125}

Manage Administrators

Create a new administrator (HTTP POST to groups/:group_id/admins)

To create a new administrator, send a post call to groups/:group_id/admins with valid params as follows:

create_url = https://groups.operoo.com/api/v1/groups/2/admins/?api_access_token=API_ACCESS_TOKEN
response = HTTParty.post(create_url, :body => { :admin => {:admin_email => "hello@test.com", :integration_administrator_id => "admin_1234"}}, :timeout => 55)
Example Response
{"errors"=>[], "responseCode"=>100}

Retrieve existing administrators (HTTP GET to groups/:group_id/admins)

To retrieve full list of existing administrators, send a GET request to 'groups/:group_id/admins' as follows: 

https://groups.operoo.com/api/v1/groups/2/admins?api_access_token=API_ACCESS_TOKEN
Example Response
{
    responseCode: 100,
    errors: [ ],
    organization: {
        id: 2,
        name: "Blackburn Bowling",
        admin_name: "Martin Howell",
        admin_email: "mph@howell.com.au",
        website: "",
        mailing_address: "",
        admin_title: "",
        timezone: "Melbourne",
        integration_year: null,
        integration_semester: null,
        sync_medical_details: false,
        sync_contact: null,
        sync_pre_enrolment: false
    },
    existing_admins: [
        {
            id: 7,
            created_at: "2016-04-13T07:24:12.434Z",
            updated_at: "2016-04-13T07:24:12.434Z",
            name: "Test Administrator",
            email: "test-admin@caremonkey.com"
        },
        {
            id: 13,
            created_at: "2016-05-02T05:50:41.715Z",
            updated_at: "2016-05-02T05:50:41.715Z",
            name: "Test Administrator2",
            email: "test-admin2@caremonkey.com"
        }
    ]
}

Show a particular existing administrator (HTTP GET to '/groups/:group_id/admins/:id')

To retrieve administrator details, send a get request with existing administrator id as follows:

https://groups.operoo.com/api/v1/groups/2/admins/7?api_access_token=API_ACCESS_TOKEN
Example Response
{
    responseCode: 100,
    errors: [ ],
    organization: {
        id: 2,
        name: "Blackburn Bowling",
        admin_name: "Martin Howell",
        admin_email: "mph@howell.com.au",
        website: "",
        mailing_address: "",
        admin_title: "",
        timezone: "Melbourne",
        integration_year: null,
        integration_semester: null,
        sync_medical_details: false,
        sync_contact: null,
        sync_pre_enrolment: false
    },
    admin: {
        id: 7,
        created_at: "2016-04-13T07:24:12.434Z",
        updated_at: "2016-04-13T07:24:12.434Z",
        name: "Test Administrator",
        email: "test-admin@caremonkey.com"
    }
}

Delete an existing administrator (HTTP DELETE to '/groups/:group_id/admins/:id')

To delete an administrator (revoking administrator access from group doesn't mean it is going to delete the user from system as well), send a DELETE request with existing administrator id as follows:

delete_url = https://groups.operoo.com/api/v1/groups/2/admins/7?api_access_token=API_ACCESS_TOKEN
response = HTTParty.delete(delete_url, :timeout => 55)
Example Response
{"errors"=>[], "responseCode"=>100}