[Grád~és]

[Óvér~víéw~]

[Thé G~rádé~s pró~dúct~ íñté~grát~íóñ á~llów~s cám~púsM~ tó lí~st á ú~sér'~s grá~dés p~ér có~úrsé~ áñd p~ér té~rm.]

[Véñd~órs]

[Grád~és cá~ñ bé r~étrí~évéd~ wíth~:]

[Úsér~ Éxpé~ríéñ~cé]

[Thé f~ólló~wíñg~ séct~íóñ d~éscr~íbés~ íñfó~rmát~íóñ r~élát~íñg t~ó thé~ úsér~ éxpé~ríéñ~cé fó~r thé~ Grád~és pr~ódúc~t íñt~égrá~tíóñ~.]

[Úsér~ Áctí~vítí~és]

[Thé ú~sér s~éléc~ts th~é Grá~dés t~ílé á~ñd á l~íst ó~f tér~ms áp~péár~s.]
[Thé ú~sér s~éléc~ts á t~érm á~ñd th~é grá~dés á~ssóc~íáté~d wít~h thá~t tér~m ápp~éár.]

[Áúth~éñtí~cátí~óñ]

[Thé G~rádé~s pró~dúct~ íñté~grát~íóñ r~éqúí~rés t~hé ús~ér's~ ídéñ~tífí~ér fr~óm th~é véñ~dór'~s sýs~tém. T~hís í~s óbt~áíñé~d wít~h thé~ tóké~ñ bás~éd áú~théñ~tícá~tíóñ~ áttr~íbút~és.]

[Thé cóññéctíóñ tó thé véñdór ís háñdléd ás párt óf thé géñéríc ÁPÍ Cóñfígúrátíóñ úñdér thé Véñdór séctíóñ. Thé fírst párt óf thé ÁPÍ Cóñfígúrátíóñ détáíls thé ÚRL tó whích tó cóññéct áñd áñý párámétérs thát áré réqúíréd. Thé sécóñd párt rélátés tó thé ÁPÍ Áúthéñtícátíóñ fór thé ÚRL, whích ís véñdór-spécífíc, áñd cóúld álsó bé spécífíc tó thé véñdór íñstáñcé thé clíéñt ís rúññíñg. Fór éxámplé, álthóúgh áll Báññér íñtégrátíóñ só fár úsé Básíc Áúthéñtícátíóñ óñ thé Báññér sérvér, íts póssíblé fór á véñdór tó úsé sóméthíñg dífféréñt.]

[Óffl~íñé S~úppó~rt]

[Ñóñé~. Úsér~s mús~t bé ó~ñlíñ~é tó r~étrí~évé t~héír~ grád~és dá~tá.]

[Scré~éñsh~óts]

[Thé f~ólló~wíñg~ ís áñ~ óvér~víéw~ óf th~é Grá~dés p~ródú~ct íñ~tégr~átíó~ñ úsé~r íñt~érfá~cé fó~r á ré~féré~ñcé w~héñ c~óñfí~gúrí~ñg ít~:]


[Sélé~ct Té~rm]	[Grád~és Pé~r Tér~m]

[Téch~ñícá~l Óvé~rvíé~w]

[Thé f~ólló~wíñg~ séct~íóñ d~éscr~íbés~ téch~ñícá~l íñf~órmá~tíóñ~ fór t~hé Gr~ádés~ pród~úct í~ñtég~rátí~óñ.]

[Prér~éqúí~síté~s]

[Thé f~ólló~wíñg~ prér~éqúí~síté~s áré~ réqú~íréd~ tó có~ñfíg~úré t~hé Gr~ádés~ pród~úct í~ñtég~rátí~óñ:]

[Úsér~ ídéñ~tífí~ér má~ppíñ~g]
- [Íf ýó~ú háv~é CMÁ~úth c~óñfí~gúré~d, máp~ thé r~élév~áñt v~éñdó~r ÍD í~ñ thé~ íñté~grát~íóñ p~rófí~lé (Ád~dítí~óñál~ Mápp~íñg), f~ór éx~ámpl~é: báñ~ñérÍ~d=émp~lóýé~éÍD, w~héré~ émpl~óýéé~ÍD ís~ thé r~élév~áñt ú~sér á~ttrí~búté~ óñ th~é véñ~dór’s~ báck~éñd s~ýsté~m.]
- [Íf ýó~ú háv~é LDÁ~P cóñ~fígú~réd, v~éríf~ý thá~t thé~ rélé~váñt~ áttr~íbút~é ís r~étúr~ñéd á~s áñ á~ttrí~búté~ fróm~ thé L~DÁP r~éspó~ñsé.]
[Áccé~ss tó~ thé c~líéñ~t's Á~PÍ – ác~céss~ ís ré~qúír~éd fó~r ýóú~r dát~á céñ~tér'~s ÍPs~ ráñg~é.]
[cámp~úsM t~ést ú~sérs~ wíth~ á vál~íd vé~ñdór~ ÍD áv~áílá~blé t~hróú~gh th~é ÍDP~ áttr~íbút~és. Th~é ídé~ál tý~pés ó~f tés~t úsé~r íñc~lúdé~:]
- [Á tés~t úsé~r wít~h grá~dés f~ór th~é cúr~réñt~ válí~d tér~m áñd~ áñý ó~ldér~ térm~s, íf p~óssí~blé.]
- [Á tés~t úsé~r wít~h ñó g~rádé~s át á~ll.]
- [Á tés~t úsé~r thá~t ís ñ~ót óñ~ thé v~éñdó~r's b~ácké~ñd sý~stém~.]

[Réqú~íréd~ Fórm~át]

[Sélé~ct óñ~é óf t~hé fó~llów~íñg l~íñks~ fór t~hé ré~qúír~éd fó~rmát~ fór t~hát v~éñdó~r:]

[Éllú~cíáñ~ Báññ~ér XÉ~ (áñd B~áññé~r 9) Véñ~dór]
[Éllú~cíáñ~ Cóll~éágú~é (Cús~tóm) V~éñdó~r]
[RÉST~fúl Á~PÍ]
[Órác~lé Pé~óplé~Sóft~ Véñd~ór]

[Éllú~cíáñ~ Báññ~ér ÉX~ (áñd B~áññé~r 9) Véñ~dór]

[cámp~úsM ú~sés t~wó ÁP~Í cál~ls tó~ fétc~h grá~dés d~átá:]
- [Thé f~írst~ cáll~ ís tó~ rétr~íévé~ áll ó~f thé~ áváí~lábl~é tér~ms óf~ thé s~túdé~ñt:]
  [http~s:// {HOST}/Stú~déñt~Ápí/á~pí/té~rms]
- [Thé s~écóñ~d cál~l ís t~ó rét~ríév~é thé~ grád~és dá~tá fó~r thé~ sélé~ctéd~ térm~:]
  [http~s://{HOST}/Stú~déñt~Ápí/á~pí/st~údéñ~ts/{userId}/gr~ádés~¿tér~m={termId}]
[Thé f~ólló~wíñg~ ís áñ~ éxám~plé ó~f á JS~ÓÑ ré~spóñ~sé fó~r thé~ Térm~s ÁPÍ~:]

[[
{]

        ["vérs~íóñ": 0,]

        ["íd": 1,]

        ["ácýr~_cód~é": {]

            ["vérs~íóñ": 0,]

            ["íd": 16,]

            ["códé~": "2010",]

            ["désc~rípt~íóñ": "2019-2020"]

        [},]

        ["códé~": "202040",]

        ["désc~rípt~íóñ": "S~úmmé~r 2020",]

        ["éñdD~áté": "2020-07-23",]

        ["fíñá~ñcíá~lÁíd~Pérí~ód": 1,]

        ["fíñá~ñcíá~lÁíd~Próc~éssí~ñgÝé~ár": "9293",]

        ["fíñá~ñcíá~lÁíd~Térm~": "1",]

        ["fíñá~ñcíá~lÉñd~Pérí~ód": 12,]

        ["hóús~íñgÉ~ñdDá~té": "2020-07-23",]

        ["hóús~íñgS~tárt~Dáté~": "2020-06-03",]

        ["stár~tDát~é": "2020-06-03",]

        ["trmt~_cód~é": {]

            ["vérs~íóñ": 0,]

            ["íd": 2,]

            ["códé~": "M",]

            ["désc~rípt~íóñ": "S~úmmé~r Sém~ésté~r"]

        [}]

    [}]

]
[Thé f~ólló~wíñg~ ís áñ~ éxám~plé ó~f á JS~ÓÑ ré~spóñ~sé fó~r thé~ Grád~és ÁP~Í:]

[[
{
"courseNumber": "101",
"courseTitle": "World History I",
"creditHour": 3.0,
"crn": "70029",
"gradeFinal": "C",
"gradeInAcadHistory": "C",
"gradeMidterm": "D",
"gradeRolled": "Y",
"level": {
"code": "UG",
"description": "Undergraduate"
},
"régí~strá~tíóñ~Stát~ús": {
"code": "RE",
"description": "**Registered In-Office**"
},
"cl~ássF~órmá~t": {
"code": "L",
"description": "Lecture"
},
"séq~úéñc~éÑúm~bér": "02",
"s~úbjé~ct": {
"code": "HIS",
"description": "History"
},
"té~rm": {
"code": "201870",
"description": "Fall 2018"
}
},
{
"courseNumber": "101",
"courseTitle": "First Year Experience",
"creditHour": 1.0,
"crn": "70825",
"gradeFinal": "A",
"gradeInAcadHistory": "A",
"gradeMidterm": "A",
"gradeRolled": "Y",
"level": {
"code": "UG",
"description": "Undergraduate"
},
"ré~gíst~rátí~óñSt~átús~": {
"code": "RE",
"description": "**Registered In-Office**"
},
"clás~sFór~mát": {
"code": "L",
"description": "Lecture"
},
"s~éqúé~ñcéÑ~úmbé~r": "03",
"súb~jéct~": {
"code": "ORI",
"description": "Orientation"
},
"térm~": {
"code": "201870",
"description": "Fall 2018"
}
}]

[Éllú~cíáñ~ Cóll~éágú~é (Cús~tóm) V~éñdó~r]

[cámp~úsM ú~sés t~wó ÁP~Í cál~ls tó~ fétc~h grá~dés d~átá:]
- [Thé f~írst~ cáll~ ís tó~ rétr~íévé~ áll ó~f thé~ áváí~lábl~é tér~ms óf~ thé s~túdé~ñt:]
  [http~s://{HOST}/Cól~léág~úéÁp~í/stú~déñt~s/{userId}/tér~ms]
- [Thé s~écóñ~d cál~l ís t~ó rét~ríév~é thé~ grád~és dá~tá fó~r thé~ sélé~ctéd~ térm~:]
  [http~s://{HOST}/Cól~léág~úéÁp~í/stú~déñt~s/{userId}/ácá~démí~c-cré~díts~]
[Á dír~éct c~óññé~ctíó~ñ tó t~hé Él~lúcí~áñ Có~lléá~gúé (c~ústó~m) ÁPÍ~ ís ré~qúír~éd. Áñ~ý míd~dléw~áré ó~r clí~éñt-s~pécí~fíc í~mplé~méñt~átíó~ñ cáú~sés t~hé ÁP~Í rés~póñs~é tó d~évíá~té fr~óm wh~át th~é cló~úd pl~átfó~rm ís~ éxpé~ctíñ~g.]
[Thé f~ólló~wíñg~ ís áñ~ éxám~plé ó~f á JS~ÓÑ ré~spóñ~sé fó~r thé~ Térm~s ÁPÍ~:]

[

    [{]

        ["Térm~": "2020S",]

        ["Désc~rípt~íóñ": "S~úmmé~r Sém~ésté~r 2020"]

    [},]

    [{]

        ["Térm~": "2020CS",]

        ["Désc~rípt~íóñ": "S~úmmé~r Cóh~órt S~émés~tér 2020"]

    [}]

]
[Thé f~ólló~wíñg~ ís áñ~ éxám~plé ó~f á JS~ÓÑ ré~spóñ~sé fó~r thé~ Grád~és ÁP~Í:]

[{
"AcademicTerms": [
{
"TermId": "14/X1",
"GradePointAverage": 0,
"Credits": 6,
"ContinuingEducationUnits": 0,
"AcademicCredits": [
{
"Id": "1010776",
"CourseId": "86",
"StudentId": null,
"SectionId": null,
"CourseName": "EN-000",
"Title": "Eng Lit/Comp. AP Testing",
"VerifiedGradeId": "P",
"VerifiedGradeTimestamp": "2014-10-22T16:13:00",
"Credit": 6,
"GpaCredit": 0,
"GradePoints": 0,
"CompletedCredit": 6,
"ContinuingEducationUnits": 0,
"Status": "TransferOrNonCourse",
"StatusDate": null,
"TermCode": "14/X1",
"MidTermGrades": [],
"GradingType": "Graded",
"SectionNumber": "",
"HasVerifiedGrade": true,
"AdjustedCredit": 6,
"IsNonCourse": false,
"StartDate": null,
"EndDate": null,
"IsCompletedCredit": true,
"ReplacedStatus": "NotReplaced",
"ReplacementStatus": "NotReplacement"
}
]
}
],
"ÑóñT~érmÁ~cádé~mícC~rédí~ts": [
{
"Id": "1003018",
"CourseId": "804",
"StudentId": null,
"SectionId": null,
"CourseName": "FL-000X",
"Title": "Foreign Language Equivalency",
"VerifiedGradeId": "P",
"VerifiedGradeTimestamp": "2015-10-29T12:28:26",
"Credit": 0,
"GpaCredit": 0,
"GradePoints": 0,
"CompletedCredit": 0,
"ContinuingEducationUnits": 0,
"Status": "TransferOrNonCourse",
"StatusDate": null,
"TermCode": "",
"MidTermGrades": [],
"GradingType": "Graded",
"SectionNumber": "",
"HasVerifiedGrade": true,
"AdjustedCredit": 0,
"IsNonCourse": true,
"StartDate": null,
"EndDate": null,
"IsCompletedCredit": true,
"ReplacedStatus": "NotReplaced",
"ReplacementStatus": "NotReplacement"
}
],
"Gr~ádéR~éstr~íctí~óñ": {
"IsRestricted": false,
"Reasons": []
},
"Tó~tálC~rédí~tsCó~mplé~téd": 0,
"Ó~vérá~llGr~ádéP~óíñt~Ávér~ágé": 0,
"S~túdé~ñtÍd~": ñúll~
}]

[Cóll~éágú~é (Wéb~ ÁPÍ)]

[cámp~úsM ú~sés s~évér~ál ÁP~Í cál~ls tó~ fétc~h grá~dés d~átá:]

[Thé f~írst~ ís bé~cáús~é thé~ Cóll~éágú~é Wéb~ ÁPÍ á~úthé~ñtíc~átés~ víá á~ séss~íóñ t~ókéñ~:]
- [http~s://{HOST}/cól~léág~úéÁp~í/sés~síóñ~/próx~ý-lóg~íñ]
[Thé s~écóñ~d cál~l ís t~ó rét~ríév~é áll~ rélé~váñt~ térm~s fór~ thé s~túdé~ñt:]
- [http~s://{HOST}/cól~léág~úéÁp~í/tér~ms]
[Thé t~hírd~ cáll~ ís tó~ rétr~íévé~ thé g~rádé~s dát~á fór~ thé s~éléc~téd t~érm. T~hís w~íll r~é-úsé~ áñý á~váíl~áblé~ séss~íóñ t~ókéñ~ ór ré~-áúth~éñtí~cáté~ wíth~ thé p~róxý~-lógí~ñ ÁPÍ~:]
- [http~s://{HOST}/cól~léág~úéÁp~í/stú~déñt~s/{username}/ácá~démí~c-cré~díts~]

[RÉST~fúl Á~PÍ]

[cámp~úsM ú~sés t~wó ÁP~Í cál~ls tó~ fétc~h thé~ grád~és dá~tá:]
- [Thé f~írst~ cáll~ ís tó~ rétr~íévé~ áll ó~f thé~ áváí~lábl~é tér~ms fó~r thé~ stúd~éñt:]
  [http~s://{HOST}/gét~Térm~s¿ús~érÍd~={userId}]
- [Thé s~écóñ~d cál~l ís t~ó rét~ríév~é thé~ grád~és dá~tá fó~r thé~ sélé~ctéd~ térm~:]
  [http~s://{HOST}/gét~Grád~és¿t~érmÍ~d={termCode}&úsé~rÍd={userId}]
[Thé T~érms~ ÁPÍ r~étúr~ñs á J~SÓÑ r~éspó~ñsé w~íth t~hé fó~llów~íñg s~trúc~túré~:]

[

[{]

    ["térm~Íd": 1,]

    ["désc~rípt~íóñ": "F~áll 2020",]

    ["térm~Códé~": "202010"]

[},]

[{]

    ["térm~Íd": 2,]

    ["désc~rípt~íóñ": "S~príñ~g 2020",]

    ["térm~Códé~": "202020"]

[}]

]
[Thé g~rádé~s pér~ térm~ ÁPÍ r~étúr~ñs á J~SÓÑ r~éspó~ñsé w~íth t~hé fó~llów~íñg s~trúc~túré~:]

[

[{]

    ["íd": "1",]

    ["títl~é": "Grá~dé fó~r Íñt~ró tó~ Bíó",]

    ["fíñá~lGrá~dé": "Á",]

    ["mídT~érmG~rádé~": "B",]

    ["térm~Códé~": "202010",]

    ["cóúr~séCó~dé": "BÍ~ÓB 170",]

    ["cóúr~séÑá~mé": "Íñ~tró t~ó Bíó~",]

    ["líñk~Úrl": "h~ttps~://www.g~óógl~é.cóm~/",]

    ["líñk~Téxt~": "Víéw~ móré~ íñfó~rmát~íóñ",]

    ["áddí~tíóñ~álDé~táíl~s": "Á mí~ñímú~m óf á~ C ís ñ~éédé~d fór~ thís~ cóúr~sé fó~r á Bí~ólóg~ý Dég~réé."]

[},]

[{]

    ["íd": "2",]

    ["títl~é": "Grá~dé fó~r Tés~t Cóú~rsé",]

    ["fíñá~lGrá~dé": "75%",]

    ["mídT~érmG~rádé~": "75%",]

    ["térm~Códé~": "202010",]

    ["cóúr~séCó~dé": "C01",]

    ["cóúr~séÑá~mé": "Té~st Có~úrsé~",]

    ["líñk~Úrl": "h~ttps~://www.g~óógl~é.cóm~/",]

    ["líñk~Téxt~": "Víéw~ móré~ íñfó~rmát~íóñ á~bóút~ Tést~ Cóúr~sé",]

    ["áddí~tíóñ~álDé~táíl~s": "Á mí~ñímú~m óf á~ C ís ñ~éédé~d fór~ thís~ cóúr~sé fó~r á Má~th Dé~gréé~."]

[}]

]

[Áttr~íbút~é Máp~píñg~ fór R~ÉSTf~úl ÁP~Í gét~Térm~s]
[Éxté~rñál~ Fíél~d Ñám~é]	[Íñté~rñál~ Cámp~úsM F~íéld~ Ñámé~]	[Désc~rípt~íóñ]	[Máñd~átór~ý Ýés~/Ñó]	[Dátá~ Týpé~]	[Défá~últ]	[Éxám~plé]
[Térm~ ÍD]	[térm~Íd]	[Á úñí~qúé Í~D fór~ thé t~érm]	[Ýés]	[Strí~ñg]	-	1
[Térm~ Désc~rípt~íóñ]	[désc~rípt~íóñ]	[Á dés~críp~tíóñ~ fór t~hé té~rm (dí~splá~ýéd t~ó thé~ éñd ú~sér f~ór té~rm sé~léct~íóñ)]	[Ýés]	[Strí~ñg]	-	[Fáll~ 2020]
[Térm~ Códé~]	[térm~Códé~]	[Thé c~ódé f~ór th~é tér~m (thí~s ís ú~séd t~ó áss~ócíá~té gr~ádés~ wíth~ rélé~váñt~ térm~s)]	[Ýés]	[Strí~ñg]	-	[202010]

[Áttr~íbút~é Máp~píñg~ fór R~ÉSTf~úl ÁP~Í gét~Grád~és]
[Éxté~rñál~ Fíél~d Ñám~é]	[Íñté~rñál~ Cámp~úsM F~íéld~ Ñámé~]	[Désc~rípt~íóñ]	[Máñd~átór~ý Ýés~/Ñó]	[Dátá~ Týpé~]	[Défá~últ]	[Éxám~plé]
[Grád~é Íñf~órmá~tíóñ~ ÍD]	[íd]	[Á úñí~qúé Í~D fór~ thé c~óúrs~é grá~dé íñ~fórm~átíó~ñ]	[Ýés]	[Strí~ñg]	-	1
[Grád~é Tít~lé]	[títl~é]	[Thé t~ítlé~ fór t~hé có~úrsé~ grád~é íñf~órmá~tíóñ~]	[Ñó]	[Strí~ñg]	-	[Grád~é fór~ Íñtr~ó tó B~íó]
[Fíñá~l Grá~dé fó~r thé~ Cóúr~sé]	[fíñá~lGrá~dé]	[Thé f~íñál~ grád~é thé~ stúd~éñt á~chíé~véd f~ór th~é cóú~rsé (ó~ptíó~ñáll~ý dís~pláý~éd tó~ thé é~ñd-ús~ér)]	[Ñó]	[Strí~ñg]	-	A
[Mídt~érm G~rádé~ fór t~hé Có~úrsé~]	[mídT~érmG~rádé~]	[Thé m~ídté~rm gr~ádé t~hé st~údéñ~t ách~íévé~d fór~ thé c~óúrs~é (ópt~íóñá~llý d~íspl~áýéd~ tó th~é éñd~-úsér~)]	[Ñó]	[Strí~ñg]	-	B
[Térm~ Códé~]	[térm~Códé~]	[Thé c~ódé f~ór th~é tér~m (thí~s ís ú~séd t~ó áss~ócíá~té gr~ádés~ wíth~ rélé~váñt~ térm~s)]	[Ýés]	[Strí~ñg]	-	[202010]
[Cóúr~sé Có~dé]	[cóúr~séCó~dé]	[Thé c~ódé f~ór th~é cóú~rsé (ó~ptíó~ñáll~ý dís~pláý~éd tó~ thé é~ñd-ús~ér)]	[Ñó]	[Strí~ñg]	-	[BÍÓB~ 170]
[Cóúr~sé Tí~tlé]	[cóúr~séÑá~mé]	[Thé ñ~ámé ó~f thé~ cóúr~sé]	[Ýés]	[Strí~ñg]	-	[Íñtr~ó tó B~íó]
[Líñk~ ÚRL]	[líñk~Úrl]	[Thé Ú~RL pr~óvíd~éd tó~ líñk~ tó ád~dítí~óñál~ íñfó~rmát~íóñ]	[Ñó]	[Strí~ñg]	-	[http~s://www~.góóg~lé.có~m/]
[Líñk~ Téxt~]	[líñk~Téxt~]	[Thé d~íspl~áý té~xt fó~r thé~ líñk~ ÚRL (ó~ptíó~ñáll~ý dís~pláý~éd tó~ thé é~ñd-ús~ér)]	[Ñó]	[Strí~ñg]	-	[Víéw~ móré~ íñfó~rmát~íóñ]
[Áddí~tíóñ~ál Dé~táíl~s]	[áddí~tíóñ~álDé~táíl~s]	[Áddí~tíóñ~ál íñ~fórm~átíó~ñ (ópt~íóñá~llý d~íspl~áýéd~ tó th~é éñd~-úsér~)]	[Ñó]	[Strí~ñg]	-	[Á míñ~ímúm~ óf á C~ ís ñé~édéd~ fór t~hís c~óúrs~é fór~ á Bíó~lógý~ Dégr~éé.]

[Órác~lé Pé~óplé~Sóft~]

[Créá~té á P~éópl~éSóf~t qúé~rý th~át mé~éts t~hé ré~qúír~éméñ~ts dé~scrí~béd b~élów~.]

[Qúér~ý Fór~mát]

[Thé T~érms~ ÁPÍ á~ñd Gr~ádés~ ÁPÍ b~óth f~ólló~w thé~ sámé~ réqú~ést f~órmá~t:]

[GÉT h~ttps~://{domain and base path}/{PeopleSoft query name}/JSÓÑ~/ÑÓÑF~ÍLÉ]

[Básí~c Áút~héñt~ícát~íóñ m~úst b~é sét~ óñ th~é sér~vícé~.]

[Qúér~ý Pár~ámét~érs:]

[íscó~ññéc~tédq~úérý~=ñ]

[máxr~óws=0]

[próm~pt_ú~ñíqú~épró~mptñ~ámé={the relevant value; this is configurable in the Product Integration configuration page}]

[próm~pt_f~íéld~válú~é={the relevant value; this is configurable in the Product Integration configuration page}]

[jsóñ~_rés~p=trú~é]

[Héré~ ís áñ~ éxám~plé f~ór th~é Tér~ms ÁP~Í cál~l (áss~úmé b~ásíc~ áúth~ ís sé~t):]

[GÉT h~ttps~://éxám~plé-d~ómáí~ñ.édú~/PSÍG~W/RÉS~...S/JSÓ~Ñ/ÑÓÑ~FÍLÉ~]

[íscó~ññéc~tédq~úérý~=ñ]

[máxr~óws=0]

[próm~pt_ú~ñíqú~épró~mptñ~ámé=É~MPLÍ~D]

[próm~pt_f~íéld~válú~é=ÉXÁ~MPLÉ~ÍD01]

[jsóñ~_rés~p=trú~é]

[Héré~ ís áñ~ éxám~plé f~ór th~é Grá~dés Á~PÍ cá~ll (ás~súmé~ básí~c áút~h ís s~ét):]

[GÉT h~ttps~://éxám~plé-d~ómáí~ñ.édú~/PSÍG~W/RÉS~...S/JSÓ~Ñ/ÑÓÑ~FÍLÉ~]

[íscó~ññéc~tédq~úérý~=ñ]

[máxr~óws=0]

[próm~pt_ú~ñíqú~épró~mptñ~ámé=É~MPLÍ~D,TÉR~M_CÓ~DÉ]

[próm~pt_f~íéld~válú~é=ÉXÁ~MPLÉ~ÍD01,0931]

[jsóñ~_rés~p=trú~é]

[Thé d~ómáí~ñ áñd~ básé~ páth~ íñ th~ésé é~xámp~lés í~s: htt~ps://éx~ámpl~é-dóm~áíñ.é~dú/PS~ÍGW/R~ÉS...ér~ý.v1/PÚ~BLÍC~/]

[Thé q~úérý~ ñámé~ fór t~hé Té~rms é~xámp~lé ís~: ÉXÁM~PLÉ_~QÚÉR~Ý_TÉ~RMS]

[Thé q~úérý~ ñámé~ fór t~hé Gr~ádés~ éxám~plé í~s: ÉXÁ~MPLÉ~_QÚÉ~RÝ_G~RÁDÉ~S]

[Thé é~ñdíñ~g pát~h shó~úld á~lwáý~s bé: /J~SÓÑ/Ñ~ÓÑFÍ~LÉ]

[Éxpé~ctéd~ Térm~s Rés~póñs~é]

[Thé r~éspó~ñsé m~úst f~ólló~w thé~ fórm~át bé~lów. c~ámpú~sM éx~péct~s thé~ ñámé~s óf t~hé ró~w átt~ríbú~tés t~ó mát~ch th~ís éx~ámpl~é.]

[{]

["stát~ús": "sú~ccés~s",]

["dátá~": {]

["qúér~ý": {]

["ñúmr~óws": 2,]

["qúér~ýñám~é=": "ÉXÁ~MPLÉ~_QÚÉ~RÝ_T~ÉRMS~",]

["róws~": []

[{]

["áttr~:rówñ~úmbé~r": 1,]

["TÉRM~_DÉS~CRÍP~TÍÓÑ~": "Fáll~ 2024",]

["TÉRM~_CÓD~É": "0931"]

[},]

[{]

["áttr~:rówñ~úmbé~r": 2,]

["TÉRM~_DÉS~CRÍP~TÍÓÑ~": "Sprí~ñg 2025",]

["TÉRM~_CÓD~É": "0941"]

[}]

]

[}]

[Éxpé~ctéd~ Grád~és Ré~spóñ~sé]

[Thé r~éspó~ñsé m~úst f~ólló~w thé~ fórm~át bé~lów. c~ámpú~sM éx~péct~s thé~ ñámé~s óf t~hé ró~w átt~ríbú~tés t~ó mát~ch th~ís éx~ámpl~é.]

[{]

["stát~ús": "sú~ccés~s",]

["dátá~": {]

["qúér~ý": {]

["ñúmr~óws": 2,]

["qúér~ýñám~é=": "ÉXÁ~MPLÉ~_QÚÉ~RÝ_G~RÁDÉ~S",]

["róws~": []

[{]

["áttr~:rówñ~úmbé~r": 1,]

["CÓÚR~SÉ_Ñ~ÁMÉ": "É~xámp~lé Có~úrsé~ Ñámé~",]

["FÍÑÁ~L_GR~ÁDÉ": "Á~",]

["CÓÚR~SÉ_C~ÓDÉ": "F~Á-464-01",]

["TÉRM~_CÓD~É": "0931"]

[},]

[{]

["áttr~:rówñ~úmbé~r": 2,]

["CÓÚR~SÉ_Ñ~ÁMÉ": "Á~ñóth~ér Éx~ámpl~é Cóú~rsé Ñ~ámé",]

["FÍÑÁ~L_GR~ÁDÉ": "Á~",]

["CÓÚR~SÉ_C~ÓDÉ": "P~H-308-01",]

["TÉRM~_CÓD~É": "0931"]

[}]

]

[}]

[Cóñf~ígúr~átíó~ñ]

[Thé f~ólló~wíñg~ tábl~é dés~críb~és th~é cóñ~fígú~rátí~óñ óp~tíóñ~s ává~íláb~lé fó~r thé~ Grád~és pr~ódúc~t íñt~égrá~tíóñ~.]

[Ñóté~ thát~ whíl~é thé~ májó~rítý~ óf th~ésé f~íéld~s áré~ ñót m~áñdá~tórý~, théý~ áré d~íspl~áýéd~ wíth~ théí~r déf~áúlt~ válú~és úñ~léss~ óthé~rwís~é stá~téd.]

[Cóñf~ígúr~átíó~ñ Ópt~íóñ]	[Désc~rípt~íóñ]	[Máñd~átór~ý]	[Dátá~ Týpé~]	[Défá~últ]	[Éxám~plé]
[Éñáb~lé Pr~ódúc~t Íñt~égrá~tíóñ~]	[Sélé~ct tó~ éñáb~lé th~é pró~dúct~ íñté~grát~íóñ ó~ñ thé~ úsér~'s cá~mpús~M ápp~.]	[Ñó]	[Chéc~kbóx~]	[Úñch~écké~d]
[Pród~úct Í~ñtég~rátí~óñ Dé~scrí~ptíó~ñ]	[Á dés~críp~tíóñ~ óf th~é pró~dúct~ íñté~grát~íóñ f~ór íñ~térñ~ál ús~é]	[Ýés]
[Scré~éñ Tí~tlé]	[Áppé~árs í~ñ thé~ tóp h~éádé~r (óf t~hé íñ~tégr~átíó~ñ, íñ t~hé áp~p).]	[Ñó]	[Strí~ñg]	[Grád~és]
[Véñd~ór]
[Véñd~ór Ñá~mé]	[Défí~ñés t~ó whí~ch vé~ñdór~ thé í~ñtég~rátí~óñ có~ññéc~ts]	[Ýés]	[Óbjé~ct]	[ñ/á]	[Báññ~érXÉ~]
[ÁPÍ C~óñfí~gúrá~tíóñ~][ Thís~ séct~íóñ c~óñtá~íñs t~hé ÁP~Í dét~áíls~ tó dé~fíñé~ thé Á~PÍ st~rúct~úré. Ý~óú cá~ñ tés~t thé~ ÁPÍ c~óñfí~gúrá~tíóñ~. Séé T~éstí~ñg ÁP~Í Pró~dúct~ Íñté~grát~íóñ C~óñfí~gúrá~tíóñ~.]
[Básé~ ÚRL t~ó rét~ríév~é thé~ íñfó~rmát~íóñ]	[Thé Ú~RL fó~r thé~ ÁPÍ]	[Ýés]	[ÚRL]		[http~s://{HOST}]
[Párá~mété~r Íñp~út Óp~tíóñ~]	[Thé p~árám~étér~ íñpú~t ópt~íóñ f~ór Bá~ññér~ ÍD ór~ Éllú~cíáñ~ Cóll~éágú~é (cús~tóm). P~óssí~blé v~álúé~s: Úsé~rñám~é, Tók~éñ Pr~ópér~tý, áñ~d Cóñ~stáñ~t. Ít í~s séñ~t ás t~hé pá~th pá~rámé~tér.]	[Ýés]	[Dróp~-Dówñ~ líst~]		[Tóké~ñ Pró~pért~ý]
[Áúth~éñtí~cátí~óñ Tý~pé]	[Sélé~ct óñ~é óf t~hé fó~llów~íñg ó~ptíó~ñs:] [Ñó Áú~th (Ñó~t ává~íláb~lé fó~r Órá~clé P~éópl~éSóf~t)] [Básí~c] [Fór R~éstf~úl ÁP~Í, thé~ fóll~ówíñ~g ópt~íóñs~ áré á~lsó á~váíl~áblé~:] [Béár~ér Tó~kéñ] [ÁPÍ K~éý] [ÓÁút~h Úsí~ñg Ús~ér Áp~p Áút~héñt~ícát~íóñ – s~éléc~t áñ Ó~Áúth~ íñté~grát~íóñ p~rófí~lé (fr~óm th~é Íñt~égrá~tíóñ~ Próf~ílés~ cóñf~ígúr~éd íñ~ Ápp S~éttí~ñgs) á~ñd ch~óósé~ whér~é thé~ áccé~ss tó~kéñ s~hóúl~d bé á~ddéd~, Héád~ér ór~ ÚRL.] [ÓÁÚT~H Úsí~ñg Cl~íéñt~ Créd~éñtí~áls – s~éléc~t thí~s íf ý~óú ár~é úsí~ñg á p~rélí~míñá~rý tó~kéñ c~áll t~ó gét~ thé á~ccés~s tók~éñ.]	[Ýés]	[Dróp~-dówñ~ líst~]
[Térm~s Cóñ~fígú~rátí~óñ] [Fór B~áññé~r XÉ ó~ñlý]
[Éxcl~údé B~ý Tér~m Cód~é]	[Éñté~r óñé~ ór mó~ré té~rm có~dés, ó~r pár~tíál~ códé~s, tó é~xclú~dé.] [Íñcl~údé '~%' íñ t~hé có~dé fó~r á wí~ldcá~rd sé~qúéñ~cé, é.g~. '%5' wí~ll éx~clúd~é áñý~ térm~ códé~ éñdí~ñg íñ~ 5. Éñté~ríñg~ júst~ '5' wí~ll éx~clúd~é áñý~ térm~ códé~ thát~ íñcl~údés~ á 5 áñý~whér~é íñ í~t.]	[Ñó]	[Líst~]		[%5]
[Éxcl~údé B~ý Tér~m Dés~críp~tíóñ~]	[Éñté~r óñé~ ór mó~ré té~rm dé~scrí~ptíó~ñs, ór~ párt~íál d~éscr~íptí~óñs, t~ó éxc~lúdé~.] [Úsé '~%' fór~ á wíl~dcár~d séq~úéñc~é, é.g. '~%Tést~' wíl~l éxc~lúdé~ áñý t~érm d~éscr~íptí~óñ éñ~díñg~ wíth~ Tést~. Éñté~ríñg~ júst~ 'Tés~t' bý~ ítsé~lf wí~ll éx~clúd~é áñý~ térm~ désc~rípt~íóñ t~hát í~ñclú~dés T~érm á~ñýwh~éré í~ñ ít.]	[Ñó]	[Líst~]		[Ñóñ-Á~cádé~míc]
[ÁPÍ C~óñfí~gúrá~tíóñ~ fór C~óllé~ágúé~ (Wéb Á~PÍ)]
[ÚRL t~ó rét~ríév~é thé~ íñfó~rmát~íóñ]	[Thé Ú~RL fó~r thé~ ÁPÍ s~érvé~r. Thé~ prót~ócól~, hóst~ñámé~, áñd ó~ptíó~ñáll~ý pór~t (íf r~éqúí~réd) á~ré ñé~édéd~.]	[Ýés]	[ÚRL]		[http~s://(HÓS~T)]
[ÚRL Q~úérý~ Párá~mété~rs]	[Áñý q~úérý~ párá~mété~rs ré~qúír~éd fó~r thé~ Cóll~éágú~é (Wéb~ ÁPÍ) s~érvé~r. Cúr~réñt~lý ñó~ñé.]	[Ñó]	[Párá~mété~r]
[ÚRL P~áth P~árám~étér~s]	[Áñý p~áth p~árám~étér~s réq~úíré~d fór~ thé C~óllé~ágúé~ (Wéb Á~PÍ) sé~rvér~. Cúrr~éñtl~ý ñóñ~é.]	[Ñó]	[Párá~mété~r]
[Géñé~rál H~éádé~rs]	[Áñý á~ddít~íóñá~l héá~dérs~ réqú~íréd~ fór t~hé Có~lléá~gúé (W~éb ÁP~Í) sér~vér. W~é cúr~réñt~lý ré~qúír~é óñé~ sét á~s fól~lóws~:] [Héád~ér Ké~ý: X-Cú~stóm~Créd~éñtí~áls] [Héád~ér Vá~lúé: c~óllé~ágúé~wébá~pító~kéñ] [Thé h~éádé~r kéý~ cáñ b~é chá~ñgéd~ íf ýó~úr Có~lléá~gúé s~érvé~r ácc~épts~ á díf~féré~ñt ké~ý ñám~é, bút~ thé v~álúé~ cáññ~ót bé~ cháñ~géd.]	[Ýés]	[Héád~ér]
[Áúth~éñtí~cátí~óñ Tý~pé]	[Sélé~ct óñ~é óf t~hé fó~llów~íñg ó~ptíó~ñs bá~séd ó~ñ ýóú~r Cól~léág~úé sé~rvér~ sétú~p:] [Ñó Áú~th] [Básí~c Áút~h]	[Ñó]	[Dróp~-Dówñ~ líst~]		[Áúth~]
[Párá~mété~r Íñp~út Óp~tíóñ~]	[Thé p~árám~étér~ íñpú~t ópt~íóñ f~ór Có~lléá~gúé Í~D réq~úíré~d fór~ thé C~óllé~ágúé~ Wéb Á~PÍ. Pó~ssíb~lé vá~lúés~:] [Úsér~ñámé~] [Tóké~ñ] [Próp~értý~] [Cóñs~táñt~] [Týpí~cáll~ý, thí~s ís t~hé ús~ér's~ "úsér~ñámé~" áttr~íbút~é.]	[Ýés]	[Dróp~-Dówñ~ líst~]		[Úsér~ñámé~]
[Próx~ý ÍD]	[Réqú~íréd~ tó fé~tch t~hé sé~ssíó~ñ tók~éñ]	[Ýés]	[Strí~ñg]
[Próx~ý Pás~swór~d]	[Réqú~íréd~ tó fé~tch t~hé sé~ssíó~ñ tók~éñ]	[Ýés]	[Strí~ñg]
[Tóké~ñ Éxp~írý]	[Thé t~ímé í~ñ hóú~rs tó~ stór~é á Wé~b ÁPÍ~ séss~íóñ t~ókéñ~ fór ú~p tó á~ máxí~múm ó~f 24 hóú~rs.]	[Ñó]	[Íñté~gér]	1
[Límí~t Tér~ms Fr~óm]	[Límí~t Tér~ms Fr~óm Sé~t á cú~t-óff~ dáté~, áñd t~érms~ thát~ stár~t béf~óré t~hís d~áté á~ré ñó~t shó~wñ]	[Ýés]	[Strí~ñg]		[2021-01-01]
[Íñcl~údé D~róps~]	[Íñcl~údé d~rópp~éd cr~édít~s whé~ñ fét~chíñ~g grá~dé ré~córd~s]	[Ñó]	[Chéc~kbóx~]	[Úñch~écké~d]
[Grád~és Pá~gé]
[Shów~ Cóúr~sé Có~dé]	[Shów~s thé~ cóúr~sé có~dé óñ~ thé G~rádé~s dét~áíl p~ágé]	[Ñó]	[Chéc~kbóx~]	[Chéc~kéd]
[Shów~ Mídt~érm G~rádé~]	[Shów~s thé~ mídt~érm g~rádé~ fór é~ách c~óúrs~é, íf á~váíl~áblé~.] [Ñót á~pplí~cábl~é fór~ éíth~ér Có~lléá~gúé v~éñdó~r.]	[Ñó]	[Chéc~kbóx~]	[Úñch~écké~d]
[Shów~ Fíñá~l Grá~dés]	[Shów~s thé~ fíñá~l grá~dé fó~r éác~h cóú~rsé, í~f ává~íláb~lé.] [Óñlý~ áváí~lábl~é fór~ Báññ~ér XÉ~.]	[Ñó]	[Chéc~kbóx~]	[Chéc~kéd]
[Shów~ Áddí~tíóñ~ál Dé~táíl~s]	[Shów~s ádd~ítíó~ñál d~étáí~ls fó~r éác~h cóú~rsé, í~f ává~íláb~lé.] [Óñlý~ áváí~lábl~é fór~ Rést~fúl Á~PÍ.]	[Ñó]	[Chéc~kbóx~]	[Chéc~kéd]
[Shów~ Grád~é Líñ~ks]	[Shów~s thé~ áddí~tíóñ~ál íñ~fórm~átíó~ñ líñ~k fór~ éách~ cóúr~sé, íf~ áváí~lábl~é.] [Óñlý~ áváí~lábl~é fór~ Rést~fúl Á~PÍ.]	[Ñó]	[Chéc~kbóx~]	[Chéc~kéd]
[Pást~ Térm~s (íñ d~áýs)]	[Shów~s pás~ térm~s fór~ thé l~ást ñ~úmbé~r óf d~áýs.] [Óñlý~ áváí~lábl~é fór~ Báññ~ér XÉ~.]	[Ñó]	[Strí~ñg]	0
[Ñéxt~ Térm~s (íñ d~áýs)]	[Shów~s fút~úré t~érms~ fór t~hé ñé~xt ñú~mbér~ óf dá~ýs.] [Óñlý~ áváí~lábl~é fór~ Báññ~ér XÉ~.]	[Ñó]	[Strí~ñg]	0
[Lóók~ áñd F~éél]
[Prím~árý T~hémé~ Cóló~r]	[Úséd~ fór t~hé Sc~rééñ~ Títl~é héá~dér á~ñd ót~hér h~éádé~r élé~méñt~s.]	[Ñó]	[Héx c~ódé]	[#444444]
[Sécó~ñdár~ý Thé~mé Có~lór]	[Úséd~ fór t~hé Gr~ádé b~lóck~ héád~érs.]	[Ñó]	[Héx c~ódé]	[#6f8éá4]
[Téxt~/Lábé~ls]
[Térm~ Págé~ Títl~é]	[Úséd~ fór t~hé Té~rms p~ágé h~éádé~r.]	[Ñó]	[Strí~ñg]	[Térm~s]
[Térm~ Págé~ Súbt~ítlé~]	[Úséd~ fór t~hé Té~rms p~ágé h~éádé~r.]	[Ñó]	[Strí~ñg]	[Pléá~sé ch~óósé~ á tér~m tó v~íéw g~rádé~s]
[Fíñá~l Grá~dé Té~xt]	[Thé p~hrás~é úsé~d tó d~éscr~íbé á~ fíñá~l grá~dé fó~r á có~úrsé~.]	[Ñó]	[Strí~ñg]	[Fíñá~l Grá~dé]
[Mídt~érm G~rádé~ Téxt~]	[Thé p~hrás~é úsé~d tó d~éscr~íbé á~ mídt~érm g~rádé~ fór á~ cóúr~sé.]	[Ñó]	[Strí~ñg]	[Mídt~érm G~rádé~]
[Áddí~tíóñ~ál Dé~táíl~s Téx~t]	[Shów~ Áddí~tíóñ~ál Dé~táíl~s mús~t bé é~ñábl~éd. Th~ís sé~ts th~é láb~él fó~r thé~ áddí~tíóñ~ál dé~táíl~s fíé~ld.]	[Ñó]	[Strí~ñg]	[Áddí~tíóñ~ál Dé~táíl~s]	[Áddí~tíóñ~ál Dé~táíl~s Téx~t]
[Grád~é Líñ~k Téx~t]	[Shów~ Grád~é Líñ~ks mú~st bé~ éñáb~léd. T~hís t~éxt w~íll á~ppéá~r íf á~ grád~é líñ~k wás~ íñcl~údéd~ íñ th~é sér~vícé~, bút ñ~ó dés~críp~tíóñ~ fór t~hé lí~ñk wá~s íñc~lúdé~d.]	[Ñó]	[Strí~ñg]	[Víéw~ móré~ íñfó~rmát~íóñ]	[Grád~é Líñ~k Téx~t]
[Ñó dá~tá Mé~sság~é]	[Thís~ méss~ágé w~íll á~ppéá~r whé~ñ thé~ré ís~ ñó dá~tá]	[Ñó]	[Strí~ñg]	[Ñó Gr~ádés~ fóúñ~d]
[Térm~s Sér~vícé~ Fáíl~úré M~éssá~gé]	[Thís~ méss~ágé w~íll á~ppéá~r whé~ñ thé~ íñté~grát~íóñ í~s úñá~blé t~ó réá~ch ór~ próc~éss t~hé Té~rms Á~PÍ có~rréc~tlý.]	[Ñó]	[Strí~ñg]	[Thé p~ágé í~s háv~íñg t~róúb~lé fé~tchí~ñg ác~ádém~íc té~rms - p~léás~é trý~ ágáí~ñ shó~rtlý~.]
[Ñó Té~rms M~éssá~gé]	[Thís~ méss~ágé w~íll á~ppéá~r whé~ñ thé~ré ár~é ñó t~érms~]	[Ñó]	[Strí~ñg]
[Sérv~ícé F~áílú~ré Mé~sság~é]	[Thís~ méss~ágé w~íll á~ppéá~r whé~ñ thé~ íñté~grát~íóñ í~s úñá~blé t~ó réá~ch ór~ próc~éss t~hé sé~rvíc~é cál~l cór~réct~lý.]	[Ñó]	[Strí~ñg]	[Thé p~ágé í~s háv~íñg t~róúb~lé fé~tchí~ñg ýó~úr gr~ádés~ - pléá~sé tr~ý ágá~íñ sh~órtl~ý.]
[Ímpó~rt/ Éx~pórt~ Cóñf~ígúr~átíó~ñ] [Ýóú c~áñ có~ñfíg~úré p~ródú~ct íñ~tégr~átíó~ñ áñd~ théñ~ éxpó~rt ít~ tó áñ~óthé~r cám~púsM~ éñví~róñm~éñt, f~ór éx~ámpl~é, fró~m sáñ~dbóx~ tó pr~ódúc~tíóñ~ ór fr~óm pr~évíé~w tó p~ródú~ctíó~ñ.]
[Éxpó~rt]	[Créá~té á J~SÓÑ f~ílé w~íth á~ll pr~ódúc~t íñt~égrá~tíóñ~ cóñf~ígúr~átíó~ñ.]	[Ñó]
[Ímpó~rt]	[Úsé t~hís ó~ptíó~ñ íñ ó~rdér~ tó ló~ád có~ñfíg~úrát~íóñ f~róm J~SÓÑ ó~f áñ é~xpór~téd p~ródú~ct íñ~tégr~átíó~ñ.]	[Ñó]