TheAlphaSchoolSystemPTYLTD / student-details

Student Details API
13 stars 10 forks source link

Retrieving student photo thumbnails not working on getStudentsDetails method v3 API #52

Closed MisterMunchkin closed 8 months ago

MisterMunchkin commented 1 year ago

We are trying to retrieve students' photo thumbnails. We sent the request with thumbnail: true in the encrypted token. The request was successful but in the JSON response, there's no data that looks to be for the thumbnail photo.

This is the token object from the response JSON

"token": {
        "timestamp": "{ts '2023-01-18 18:43:36'}",
        "includephoto": false,
        "thumbnail": true,
        "currentstatus": "current"
    },

And this is an example of the student object from the response JSON with data removed.

{
            "general_details": {
                "surname": "",
                "next_year_indicator": "",
                "multiparent_flag": "",
                "last_update_on": "",
                "date_of_leaving": "",
                "student_code":,
                "usi": "",
                "preferred_surname": "",
                "first_name": "",
                "last_update_by": "",
                "mobile_phone": "",
                "lui_number": "",
                "entry_year_group": ,
                "par_code":,
                "sms_flg": "",
                "religion": "",
                "preferred_name": "",
                "other_name": "",
                "gender": "",
                "date_of_entry": "",
                "date_of_birth": "",
                "alternate_id": "",
                "given_names": ""
            },
            "school_details": {
                "campus": "",
                "email_address": "",
                "pc_tutor_group": "",
                "boarder": "",
                "student_cafe_access": "",
                "house": "",
                "year_group": ,
                "form_class": "",
                "residency_status": ""
            },
            "other_school_details": {
                "nationality": "",
                "media_consent_-_web": "",
                "place_of_birth": "",
                "bapt_cert_sighted": "",
                "marketing": "",
                "media_consent_status": "",
                "media_consent_notes": "",
                "notepad_s/n": "",
                "birth_cert._sighted": "",
                "immunisation_sighted": "",
                "medical_info": "",
                "split_family": "",
                "sacraments": "",
                "bus_route": "",
                "visa_number": "",
                "esl": "",
                "share_personal_info": "",
                "computer_pol/consent": ""
            }
        }

How do we retrieve the thumbnail data for each student?

leonseremelis-tass commented 1 year ago

Hello, thank you for your inquiry. In order to receive the thumbnail, please make sure to set both "includephoto" and "thumbnail" as true when calling the endpoint. We have recently updated the documentation to provide further clarification on this requirement.