johanwinther/chalmers-card-balance

Public REST API for checking account balance of Chalmers Student Union cards

THIS HAS BEEN DEPRECATED SINCE THE SERVICE HAS ENABLED A CAPTCHA

chalmers-card-balance

Public REST API for checking account balance of Chalmers Student Union cards, _(*1)

Installation

Add johanwinther/chalmers-card-balance as a require dependency in your composer.json file:, _(*2)

composer require johanwinther/chalmers-card-balance

Rename .htaccess.tmp to .htaccess and set the RewriteBase to the absolute folder path of card.php., _(*3)

API

Show Card Balance

Returns JSON data of card balance., _(*4)

• URL, _(*5)

  /<Card number>, _(*6)

• Method:, _(*7)

  GET, _(*8)

• URL Params, _(*9)

  Required:, _(*10)

  Card number - 16-digit Student Union card number, _(*11)

• Data Params, _(*12)

  None, _(*13)

• Success Response:, _(*14)

  • Code: 200
    Content: json { "cardHolder": "Emil Emilsson", "cardNumber": "1111222233334444", "cardBalance": { "value": 200.01, "currency": "kr" } }

• Error Response:, _(*15)

  • Code: 400 BAD REQUEST
    Content: ``` json { "error": "Invalid card number: should be 16 digits." }

  **Explanation:** Request was not 16 digits.
  
  OR
  
  * **Code:** 404 NOT FOUND <br />
  **Content:**
  ``` json
  {
      "error": "Invalid card number: card not found."
  }
  

  Explanation: Card is not registered in the system., _(*16)

  OR, _(*17)

  • Code: 408 REQUEST TIMED OUT
    Content: json { "error": "Connection timed out." } Explanation: Could not load external service.

• Sample Call:, _(*18)

  $.ajax({
    url: "https://ftek.se/api/v1/1111222233334444",
    dataType: "json",
    type : "GET",
    success : function(r) {
      console.log(r);
    }
  });