[isams] Student data to Excel via API

[Griff13]

I am an absolute beginner to this process but have been tasked with setting up an API function for all student data from iSAMS to excel. I have managed to get this working for the basic student data, but when I try to include Pupil Register (SEND, MAGT) I keep getting an error message and it fails to laod. On the Batch API logs I get the following error message 'Method "PupilRegisters - GetGiftedAndTalentedRegister" requires at least one of the following filters: apiKey systemStatusesToInclude' .Has anyone managed to successfuly complete this task and offer any insight to where I am going wrong. Or if it is even possible. My messages to the support team have not been helpful at all.

[dhicks]

Method "PupilRegisters - GetGiftedAndTalentedRegister" requires at least one of the following filters: apiKey systemStatusesToInclude'

 

I sounds like the API is expecting a paramater named "systemStatusesToInclude", which it hasn't been passed. I have some Python code that does a call to the iSAMS API, simply passing the "apiKey" value, I think to pass another paramater the code might look something like:

 

print("STATUS: Getting data from iSAMS...", flush=True)
requestURL = "https://" + config["iSAMSAPIDomain"] + "/api/batch/1.0/xml.ashx?apiKey=" + config["iSAMSAPIKey"]
try:
response = urllib.request.urlopen(requestURL, context=ssl._create_unverified_context()), data=urllib.parse.urlencode({"systemStatusesToInclude":"SEND"}).encode())
except urllib.error.HTTPError as theHTTPError:
print("Error calling the iSAMS API.")