Sample JSON Object
METHOD : POST
ENDPOINT : http://api.jupeb.edu.ng/api/CandidateInfo
ENDPOINT DEVELOPMENT SANDBOX : http://api.jupeb.edu.ng:8003/api/CandidateInfo
AUTHORIZATION HEADER : Your institution API Key
DATA BODY: Post JSON Object in the HTTP REQUEST BODY
SAMPLE:
{
"ExamYear": "2020",
"Candidates": [
{
"Profile" : { "FirstName": "Augusta",
"MiddleName": "Gbenga",
"LastName": "Bode",
"ProgramNumber": "T1B7/202190",
"DOB": "2010-01-01T00:00:00",
"Gender": "F",
"Mobile": "08171627837",
"Email": ""
},
"Subjects": [
{
"SubjectCode": "ECO"
},
{
"SubjectCode": "GOV"
},
{
"SubjectCode": "ACC"
}
],
"PassportImage": {
"file": "",
"caption": "2323",
"mime": "image/jpg"
},
"FingerPrint":{
"imagefile": "",
"minutae": "",
"templateFormat": "ANSI"
}
}
]
}
Sample Response Object
{
"response": the status code(200,300,400 or 500),
"items": [
{
"itemStatus": the status code(200,300,400 or 500),
"candidateID": "The Program number of a specific candidate on whose data was affected",
"message": "Returned message from server on a specific item"
}
],
"message": "Response summary, cand be empty"
}
Response Object
RESPONSE CODE :
REQUEST WAS SUCCESSFUL = 200,
REQUEST WAS EXECTED BUT SOME ITEMS FAILED AND OTHERS SUCCEDED = 300,
REQUEST WAS EXECUTED BUT HAS NOTIFICATIONS = 400,
REQUEST ENCOUNTERED AN ERROR = 500
ITEMS :
Contains the individual messages for each item.
It could be a 200,300,400 or 500 code as well as contains a descriptive message
MESSAGE :
This could be empty but contains a summary message of the response