1. Watermark
  2. Student Success & Engagement (SSE)
  3. Watermark Student App
  4. API Usage

Mobile Feature API Endpoints

Updated
Watermark Support
  • /mobileFeature
    • Returns a (non-exhaustive) list of features that can be accessed on the Watermark Student app.
    • Headers 
      • X-TOKEN: {Access Token}
        • This access token can be retrieved by following the instructions here
    • URL Parameters
      • None
    • Example Response  
      • {
          "_embedded": {
            "mobileFeature": [
              {
                "id": 1,
                "name": "Meetings",
                "createdDate": "2020-09-23T12:38:47.897+0000",
                "modifiedDate": "2020-09-23T12:38:47.897+0000",
                "_links": {
                  "self": {
                    "href": "http:///mobileFeature/1"
                  },
                  "mobileFeature": {
                    "href": "http:///mobileFeature/1"
                  },
                  "modifiedBy": {
                    "href": "http:///mobileFeature/1/modifiedBy{?projection}",
                    "templated": true
                  },
                  "createdBy": {
                    "href": "http:///mobileFeature/1/createdBy{?projection}",
                    "templated": true
                  }
                }
              }
            ]
          },
          "_links": {
            "self": {
              "href": "http:///mobileFeature{?page,size,sort}",
              "templated": true
            },
            "profile": {
              "href": "http:///profile/mobileFeature"
            }
          },
          "page": {
            "size": 20,
            "totalElements": 1,
            "totalPages": 1,
            "number": 0
          }
        }
  • /mobileFeature/getFeaturesForStudent
    • This will return the count of features provided that have been created after provided date for a specific student 
    • Headers 
      • X-TOKEN: {Access Token}
        • This access token can be retrieved by following the instructions here
    • URL parameters
      • features (required)
        • Type: String array
        • Using the /mobileFeature method as a guide for what features are offered, enter the names of the features in the form of a string array
      • institutionPersonId (required)
        • Type: String
        • This is the student that the data is being retrieved for
      • date (required)
        • Type: String
        • Counts of items that have been created after this date will be returned
        • Must be formatted like 
          yyyy-MM-ddTHH:mm:ss.SSSSSSZ
    • Response Object's Properties
      • name - This is the name of the feature.
      • count -  This is the number of items that have been created after the given date.
      • url - This is a deep link that will open in the students app if they have it. If this link is opened on a desktop, then it will take the user to the appropriate web page within SS&E.
      • asOfDate - This is the date that was originally provided which the counts are based off of.
    • Example Response
      • Request: https://.api.avisoapp.com/mobileFeature/getFeaturesForStudent?features=Meetings,Messages,Tasks&institutionPersonId=824044816&date=2020-08-01T00:00:00.000Z 
      • [
          {
            "name": "Meetings",
            "count": 67,
            "url": "https://app.avisoretention.com/?link=https://app.avisoretention.com/meetings&ofl=http://.avisoapp.com/aviso/student/home&ifl=http://.avisoapp.com/aviso/student/home&afl=http://.avisoapp.com/aviso/student/home&apn=com.avisoretention.app&ibi=com.avisoretention.mobileapp",
            "asOfDate": "2020-08-01T00:00:00.000+0000"
          },
          {
            "name": "Messages",
            "count": 30,
            "url": "https://app.avisoretention.com/?link=https://app.avisoretention.com/messages&ofl=http://.avisoapp.com/aviso/student/messages&ifl=http://.avisoapp.com/aviso/student/messages&afl=http://.avisoapp.com/aviso/student/messages&apn=com.avisoretention.app&ibi=com.avisoretention.mobileapp",
            "asOfDate": "2020-08-01T00:00:00.000+0000"
          },
          {
            "name": "Tasks",
            "count": 4,
            "url": "https://app.avisoretention.com/?link=https://app.avisoretention.com/tasks&ofl=http://.avisoapp.com/aviso/student/home&ifl=http://.avisoapp.com/aviso/student/home&afl=http://.avisoapp.com/aviso/student/home&apn=com.avisoretention.app&ibi=com.avisoretention.mobileapp",
            "asOfDate": "2020-08-01T00:00:00.000+0000"
          }
        ]

         

Was this article helpful?
0 out of 0 found this helpful

Articles in this section

How to Contact Support
There are many ways to reach out! Click here for our support options.
Watermark Academy
Click to access the Watermark Academy for consultation, training, and implementation companion courses.
Customer Community
Can’t find the answer? Ask fellow users how they’re making the most of Watermark in our Community!