Back to top

JobReady Plus API

A RESTful API for managing JobReady Plus.

Overview

The JobReady Plus application is exposed through a web services interface. This interface enables clients to request, create and modify records stored in JobReady Plus. This guide outlines the web services interface, the resources made available, and the operations that can be performed.

Protocol

All communication takes place over HTTPS. The API subdomain is different for each tenant and will take the form https://subdomain.jobreadyplus.com Request and response bodies are in the XML format.

Response codes

The web services interface may return the following HTTP status codes:

Code Body When Used
200 OK XML When returning the result set of a resource GET query.
201 Created XML After a new record has been successfully created.
204 No Content None After an existing record has been successfully modified or deleted.
400 Bad Request XML The request body is invalid, e.g. malformed XML.
401 Unauthorized XML No or invalid authentication credentials have been supplied.
403 Forbidden XML The requested action is not allowed for this particular resource.
404 Not Found XML The requested resource does not exist.
405 Method Not Allowed XML The HTTP method being used is not allowed for this particular URL.
409 Conflict XML The resource could not be modified due to external dependencies.
422 Unprocessable Entity XML The requested creation or modification could not be completed because the values provided cause a validation error.
500 Internal Server Error XML or HTML The request caused an internal exception to be raised. A log entry is created and the developer team are notified.
503 Service Unavailable XML or HTML The service is currently unavailable due to maintenance.

Authentication

All API endpoints use HTTP Basic Authentication. https://en.wikipedia.org/wiki/Basic_access_authentication.

The password must be your provided API key, the username can be anything.

A 401 response will be provided if authentication fails.

Retrieving a paginated list of records

When retrieving a list of records, .e.g. /webservice/parties, it is recommended to reduce the result set to the records of interest so not to put undue stress on the server. This can be done by applying filters through URL query parameters (e.g. ‘created_since’, ‘updated_since’) or by retrieving the result set in batches. Batches are retrieved by supplying the ‘offset’ and ‘limit’ query parameters. ‘offset’ is a zero-based index indicating on which record to start and ‘limit’ specifies the maximum number of records to return in the batch. If one wishes to retrieve all records the best way is often to start with a zero offset and then increase the ‘offset’ parameter by the value of ‘limit’ each time. If ‘offset’ is greater than or equal to the total number of records, the server will return an empty set. This functionality is analogous to the OFFSET and LIMIT keywords in SQL

Example: Retrieving the first 100 party records and then the next 100

https://host/webservice/parties?offset=0&limit=100
https://host/webservice/parties?offset=100&limit=100

If not specified, the default values for ‘offset’ and ‘limit’ are zero and 100, respectively. The maximum value for the limit is 100. Therefore, if the total number of records in the database is larger than 100 and one wishes to retrieve all records, batch retrieving is necessary. When retrieving a list of records a ‘total’ attribute is available on the root element. This attribute always indicates the total number of records available for the resource after additional filters have been applied, such as ‘created_since’, barring the ‘offset’ and ‘limit’ parameters. The purpose of this attribute is hence to aid batch retrieving. Another way of knowing when to stop increasing the offset is when the server returns an empty result set.

Generating an API key

An API key can be generated via the software’s user interface by navigating to Administration → Configuration → Preferences. Select the relevant Provider, and then go to Integration → JobReady Open Integration. Add a new API key and make sure it is enabled.

API keys for Multi Provider Systems

If the system is a multi-provider set-up, the API key will belong to a specific Provider, and all subsequent interaction with the web services interface will be carried out within the context of that Provider. As an exampe, when creating a new enrolment it will belong to the Provider associated with the API key used.

Similarly searches will also be scoped to the provider associated with the used API key. If you want to search across all Providers for a particular record, you can add the “all_rtos” query parameter to your search request.

Examples of the usage of this query parameter are provided in Party and Enrolment

XML Encoding

Records are encoded in XML, and both the request and response body follow the same format. The name of the root element for a particular record is always the record’s type name in singular (e.g. “party”). If the record is sent or returned as part of a list, the record element is enclosed within a parent element whose name is the record type in plural (e.g. “parties”). This is referred to as a collection. A record may have a set of properties, which are specified as child elements of the record element. The values of the properties are given as the text content of the property element.

The XML encoding is illustrated in the examples below. Here, the party resource has been as an example. Most party properties have been left out for brevity.

Example 1: A single record

<?xml version="1.0" encoding="UTF-8"?>
<party>
  <surname>Johnson</surname>
  <first-name>Diana</first-name>
</party>

Example 2: A collection of records

<?xml version="1.0" encoding="UTF-8"?>
<parties total="2">
  <party>
    <surname>Johnson</surname>
    <first-name>Diana</first-name>
  </party>
  <party>
    <surname>Grey</surname>
    <first-name>Robert</first-name>
  </party>
</parties>

When querying the server for records, the result is either returned as a collection of multiple records or as a single record. The single-record structure is used when a specific record is requested (i.e. by referring to it by its ID number), and the collection structure is used when listing all records or querying for a list of records matching a certain set of criteria. The single-record structure is also always used when creating new records or modifying existing records.

If some of the properties are left out when submitting a new record for creation, default values are assumed for these properties if applicable. If the properties are mandatory it may also result in a validation error (422). If properties are left out when updating an existing record those properties will be left untouched and only the properties supplied will be updated.

A record may also contain child resources. The child resources are encoded as child elements of the parent record element and may themselves have properties and also child resources. The child resources may have a cardinality of one or many: if one, only a single element may appear, and if many, the elements will appear within a collection element – analogously to how the top-level elements work.

Example 3: Child resources (contact-detail has multiple cardinality and AVETMISS single)

<?xml version="1.0" encoding="UTF-8"?>
<party>
  <surname>Johnson</surname>
  <first-name>Diana</first-name>
  <contact-details>
    <contact-detail>
      <value>0212341234</value>
      <contact-type>Phone</contact-type>
    </contact-detail>
    <contact-detail>
      <value>[email protected]</value>
      <contact-type>Email</contact-type>
    </contact-detail>
  </contact-details>
  <avetmiss>
    <country-of-birth>Australia</country-of-birth>
  </avetmiss>
</party>

For most child resources with multiple cardinality, when updating the record all child records will be replaced with the ones provided in the request XML body. If an empty collection element for the child resource is given, all child records will be removed. In the example above, if an update request were performed with only one contact-detail element, the first contact detail would be updated to the new values and the second one removed. This is the default behaviour for child resources with multiple-cardinality, but does not apply to all child resource types.

Errors

  • In most error conditions, the server responds with a HTTP error status code and an error message encoded as XML. The XML error response has the following format:
<?xml version="1.0" encoding="UTF-8"?>
  <error>
  <message>Message explaining the error</message>
  </error>
  • If the error is of type Validation Error and the response code is 422, the error element will contain a validation-errors child element listing one error that was encountered during the validation process.

  • Each validation-error element contains a resource, index and can display one error at a time.

  • The resource element contains the name of the resource affected (e.g. ‘party’), the index element contains a zero-indexed number identifying the record if it was submitted as part of a series of records, and the message element contains a message explaining the validation error. Example:

<?xml version="1.0" encoding="UTF-8"?>
<error>
    <message>Validation failure</message>
    <validation-errors>
        <validation-error>
            <resource>party</resource>
            <index>0</index>
            <message>Please enter a First Name</message>
        </validation-error>
    </validation-errors>
</error>
  • If the server is temporarily unavailable or down for maintenance and the HTTP response code is a 5xx code, it may respond with a HTML response body. It is therefore recommended that the web services client always check the response content type and not try to parse a response body unless the ‘application/xml’ content type has been used.

Ad-hoc Fields

Some resource types support ad-hoc fields. Ad-hoc fields are custom fields that are set up for a specific entity type. Ad-hoc fields are made available via an ad-hoc-fields collection. When creating and updating ad-hoc fields matching is done by looking at the name property. Sending an empty ad-hoc-fields collection will not remove any previously added ad-hoc fields.

Ad-hoc fields can be added against the following entities:

  • Party

  • Enrolment

  • Trainer

An element of type ad-hoc-field accepts the following properties:

  • name (string) - A name of a valid ad-hoc field type

  • value (string) - The value to assign the field

Example: A party record with two ad-hoc fields

<?xml version="1.0" encoding="UTF-8"?>
<party>
  <ad-hoc-fields>
    <ad-hoc-field>
      <name>Shoe size</name>
      <value>7</value>
    </ad-hoc-field>
    <ad-hoc-field>
      <name>Referrals</name>
      <value>Advertiser/Magazine</value>
    </ad-hoc-field>
  </ad-hoc-fields>
</party>

Development

In order to save bandwidth, the XML code returned by the server does by default not contain any white space. To aid readability while debugging, white space and indentation can be enabled by passing a pretty_print=true query parameter.

The interface can easily be tested by using the UNIX command line program curl. Example querying for party records:

curl -D - --user "api:faa1fbc07d51735274acf1e99f5b9c1056036839" \
"https://subdomain.jobreadyplus.com/webservice/parties?updated_since=2011-01-01&pretty_print=true"

Example creating a new party record (with the new party stored in party.xml):

curl -D - --user "api:faa1fbc07d51735274acf1e99f5b9c1056036839" \
-H "Content-Type: text/xml" –d @party.xml \
-X POST "https://subdomain.jobreadyplus.com/webservice/parties?pretty_print=true"

Example updating an existing party record:

curl -D - --user "api:faa1fbc07d51735274acf1e99f5b9c1056036839" \
-H "Content-Type: text/xml" –d @party.xml \
-X POST https://subdomain.jobreadyplus.com/webservice/parties/PARTO02385

API FAQS

JobReady webservice access

Q1: What is the Host name (URL) for Production?

https://subdomain.jobreadyplus.com/

Each client has a unique subdomain which must be used.

Q2: How do we authenticate?

See Authentication.

Your API key must be generated in the browser application. See Generating an API key.

Q3: Is the API key a session key or site key?

The API key is a site key.

Q4: Do we need to submit the key every time?

HTTP Basic Authentication is stateless so the key must be provided with each request. Your browser or software may provide its own password caching mechanism.

Course Queries

Q1: How do we query new courses by course scope?

curl -H "Content-Type: text/xml" -X GET -u username:api_key -v https://subdomain.jobreadyplus.com/webservice/courses/?course_scope_code=BSB20107&start_date_from=2015-01-01

Q2: Do courses have different statuses Eg: Active, Inactive, deleted/removed, archived?

While there is an ‘enabled’ concept for courses, this isn’t exposed in the API as the rules are quite complex. Instead, this query is generally done using dates. There are 2 sets of dates that assist with this query ‘Course Dates’ which relate to the period that the course is open for and ‘Enrolment Dates’ that act as a control and relate to the period that enrolments are allowed for the course. You may choose to include a condition to include/exclude courses based on these date fields.

Booking and Enrolments

Q1: How do we set up a booking and enrolments model?

Clients can ‘scrape’ the JobReady API periodically to extract the course details. It is possible to keep a local copy to ensure your website response times are rapid and not dependent on external API calls.

A sample query they use to extract the first 100 results for courses over the next 6 months is:

curl -H "Content-Type: text/xml" -X GET -u username:api_key -v https://subdomain.jobreadyplus.com/webservice/courses/?limit=100&offset=0&start_date_from=2015-06-28&start_date_to=2015-12-28

A ‘Book Now’ button can embed a course-related link to facilitate enrolment using JobReady’s Online Enrolment Portal.

Q2: What is the URL format for a specific course enrolment via the Online Enrolment Portal?

https://subdomain.jobreadyplus.com/terminal/online_book_course/course_id

Q3: What webservice do we use to determine the available spaces for a course?

This can be determined from the total_enrolments and maximum_enrolments attributes of a course available from the Courses webservice.

Q4: How do we create a new enquiry (prospect)? We have to create a Party with a role ‘Prospect’?

A new Prospect record needs both a Party and a Course. You may need to create the Party in an initial request and then use that ‘party-identifier’ in the request to create a Prospect.

Updating Child Resources

Q1: How can I update a single child resource of a party like contact_detail?

POST: /webservice/parties/id/contact_details/id

Q2: How can I update multiple child resources of a party at one time?

POST: /webservice/parties/id

API Support

If you have any API related issues, you can lodge a ticket on: https://jobready.zendesk.com

If you are a 3rd party developer, please have your JobReady client contact us to authorise your access.

API Pricing

As the API is an additional module, please contact our Customer Experience Team to help you get started.

Changelog

All notable changes to this project will be documented in this section.

The format is based on Keep a Changelog

2018-01-19

  • Release of HTML documentation

2018-01-29

2018-01-31

  • Fixed a typo for the example of attribute: client-occupation-identifier under resource enrolment

  • Updated correct example for attribute: client-industry-employment under resource enrolment

2018-02-05

  • Removed the Beta status from the Documentation

Party

  • Ad-hoc fields: Yes

Party

Individual Party

This is a record for an individual. This acts as a base record where all details common to each individual are captured.

A party record can have many ‘roles’ (i.e. a Party can have the role of a Trainer, User and Student Enrolment) and as such a party record must be created before you can create a student enrolment for example.

Employer Party

This is a record for an employer. It is effectively the same as that for an individual, but is distinguished by a ‘Type’. This changes the fields on the record to show those applicable for a company (e.g. legal name, trading name etc)

A Party has the following attributes:

  • party-identifier (string, optional) - Automatically generated for new records unless explicitly specified.

  • party-type (string, required) - Either Person or Employer. Reference data table_name: party_type.

  • contact-method (string, required) - Either Letter or Email. Reference data table_name: contact_method.

  • surname (string, required) - Used only for party-type person.

  • first-name (string, required) - Used only for party-type person.

  • middle-name (string, nullable) - Used only for party-type person.

  • known-by (string, nullable) - Used only for party-type person.

  • birth-date (string, required) - Used only for party-type person.

  • gender (enum[string]) - Used only for party-type person. Reference data table_name: gender.

  • title (string, nullable) - Used only for party-type person. Reference data table_name: title.

  • tags (string, nullable) - Multiple tags must be separated by commas.

  • legal-name (string, required) - Used only for party-type employers.

  • trading-name (string, required) - Used only for party-type employers.

  • website (string, nullable) - Used only for party-type employers. Must be prefixed with “http://” or “https://”.

  • num-of-employees (number, nullable) - Used only for party-type employers.

  • company-level (enum[string], nullable) - Used only for party-type employers.

    • Local
    • State
    • National
  • employer-source (enum[string], nullable) - Used only for party-type employers.

    • Cold Call
    • Mail-out
    • Partner
    • Trade Show
    • Web Enquiry
    • Existing Client
    • AAC Referral
  • anzsic-code - Used only for party-type employers. Reference data table_name: anzsic_code.

  • description (string, nullable) - Used only for party-type employers.

  • industry (string, nullable) - Used only for party-type employers.

  • image (string, nullable) - Person’s profile picture or employer’s logo.

  • do-not-market (boolean, nullable) - Used to manage marketing related privacy for a party.

  • login (string, nullable) - Username for portals.

  • password (string, nullable) - Used to set a new password (will always be blank when returned).

  • password-temporary (string, nullable) - Value visible in the application.

  • logon-enabled (boolean, nullable) - Whether to enable portal login.

  • created-on (string) - Created at timestamp in ISO 8601 format. Read-Only

  • updated-on (string) - Updated at timestamp in ISO 8601 format. Read-Only

  • usi-number (string) - The Unique Student Identifier.

  • usi-status (string) - Return Verified if the USI is present and has been verified by the USI portal OR Unverified if the USI is present and has not been verified by the USI portal OR No USI if USI is not present. Read only

  • addresses (array[object])

    • address (object)
      • primary (boolean, required) - If true, this will be the party’s primary address.
      • street-address1 (string, required) - Building Name and Postal Delivery box is returned, e.g. “UNIT 1 84 ALEXANDER”
      • street-address2 (string, optional)
      • unit-type (string) - Results from JobReady Plus address verification, e.g. Flat, Unit, Suite Read Only
      • unit-number (string) - Results from JobReady Plus address verification. Read Only
      • street-number (string) - Results from JobReady Plus address verification. Read Only
      • street-name (string) - Results from JobReady Plus address verification. Read Only
      • street-suffix (string) - Results from JobReady Plus address verification, e.g. West, North Read Only
      • street-type (string) - Results from JobReady Plus address verification, e.g. RD, ST, CCT Read Only
      • suburb (string, required)
      • post-code (string, required) - If Country is Australia. Reference data table_name: postcode.
      • state (string, required) - If Country is Australia. Reference data table_name: state.
      • country (string, required) - Reference data table_name: country.
      • location (string, required) - Reference data table_name: contact_location.
  • contact-details (array[object])

    • contact-detail (object)
      • primary (boolean, required) - If true, this email address or phone number will be the party’s primary.
      • value (string, required) - Phone number or email address. The value must validate according to the format of a phone number or email address, depending on below contact_type.
      • contact-type (string, required) - Reference data table_name: contact_type.
      • location (string, required) - Reference data table_name: contact_location.
  • identifications (array[object])

    • identification (object)
      • id (number, optional) - Automatically generated – cannot be assigned.
      • identification-type (string, required) - The identification type, e.g. Passport. Reference data table_name: identification_type.
      • identification-number (string, required) - The identification number
  • avetmiss (object)

  • party_vet_fee_help (object)

    • fee-type (enum[string]) - Reference data, any of the below
      • Full Fee Paying
      • Subsidised by a Reform State/Territory Government
      • None of the above
    • chessn (string) - A valid Commonwealth Higher Education Student Support Number
    • tax-file-number (string) - A valid TFN Number.
    • tfn-status (enum[string]) - Reference data, any of the below
      • Received
      • Awaiting
      • Not Supplied
      • Applicable Submitted
    • visa (string) - Reference data table_name: visa_type.
    • year-of-arrival (string) - Arrival year to Australia.
  • party_cricos (object)

    • visa-status (string) - Reference data lookup > International Reference Data > Visa Status.
    • visa-type (string) - Reference data table_name: visa_type.
    • visa-subtype (string)- Reference data table_name: visa_subtype.
    • visa-education-sector (string) - Reference data lookup > International Reference Data > Visa Education Sector.
    • svp-assessment-level (string) - Reference data table_name: svp_assessment_level.
    • english-test-type (string) - Reference data table_name: english_test_type.
    • english-test-delivery-method (string) - Reference data table_name: english_test_delivery_method.
    • english-test-score (string) - Score achieved in the english test.
    • english-test-date (string) - The English test date in ISO 8601 format.
    • agent-party-identifier (string) - An agent party identifier that can be retrieved from rescource party.
    • citizenship_status (string) - Reference data table_name: citizenship_status. Available from Feb 17.
    • nationality (string)- Reference data table_name: country.
    • country-of-birth (string) - Reference data table_name: country.
    • country-of-passport (string) - Reference data table_name: country.
    • oshc (Boolean) - States whether OSHC is enabled or disabled.
    • oshc-provider (string) - Reference data lookup > International Reference Data > OSHC.
    • oshc-member-number (string) - OHSC number
    • oshc-expiry-date (string) - OHSC expiry date in ISO 8601 format.
    • created-on (string) - Created at timestamp in ISO 8601 format. Read-Only
    • updated-on (string) - Updated at timestamp in ISO 8601 format. Read-Only
  • party-group-members (array[object])

    • party-group-member (object)
      • id (number) - auto-assigned.
      • group-type (string) - A valid party group type which is drawn from party group name. Read Only
      • name (string, required) - A valid party group name. Reference data table_name: party_group.
  • ad-hoc-fields (array)

  • ad-hoc-field (object)

    • name (string) - A name of a valid ad-hoc field type
    • value (string) - The value to assign the field

List
GET/webservice/parties{?birth_date,child_parties_of,created_since,email,employer_party_identifier,first_name,legal_name,login,parent_parties_of,party_type,phone,surname,trading_name,updated_since,all_rtos}

List party.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/parties?birth_date=1988-01-01&child_parties_of=PRT123&created_since=2016-01-01&email=[email protected]&employer_party_identifier=EMP123&first_name=Chris&legal_name=JobReady&login=support&parent_parties_of=PRT111&party_type=Person&phone=02133223232&surname=Smith&trading_name=JobReady&updated_since=2016-01-01&all_rtos=
URI Parameters
HideShow
birth_date
string (optional) Example: 1988-01-01

Find by birth date. Date in ISO8601 format.

child_parties_of
string (optional) Example: PRT123

Provide the Party identifier whose linked party to list.

created_since
string (optional) Example: 2016-01-01

Find records created since. A date in ISO8601 format.

email
string (optional) Example: [email protected]

Find by email address.

employer_party_identifier
string (optional) Example: EMP123

Provide party identifier of the employer to list its employee.

first_name
string (optional) Example: Chris

Find by first name. Used only for party-type person.

legal_name
string (optional) Example: JobReady

Find by legal name. Used only for party-type employer.

login
string (optional) Example: support

Find by login.

parent_parties_of
string (optional) Example: PRT111

Provide the Party identifier whose linked party to list.

party_type
string (optional) Example: Person

Find by party type, e.g. Person or Employer.

phone
string (optional) Example: 02133223232

Find by phone number

surname
string (optional) Example: Smith

Find by surname. Used only for party-type person.

trading_name
string (optional) Example: JobReady

Find by trading name. Used only for party-type employer.

updated_since
string (optional) Example: 2016-01-01

Find records updated since. A date in ISO8601 format.

all_rtos
string (optional) 

If this query parameter is set, results will not be scoped to the provider associated with your API key

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/parties

Create a party.

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Retrieve
GET/webservice/parties/{party_identifier}

Find party.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/parties/PRT123
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123
Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/parties/{party_identifier}

Updates a party.

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/PRT123
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123
Request
HideShow
Headers
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Address

  • Ad-hoc fields: No

Address

An Address has the following attributes:

  • primary (boolean, required) - If true, this will be the party’s primary address.

  • street-address1 (string, required) - Building Name and Postal Delivery box is returned, e.g. “UNIT 1 84 ALEXANDER”

  • street-address2 (string, optional)

  • unit-type (string) - Results from JobReady Plus address verification, e.g. Flat, Unit, Suite Read Only

  • unit-number (string) - Results from JobReady Plus address verification. Read Only

  • street-number (string) - Results from JobReady Plus address verification. Read Only

  • street-name (string) - Results from JobReady Plus address verification. Read Only

  • street-suffix (string) - Results from JobReady Plus address verification, e.g. West, North Read Only

  • street-type (string) - Results from JobReady Plus address verification, e.g. RD, ST, CCT Read Only

  • suburb (string, required)

  • post-code (string, required) - If Country is Australia. Reference data table_name: postcode.

  • state (string, required) - If Country is Australia. Reference data table_name: state.

  • country (string, required) - Reference data table_name: country.

  • location (string, required) - Reference data table_name: contact_location.

List
GET/webservice/parties/{party_identifier}/contact_addr

List party addresses.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/parties/PRT123/contact_addr
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/parties/{party_identifier}/contact_addr

Create a party address.

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/PRT123/contact_addr
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Retrieve
GET/webservice/parties/{party_identifier}/contact_addr/{id}

Find party address.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/parties/PRT123/contact_addr/1
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123
id
number (required) Example: 1
Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/parties/{party_identifier}/contact_addr/{id}

Updates a party address.

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/PRT123/contact_addr/1
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123
id
number (required) Example: 1
Request
HideShow
Headers
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Delete
POST/webservice/parties/{party_identifier}/contact_addr/{id}/delete

Deletes a party address

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/PRT123/contact_addr/1/delete
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123
id
integer (required) Example: 1
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  204
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Contact detail

  • Ad-hoc fields: No

Contact detail

Contact detail refers to Phone, Mobile, Fax and Email. Contact detail has the following attributes:

  • primary (boolean, required) - If true, this email address or phone number will be the party’s primary.

  • value (string, required) - Phone number or email address. The value must validate according to the format of a phone number or email address, depending on below contact_type.

  • contact-type (string, required) - Reference data table_name: contact_type.

  • location (string, required) - Reference data table_name: contact_location.

List
GET/webservice/parties/{party_identifier}/contact_detail

List party contact details.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/parties/PRT123/contact_detail
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/parties/{party_identifier}/contact_detail

Create a party contact detail.

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/PRT123/contact_detail
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Retrieve
GET/webservice/parties/{party_identifier}/contact_detail/{id}

Find party contact detail.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/parties/PRT123/contact_detail/1
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123
id
number (required) Example: 1
Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/parties/{party_identifier}/contact_detail/{id}

Updates a party contact detail.

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/PRT123/contact_detail/1
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123
id
number (required) Example: 1
Request
HideShow
Headers
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Identification

  • Ad-hoc fields: No

Identification

  • id (number, optional) - Automatically generated – cannot be assigned.

  • identification-type (string, required) - The identification type, e.g. Passport. Reference data table_name: identification_type.

  • identification-number (string, required) - The identification number

List
GET/webservice/parties/{party_identifier}/identifications

List party identifications.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/parties/PRT123/identifications
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/parties/{party_identifier}/identifications

Create a party identification.

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/PRT123/identifications
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Retrieve
GET/webservice/identifications/{id}

Find party identification.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/identifications/1
URI Parameters
HideShow
id
number (required) Example: 1

The identification id

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/parties/{party_identifier}/identifications/{id}

Updates a party identification.

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/PRT123/identifications/1
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123
id
number (required) Example: 1

The identification id

Request
HideShow
Headers
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Avetmiss

  • Ad-hoc fields: No

AVETMISS

There is a maximum of 1 child of this resource per party. To create or update these records, the details should be included as part of the party xml and sent to the party (i.e. the ‘parent’ of the ‘child’) endpoint. Avetmiss has the following attributes:

List
GET/webservice/party_avetmiss

List party AVETMISS.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/party_avetmiss
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/parties/{party_identifier}

Create or Update a party AVETMISS.

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/PRT123
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Party VET fee help

  • Ad-hoc fields: No

Party VET Fee Help

There is a maximum of 1 child of this resource per party. To create or update these records, the details should be included as part of the party xml and sent to the party (i.e. the ‘parent’ of the ‘child’) endpoint.

Party VET fee help has the following attributes:

  • fee-type (enum[string]) - Reference data, any of the below

    • Full Fee Paying
    • Subsidised by a Reform State/Territory Government
    • None of the above
  • chessn (string) - A valid Commonwealth Higher Education Student Support Number

  • tax-file-number (string) - A valid TFN Number.

  • tfn-status (enum[string]) - Reference data, any of the below

    • Received
    • Awaiting
    • Not Supplied
    • Applicable Submitted
  • visa (string) - Reference data table_name: visa_type.

  • year-of-arrival (string) - Arrival year to Australia.

List
GET/webservice/party_fee_help

List all party VET fee help.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/party_fee_help
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/parties/{party_identifier}

Create or Update a party VET fee help.

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/PRT123
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Party CRICOS

  • Ad-hoc fields: No

Party Vet Fee Help

There is a maximum of 1 child of this resource per party. To create or update these records, the details should be included as part of the party xml and sent to the party (i.e. the ‘parent’ of the ‘child’) endpoint.

Party CRICOS has the following attributes:

  • visa-status (string) - Reference data lookup > International Reference Data > Visa Status.

  • visa-type (string) - Reference data table_name: visa_type.

  • visa-subtype (string)- Reference data table_name: visa_subtype.

  • visa-education-sector (string) - Reference data lookup > International Reference Data > Visa Education Sector.

  • svp-assessment-level (string) - Reference data table_name: svp_assessment_level.

  • english-test-type (string) - Reference data table_name: english_test_type.

  • english-test-delivery-method (string) - Reference data table_name: english_test_delivery_method.

  • english-test-score (string) - Score achieved in the english test.

  • english-test-date (string) - The English test date in ISO 8601 format.

  • agent-party-identifier (string) - An agent party identifier that can be retrieved from rescource party.

  • citizenship_status (string) - Reference data table_name: citizenship_status. Available from Feb 17.

  • nationality (string)- Reference data table_name: country.

  • country-of-birth (string) - Reference data table_name: country.

  • country-of-passport (string) - Reference data table_name: country.

  • oshc (Boolean) - States whether OSHC is enabled or disabled.

  • oshc-provider (string) - Reference data lookup > International Reference Data > OSHC.

  • oshc-member-number (string) - OHSC number

  • oshc-expiry-date (string) - OHSC expiry date in ISO 8601 format.

  • created-on (string) - Created at timestamp in ISO 8601 format. Read-Only

  • updated-on (string) - Updated at timestamp in ISO 8601 format. Read-Only

List
GET/webservice/party_cricos

List all party CRICOS.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/party_cricos
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/parties/{party_identifier}/party_cricos

Create or Update a party CRICOS.

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/PRT123/party_cricos
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123

Find by party identifier.

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Retrieve
GET/webservice/parties/{party_identifier}/party_cricos

Find party CRICOS.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/parties/PRT123/party_cricos
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123

Find by party identifier.

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Party Group Member

  • Ad-hoc fields: No

Party Group Member

Party group member does not work like other child resources in that an update request does not replace all records with the new ones, and sending an empty party-group-members collection does not remove any party group member records. Instead, matching and updating is done by looking at the value of the group-type property. A party group can be reset by providing an empty name property. Party group member has the following attributes:

  • id (number) - auto-assigned.

  • group-type (string) - A valid party group type which is drawn from party group name. Read Only

  • name (string, required) - A valid party group name. Reference data table_name: party_group.

List
GET/webservice/party_group_member

List all party group members.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/party_group_member
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/parties/{party_identifier}/party_group_member

Create a party group member.

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/PRT123/party_group_member
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123

Find by party identifier.

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/parties/{party_identifier}/party_group_member/{id}

Update a party group member.

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/PRT123/party_group_member/id
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123

The party identifier.

id
number (required) 

The party group member id.

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Retrieve
GET/webservice/parties/{party_identifier}/party_group_member/{id}

Find a party group member.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/parties/PRT123/party_group_member/id
URI Parameters
HideShow
party_identifier
string (required) Example: PRT123

The party identifier.

id
number (required) 

The party group member id.

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

File Note

Ad-hoc fields: No

File Note

At the moment, only file notes associated with parties are available. The URL must contain the unique party identifier of an existing party record whose file notes are to be retrieved, modified or created.

A file note can be assigned to either a user or a user group. This is specified by providing a username in the assigned-user field or a name of a user group in the assigned-user-group field. If both values are provided the behaviour is undefined, as a file note can only be assigned to either or.

A File Note has the following attributes:

  • id (number) - Automatically generated - cannot be assigned

  • name (string, required) - The file note’s name

  • description (string) - The file note’s description

  • party-identifier (string) - The party identifier of a valid party **Read Only

  • category (string, required) - Category of the file note. Can be found under Administration > Templates > Entity > Party > Notes > Categories

  • status (enum[string], nullable) - The file note status

    • Open
    • Closed
    • Cancelled
  • priority (enum[string], required) - The file note’s priority level

    • Low
    • Normal
    • High
  • followup-date (string) - The followup date in ISO 8601 format. Read-Only

  • specific-time (boolean) - Enables start-time and end-time

  • start-time (string) - The start time of the followup in “HH:mm” format, e.g “10:00”. Mandatory if specific-time is enabled

  • end-time (string) - The end time of the followup in “HH:mm” format, e.g “10:00”. Mandatory if specific-time is enabled

  • public (boolean) - States whether or not the file note is public

  • private (boolean) - States whether or not the file note is private

  • assigned-user (string) - Username of the user to whom the file note is assigned. Can be found under Administration > Security > User

  • assigned-user-group (string) - Name of the group to which the file note is assigned. Can be found under Administration > Security > User Groups

  • assigned-date (string) - The assigned date in ISO 8601 format. Read-Only

  • closed-date (string) - The close date in ISO 8601 format. Read-Only

  • created-on (string) - Created on timestamp in ISO 8601 format, e.g. “2017-11-20T15:13:58+10:00” Read-Only

  • updated-on (string) - Updated on timestamp in ISO 8601 format, e.g. “2017-11-21T12:11:51+10:00” Read-Only

List
GET/webservice/parties/{party_id}/file_notes{?created_since,updated_since,assigned_user,assigned_user_group}

List file notes

Example URI

GET https://subdomain.jobreadyplus.com/webservice/parties/A12B/file_notes?created_since=2016-06-02&updated_since=2016-09-14&assigned_user=Abhinesh&assigned_user_group=Admins
URI Parameters
HideShow
party_id
string (required) Example: A12B

Find file notes by party id

created_since
string (optional) Example: 2016-06-02

Find file notes created since

updated_since
string (optional) Example: 2016-09-14

Find file notes updated since

assigned_user
string (optional) Example: Abhinesh

Find by Username

assigned_user_group
string (optional) Example: Admins

Find by Name of User Group

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/parties/{party_id}/file_notes

Create a file note

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/1/file_notes
URI Parameters
HideShow
party_id
string (required) Example: 1

Find file notes by party id

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201

Retrieve
GET/webservice/parties/{party_id}/file_notes/{id}

Find a file note

Example URI

GET https://subdomain.jobreadyplus.com/webservice/parties/1/file_notes/1
URI Parameters
HideShow
party_id
string (required) Example: 1

Find file notes by party id

id
string (required) Example: 1

Find by file note id

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/parties/{party_id}/file_notes/{id}

Update a file note

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/1/file_notes/1
URI Parameters
HideShow
party_id
string (required) Example: 1

Find file notes by party id

id
string (required) Example: 1

Find by file note

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Delete
POST/webservice/parties/{party_id}/file_notes/{id}/delete

Deletes a file note

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/1/file_notes/1/delete
URI Parameters
HideShow
party_id
string (required) Example: 1

Find file notes by party id

id
string (required) Example: 1

Find by file note

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  205
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Party Contact

Ad-hoc fields: No

Party contacts

A Party contact has the following attributes:

  • id (number) - The unique party contact id. Read-Only

  • primary (boolean) - States whether or not the party contact is primary.

  • first-name (string, required) - First name of the party contact.

  • surname (string) - surname of the party contact.

  • title (string, nullable) - Title of the party contact. Reference data table_name: title.

  • relationship (string) - Used only for party-type Person.

  • jobtitle (string) - Used only for party-type Employer.

  • phone (string) - Phone number of the party contact.

  • email (string) - Email address of the party contact.

  • address (string) - Address of the party contact. Read Only

  • contact-method (string) - Method of contact for party contact. Reference data table_name: contact_type.

  • party-identifier (string) - If used, the party with the given identifier will be used instead of the details above. Can be retrieved from resource Party

  • party_contact_roles (array[object])

    • party_contact_role (object)

List
GET/webservice/parties/{party_identifier}/party_contacts

List Party contacts.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/parties/ABC123/party_contacts
URI Parameters
HideShow
party_identifier
string (required) Example: ABC123

Find by party id.

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/parties/{party_identifier}/party_contacts

Create a party contact.

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/ABC123/party_contacts
URI Parameters
HideShow
party_identifier
string (required) Example: ABC123

Find by party id.

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201

Retrieve
GET/webservice/parties/{party_identifier}/party_contacts/{id}

Find a party contact

Example URI

GET https://subdomain.jobreadyplus.com/webservice/parties/ABC123/party_contacts/1
URI Parameters
HideShow
party_identifier
string (required) Example: ABC123

Find by party id.

id
number (required) Example: 1

Party contact id.

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/parties/{party_identifier}/party_contacts/{id}

Update a party contact

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/ABC123/party_contacts/1
URI Parameters
HideShow
party_identifier
string (required) Example: ABC123

Find by party id.

id
number (required) Example: 1

Party contact id

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Delete
POST/webservice/parties/{party_identifier}/party_contacts/{id}/delete

Delete a party contact

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/ABC123/party_contacts/1/delete
URI Parameters
HideShow
party_identifier
string (required) Example: ABC123

Find by party id.

id
number (required) Example: 1

Party contact id

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  204
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Employee

Ad-hoc fields: No

Employees

An Employee has the following attributes:

  • id (number) - auto-assigned.

  • employer-party-identifier (string, required) - An employer party identifier can be retrieved from resource party.

  • employee-title (string) - Title of the employee.

  • start-date (string, required) - Start Date of the employee in ISO 8601 format.

  • end-date (string, required) - End Date of the employee in ISO 8601 format.

  • supervisor-contact-id (string) - An Employer contact ID. Read Only

List
GET/webservice/parties/{party_id}/employees

List Employees

Example URI

GET https://subdomain.jobreadyplus.com/webservice/parties/1/employees
URI Parameters
HideShow
party_id
number (required) Example: 1

ID of the Party

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/parties/{party_id}/employees

Create an Employee

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/1/employees
URI Parameters
HideShow
party_id
number (required) Example: 1

ID of the Party

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201

Retrieve
GET/webservice/parties/{party_id}/employee/{id}

Find an Employee

Example URI

GET https://subdomain.jobreadyplus.com/webservice/parties/1/employee/1
URI Parameters
HideShow
party_id
number (required) Example: 1

ID of the Party

id
number (required) Example: 1

ID of the Employee

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/parties/{party_id}/employee/{id}

Updates an Employee

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/1/employee/1
URI Parameters
HideShow
party_id
number (required) Example: 1

ID of the Party

id
number (required) Example: 1

ID of the Employee

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Delete
POST/webservice/parties/{party_id}/employee/{id}/delete

Deletes a Employee

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/1/employee/1/delete
URI Parameters
HideShow
party_id
integer (required) Example: 1

ID of the Party

id
integer (required) Example: 1

ID of the Employee

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  204
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Enrolment

  • Ad-hoc fields: Yes

Enrolment

An enrolment is effectively a role against a party. A party can have many enrolments. The enrolment captures attributes specific to the student (e.g. start date, target end date, delivery mode etc)

An Enrolment has the following attributes:

  • enrolment-identifier (string) - Automatically generated for new records unless explicitly specified.

  • party-identifier (string, required) - The party identifier which cannot be changed after creation. Can be retrieved from resource Party

  • rto-identifier (string) - Unique Provider Code. Can be retrieved from Administration > Configuration > Preferences

  • course_number (string, required) - The course number for the enrolment. Cannot be changed after creation. Can be retrieved from resource Course

  • start-date: 2016-11-15 (string, required) - Start date of the enrolment in ISO 8601 format

  • target-end-date: 2017-12-25 (string, required) - Target end date of the enrolment in ISO 8601 format

  • end-date: 2017-12-25 (string) - The actual end date of the enrolment in ISO 8601 format

  • study-reason (string) - The reason for enrolment. Reference data table_name: study_reason

  • study-mode (string) - The study mode for enrolment. Reference data table_name: study_mode

  • enrolment-status (string) - The enrolment status which. Reference data table_name: enrolment_status

  • vet-in-school (boolean) - States whether or not a course is a Vet in Schools course

  • employment-basis (string) - The employment basis for the enrolment. Reference data table_name: employment_basis

  • enabled (string) - States whether or not the enrolment is enabled

  • invoice-option (string) - The invoice options

  • worker-type: New Worker (string, nullable) - The worker type

  • traineeship (boolean) - States whether or not the traineeship is enabled for the enrolment

  • tcid (string) - Note: TRS ID in the application. Requires traineeship= true

  • aac (string) - Reference data table_name: aac. Requires traineeship= true

  • end-reason (string) - The reason for the end of enrolment. Reference data table_name: end_reason. Requires traineeship= true

  • training-type: Apprentice (string, nullable) - The training type

  • traineeship-mode: On The Job (string, nullable) - The traineeship mode

  • training-plan (boolean) - States whether or not training plan is enabled. Requires traineeship= true

  • training-plan-signed-date: 2017-12-25 (string) - Training plan signed date of the enrolment in ISO 8601 format. Requires traineeship= true

  • initial-skills-assessment-date: 2017-12-25 (string) - Initial skills assessment date of the enrolment in ISO 8601 format. Requires traineeship= true

  • annual-leave-balance: 25.78 (number) - Amount of annual leave balance. Format: 2 decimal precision float. Requires traineeship= true

  • personal-leave-balance: 25.78 (number) - Amount of personal leave balance. Format: 2 decimal precision float. Requires traineeship= true

  • pay-rate: 20.78 (number) - Pay rate of the employee. Format: 2 decimal precision float. Requires traineeship= true

  • qualification-issued (boolean) - States whether or not the qualification has been issued for the enrolment

  • location (string) - The location where the course will be conducted which can be retrieved from retrieved from resource location.

  • course-type: Cert 3 Guarantee (string) - The type of course. Reference data table_name: course_type.

  • fee-exemption-state (string) - Denotes the fee exemption state. Reference data table_name: fee_exemption_state.

  • language (string) - The language in which the enrolment course will be conducted. Reference data table_name: language.

  • statement-issued (boolean) - States whether or not a statement has been issued.

  • reporting-enabled (boolean) - Whether to include the enrolment in AVETMISS reports

  • priority (string) - Denotes the priority type for the Enrolment Course’s claims and funding. Reference data table_name: priority.

  • funding-source-state (string) - The funding source state for the Enrolment course. Reference data table_name: funding_source_state.

  • funding-source-national (string) - Mandatory if reporting-enabled = true. Reference data table_name: funding_source_national.

  • delivery-mode (string) - Mandatory if reporting-enabled = true. Reference data table_name: delivery_mode.

  • contract (string) - Denotes the contract for claims and funding of the Course

  • victorian-student-number (string) - Only relevant if the course state is Victoria

  • unknown-victorian-student-number (boolean) - States whether or not the Victoria Student Number for the enrolment is unknown. Only relevant if the course state is Victoria

  • previous-victorian-education-enrolment (boolean) - States whether or not the enrolment party had any previous victorian education enrolments. Only relevant if the course state is Victoria

  • client-occupation-identifier: Managers (string, nullable) - Only relevant if the course state is Victoria

  • client-industry-employment: Agriculture, Forestry and Fishing (string, nullable) - Only relevant if the course state is Victoria

  • trainer (string) - Trainer party identifier. Can be retrieved from resource trainer

  • other-trainer (string) - Trainer party identifier. Can be retrieved from retrieved from resource trainer

  • admission-basis: 01 - Not a commencing student (string, nullable) - Only relevant if the course state is Victoria

  • applied-vfh (boolean) - Relates to VET Fee-Help

  • details-of-prior-study: No credit/RPL was offered (string, nullable) - Only relevant if the course state is Victoria

  • foe-credit-offered: Mathematical Sciences/101 (string, nullable) - Only relevant if the course state is Victoria

  • level-of-education: Advanced Diploma/411 (string], nullable) - Only relevant if the course state is Victoria

  • provider-type: 90 - Not elsewhere categorised (string], nullable) - Only relevant if the course state is Victoria

  • attendance-mode: 1 - Internal Mode of Attendance at an on-shore or off-shore campus (includes classroom based) (string, nullable) - Only relevant if the course state is Victoria

  • student-status: 401 - Deferred all/part of tuition fee through VET FEE-HELP - non State Government subsidised (string, nullable) - Only relevant if the course state is Victoria

  • requested-assistance (boolean) - Relates to VET Fee-Help. Must be ‘True’ or ‘False’ if provided (not Null)

  • form-received (string) - The date the assistance form was received in ISO 8601 format. Relates to VET Fee-Help. Only relevant if request-assistance is true

  • form-submitted (string) - The date the assistance form was submitted in ISO 8601 format. Relates to VET Fee-Help. Only relevant if request-assistance is true

  • signature-date (string) - The date the assistance form was signed in ISO 8601 format. Relates to VET Fee-Help. Only relevant if request-assistance is true

  • vet-opted-in (boolean) - Whether on not VET has been opted in. Relates to VFH

  • vet-opted-in-date (string) - VET opt in date in ISO 8601 format. Relates to VFH

  • status-date (string) - The status date in ISO 8601 format. Read-Only

  • created-on (string) - Created at timestamp in ISO 8601 format. Read-Only

  • updated-on (string) - Updated at timestamp in ISO 8601 format. Read-Only

  • units (array[object])

    A course enrolment should have a set of unit enrolments. Unit enrolments are available through the unit child resource. The unit child resource works in a slightly different way compared to other child resources. Updating an existing unit is done by matching the unit scope codes. Sending an empty units collection will not remove any existing associated units. A new enrolment will have any enabled core course units added by default. Additional units can be specified explicitly.

    • unit (object)
      • unit-scope (string, required) - A valid unit scope code. Can be retrieved from the menu bar: Administration > Curriculum > Unit scope
      • name (string) - Name of the enrolment unit. Read Only
      • score: 72 (number) - Denotes the score in that enrolment unit
      • outcome (string) - Refers to the enrolment unit outcome table_name: outcome_identifier_avetmiss
      • outcome-date: 2017-12-25 (string) - Outcome date of the enrolment unit in ISO 8601 format. Read Only
      • start-date: 2017-12-25 (string) - Start date of the enrolment unit in ISO 8601 format.
      • end-date: 2018-5-25 (string) - End date of the enrolment unit in ISO 8601 format. Mandatory if outcome is a final outcome (e.g. Competent)
      • target-end-date: 2018-6-25 (string) - Target end date of the enrolment unit in ISO 8601 format
      • note (string) - Note for the enrolment unit
      • delivery-mode (string) - Mandatory if avetmiss = true. Reference data table_name: delivery_mode.
      • funding-source-state (string) - The funding source state for the enrolment unit. Reference data table_name: funding_source_state.
      • scheduled-hours (number) - Scheduled hours for the enrolment unit
      • vet-disable (boolean) - States whether or not the enrolment unit is a VET enabled unit
      • assessment-method (string) - Assessment method of the course. Reference data table_name: assessment_method.
      • internal-name (string) - The internal name of the enrolment unit. Read Only
      • created-on (string) - Created on timestamp in ISO 8601 format. Read Only
      • updated-on (string) - Updated on timestamp in ISO 8601 format. Read Only
  • subjects (array[object])

    If subject delivery has been enabled on the course, the subjects of an enrolment are available through the subject child resource. Adding a subject to a course enrolment via the subject child resource will also cause unit enrolments to be for those unit scopes that have an association with the subject scope.

    • subject (object)
      • id (number) - The id of the enrolment subject (Unit of Study)
      • subject-scope (string, required) - A valid subject scope code. Can be retrieved from the menu bar: Administration > Curriculum > Subject scope
      • score: 72 (number) - Denotes the score in that enrolment subject
      • outcome (string) - Refers to the enrolment subject outcome table_name: outcome_identifier_avetmiss
      • outcome-date (string) - Outcome date of the enrolment subject in ISO 8601 format. Read Only
      • start-date: 2017-12-25 (string) - Start date of the enrolment subject in ISO 8601 format.
      • end-date: 2018-5-25 (string) - End date of the enrolment subject in ISO 8601 format. Mandatory if outcome is a final outcome (e.g. Competent)
      • target-end-date: 2018-6-25 (string) - Target end date of the enrolment subject in ISO 8601 format
      • note (string) - Note for the enrolment subject
      • tuition-fee: 7568.0 (number) - The tuition fee for the enrolment subject
      • paid-up-front: 1200.0 (number) - The amount of tuition fee paid upfront
      • vet-fee-help-debt (number) - The VET fee help debt calculated from tuition_fee subtract paid_up_front Read Only
      • vet-fee-help-loan-fee: 2000.0 (number) - The VET help loan fee
      • census-date: 2018-01-25 (string) - Census date for the enrolment subject in ISO 8601 format
      • admin-date: 2017-12-25 (string) - Admin date for the enrolment subject in ISO 8601 format
      • attendance-mode: 1 - Internal Mode of Attendance at an on-shore or off-shore campus (includes classroom based) (string, nullable) - Only relevant if the course state is Victoria
      • student-status: 401 - Deferred all/part of tuition fee through VET FEE-HELP - non State Government subsidised (string, nullable) - Only relevant if the course state is Victoria
      • created-at (string) - Created on timestamp in ISO 8601 format. Read Only
      • updated-at (string) - Updated on timestamp in ISO 8601 format. Read Only
  • elements (array[object])

    A course enrolment can have a set of element enrolments. Elements are linked to units in the system and are auto generated on enrolment. Element enrolments are available through the element child resource. Updating an existing element is done by matching the element scope codes. Sending an empty elements collection will not remove any existing associated element.

    • element (object)
      • id (number) - The id of the enrolment element
      • code (string) - A valid element scope code. Can be retrieved from the menu bar: Administration > Curriculum > Element scope
      • score: 72 (number) - Denotes the score in that enrolment element
      • outcome (string) - Refers to the enrolment element outcome table_name: outcome_identifier_avetmiss
      • outcome-date: 2017-12-25 (string) - Outcome date of the enrolment element in ISO 8601 format. Read Only
      • start-date: 2017-12-25 (string) - Start date of the enrolment element in ISO 8601 format.
      • end-date: 2018-5-25 (string) - End date of the enrolment element in ISO 8601 format. Mandatory if outcome is a final outcome (e.g. Competent)
  • invoice-options (array[object])

    An enrolment may have zero, one or multiple invoice options allocated to it, and these can be managed via the invoice-options child resource. New invoice options can be added and old ones disabled. This child resource supersedes the now deprecated invoice-option property on the enrolment. Do not use both the invoice-option property and the invoice-options child resource as this might cause duplicate invoice options to be created.

    • invoice-option (object)
      • id (number) - The id of the enrolment invoice option.
      • name (string, required) - A valid invoice option name as defined on the course. This value cannot be changed once the invoice option has been added to the enrolment. If a new enrolment is created, the special value “default” can be used for this parameter. The invoice option will then be the course default, if a default invoice option has been defined. Reference data table_name: invoice_option_type.
      • created-on (string) - Created on timestamp in ISO 8601 format. Read-Only
      • updated-on (string) - Updated on timestamp in ISO 8601 format. Read-Only
      • payment-made (boolean) - Set to true to make a full payment against an invoice that’s created immediately with this invoice option.
  • client-vet-student-loans (object)

    VET Student Loans commenced on 1 January 2017, replacing the VET FEE‑HELP scheme, which ceased on 31 December 2016. An enrolment can opt in for VSL (VET Student Loans) and the following fields could be used to add the related details

    • vet-student-loans (boolean) - Denotes whether or not the enrolment has VET Student Loans (VSL) enabled. Set to ‘True’ in order to view the following attributes:
    • admission-basis: 01 - Not a commencing student (string, nullable) - Admission basis on the enrolment
    • credit-offered: 9.99 (number, nullable) - Format: 2 decimal precision float.
    • credit-used: 7.89 (number, nullable) - Format: 2 decimal precision float.
    • details-of-prior-study: No credit/RPL was offered (string, nullable) - Denotes the details of previous study
    • foe-for-credit-offered: Mathematical Sciences/101 (string, nullable) - Denotes the Field of Education for the credit offered in the enrolment. Can be retrieved from Menu Bar > Administration > Lookups > AVETMISS Reference Data > FOE Code
    • level-of-education: Advanced Diploma/411 (string], nullable) - Denotes the level of education of the enrolment
    • provider-type: 90 - Not elsewhere categorised (string, nullable) - The provider type
    • attendance-mode: 1 - Internal Mode of Attendance at an on-shore or off-shore campus (includes classroom based) (string, nullable) - Attendance mode for the enrolment
    • student-status: 401 - Deferred all/part of tuition fee through VET FEE-HELP - non State Government subsidised (string, nullable) - The student status.
    • request-for-assistance-form (boolean) - Set to true if Assistance Form is requested.
    • assistance-date-received (string) - The date assistance form was received in ISO 8601 format. Only relevant if request-assistance is true.
    • assistance-date-submitted (string) - The date assistance form was submitted in ISO 8601 format. Only relevant if request-assistance is true.
    • assistance-signature-date (string) - The date assistance form was signed in ISO 8601 format. Only relevant if request-assistance is true.
  • client_agents (array[object])

    • client_agent (object)
      • id (number) - auto-assigned
      • agent-party-identifer: PATRA02507 (string, required) - The party ID of the client agent. Can be retrieved from resource Party Read Only
      • agent-rate: 3.32 (number) - The agent’s rate. A client agent can only have either agent-rate or commission-rate. Format: 2 decimal precision float.
      • commission-rate: Base Rate (string) - The name of an Agent’s Commission Rate which can be found under Commission Rate list in Agent Profile
  • ad-hoc-fields (array)

  • ad-hoc-field (object)

    • name (string) - A name of a valid ad-hoc field type
    • value (string) - The value to assign the field

List
GET/webservice/enrolments{?party_identifier,rto_identifier,employer_identifier,unit_id,created_since,updated_since,course_number,enrolment_identifier,start_date_from,start_date_to,target_end_date_from,target_end_date_to,unit_updated_since,unit_created_since,all_rtos}

List enrolments

Example URI

GET https://subdomain.jobreadyplus.com/webservice/enrolments?party_identifier=PATRA412&rto_identifier=1A4ASB&employer_identifier=EMP123&unit_id=ASD132&created_since=2016-01-01&updated_since=2016-01-01&course_number=CSEJOB01885&enrolment_identifier=ENJOB63375&start_date_from=2015-01-01&start_date_to=2017-01-01&target_end_date_from=2017-01-01&target_end_date_to=2017-01-01&unit_updated_since=2017-01-01&unit_created_since=2017-01-01&all_rtos=
URI Parameters
HideShow
party_identifier
string (optional) Example: PATRA412

Find by party identifier

rto_identifier
string (optional) Example: 1A4ASB

Find by RTO identifier

employer_identifier
string (optional) Example: EMP123

Find all enrolments of employees of the given party

unit_id
string (optional) Example: ASD132

Find all enrolments forthe given unitcode

created_since
string (optional) Example: 2016-01-01

Find records created since. A date in ISO8601 format.

updated_since
string (optional) Example: 2016-01-01

Find records updated since. A date in ISO8601 format.

course_number
string (optional) Example: CSEJOB01885

Find by course Number

enrolment_identifier
string (optional) Example: ENJOB63375

Find by enrolment identifier

start_date_from
string (optional) Example: 2015-01-01

Find enrolments with start date since this date, date in ISO 8601 format

start_date_to
string (optional) Example: 2017-01-01

Find enrolments with start date till this date, date in ISO 8601 format

target_end_date_from
string (optional) Example: 2017-01-01

Find enrolments with target end date since this date, in ISO 8601 format

target_end_date_to
string (optional) Example: 2017-01-01

Find enrolments with target end date till this date, in ISO 8601 format

unit_created_since
string (optional) Example: 2017-01-01

Find enrolments with start date since this date, in ISO 8601 format

unit_updated_since
string (optional) Example: 2017-01-01

Find enrolments with units updated since this date, in ISO 8601 format

all_rtos
string (optional) 

If this query parameter is set, results will not be scoped to the provider associated with your API key

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/enrolments

Create an Enrolment

Example URI

POST https://subdomain.jobreadyplus.com/webservice/enrolments
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Retrieve
GET/webservice/enrolments/{enrolment_identifier}

Find party.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/enrolments/ENJOB63375
URI Parameters
HideShow
enrolment_identifier
string (required) Example: ENJOB63375

Find by enrolment identifier

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/parties/{enrolment_identifier}

Updates an enrolment

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/ENJOB63375
URI Parameters
HideShow
enrolment_identifier
string (required) Example: ENJOB63375

Find by enrolment identifier

Request
HideShow
Headers
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Event Attendance Summary

Ad-hoc fields: Yes

Event Attendance Summary

A course enrolment will attend one or more events and attendance will be marked in them. The calculated percentages of actual attendance, projected attendance and overall attendance (if ELICOS is present) can be know from Event Attendance Summary child resource. An Event Attendance Summary has the following attributes:

  • enrolment-identifier (string) - A valid enrolment id. Read Only

  • actual-attendance (number) - Actual attendance of the enrolment. Read Only

  • projected-attendance (number) - Projected attendance of the enrolment. Read Only

  • overall-attendance (number) - Overall attendance of the enrolment. Read Only

Retrieve
GET/webservice/enrolments/{enrolment_identifier}/event_attendance_summary

Retrieves the Event Attendance Summary for an Enrolment.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/enrolments/enrolment_identifier/event_attendance_summary
URI Parameters
HideShow
enrolment_identifier
string (required) 

Find event attendance summary by enrolment id.

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Certificate

Ad-hoc fields: No

Certificate

This resource can be used to access certificate records for a particular enrolment. Normally, when creating a certificate through the user interface the system will also generate a PDF document based on a template. Creating a certificate record through this resource will not generate such a document, just the certificate record. If the certificate indicates that the student has completed his or her qualification or statement of attainment, the qualification issued or statement-issued flag on the enrolment has to be manually updated through the enrolment resource.

A Certificate has the following attributes:

  • id (number) - auto-assigned

  • enrolment_identifier (string, required) - Enrolment identifier

  • party_identifier (string) - Party identifier. Read-only

  • certificate_number (string) - Has to be provided when creating the record and can be a combination of letters and numbers.

  • reprint (boolean) - Whether this record is a reprint of a previously issued certificate

  • issue-date (string) - The date when the certificate was issued. ISO8601 format

  • enabled (boolean) - Can be set to false if the certificate was created in error. Default: ‘true’

  • note (string) - Additional notes for the certificate

  • certificate-type (enum[string], nullable) - The Certificate Type

    • Qualification
    • Statement of Attainment
    • Other
  • created-on (string) - When a certificate was created in “yyyy-MM-dd’T’HH:mm:ss’Z’” format, e.g “2015-04-27T10:10:20+10:00” Read Only

  • updated-on (string) - When a certificate was updated in “yyyy-MM-dd’T’HH:mm:ss’Z’” format, e.g “2017-11-27T11:41:17+11:00” Read Only

List
GET/webservice/certificates{?enrolment_identifier,certificate_number,created_since,updated_since,issue_date,issued_since}

List all certificates

Example URI

GET https://subdomain.jobreadyplus.com/webservice/certificates?enrolment_identifier=1&certificate_number=1&created_since=2017-08-13&updated_since=2017-06-11&issue_date=2017-07-21&issued_since=2017-10-15
URI Parameters
HideShow
enrolment_identifier
string (optional) Example: 1

Find by enrolment

certificate_number
string (optional) Example: 1

Find by certificate number

created_since
string (optional) Example: 2017-08-13

Find certificates created since a particular date, ISO8601 format

updated_since
string (optional) Example: 2017-06-11

Find certificates updated since a particular date, ISO8601 format

issue_date
string (optional) Example: 2017-07-21

Find certificates issued on a particular date, ISO8601 format

issued_since
string (optional) Example: 2017-10-15

Find certificates issued since a particular date, ISO8601 format

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/enrolments/{enrolment_identifier}/certificates/

Create a certificate

Example URI

POST https://subdomain.jobreadyplus.com/webservice/enrolments/1/certificates/
URI Parameters
HideShow
enrolment_identifier
string (required) Example: 1

Find by enrolment identifier

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201

Retrieve
GET/webservice/certificates/{id}

Find a certificate

Example URI

GET https://subdomain.jobreadyplus.com/webservice/certificates/1
URI Parameters
HideShow
id
number (required) Example: 1

ID of the certificate

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/certificates/{id}

Updates a certificate

Example URI

POST https://subdomain.jobreadyplus.com/webservice/certificates/1
URI Parameters
HideShow
id
number (required) Example: 1

ID of the certificate

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Delete
POST/webservice/certificates/{id}/delete

Deletes a certificate

Example URI

POST https://subdomain.jobreadyplus.com/webservice/certificates/1/delete
URI Parameters
HideShow
id
number (required) Example: 1

ID of the certificate

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  204
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Transfer

Ad-hoc fields: No

Transfer

A Transfer has the following attributes:

  • to-course (string, required) - The course number of the new course to transfer to, Course number can be retrieved from resource course.

List
GET/webservice/enrolments/{enrolment_id}/transfers

List Transfers

Example URI

GET https://subdomain.jobreadyplus.com/webservice/enrolments/1/transfers
URI Parameters
HideShow
enrolment_id
string (required) Example: 1

ID of the enrolment

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/enrolments/{enrolment_id}/transfers

Create a Transfer

Example URI

POST https://subdomain.jobreadyplus.com/webservice/enrolments/1/transfers
URI Parameters
HideShow
enrolment_id
string (required) Example: 1

ID of the enrolment

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Client Agent

  • Ad-hoc fields: Yes

Client Agent

A course enrolment can have one or more agents and the following fields can be used to add the related details. Note: In order to view agents added through API in UI, the ‘Has Agent’ checkbox under Enrolment > Agents tab has to be ticked.

A Client Agent has the following attributes:

  • id (number) - auto-assigned

  • agent-party-identifer: PATRA02507 (string, required) - The party ID of the client agent. Can be retrieved from resource Party Read Only

  • agent-rate: 3.32 (number) - The agent’s rate. A client agent can only have either agent-rate or commission-rate. Format: 2 decimal precision float.

  • commission-rate: Base Rate (string) - The name of an Agent’s Commission Rate which can be found under Commission Rate list in Agent Profile

List
GET/webservice/client_agent{?id}

List Client Agents

Example URI

GET https://subdomain.jobreadyplus.com/webservice/client_agent?id=12
URI Parameters
HideShow
id
string (optional) Example: 12

Find by client agent id

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/enrolments/{enrolment_identifier}/client_agent/

Create a Client Agent

Example URI

POST https://subdomain.jobreadyplus.com/webservice/enrolments/ENJOB63375/client_agent/
URI Parameters
HideShow
enrolment_identifier
string (required) Example: ENJOB63375

Find by enrolment identifier

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Retrieve
GET/webservice/enrolments/{enrolment_identifier}/client_agent/{id}

Find client agent.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/enrolments/ENJOB63375/client_agent/12
URI Parameters
HideShow
enrolment_identifier
string (required) Example: ENJOB63375

Find by enrolment identifier

id
string (optional) Example: 12

Find by client agent id

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/enrolments/{enrolment_identifier}/client_agent/{id}

Updates client agent.

Example URI

POST https://subdomain.jobreadyplus.com/webservice/enrolments/ENJOB63375/client_agent/12
URI Parameters
HideShow
enrolment_identifier
string (required) Example: ENJOB63375

The enrolment identifier

id
string (required) Example: 12

The client agent id

Request
HideShow
Headers
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Trainer

Ad-hoc fields: No

Trainer

A Trainer has the following attributes:

  • id (number) - auto-assigned. Read-Only

  • party_identifier (string, required) - Cannot be changed after creation.

  • enabled (boolean) - Can be set to false if the trainer was not active.

  • internal_identifier (string) - Unique number used to identify staff-member. Read-Only

  • employment-basis (reference) - Relates to type of employement.

  • ind-assessor (boolean) - Whether this is an assessor.

  • ind-coordinator (boolean) - Whether this is a coordinator.

  • ind-trainer (boolean) - Whether this is a trainer.

  • profile (string) - Details of the trainer.

  • ad-hoc-fields (array)

  • ad-hoc-field (object)

    • name (string) - A name of a valid ad-hoc field type
    • value (string) - The value to assign the field

List
GET/webservice/trainers{?party_identifier,internal_identifier}

List trainers

Example URI

GET https://subdomain.jobreadyplus.com/webservice/trainers?party_identifier=ABC123&internal_identifier=321xyz
URI Parameters
HideShow
party_identifier
string (optional) Example: ABC123

Find by party id

internal_identifier
string (optional) Example: 321xyz

Find records using a unique internal id

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/trainers

Create a trainer

Example URI

POST https://subdomain.jobreadyplus.com/webservice/trainers
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201

Retrieve
GET/webservice/trainer/{id}

Find trainer

Example URI

GET https://subdomain.jobreadyplus.com/webservice/trainer/1
URI Parameters
HideShow
id
number (required) Example: 1

ID of the trainer

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/trainer/{id}

Updates a trainer

Example URI

POST https://subdomain.jobreadyplus.com/webservice/trainer/1
URI Parameters
HideShow
id
number (required) Example: 1

ID of the trainer

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Course Scope

Ad-hoc fields: No

Course Scope

A course scope record is a base record for a course. It contains all the fields common to that type of record (e.g. Course number, Unit outcome, etc). It has the following attributes:

  • course-code (string) - Could be a training.gov.au qualification code or a custom code Read Only resource course

  • name (string) - The Course Scope’s name Read Only

  • internal-name (string) - The internal name can be used to distinguish between course scopes with the same name and code. It is not included on AVETMISS reports or certificates Read Only

  • enabled (boolean) - States whether or not the Course Scope is enabled Read Only

  • vet (boolean) - States whether a Course Scope is a VET Course Scope or not Read Only

  • accredited (boolean) - States whether or not the Course Scope is an accredited one Read Only

  • individual-unit-enrolments (boolean) - The internal name can be used to distinguish between Course Scopes with the same name and code. It is not included on AVETMISS reports or certificates. Read Only

  • recognition-status-type (string) - The recognition status type of the Course Scope. Reference data table_name: recognition_status_type Read Only

  • qualification-level (string) - Qualification level of the Course Scope. Reference data table_name: qualification_level Read Only

  • foe-code (string) - Field of Education code of the Course Scope. Reference data table_name: foe_code Read Only

  • anzsco-code (string) - ANZSCO code of the Course Scope. Reference data table_name: anzsco_code Read Only

  • nominal-hours (number) - Hours of training required to achieve the outcomes of units of competency Read Only

  • estimated-course-cost (number) - Estimated course cost (New field for VSL) Read Only

  • applicable-loan-cap (number) - Applicable loan cap (New field for VSL) Read Only

List
GET/webservice/course_scopes{?course_code,name,internal_name,enabled}

List all Course Scopes

Example URI

GET https://subdomain.jobreadyplus.com/webservice/course_scopes?course_code=1&name=Certificate III in Retail&internal_name=C3 in Retail&enabled=true
URI Parameters
HideShow
course_code
string (optional) Example: 1

Find by Course Scope code

name
string (optional) Example: Certificate III in Retail

Find by Course Scope name

internal_name
string (optional) Example: C3 in Retail

Find by internal name

enabled
boolean (optional) Example: true

find course scopes that are active/inactive

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Retrieve
GET/webservice/course_scopes/{course_code}

Find a Course Scope

Example URI

GET https://subdomain.jobreadyplus.com/webservice/course_scopes/1
URI Parameters
HideShow
course_code
string (optional) Example: 1

The Course Scope code

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Course

Ad-hoc fields: Yes

Course

A course is a way of grouping common enrolments and is one of the most common entities used on the API. This is often the record that is called and published on a provider’s website to facilitate online student enrolment. It is also where the Online Enrolment Portal (OEP) settings are enabled and configured.

When creating a new course, either one or both of the attributes course-scope-code and course-scope-name need to be present. The elements represent, respectively, the code and name of an existing course scope in the system.

Subject/Unit of Study (VET Fee-Help)

A cluster of units used to set up modular style delivery. This is particularly important for VET Fee-Help that is structured and reported based on Units of Study. A subject or unit of study can have many units linked

Unit

Unit of Competency (accredited and non-accredited) in JobReady Plus. A unit can have many elements linked.

Element

Components of a unit of competency – often outlined in the training package, but more commonly they are custom and reflect the assessments/assignments involved in a unit.

A course has the following attributes:

  • id (number) - auto-assigned

  • course-number (string) - Course number of the course which is automatically generated if blank

  • course-name (string) - The Course’s name.

  • tags (string) - A comma separated list of values as used against Course

  • course-status (string) - Status of the the Course. It can be found under Menu item Administration > Lookups > References > Course Status

  • course-scope-code (string) - Could be a training.gov.au qualification code or a custom code. Mandatory if course-scope-name is blank. Can be retrieved from retrieved from resource course scope

  • course-scope-name (string) - Name of Course Scope. Mandatory if course-scope-code is blank. Can be retrieved from retrieved from resource course scope

  • trainer (string) - Trainer party identifier. Can be retrieved from resource trainer

  • other-trainer (string) - Trainer party identifier. Can be retrieved from retrieved from resource trainer

  • assessor (string) - Trainer party identifier. Can be retrieved from retrieved from resource trainer

  • coordinator (string) - Trainer party identifier. Can be retrieved from retrieved from resource trainer

  • start-date (string, required) - Start date of the course in ISO 8601 format.

  • end-date (string, required) - End date of the course in ISO 8601 format.

  • enrolment-start-date (string) - Start date for the course enrolment in ISO 8601 format.

  • enrolment-end-date (string) - End date for the course enrolment in ISO 8601 format.

  • course-type (string) - The type of course, e.g. Cert 3 Guarantee . Reference data table_name: course_type.

  • maximum-enrolments (number, required) - Maximum number of enrolments for the course

  • minimum-enrolments (number, required) - Minimum number of enrolments for the course

  • total-enrolments (number) - The total number of enrolments in the course Read Only

  • assessment-method (string) - Assessment method of the course. Reference data table_name: assessment_method.

  • avetmiss (boolean) - States whether or not the AVETMISS reporting for the Course is enabled.

  • delivery-mode (string) - Mandatory if avetmiss = true. Reference data table_name: delivery_mode.

  • funding-source-national (string) - Mandatory if avetmiss = true. Reference data table_name: funding_source_national.

  • fee-exemption-state (string) - Denotes the fee exemption state. Reference data table_name: fee_exemption_state.

  • vet-in-school (boolean) - States whether or not a course is a Vet in Schools course

  • location (string) - The location where the course will be conducted which can be retrieved from retrieved from resource location.

  • state (string) - The state where the course will be conducted and mandatory if avetmiss = true. Reference data table_name: state.

  • element-grade (boolean) - Specifies whether of not element grading for the course has been enabled

  • invoice-template (string) - Refers to the invoice template of the Course. Reference data table_name: invoice_template_type.

  • complete (boolean) - Specifies whether or not the Course has been completed

  • study-reason (string) - The reason for studying the course. Reference data table_name: study_reason.

  • language (string) - The language in which the course will be conducted. Reference data table_name: language.

  • course-fee (number) - The Course fee

  • priority (string) - Denotes the priority type for the Course’s claims and funding. Reference data table_name: priority.

  • funding-source-state (string) - The funding source state for the course. Reference data table_name: funding_source_state.

  • study-period (string) - The amount of period for which the course will run, e.g. 4 weeks.

  • start-time (string) - The start time of the course in “HH:mm” format, e.g “10:00”

  • end-time (string) - The end time of the course in “HH:mm” format, e.g “10:00”

  • course-information (string) - Information regarding the course

  • contract (string) - Denotes the contract for claims and funding of the Course

  • Unit-of-study (boolean) - Allows Subjects/Units of Study to be enabled on a course

  • web-description (string) - Web description of the course

  • course_invoice_options (object)

    • date-from (string) - Read Only
    • date-to (string) - Read Only
    • option-type (string) - The invoice option type. Reference data table_name: invoice_option_type Read Only
    • online-enrolments-enabled (boolean) - States whether or not the invoice option is enabled on online enrolments. Read Only
    • name (string) - Name of the Invoice Option. Read Only
    • description (string) - Description of the Invoice Option. Read Only
    • total (number) - The total amount of Invoice Option. Read Only

List
GET/webservice/courses{?course_number,course_scope_code,course_status,online,start_date_from,start_date_to,end_date_from,end_date_to}

List all courses

Example URI

GET https://subdomain.jobreadyplus.com/webservice/courses?course_number=1&course_scope_code=1&course_status=Course Status A&online=true&start_date_from=2017-11-20&start_date_to=2017-11-20&end_date_from=2017-11-20&end_date_to=2017-11-20
URI Parameters
HideShow
course_number
string (optional) Example: 1

Find by course number

course_scope_code
string (optional) Example: 1

Find by course scope code

course_status
string (optional) Example: Course Status A

Find by course Status

online
boolean (optional) Example: true

Find by Course that have Online Enrolment enabled/disabled

start_date_from
string (optional) Example: 2017-11-20

Find records with a start date after this. Date in ISO 8601 format

start_date_to
string (optional) Example: 2017-11-20

Find records with a start date before this. Date in ISO 8601 format

end_date_from
string (optional) Example: 2017-11-20

Find records with a end date after this. Date in ISO 8601 format

end_date_to
string (optional) Example: 2017-11-20

Find records with a end date before this. Date in ISO 8601 format

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/courses

Create a Course

Example URI

POST https://subdomain.jobreadyplus.com/webservice/courses
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201

Retrieve
GET/webservice/courses/{id}

Find courses

Example URI

GET https://subdomain.jobreadyplus.com/webservice/courses/1
URI Parameters
HideShow
id
string (required) Example: 1

Find by Course Number of the course

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/courses/{id}

Updates a course

Example URI

POST https://subdomain.jobreadyplus.com/webservice/courses/1
URI Parameters
HideShow
id
string (required) Example: 1

Find by Course Number of the course

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Invoice Options

The Invoice Option (aka Payment Options) child resource is created against the Course resource via the user interface. Invoice Options are used to invoice fees and services to Parties or Debtors, e.g. students or employers. The Invoice Option child resource is only available as a read-only request (GET) via the JobReady Plus API. It has the following attributes:

  • date-from (string) - Read Only

  • date-to (string) - Read Only

  • option-type (string) - The invoice option type. Reference data table_name: invoice_option_type Read Only

  • online-enrolments-enabled (boolean) - States whether or not the invoice option is enabled on online enrolments. Read Only

  • name (string) - Name of the Invoice Option. Read Only

  • description (string) - Description of the Invoice Option. Read Only

  • total (number) - The total amount of Invoice Option. Read Only

Location

Ad-hoc fields: No

Location

A Location has the following attributes:

  • name (string, required) - Name of the location.

  • description (string) - Short note about the location

  • address (string) - Address of the location. Read-Only

  • contact-number (number) - Contact number of the location.

  • enabled (boolean) - Indicates if the location is active or not.

  • information (string) - Detailed description about the location.

List
GET/webservice/location

List locations

Example URI

GET https://subdomain.jobreadyplus.com/webservice/location
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/location

Create a Location

Example URI

POST https://subdomain.jobreadyplus.com/webservice/location
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200

Retrieve
GET/webservice/location/{id}

Find location

Example URI

GET https://subdomain.jobreadyplus.com/webservice/location/1
URI Parameters
HideShow
id
number (required) Example: 1

ID of the location

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/location/{id}

Updates a location

Example URI

POST https://subdomain.jobreadyplus.com/webservice/location/1
URI Parameters
HideShow
id
number (required) Example: 1

ID of the location

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Timetable

Ad-hoc fields: No

Timetable

Calendar framework to manage ‘Events’. A timetable can exist against either a course or at system level.

A Timetable has the following attributes:

  • id (number) - auto-assigned. Read-Only

  • name (string, required) - Name of the timetable.

  • description (string) - Short note about the timetable.

  • created-at (string) - Created at timestamp in ISO 8601 format. Read-Only

  • updated-at (string) - Updated at timestamp in ISO 8601 format. Read-Only

List
GET/webservice/timetable{?name,created_since,updated_since}

List timetables

Example URI

GET https://subdomain.jobreadyplus.com/webservice/timetable?name=Class1&created_since=2016-01-01&updated_since=2016-01-01
URI Parameters
HideShow
name
string (optional) Example: Class1

Find by name

created_since
string (optional) Example: 2016-01-01

Find records created since, date+time in ISO 8601 format.

updated_since
string (optional) Example: 2016-01-01

Find records updated since, date+time in ISO 8601 format.

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/timetable

Create a timetable

Example URI

POST https://subdomain.jobreadyplus.com/webservice/timetable
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201

Retrieve
GET/webservice/timetable/{id}

Find timetable

Example URI

GET https://subdomain.jobreadyplus.com/webservice/timetable/1
URI Parameters
HideShow
id
number (required) Example: 1

ID of the timetable

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/timetable/{id}

Updates a timetable

Example URI

POST https://subdomain.jobreadyplus.com/webservice/timetable/1
URI Parameters
HideShow
id
number (required) Example: 1

ID of the timetable

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Event

Ad-hoc fields: No

Event

Events are records for scheduling and include properties such as dates, times, locations and attendees.

An Event has the following attributes:

  • id (number, optional) - Automatically generated for new events.

  • course-number (string, optional) - Course number, if the event is attached to a course. Course number can be retrieved from resource course. Read-only

  • timetable-id (string, optional) - Timetable ID, if the event is attached to a timetable. Timetable ID can be retrieved from resource timetable. Read-only

  • title (string, required) - Title of the event.

  • event-type (string, optional) - Type of the event. Reference data table_name: event_type.

  • description (string, optional) - Description of the event if any.

  • colour (string) - Used to easily identify the event.

  • enabled (boolean) - Used to manage whether the event is rescheduled or not. ‘False’ if the event has been rescheduled otherwise ‘True’.

  • event-date (string, required) - Scheduled Date of the event, in ISO 8601 format.

  • start-time (string, required) - Start Time of the event, in ISO 8601 format.

  • end-time (string, required) - End Time of the event, in ISO 8601 format.

  • all-day (boolean) - True if the event has been scheduled for whole day, otherwise false.

  • location-room: 6021 WA testroom 1 (string, optional) - The location room where the event will be conducted which can be retrieved from menu bar Administration > Lookups > Locations.

  • unit (string, optional) - A valid unit of the Course scope. Can be retrieved from the menu bar: Administration > Curriculum > course scope < Units Qualified

  • element (string, optional) - A valid element of the course scope. Can be retrieved from the menu bar: Administration > Curriculum > course scope < elements Qualified

  • all-staff (boolean, required) - If checked All Staffs will be included in the event.

  • all-students (boolean, required) - If checked All Students will be included in the event.

  • minimum-number-of-attendees (number, optional) - The minimum number of attendees required for the event.

  • maximum-number-of-attendees (number, optional) - The maximum number of attendees for the event.

  • trainer (string, optional) - Party identifier of the trainer can be retrieved from resource trainer.

  • number-of-invitees (number, nullable) - Total number of parties (students, trainers and other parties) invited to this event. Read-Only

  • event-repeat-type ((enum[string], nullable)) - The type of repeat to apply.

    • Does not repeat
    • Daily
    • Weekday
    • Weekly
    • Fortnightly
    • Monthly
    • Yearly
  • repeat-every (string, nullable) - 1 to repeat every X, 2 to repeat every second X, etc., where X is day, week, month, etc. as specified by event-repeat-type.

  • repeat-end (string) - The last date of the repeated series in ISO 8601 format.

  • repeat-days (string) - Comma-separated list of number to indicate days if event-repeat-type is Weekly. 0 = Sunday, 1 = Monday, etc. For instance, the value “2,3,5” means repeat every Tuesday, Wednesday and Friday.

  • created-on (string) - Created at timestamp in ISO 8601 format. Read-Only

  • updated-on (string) - Updated at timestamp in ISO 8601 format. Read-Only

  • update ((enum[string], nullable)) - Only used when updating an existing event part of a repeated series. Valid values are

    • current
    • following
    • all
    • event_items (array[object])
    • event_item (object)
      • course (string) - A valid course number.
      • unit-scope (string) - A valid unit scope code.
      • element-scope (string) - A valid element scope code.

List
GET/webservice/events/{?course_number,event_id,date_from,date_to,created_since,updated_since}

List events.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/events/?course_number=1&event_id=1&date_from=2016-01-01&date_to=2016-02-01&created_since=2017-11-20T15:13:58+10:00&updated_since=2017-11-20T15:13:58+10:00
URI Parameters
HideShow
course_number
string (optional) Example: 1

Find by course number

event_id
string (optional) Example: 1

Id of the event.

date_from
string (optional) Example: 2016-01-01

Finds events with this or a later date. Date in ISO 8601 format, e.g. “2017-11-20”

date_to
string (optional) Example: 2016-02-01

Finds events with this or an earlier date. Date in ISO 8601 format, e.g. “2017-11-20”

created_since
string (optional) Example: 2017-11-20T15:13:58+10:00

Finds events created on or after this date and time. date+time in ISO 8601 format, e.g. “2017-11-20T15:13:58+10:00”

updated_since
string (optional) Example: 2017-11-20T15:13:58+10:00

Finds events updated on or after this date and time. date+time in ISO 8601 format, e.g. “2017-11-20T15:13:58+10:00”

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/courses/{course_number}/events

Create an event.

Example URI

POST https://subdomain.jobreadyplus.com/webservice/courses/1/events
URI Parameters
HideShow
course_number
string (required) Example: 1

Find by course number.

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Retrieve
GET/webservice/courses/{course_number}/events/{event_id}

Find an Event.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/courses/1/events/1
URI Parameters
HideShow
course_number
string (required) Example: 1

Find by course number.

event_id
string (required) Example: 1

Id of the event.

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/courses/{course_number}/events/{event_id}

Update an Event.

Example URI

POST https://subdomain.jobreadyplus.com/webservice/courses/1/events/1
URI Parameters
HideShow
course_number
string (required) Example: 1

Find by course number.

event_id
string (required) Example: 1

Id of the event.

Request
HideShow
Headers
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Delete
POST/webservice/courses/{course_number}/events/{event_id}/delete

Delete an Event

Example URI

POST https://subdomain.jobreadyplus.com/webservice/courses/1/events/1/delete
URI Parameters
HideShow
course_number
string (required) Example: 1

Find by course number.

event_id
string (required) Example: 1

Id of the event.

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  204
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Attendee

Ad-hoc fields: No

Attendee

This resource is used for listing and manipulating attendance for parties invited to events. It is therefore necessary for the party to be associated with the event via the invitees resource in order for any details entered via this resource to be meaningful.

An Attendee has the following attributes:

  • id (number) - auto-assigned.

  • party-identifier (string, required) - Unique id of an existing party record.

  • attended (boolean) - Specifies whether or not the party attended an event.

  • arrived-at (string) - When a party arrived to an event in “HH:mm” format, e.g “10:00”

  • left-at (string) - When a party arrived to an event in “HH:mm” format, e.g “14:00”

  • duration (string) - Automatically calculated from arrived-at and left-at. Blank if those attributes are blank.

  • notes (string) - Notes about the attendance record.

  • absence-reason (string) - The reason for a party’s absence in an event. e.g. “Sick”

List
GET/webservice/courses/{course_number}/events/{event_id}/attendees{?id}

List all attendees

Example URI

GET https://subdomain.jobreadyplus.com/webservice/courses/1/events/1/attendees?id=1
URI Parameters
HideShow
course_number
string (required) Example: 1

Find by course

event_id
string (required) Example: 1

Find by event

id
string (optional) Example: 1

Find by party identifier

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/courses/{course_number}/events/{event_id}/attendees

Create an attendee

Example URI

POST https://subdomain.jobreadyplus.com/webservice/courses/1/events/1/attendees
URI Parameters
HideShow
course_number
string (required) Example: 1

Find by course

event_id
string (required) Example: 1

Find by event

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201

Retrieve
GET/webservice/courses/{course_number}/events/{event_id}/attendees/{party_identifier}

Find an attendee

Example URI

GET https://subdomain.jobreadyplus.com/webservice/courses/1/events/1/attendees/1
URI Parameters
HideShow
course_number
string (required) Example: 1

Find by course

event_id
string (required) Example: 1

Find by event

party_identifier
string (required) Example: 1

ID of the attendee

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/courses/{course_number}/events/{event_id}/attendees/{party_identifier}

Updates an attendee

Example URI

POST https://subdomain.jobreadyplus.com/webservice/courses/1/events/1/attendees/1
URI Parameters
HideShow
course_number
string (required) Example: 1

Find by course

event_id
string (required) Example: 1

Find by event

party_identifier
string (required) Example: 1

ID of the attendee

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Delete
POST/webservice/courses/{course_number}/events/{event_id}/attendees/{party_identifier}/delete

Deletes an attendee

Example URI

POST https://subdomain.jobreadyplus.com/webservice/courses/1/events/1/attendees/1/delete
URI Parameters
HideShow
course_number
string (required) Example: 1

Find by course

event_id
string (required) Example: 1

Find by event

party_identifier
string (required) Example: 1

ID of the attendee

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  204
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Invitee

Ad-hoc fields: No

Invitee

This resource is used for listing and manipulating parties invited to events. Create a record via this resource to associate a party with an event. The party will then be expected to participate in the event and show up on event screens in the user interface.

Parties can be implicitly invited to events if and only if all of the following conditions hold true: • The event is attached directly to a course, not through a separate timetable. • The party is a student or a trainer of the course. • all-clients or all-staff is true on the event record for students and trainers, respectively.

An invitee has the following attributes:

  • party-identifier (string, required) - Unique id of an existing party record.

  • exclusion (string) - Populating this attribute is only necessary if the party has been implicitly invited. If true, the party is excluded from the event. e.g: false

List
GET/webservice/courses/{course_number}/events/{event_id}/invitees/{id}

List all invitees of an event

Example URI

GET https://subdomain.jobreadyplus.com/webservice/courses/1/events/1/invitees/1
URI Parameters
HideShow
course_number
string (required) Example: 1

Find by course

event_id
string (required) Example: 1

Find by event

id
string (optional) Example: 1

Find by party identifier

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/courses/events/invitees

Create an invitee

Example URI

POST https://subdomain.jobreadyplus.com/webservice/courses/events/invitees
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201

Retrieve
GET/webservice/courses/{course_number}/events/{event_id}/invitees/{id}

Find an invitee

Example URI

GET https://subdomain.jobreadyplus.com/webservice/courses/1/events/1/invitees/1
URI Parameters
HideShow
course_number
string (required) Example: 1

Find by course

event_id
string (required) Example: 1

Find by event

id
string (required) Example: 1

Find by party identifier

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/courses/{course_number}/events/{event_id}/invitees/{id}

Updates an invitee

Example URI

POST https://subdomain.jobreadyplus.com/webservice/courses/1/events/1/invitees/1
URI Parameters
HideShow
course_number
string (required) Example: 1

Find by course

event_id
string (required) Example: 1

Find by event

id
string (required) Example: 1

Find by party identifier

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Delete
POST/webservice/courses/{course_number}/events/{event_id}/invitees/{id}/delete

Deletes an invitee

Example URI

POST https://subdomain.jobreadyplus.com/webservice/courses/1/events/1/invitees/1/delete
URI Parameters
HideShow
course_number
string (required) Example: 1

Find by course

event_id
string (required) Example: 1

Find by event

id
string (optional) Example: 1

Find by party identifier

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  204
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Prospect

Ad-hoc fields: No

Prospect

A prospect has the following attributes:

  • id (number) - auto-assigned.

  • party_identifier (string, required) - Cannot be changed after creation. Mandatory

  • course-number (string, required) - Course number can be retrieved from resource course.

  • status (string, required) - Status of the prospect. Reference data table_name: prospect_status(placeholder).

  • prospect-type (string, required) - Status of the prospect. Reference data table_name: role_prospect_type.

  • assignee: PAJOB17532 (string) - The party ID of the prospect assignee from resource party

  • start-date (string) - Start date of the prospect. Date in ISO8601 format. Read Only

  • target-end-date (string) - End date of the prospect. Date in ISO8601 format. Read Only

  • created-on (string) - The date prospect was created on. Date in ISO8601 format. Read Only

  • updated-on (string) - The date prospect was updated on. Date in ISO8601 format. Read Only

  • referring-agent (string) - The name of the agent that the prospect was referred by, from resource party Read only

  • sales-lead (object)

    • name (string) - Name of the sales lead.
    • id (number) - The id of sales lead.

List
GET/webservice/prospects{?party_identifier,sales_lead_id}

List all prospects

Example URI

GET https://subdomain.jobreadyplus.com/webservice/prospects?party_identifier=1&sales_lead_id=1
URI Parameters
HideShow
party_identifier
string (optional) Example: 1

Find by party

sales_lead_id
number (optional) Example: 1

Find by sales lead id

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/prospects

Create a Prospect

Example URI

POST https://subdomain.jobreadyplus.com/webservice/prospects
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201

Retrieve
GET/webservice/prospects/{id}

Find prospects

Example URI

GET https://subdomain.jobreadyplus.com/webservice/prospects/1
URI Parameters
HideShow
id
number (required) Example: 1

ID of the Prospect

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/prospects/{id}

Updates a prospect

Example URI

POST https://subdomain.jobreadyplus.com/webservice/prospects/1
URI Parameters
HideShow
id
number (required) Example: 1

ID of the prospect

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Sales Lead

Ad-hoc fields: No

Sales Leads

A Sales Lead has the following attributes:

  • id (number) - auto-assigned.

  • name (string, required) - Sales lead name.

  • description (string) - Description of the lead.

  • status (string, required) - Status of the lead. Reference data table_name: sale_lead_status.

  • source (string, required) - Source of the lead. Reference data table_name: sales_lead_source.

  • course-number (string) - Course number can be retrieve from resource course.

  • course-name (string) - A course name. Read Only

  • course-scope-code (string) - A course scope code. Read Only

  • course-scope-name (string) - A course scope name. Read Only

  • employer (string) - An employer party identifier can be retrieved from rescource party.

  • agent (string) - An agent party identifier can be retrieved from rescource party.

  • estimated (object)

    • enrolments (number) - Estimated number of enrolments.
    • revenue (number) - Estimated revenue from enrolments.
    • close-date (string) - Estimated close date for the sales lead. Date in ISO8601 format.
  • actual (object)

    • enrolments (number) - Actual number of enrolments. Read Only
    • revenue (number) - Actual revenue from enrolments. Read Only
    • close-date (string) - Actual close date for the sales lead. Date in ISO8601 format. Read Only
  • net (object)

    • enrolments (number) - Net number of enrolments. Read Only
    • revenue (number) - Net revenue from enrolments. Read Only
    • close-date (string) - Net close date for the sales lead. Date in ISO8601 format. Read Only

List
GET/webservice/sales_lead{?name}

List sales leads

Example URI

GET https://subdomain.jobreadyplus.com/webservice/sales_lead?name=Sales one
URI Parameters
HideShow
name
string (optional) Example: Sales one

The name of the sales lead

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/sales_lead

Create a Sales lead

Example URI

POST https://subdomain.jobreadyplus.com/webservice/sales_lead
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200

Retrieve
GET/webservice/sales_lead/{id}

Find sales lead

Example URI

GET https://subdomain.jobreadyplus.com/webservice/sales_lead/1
URI Parameters
HideShow
id
number (required) Example: 1

ID of the Sales lead

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/sales_lead/{id}

Updates a sales lead

Example URI

POST https://subdomain.jobreadyplus.com/webservice/sales_lead/1
URI Parameters
HideShow
id
number (required) Example: 1

ID of the Sales lead

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Invoice

Ad-hoc fields: No

Invoice

An Invoice has the following attributes:

  • invoice-number (string) - Automatically generated for new records unless explicitly specified.

  • invoice-date (string, required) - Automatically defaulted to created date for new records unless explicitly specified, in ISO 8601 format.

  • internal-reference (string) - Used to set an invoice ID from an integrated finance system.

  • purchase-order-identifier (string) - Used to track a related purchase order ID for the invoice.

  • party-identifier (string, required) - The party identifier of a valid party.

  • delivery-method (string, required) - Delivery method options. Reference data table_name: Delivery_Method.

  • description (string) - Short note about the invoice.

  • category (string) - Category of the invoice. Reference data table_name: Ledger_Category.

  • payment-term-days (number) - Number of days to be paid, eg: ‘30’.

  • status (reference, required) - Status of the invoice. Reference data table_name: Invoice_Status.

  • created-on (string) - Created on timestamp in ISO 8601 format. Read-Only

  • updated-on (string) - Updated on timestamp in ISO 8601 format. Read-Only

  • invoice_items (array[object])

    • invoice_item (object)
      • id (number, optional) - Automatically generated – cannot be assigned.
      • quantity (number) - Defaults to 1 if not specified.
      • ledger-code (string, required) - A valid ledger code. Reference data table_name: Ledger_Code_Lookup.
      • description (string) - Short description about the line item.
      • Job-account (string) - A valid job code. Reference data table_name: Job_Account.
      • amount: 199.99 (number, required) - An amount being paid in this transaction for the line item. Can be the full or partial amount for the line item. Format: 2 decimal precision float.
      • tax-treatment (string) - A valid tax treatment code. Reference data table_name: Tax_Treatment.
      • tax-amount (number) - Total tax amount. Format: 2 decimal precision float. Read-Only
      • sub-total (number) - Total amount including tax. Format: 2 decimal precision float. Read-Only

List
GET/webservice/invoices{?party_id,invoice_number,created_since,updated_since,invoice_date,enrolment_identifier,ledger_code}

List invoices

Example URI

GET https://subdomain.jobreadyplus.com/webservice/invoices?party_id=PRT123&invoice_number=INV123&created_since=2017-11-20&updated_since=2017-11-20&invoice_date=2017-11-20&enrolment_identifier=&ledger_code=
URI Parameters
HideShow
party_id
string (optional) Example: PRT123

Find invoices by party id

invoice_number
string (optional) Example: INV123

Find invoices by invoice number

created_since
string (optional) Example: 2017-11-20

Find invoices created since, date+time in ISO 8601 format

updated_since
string (optional) Example: 2017-11-20

Find invoices updated since, date+time in ISO 8601 format

invoice_date
string (optional) Example: 2017-11-20

Find invoices by invoice date

enrolment_identifier
string (required) 

Find invoices by enrolment identifier

ledger_code
string (required) 

Find invoices by ledger code

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/invoices

Create an invoice

Example URI

POST https://subdomain.jobreadyplus.com/webservice/invoices
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201

Retrieve
GET/webservice/invoice/{invoice_number}

Find invoice

Example URI

GET https://subdomain.jobreadyplus.com/webservice/invoice/ABC123
URI Parameters
HideShow
invoice_number
string (required) Example: ABC123

Invoice number

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/invoice/{invoice_number}

Updates an invoice

Example URI

POST https://subdomain.jobreadyplus.com/webservice/invoice/ABC123
URI Parameters
HideShow
invoice_number
string (required) Example: ABC123

Invoice number

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Payments

Ad-hoc fields: No

Payments

A Payment has the following attributes:

  • invoice-number (string) - The invoice number for which the payment was made. Read-Only

  • payment-date (string) - Automatically defaulted to created date for new records unless explicitly specified, in ISO 8601 format. Read-Only

  • party-identifier (string, required) -The party identifier of a valid party. resource party

  • type (string, required) - Refers to the type of payment [table_name: payment_type] (#reference-data-reference-data-get-1)

  • description (string) - The payment description

  • source (string, required) - Refers to the source of payment [table_name: payment_source] (#reference-data-reference-data-get-1)

  • amount-total (number) - Total payment amount. Payment amounts are created on the Payment Item child resource. resource Payment Item

  • location (string) - Reference data table_name: contact_location.

  • enabled (boolean, required) - States whether or not the payment is enabled

  • created-at (string) - Created at timestamp in ISO 8601 format. Read-Only

  • updated-at (string) - Updated at timestamp in ISO 8601 format. Read-Only

  • payment_items (array[object])

    • payment_item (object)
      • invoice-item-id (number) - Used to assign a Payment Item to an Invoice Item. If left blank, the first Invoice Item will be used. Read-Only
      • quantity (number) - Quantity of payment items Read Only
      • ledger-code (string) - References from [table_name: ledger_code_lookup] (#reference-data-reference-data-get-1) Read Only
      • ledger-account-name (string) - Can be found under Menu item Administration > Lookups > References > Ledger Code Lookup Read Only
      • description (string) - Description of the payment item Read Only
      • amount (number) - Total Invoice line item amount Read Only
      • paid-to-date (number) - Total amount paid to date for the line item Read Only
      • payment-amount (number) - Amount being paid in this transaction for the line item. Can be the full or partial amount for the line item.

List
GET/webservice/payments{?invoice_number,created_since,updated_since,payment_date,location}

List all payments

Example URI

GET https://subdomain.jobreadyplus.com/webservice/payments?invoice_number=INVJOB50521&created_since=2016-01-01&updated_since=2016-06-02&payment_date=2016-06-02&location='Sydney'
URI Parameters
HideShow
invoice_number
string (optional) Example: INVJOB50521

Find by invoice number

created_since
string (optional) Example: 2016-01-01

Find records created since this date in ISO 8601 format

updated_since
string (optional) Example: 2016-06-02

Find records updated since this date in ISO 8601 format

payment_date
string (optional) Example: 2016-06-02

Find by payment date

location
string (optional) Example: 'Sydney'

Find by location

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/payments

Create a Payment

Example URI

POST https://subdomain.jobreadyplus.com/webservice/payments
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201

Credit Note

Ad-hoc fields: No

Credit Note

A Credit Note has the following attributes:

  • credit-note-number (string) - Automatically generated for new records unless explicitly specified.

  • invoice-number (string) - Automatically generated for new records unless explicitly specified.

  • credit-note-date (string) - Automatically defaulted to created date for new records unless explicitly specified, in ISO 8601 format.

  • party-identifier (string, required) - The party identifier of a valid party.

  • delivery-method (string, required) - Delivery method options. Reference data table_name: Delivery_Method.

  • description (string) - Short note about the credit note.

  • category (reference) - Category of the credit note. Reference data table_name: Ledger_Category.

  • payment-due-terms (number) - Number of days due for the payment, eg: ‘30’.

  • status (string, required) - Status of the credit note. Reference data table_name: Invoice_Status.

  • created-on (string) - Created on timestamp in ISO 8601 format. Read-Only

  • updated-on (string) - Updated on timestamp in ISO 8601 format. Read-Only

  • credit_note_items (array[object])

    • credit_note_item (object)
      • quantity (number, optional) - Defaults to 1 if not specified.
      • ledger-code (string, required) - A valid ledger code. Reference data table_name: Ledger_Code_Lookup.
      • ledger-account-name (string, required) - A valid ledger account name. Reference data table_name: Ledger_Code_Lookup.
      • description (string) - Short description about the line item.
      • job (string) - A valid job code. Reference data table_name: Job_Account.
      • amount-ex: -199.99 (number, required) - A negative amount being paid in this transaction for the line item. Can be the full or partial amount for the line item. Format: 2 decimal precision float.
      • tax-treatment (string, required) - A valid tax treatment code. Reference data table_name: Tax_Treatment.
      • tax-amount (number) - Total tax amount. Format: 2 decimal precision float. Read-Only
      • sub-total (number) - Total amount including tax. Format: 2 decimal precision float. Read-Only

List
GET/webservice/credit_notes{?party_id,credit_note_number,invoice_number,created_since,updated_since,credit_note_date}

List credit notes

Example URI

GET https://subdomain.jobreadyplus.com/webservice/credit_notes?party_id=PART123&credit_note_number=CRN123&invoice_number=INV123&created_since=2017-11-20&updated_since=2017-11-20&credit_note_date=2017-11-20
URI Parameters
HideShow
party_id
string (optional) Example: PART123

Find credit notes by party id

credit_note_number
string (optional) Example: CRN123

Find credit notes by credit note number

invoice_number
string (optional) Example: INV123

Find credit notes by invoice number

created_since
string (optional) Example: 2017-11-20

Find credit notes created since, date+time in ISO 8601 format

updated_since
string (optional) Example: 2017-11-20

Find credit notes updated since, date+time in ISO 8601 format

credit_note_date
string (optional) Example: 2017-11-20

Find credit notes by credit note date

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/credit_notes

Create a credit note

Example URI

POST https://subdomain.jobreadyplus.com/webservice/credit_notes
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201

Retrieve
GET/webservice/credit_note/{credit_note_number}

Find a credit note

Example URI

GET https://subdomain.jobreadyplus.com/webservice/credit_note/ABC123
URI Parameters
HideShow
credit_note_number
string (required) Example: ABC123

credit note number

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/credit_note/{credit_note_number}

Update a credit note

Example URI

POST https://subdomain.jobreadyplus.com/webservice/credit_note/ABC123
URI Parameters
HideShow
credit_note_number
string (required) Example: ABC123

credit note number

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Refunds

Ad-hoc fields: No

Refund

A refund can be created against an invoice belonging to an individual or employer resource party. A Refund has the following attributes:

  • invoice-number (string) - The invoice number for which the payment was made. Read-Only

  • refund-date (string) - Automatically defaulted to created date for new records unless explicitly specified, in ISO 8601 format. Read-Only

  • party-identifier (string, required) -The party identifier of a valid party. resource party

  • type (string, required) - Refers to the type of payment table_name: payment_type

  • description (string) - The payment description

  • source (string, required) - Refers to the source of payment table_name: payment_source

  • amount-total (number) - Total payment amount. Payment amounts are created on the Payment Item child resource. resource Payment Item Read Only

  • location (string) - Reference data table_name: contact_location.

  • enabled (boolean, required) - States whether or not the payment is enabled

  • created-at (string) - Created at timestamp in ISO 8601 format. Read-Only

  • updated-at (string) - Updated at timestamp in ISO 8601 format. Read-Only

  • refund_items (array[object])

    • refund_item (object)
      • invoice-item-id (number) - Used to assign a Refund Item to an Invoice Item. If left blank, the first Invoice Item will be used. Read-Only
      • quantity (number) - Quantity of refund items Read Only
      • ledger-code (string) - References from table_name: ledger_code_lookup Read Only
      • ledger-account-name (string) - Can be found under Menu item Administration > Lookups > References > Ledger Code Lookup Read Only
      • description (string) - Description of the refund item Read Only
      • amount (number) - Total Invoice line item amount. Format: 2 decimal precision float. Read Only
      • paid-to-date (number) - Total amount paid to date for the line item Read Only
      • refund-amount: -199.99 (number, required) - A negative amount being paid in this transaction for the line item. Can be the full or partial amount for the line item. Format: 2 decimal precision float.

List
GET/webservice/refunds{?invoice_number,created_since,updated_since,refund_date,location}

List all payments

Example URI

GET https://subdomain.jobreadyplus.com/webservice/refunds?invoice_number=INVJOB50521&created_since=2016-01-01&updated_since=2016-06-02&refund_date=2016-06-02&location='Sydney'
URI Parameters
HideShow
invoice_number
string (optional) Example: INVJOB50521

Find by invoice number

created_since
string (optional) Example: 2016-01-01

Find records created since this date in ISO 8601 format

updated_since
string (optional) Example: 2016-06-02

Find records updated since this date in ISO 8601 format

refund_date
string (optional) Example: 2016-06-02

Find by refund date

location
string (optional) Example: 'Sydney'

Find by location

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/parties/{party_id}/refunds

Create a Refund

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/S12D34/refunds
URI Parameters
HideShow
party_id
string (optional) Example: S12D34

Find by party id

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201

Document

Ad-hoc fields: No

Document

A document has the following attributes:

  • id (number) - The unique document id. Read-Only

  • name (string) - The document’s name.

  • description (string) - Description of the document

  • document_category (string, required) - Category of the document, e.g ‘Certificate’. Reference data table_name: document_category.

  • document_type (string) - The document type, e.g ‘Multimedia’ Reference data table_name: document_type.

  • order_by (number) - Custom sort order number for the document that needs to be greater than 0, e.g ‘4’

  • online (boolean) - States whether or not the document is available on additional portals

  • web_public (boolean) - States whether or not the document is available to everyone without authentication. Default: false

  • filename (string) - File contents for upload as multipart/form-data

  • url (string) - URL where document file can be downloaded

List
GET/webservice/parties/{party_identifier}/documents/

List all documents of a party

Example URI

GET https://subdomain.jobreadyplus.com/webservice/parties/1/documents/
URI Parameters
HideShow
party_identifier
string (required) Example: 1

Find by party

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Create
POST/webservice/parties/{party_identifier}/documents/

Create a document

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/1/documents/
URI Parameters
HideShow
party_identifier
string (required) Example: 1

Find by party

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  201

Retrieve
GET/webservice/parties/{party_identifier}/documents/{id}

Find a document

Example URI

GET https://subdomain.jobreadyplus.com/webservice/parties/1/documents/1
URI Parameters
HideShow
party_identifier
string (required) Example: 1

Find by party

id
number (required) Example: 1

Find by document id

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Update
POST/webservice/parties/{party_identifier}/documents/{id}

Updates a document

Example URI

POST https://subdomain.jobreadyplus.com/webservice/parties/1/documents/1
URI Parameters
HideShow
party_identifier
string (required) Example: 1

Find by party

id
number (required) Example: 1

Find by document id

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  202
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Reference Data

Reference Data

List Reference Tables
GET/webservice/references

List all the reference tables.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/references
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Get Reference Table Data
GET/webservice/references/{table_name}

Returns reference data of that table.

Example URI

GET https://subdomain.jobreadyplus.com/webservice/references/table_name
URI Parameters
HideShow
table_name
string (required) 

The unique ID could be found on “/webservices/references” page as <table-name>

Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Party Authentication

Party Authentication

A Party Authentication request has the following attributes:

  • party (object)
    • login (string) - The party login username
    • password (string) - The clear text user password

Verify party authentication
POST/webservice/party_authentication

Returns valid_password: true/false to indicate if the provided details are current.

Example URI

POST https://subdomain.jobreadyplus.com/webservice/party_authentication
Request
HideShow
Headers
Content-Type: application/xml; charset=utf-8
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/xml; charset=utf-8

Generated by aglio on 15 Feb 2018