WS API - SalleCat

Consideracions generals

Per tal d'utilitzar correctament els mèdodes del servei web, cal tenir en compte:

• La URL base de l'API és https://testapi-pprog2.azurewebsites.net/api/schools.php.
• Les respostes són en format JSON.
• Les variables s'han d'enviar per GET / POST segons el mètode ho especifiqui.
• El mètode que es vol invocar s'indica mitjançant la variable method.
• El camp de retorn msg (message) es pot utilitzat donar informació a l'usuari de l'app.

get-schools - [GET] Obtenir informació escoles

Mètode GET que retorna una llista amb la informació de totes les escoles.

Exemple de crida

• https://testapi-pprog2.azurewebsites.net/api/schools.php?method=getSchools

Paràmetres d'entrada

• method, nom del mètode, ha de ser getSchools

Exemple de la resposta

{
    "res": 1,
    "msg": [{"id":"1","schoolName":"aaa","schoolAddress":"aaa","isInfantil":"0","isPrimaria":"0","isEso":"1","isBatxillerat":"1","isFP":"1","isUniversitat":"0","description":"Lorem ipsum"},{"id":"2","schoolName":"bbb","schoolAddress":"bbb","isInfantil":"1","isPrimaria":"1","isEso":"0","isBatxillerat":"0","isFP":"0","isUniversitat":"0","description":"Lorem ipsum"},{"id":"3","schoolName":"ccc","schoolAddress":"ccc","isInfantil":"0","isPrimaria":"0","isEso":"0","isBatxillerat":"0","isFP":"0","isUniversitat":"1","description":"Lorem ipsum"},{"id":"5","schoolName":"SchoolName","schoolAddress":"abc","isInfantil":"0","isPrimaria":"0","isEso":"1","isBatxillerat":"1","isFP":"0","isUniversitat":"0","description":"Lorem ipsum "},{"id":"6","schoolName":"SchoolName","schoolAddress":"abc","isInfantil":"0","isPrimaria":"0","isEso":"1","isBatxillerat":"1","isFP":"0","isUniversitat":"0","description":"Lorem ipsum "}]
 }

add-school - [POST] Afegir nova escola

Mètode POST que permet afegir una nova escola al sistema.

Paràmetres d'entrada

• method, nom del mètode, ha de ser sempre addSchool
• name, nom de l'escola, string
• address, direcció / adreça de l'escola, string
• province, provincia {barcelona, girona, lleida o tarragona} on es troba l'escola
• type, tipus de nivells formatius que imparteix, string[6] on cada casella valdrà 0 o 1 emn funció de si imparteix el nivell formatiu corresponent (infantil, primaria, ESO, Batxillerat, Formació Professional, Universitat). Per exemple: 001100 -> Eso i Batxillerat
• description, descripció de l'escola, string

Exemple de la resposta

{
    "res": 1,
    "msg": Escola inserida correctament
 }

delete-school - [GET] Esborrar una escola

Mètode GET que permet esborrar una escola del sistema a partir del seu identificador.

Exemple de crida

• https://testapi-pprog2.azurewebsites.net/api/schools.php?method=deleteSchool&schoolId=4

Paràmetres d'entrada

• method, nom del mètode, ha de ser deleteSchool
• schoolId, identificador de l'escola a esborrar, enter

Exemple de la resposta

{
    "res": 1,
    "msg": Escola esborrada correctament
 }

Informació útil

Eines útils pel desenvolupament de la pràctica.

• Mètodes POST Si voleu fer proves amb els mètodes POST, ho podeu fer utilitzant algun client web com Postman