API - Posting Card Codes to RollCall

Modified on Wed, 2 Oct at 9:46 AM

Overview

The RolLCall system does not take card codes form the Student Details API, due to the variety of fields available for clients to store this information in. Instead we offer an endpoint for card codes to be posted directly to the RollCall system from your card production system.


Below are the technical. details required for setting up the API connection.


Please contact support for your schoolcode and unique API token, which are required to send information to the RollCall student record.


Update Student Card Details API

Endpoint:
POST https://schoolcode.rollcall.com.au/api/update_card


NOTE: "schoolcode" is YOUR schoolcode. EXAMPLE. "stjohns" for St John's College URL = https://stjohns.rollcall.com.au/api/update_card


Description:
This API endpoint allows schools to update a student's card details within the RollCall system.

Request Format:
The request should be sent as an XML payload in the body of the POST request.

Headers:

  • Content-Type: application/xml

Request Body:

<xml> 
  <Token>Tokengoeshere</Token>
  <StudentNumber>547787</StudentNumber>
  <CardCode>1358891094</CardCode>
</xml>
  • Token: (string) A unique token provided for authentication.
  • StudentNumber: (string) The student's unique identification number.
  • CardCode: (string) The new card code to be assigned to the student.

Response:

  • 200 OK: The card details were successfully updated.
  • 400 Bad Request: The request was malformed or missing required fields.
  • 401 Unauthorized: The provided token is invalid or expired.
  • 500 Internal Server Error: An error occurred on the server side.

Example Request:

curl -X POST https://schoolcode.rollcall.com.au/api/update_card \
-H "Content-Type: application/xml" \
-d '<xml><Token>YOUR_TOKEN_HERE</Token><StudentNumber>547787</StudentNumber><CardCode>1358891094</CardCode></xml>'

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article