Pwyntiau Gorffen API Adroddiadau
Pwyntiau Gorffen API Adroddiadau
Rhybudd
Mae'r pwyntiau gorffen sydd wedi'u cynnwys yn yr API ar gyfer adroddiadau yn bwyntiau gorffen preifat ac nid oes ganddynt bolisi anghymeradwyo ar hyn o bryd. Gall Antholeg Ally newid neu ddiweddaru'r pwyntiau gorffen hyn yn dibynnu ar ein map ffordd neu fersiynau rydym yn eu rhyddhau yn y dyfodol.
Adolygwch y ddogfennaeth dechnegol ganlynol i ddysgu sut i osod ac addasu eich pwyntiau gorffen yn briodol. Mae croeso i chi wirio sut i integreiddio API Ally ag Offeryn Adroddiadau Allanol i gael arweiniad ychwanegol.
Dulliau sydd ar gael
Mae gan API Ally ar gyfer adroddiadau ddau ddull. Mae'r adran ganlynol yn eu disgrifio:
Dull | LAU | Math Cais HTTP | Disgrifiad |
Cyffredinol | https://[rhanbarth]/api/v2/clients/[ID Cleient Ally]/reports/overall | Cael | Yn ddiofyn, mae'r dull hwn yn dychwelyd set ddata gyda gwybodaeth am y cwrs, WYSIWYG, a sgoriau ffeiliau a mathau o ffeiliau a gynhwysir ym mhob cwrs o enghraiff yr LMS, heb ystyried a yw Ally wedi'i alluogi ai peidio. |
Problemau | https://[rhanbarth]/api/v2/clients/[ID Cleient Ally]/reports/issues | Cael | Yn ddiofyn, mae'r dull hwn yn dychwelyd set ddata gyda gwybodaeth sy'n gysylltiedig â phob problem hygyrchedd sy'n digwydd ym mhob cwrs, wedi'u cynnwys yn enghraifft yr LMS, heb ystyried a yw Ally wedi'i alluogi ai peidio. |
Cynghoryn
Amnewid [Ally Client ID] gyda'ch ID Ally. Os nad ydych yn gwybod eich ID, gallwch greu tocyn cymorth i ofyn amdano.
Cynghoryn
Newidiwch [Rhanbarth] yn seiliedig ar y rhanbarth mae amgylchedd Ally eich sefydliad yn cael ei letya ynddi:
Canolfan ddata UDA: prod.ally.ac
Canolfan ddata Canada: prod-ca-central-1.ally.ac
Canolfan ddata Ewropeaidd: prod-eu-central-1.ally.ac
Canolfan ddata Singapore: prod-ap-southeast-1.ally.ac
Canolfan ddata Awstralia: prod-ap-southeast-2.ally.ac
Ymateb Cyflwr HTTP
Mae API Ally yn cynnwys maes statws yn y metaddata fel a ganlyn:
Statws 200 - Llwyddiannus: Derbyniwyd eich cais yn llwyddiannus ac mae'r set ddata y gofynnwyd amdano yn rhan o'r ymateb.
Statws 202 - Prosesu: Derbyniwyd eich cais yn llwyddiannus ond mae'r set ddata yn cael ei pharatoi, ac nid yw ar gael eto. Gwnewch eich cais eto ar ôl ychydig o amser (argymhellir aros un munud ar y lleiaf).
Statws 401 - Heb awdurdodiad: Nid yw'r ID Cleient Ally neu'r tocyn awdurdodi yn gywir.
Statws 400 - Cais gwael: Mae gan yr URL enw paramedr annilys, er enghraifft, opsiwn hidlo, gweithredwr neu werth anhysbys. Adolygwch gystrawen yr URL. Cofiwch fod rhai o'r opsiynau hidlo a didoli yn cael eu trin yn wahanol.
Dogfennaeth Dulliau
Dull: Cyffredinol
Cais HTTP: GET
https://[rhanbarth]/api/v2/clients/[ID Cleient Ally]/reports/overall
Amnewid [Ally Client ID] gyda'ch ID Ally. Os nad ydych yn gwybod eich ID, gallwch greu tocyn cymorth i ofyn amdano.
Newidiwch [Rhanbarth] yn seiliedig ar y rhanbarth mae amgylchedd Ally eich sefydliad yn cael ei letya ynddi:
Canolfan ddata UDA: prod.ally.ac
Canolfan ddata Canada: prod-ca-central-1.ally.ac
Canolfan ddata Ewropeaidd: prod-eu-central-1.ally.ac
Canolfan ddata Singapore: prod-ap-southeast-1.ally.ac
Canolfan ddata Awstralia: prod-ap-southeast-2.ally.ac
Awdurdodi: Tocyn cludwr OAuth.
Paramedrau: Hidlyddion neu opsiynau trefnu dewisol.
Corff Cais: Dim
Ymateb:
{
"data": [
{
"application/x-quiz": 2,
"observedDeletedOn": "",
"termName": "Fall 2016",
"courseId": "1",
"application/x-announcement": 0,
"image": 4,
"termId": "2",
"document": 93,
"allyEnabled": true,
"pdf": 74,
"courseCode": "BIO101",
"application/x-assignment": 0,
"departmentId": "1",
"totalFiles": 192,
"courseUrl": "https://ally.instructure.com/courses/1",
"departmentName": "Anthology Ally",
"application/x-page": 1,
"filesScore": 0.6022810739019293,
"application/x-syllabus": 1,
"numberOfStudents": 1,
"html-page": 5,
"lastCheckedOn": "2022-04-13 15:33:23",
"WYSIWYGScore": 1.0,
"totalWYSIWYG": 5,
"courseName": "Biology 101",
"application/x-discussion-topic": 1,
"other": 11,
"overallScore": 0.6129724428830603,
"presentation": 5
}
],
"metadata": {
"filteredTotal": 0,
"total": 7186,
"to": 7186,
"status": "Processing",
"from": 1
}
} Dull: Materion
Cais HTTP: GET
https://[rhanbarth]/api/v2/clients/[ID Cleient Ally]/reports/overall
Rhowch eich ID Ally yn lle [ID Cleient Ally]. Os nad ydych yn gwybod eich ID gallwch greu tocyn cymorth i ofyn amdano.
Newidiwch [Rhanbarth] yn seiliedig ar y rhanbarth mae amgylchedd Ally eich sefydliad yn cael ei letya ynddi:
Canolfan ddata UDA: prod.ally.ac
Canolfan ddata Canada: prod-ca-central-1.ally.ac
Canolfan ddata Ewropeaidd: prod-eu-central-1.ally.ac
Canolfan ddata Singapore: prod-ap-southeast-1.ally.ac
Canolfan ddata Awstralia: prod-ap-southeast-2.ally.ac
Awdurdodiad: tocyn cludwr OAuth
Paramedrau: Hidlyddion neu opsiynau trefnu dewisol.
Corff Cais: Dim
Ymateb:
{
"data": [
{
"imageDecorative2": 4,
"htmlEmptyHeading2": 0,
"imageSeizure1": 2,
"observedDeletedOn": "",
"htmlObjectAlt2": 0,
"security1": 3,
"termName": "Fall 2016",
"courseId": "1",
"languageCorrect3": 14,
"htmlColorContrast2": 2,
"htmlLinkName3": 0,
"termId": "2",
"languagePresence3": 10,
"allyEnabled": true,
"htmlLabel2": 0,
"alternativeText2": 68,
"htmlImageAlt2": 0,
"htmlImageRedundantAlt3": 0,
"headingsPresence2": 20,
"courseCode": "BIO101",
"headingsSequential3": 4,
"departmentId": "1",
"htmlHeadingsPresence2": 0,
"courseUrl": "https://ally.instructure.com/courses/1",
"headingsStartAtOne3": 4,
"departmentName": "Anthology Ally",
"htmlHeadingsStart2": 0,
"htmlTdHasHeader2": 0,
"htmlList3": 0,
"htmlDefinitionList3": 0,
"htmlCaption2": 0,
"tableHeaders2": 23,
"htmlEmptyTableHeader2": 0,
"htmlHasLang3": 1,
"ocred2": 0,
"scanned1": 6,
"htmlBrokenLink2": 0,
"numberOfStudents": 1,
"htmlHeadingOrder3": 0,
"lastCheckedOn": "2022-04-13 15:33:23",
"headingsHigherLevel3": 0,
"contrast2": 28,
"title3": 46,
"imageOcr3": 0,
"tagged2": 4,
"libraryReference": 172,
"courseName": "Biology 101",
"imageContrast2": 0,
"imageDescription2": 4,
"htmlTitle3": 1,
"parsable1": 2
}
],
"metadata": {
"filteredTotal": 0,
"total": 7186,
"to": 7186,
"status": "Processing",
"from": 1
}
} Ble:
Data: yn cynnwys set ddata'r canlyniadau.
Metaddata:
At: cofnod y bydd data yn cael ei nôl iddo, mae'n "offset" + "limit" neu "total" os yw'r swm yn fwy na "total".
O: cofnod y bydd data yn dechrau ohono, mae'n "gwrthbwyso" + 1.
Cyfanswm: cyfanswm nifer y cyrsiau a ystyriwyd gan Ally yn achos LMS.
Gwrthbwyso - o ba record sy'n dechrau
Mae'r rhes gyntaf yn cael ei wrthbwyso = 0,
Pan fydd gwrthbwys < 0 bydd y defnyddiwr yn cael gwall 400 - [Gwerth annilys (paramedr=gwrthbwys, neges=Dim data o'r fath)],
Pan fydd (gwrthbwys >= cyfanswm) => bydd y defnyddiwr yn cael gwall 400 - [Gwerth annilys (paramedr=gwrthbwys, neges=Dim data o'r fath)]
Terfyn - faint o gofnodion sy'n cael eu nôl gan ddechrau o'r gwrthbwyso
Pan fydd (terfyn < 1) bydd y defnyddiwr yn cael gwall 400 - [Gwerth annilys (paramedr=terfyn, neges=Mae'r terfyn y tu allan i'r ffiniau)]
Pan (terfyn > 10000) yna mae'r defnyddiwr yn cael gwall 400 - [Gwerth annilys (paramedr = terfyn, neges = Terfyn y tu allan i'r ffiniau)]
Pan (cyfanswm gwrthbwyso < total && offset + limit > ), yna rydyn ni'n newid y terfyn yn y cefndir i chi, a bydd data yn cael ei adfer tan yr olaf (cyfanswm)
Hidlyddion ac opsiynau didoli
Mae modd hidlo ymatebion Pwyntiau Gorffen yn yr URL. Mae'r adran hon yn disgrifio'r opsiynau sydd ar gael:
Opsiynau didoli
Gallwch ddiffinio a ydych eisiau dangos y canlyniadau wedi'u trefnu yn esgynnol neu'n ddisgynnol gan ystyried un maen prawf. Os oes angen i chi ychwanegu opsiwn trefnu, bydd yn rhaid i chi ychwanegu'r paramedr trefnu fel y'i disgrifir isod:
endpoint-url?sort=<Sort parameter value>
Lle gall <Gwerth paramedr trefnu> fod yn unrhyw un o'r gwerthoedd paramedr canlynol:
Gwerth paramedr | Disgrifiad | Cefnogir yn | Enghraifft |
courseName | Trefnu yn ôl enw'r cwrs, e.e. Cemeg 101 (nid yw courseCode yn ddilys) | Pwyntiau gorffen Cyffredinol a Phroblemau | endpoint-url?sort=courseName |
courseId | Trefnu yn ôl ID y cwrs, e.e. 123456 (rhif cyfan yw hwn fel arfer) | Pwyntiau gorffen Cyffredinol a Phroblemau | endpoint-url?sort=courseId |
termId | Trefnu yn ôl ID tymor. E.e. Swm | Pwyntiau gorffen Cyffredinol a Phroblemau | endpoint-url?sort=termId |
termName | Trefnu yn ôl tymor Enw. e.e. Haf | Pwyntiau gorffen Cyffredinol a Phroblemau | endpoint-url?sort=termName |
overallScore | Trefnu yn ôl sgôr hygyrchedd cyffredinol pob cwrs. | Pwynt gorffen Cyffredinol yn unig. | endpoint-url?sort=overallScore |
filesScore | Trefnu'r canlyniadau yn ôl sgôr ffeil pob cwrs. | Pwynt gorffen Cyffredinol yn unig. | endpoint-url?sort=filesScore |
wysiwygScore | Trefnu'r canlyniadau yn ôl sgôr WYSIWYG pob cwrs. | Pwynt gorffen Cyffredinol a dim ond ar gael ar gyfer Ally ar gyfer LMS. | endpoint-url?sort= wysiwygScore |
webPagesScore | Trefnu'r canlyniadau yn ôl sgôr tudalen we pob parth. | Pwynt gorffen Cyffredinol a dim ond ar gael ar gyfer Ally ar gyfer y We ac WCM. | endpoint-url?sort= webPagesScore |
Nodyn
Mae gwerthoedd paramedr yn gwahaniaethu rhwng priflythrennau a llythrennau bach, ac mae dim ond modd defnyddio un opsiwn trefnu ar y tro.
Yn ddiofyn, mae'r canlyniadau'n cael eu trefnu'n esgynnol. Os ydych eisiau gosod trefn arall, gallwch ychwanegu'r paramedr trefnu:
endpoint-url?sort=<Sort parameter value>&order=<Order value>
Lle gall <gwerth archeb> fod: asc neu desc
Enghraifft:
https://prod.ally.ac/api/v2/clients/0/issues?sort=courseName&order=desc
Opsiynau hidlo
Gallwch ddefnyddio opsiynau hidlo i gael llai o ymatebion neu set o ymatebion wedi'i lleihau yn seiliedig ar y meini prawf a ddewiswyd. Os oes angen i chi ychwanegu opsiwn hidlo, rhaid i chi ychwanegu'r paramedr hidlo fel y disgrifir isod:
Paramedrau Hidlo (heb weithredydd)
Enw paramedr hidlo | Disgrifiad | Cefnogir yn |
allyEnabled | Gallwch gael y cyrsiau lle mae Ally yn weithredol Mae'r gwerth yn wir neu'n gau | Pwyntiau gorffen Cyffredinol a Phroblemau |
departmentId | Hidlo yn ôl ID yr adran | Pwyntiau gorffen Cyffredinol a Phroblemau |
adranName | Hidlo yn ôl enw'r adran. e.e. Peirianneg | Pwyntiau gorffen Cyffredinol a Phroblemau |
termId | Hidlo yn ôl ID y tymor | Pwyntiau gorffen Cyffredinol a Phroblemau |
termName | Hidlo yn ôl enw'r tymor. e.e Haf | Pwyntiau gorffen Cyffredinol a Phroblemau |
courseId | Hidlo yn ôl yr ID neu gwrs. e.e. 123456 (rhif cyfan yw hwn fel arfer) | Pwyntiau gorffen Cyffredinol a Phroblemau |
courseName | Hidlo yn ôl enw cwrs. E.e. Cemeg 101 (nid yw courseCode yn ddilys) | Pwyntiau gorffen Cyffredinol a Phroblemau |
endpoint-url?<Filter Parameter>=<value>
Paramedrau Hidlo (gyda'r gweithredwr)
endpoint-url?<Filter Parameter>=<Operator>:<value>
Ble:
<Paramedr Hidlo>: Paramedr hidlo i gael set lai o ganlyniadau. Gallwch weld y paramedrau a gefnogir yn y tabl isod.
<Gweithredwr>: Rhaid i chi ddefnyddio gweithredydd i hidlo, fel cyfartal, nid cyfartal.
<value>: Gwerth a ddefnyddir yn yr hidlydd.
Enw paramedr hidlo | Math o faes | Gweithredwyr a gynhelir | Disgrifiad | Cefnogir yn |
allyEnabled | Boolean | eq, ne | Gallwch gael y cyrsiau lle mae Ally yn weithredol. Mae'r gwerth yn wir neu'n gau. | Pwyntiau gorffen Cyffredinol a Phroblemau |
courseName | Llinyn | eq, ne, co, nc, sw | Hidlo yn ôl enw cwrs. E.e. Cemeg 101 (nid yw courseCode yn ddilys) | Pwyntiau gorffen Cyffredinol a Phroblemau |
courseId | Llinyn | eq, ne, co, nc, sw | Hidlo yn ôl rhif adnabod neu gwrs. E.e. 123456 (rhif cyfan yw hwn fel arfer) | Pwyntiau gorffen Cyffredinol a Phroblemau |
termId | Llinyn | eq, ne, co, nc, sw | Hidlo yn ôl ID y tymor. | Pwyntiau gorffen Cyffredinol a Phroblemau |
termName | Llinyn | eq, ne, co, nc, sw | Hidlo yn ôl enw'r tymor. e.e. Haf | Pwyntiau gorffen Cyffredinol a Phroblemau |
overallScore | Rhif | eq, ne, le, lt, ge, gt | Gallwch hidlo yn ôl sgôr gyffredinol. e.e. Cyrsiau sydd â sgôr sy'n hafal i 90% | Terfyn cyffredinol ac ym mhob datrysiad Ally: LMS, gwefannau, a WCM. |
filesScore | Rhif | eq, ne, le, lt, ge, gt | Gallwch hidlo yn ôl y sgôr ffeiliau. e.e. Cyrsiau gyda sgôr ffeiliau sy'n hafal i 90% | Terfyn cyffredinol ac ym mhob datrysiad Ally: LMS, gwefannau, a WCM. |
wysiwygScore | Rhif | eq, ne, le, lt, ge, gt | Gallwch hidlo yn ôl y sgôr WYSIWYG. e.e. Cyrsiau gyda sgôr WYSIWYG sy'n hafal i 90% | Pwynt gorffen Cyffredinol a dim ond ar gael ar gyfer Ally ar gyfer LMS. |
webPagesScore | Rhif | eq, ne, le, lt, ge, gt | Gallwch hidlo yn ôl sgôr parth. e.e. Tudalennau gwe â sgôr sy'n hafal i 90%. | Pwynt gorffen Cyffredinol a dim ond ar gael ar gyfer Ally ar gyfer Web neu WCM. |
Nodyn
Mae gwerthoedd paramedrau'n gwahaniaethu rhwng priflythrennau a llythrennau bach.
Gweithredwyr a gynhelir
Mae'r tabl canlynol yn cynnwys y gweithredyddion a gefnogir yn seiliedig ar y math o faes:
Math o faes | Gweithredydd | Disgrifiad |
Llinyn | eq | Yn hafal |
Llinyn | ne | Ddim yn hafal |
Llinyn | co | Yn cynnwys allweddair |
Llinyn | nc | Ddim yn cynnwys allweddair |
Llinyn | sw | Dechrau gydag allweddair |
Rhif | eq | Yn hafal |
Rhif | ne | Ddim yn hafal |
Rhif | le | Llai na neu'n hafal |
Rhif | lt | Llai na |
Rhif | ge | Yn fwy na neu'n hafal |
Rhif | gt | Mwy na |
Enghraifft:
Mae'r enghraifft ganlynol yn nôl yr holl gyrsiau sy'n cynnwys yr allweddair "profion" yn enw'r cwrs:
https://prod.ally.ac/api/v2/clients/15/reports/overall?courseName=co:tests
Defnyddio hidlydd lluosog
Gallwch gyfuno'r opsiynau trefnu a hidlo yn yr un URL pwynt gorffen drwy ychwanegu'r nod "&" rhwng y ddau amod. Er enghraifft, gadewch i ni ddweud eich bod am nôl yr holl gyrsiau sy'n cynnwys yr allweddair "prawf" yn enw'r cwrs lle mae Ally wedi'i alluogi, ac mae'r sgôr cyffredinol yn llai na 90%. Byddai'r URL yn edrych fel hyn:
https://prod.ally.ac/api/v2/clients/0/overall?courseName=co:test&allyEnabled=true&overallScore=lt:0.9
Gallwch hefyd ddefnyddio dau opsiwn hidlo. Er enghraifft, gadewch i ni ddweud bod angen i chi gael yr holl gyrsiau sydd â sgôr cyffredinol rhwng 10% a 70%:
https://prod.ally.ac/api/v2/clients/0/reports/overall?overallScore=ge:0.1&overallScore=le:0.7