1️Get scholarship data

Query

gs_get_scholarship

Header

Data field	Type	Note
authorization	String	service key to pass authentication
entity	String	service entity name

Header example

{
    "authorization": "oxalus_secret_Y68FurhtnvHp3IP0sRMzHQWY",
    "entity": "Oxalus"
}

Parameter

Data field	Type	Note
_id	String	Scholarship's ID
address	String	Guild/Scholar's address

Success 200

Data field	Type	Note
data	Object	Scholarships data.
_id	String	Scholarship id.
paragon	Object	Scholarship paragon.
tokenId	Number	Paragon token id.
image	Object	Paragon image.
name	Object	Paragon name.
guild	Object	Scholarship guild.
earns	String	Guild earn.
rate	Number	Guild rate.
address	String	Guild address.
scholar	Object	Scholarship scholar.
earns	String	Scholar earn.
rate	Number	Scholar rate.
address	String	Scholar address.
matches	Number	Scholarship total matches.
winRate	Number	Scholarship winRate.
createdAt	Number	Scholarship created date (timestamp, ms)
endedAt	Number	Scholarship ended date (timestamp, ms)
status	String	Scholarship status Accepted Value: "Active", "Closed"
game	String	Scholarship game title (currently Ascension).
winMatches	Number	Scholarship total win matches.
totalEarns	Number	Scholarship total earns.
resultCode	String	anything different than GS:000 is failed request.
resultMessage	String	description of error or success.

Success-Response: (data is the same as you get scholarships from guild, so this API may not be necessary )

{
    "data": {
        "gs_get_scholarships": {
            "resultCode": "GS:000",
            "resultMessage": "Success",
            "total": 35,
            "data": [
                {
                    "_id": "6299b4677d9e180013eca66a",
                    "paragon": {
                        "tokenId": 471,
                        "name": "X"
                    },
                    "guild": {
                        "earns": "0",
                        "rate": 50,
                        "address": "0x648C4273C681Ba2E668F29Ac00124005b10D09CD"
                    },
                    "scholar": {
                        "earns": "0",
                        "rate": 50,
                        "address": "0x591a1b985f982f7A66C1609CBe5a621a48c2B593"
                    },
                    "matches": 0,
                    "winRate": 0,
                    "createdAt": 1654240359638,
                    "endedAt": 1654240393431,
                    "status": "Closed",
                    "game": "Ascension",
                    "winMatches": 0
                }
            ]
        }
    }
}