Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 20 Next »

Objective

This article outlines how to use the Paradigm API to perform specific tasks through a series of sample POSTMAN commands.

Complexity: EXPERT

Be Advised

The Paradigm API examples calls may be viewed in the format of a Postman Collection available via this link: https://documenter.getpostman.com/view/541303/TVRpz4qD

Advanced programmers that are familiar with connecting to APIs are welcome to dive straight in using the postman documentation for reference.

Getting started

When reading the documentation you’ll notice contents such as {{apiUser}} , these will need to be populated with values that would exist only on your Paradigm system. If you are making use of Postman to test call executions, this is how Postman represents environment variables.

Common Variables

Variable Name

Description

Example Content

apiUser

This is the username of the user you wish to use the API with.
This username can be any user login in your system.

YourApplicationName.API

apiPw

The password for the user

*********

host

The hostname of your site

https://abc.edu.net.au

Example Requests

In the top menu you have the option to select the LANGUAGE - as in the programming language or method that you will be using to connect to the API.

By default this is curl:

curl --location -g --request GET 'https://host/api/rest/EduNoteData/?partyId={{sampleStudentPartyId}}' \
--header 'Content-Type: application/json'

  • No labels