aXcelerate RESTful API Dashboard
Database Welcome to the aXcelerate API Dashboard

Welcome to our API Dashboard. This relax console was created by the developers at ColdBox.

Getting Started

This section will give you brief introduction to the aXcelerate RESTFul Service API and what you need to know to get started. This documentation is aimed at developers who have knowledge and experience implementing RESTful services.

About REST

Our APIs are implemented as a RESTful service. All responses are returned as JSON structures. Unlike SOAP, REST is implemented using standard HTTP calls with data transmitted via formfields (for POST) and URL variables (for GET). This is a standard Web architecture and the Internet has hundreds of examples and tutorials for you to check if you are not familiar with REST.

aXcelerate Authentication

To access the APIs, you must have 2 tokens: A Web Service Token and an API Token. These tokens act as your key, enabling the server to authenticate your access. The keys should be kept secret - as they allow direct access to your aXcelerate account - much like a username / password.
If you do not yet have tokens, contact our service team via the aXcelerate Support System using the Client Request Form or call 07 3215 8888.

The Relax Console

The relax console you are currently using is based on a 3rd-party module developed by the people at Coldbox. This console is not the actual APIs, but a tool in order to test calls to the APIs. You can, of course, use any number of other tools for this. Some examples include SoapUI, or Hurl.it, and the Google Chrome browser has extensions such as the Dev HTTP Client. On the left hand sidebar you will see several links to the various sections:

Services Overview

This will give you a quick overview of our APIs, and mentions the global headers (your tokens) needed with every request.

Defined Resources

In REST, a resource is a URL that allows your system to make calls and perform functions. This section will list all available resources and give you information on how to use each one, what parameters are required, and what the format is of the return.

HTTP Codes

This is a standard list of HTTP status codes. In REST, return status codes are very important. Most calls you make will (hopefully) return a standard 200 status code. However, if there are errors in your request (for example, you have forgotten to provide a surname when creating a contact) the status code will return a number corresponding to the error. In some cases this will also include a message, detailing the nature of the error.
For more information on the return error structure, see Error Handling below.

FAQ

As you'd expect, this section is a list of Frequently Asked Questions. Please consult this before emailing support as chances are your question is here.

Testing with the Relax Console

Above you will see a link that says AxcelerateURL, this will take you to the testing console. This console is a powerful tool that easily allows developers to test REST calls against our APIs. Below we will explain the steps for a few basic tests.

Getting contact details

This first example is a simple GET call to read contact details for a known contact. (We use contactID 123)

1. Choose Resource

On the sidebar on the right, choose the resource (Staging or Production) to test against. You will see that the dropdown has all defined resources. Choose the one that says: /contact/:contactID
Once this is selected you will see that the URL is populated in the form, the selected method should be GET. In our example, we will be using Staging, so our URL should be: https://stg.axcelerate.com.au/api/contact/:contactID

2. Authentication Headers

Click the GEAR icon. This opens the settings panel. Here is where you will need to add all your parameters, including your aXcelerate tokens.
Click on the PLUS icon under API Headers. In the first box enter apitoken, and in the second box the value of your token. Click the PLUS icon again to add your wstoken.
Note: A common error is to enter your tokens as API Parameters. This will not work. Your tokens must be sent as headers in every aXcelerate API request. Another common error is to enter your aXcelerate username and password in the HTTP Basic Authentication area. This will not work. You must use the API tokens.

3. Set Parameters: Choose a contactID

From aXcelerate, find a contact that you'd like to get the details for and get the contactID. (We also have a search function, but for this example, you need to know the contactID of someone in your system.)
Let say, for example, the contactID is 123. You need to replace in the URL where it says :contactID with the number. Now, for our example, the URL should look like: https://stg.axcelerate.com.au/api/contact/123
Note: This contactID will not work for you. You must get a real contact from your own aXcelerate account.

4. Send the request

That's all that's needed for this GET request example. For some more complex requests, such as enrol or payment, you will need API Parameters as well.
Click the arrow icon next to the gear icon to send the request. Once sent, the console should populate the 4 tabs with the results. The first tab, Response Headers, should contain a Request Status with the status code 200 Success. If you click on Pretty Results you should see the return JSON data structure of your selected contact.

Enrolling a contact

This second example is a simple POST request. We will use this to enrol contact 123 into course 22500 which is a workshop (type w).

1. Choose Resource

Choose the resource: /course/enrol
Once this is selected you will see that the URL is populated in the form, and that the selected method is POST. Note that unlike the previous GET contact example, the URL itself does not contain any dynamic information. All parameters will be set later in the API Parameters section.

2. Authentication Headers

If not already done, add your tokens under the API Headers section as discussed in the previous example.

3. Set Parameters

From aXcelerate, find a contact and a workshop that you'd like to enrol into. You will need the contactID and the Workshop ID. The workshop ID (possibly called something else in your system as it uses client-defined terminology) can be found on the workshop view page. You can also see it in the URL of this page as PDataID. Note: In order to enrol in a workshop, the workshop must meet the eligibility requirements in your set up. See the FAQs for a discussion on which workshops you can and cannot enrol into.
The parameters are set in the API Parameters section. Click the plus PLUS and add each of these parameters, in any order (with the name in one box and the value in the other):
contactID = 123
instanceID = 22500
type = w

Note: This example values will not work for you! You must get a real data from your own aXcelerate account.

4. Send the request

Assuming all your IDs were correct and the workshop can be enrolled into, in the Pretty Results tab you should see the return JSON data structure giving you a new unique LEARNERID. If you check this course in your aXcelerate system, you will see the new student as a booked participant.

Error Handling

Aside from the status codes, aXcelerate has a standard error struct that is returned whenever something goes wrong. This includes validation errors, as well as unexpected application errors. The structure is below:

Name Type Description
error boolean The will always be true, as it is always present if the error struct is returned.
code string Corresponds to the HTTP Status code of the error (See HTTP Codes on the left)
messages string A message the describes the type of error. This message is generally short and is usually the same message that corresponds to the returned status code.
details string A more detailed explaination of the error. For validation errors, for example, this would be a list of validation problems.
data string May contain extra exception data. Not currently used.
Validation error example
{
    "details": "surname is undefined in the request collection.,emailAddress is undefined in the request collection.",
    "error": true,
    "data": "",
    "code": "412",
    "messages": "Validation Error."
}
Bad token error example
{
    "details": "A valid API token must exist in the HTTP header in order to use this API",
    "error": true,
    "data": "",
    "code": "401",
    "messages": "No API token provided"
}

Coding Example

Below are a few simple examples in server-side code. We will use the same example as above, getting details for contactID: 123.

Coldfusion
<!--- Token data hidden on your server --->
<cfset WSTOKEN = "[WEB_TOKEN]" />
<cfset APITOKEN = "[API_TOKEN]" />
<!--- Set dynamic data here, could be from settings or a form etc. --->
<cfset contactid = "123" />
<!--- Call API --->
<cfhttp method="get" url="https://stg.axcelerate.com.au/api/contact/#contactid#" result="APIResult">
	<cfhttpparam type="header" name="wstoken" value="#WSTOKEN#" />
	<cfhttpparam type="header" name="apitoken" value="#APITOKEN#" />
</cfhttp>
<cfset resultsJSON = {error=true}>
<cfif IsJSON(APIResult.filecontent)>
	<cfset resultsJSON = deserializeJSON(APIResult.filecontent)>
</cfif>
<!--- Next it is important to always check and handle error conditions --->
<cfif APIResult.status_code neq "200" or StructKeyExists(resultsJSON, "error")>
    <cfset viewMessage = StructKeyExists(resultsJSON, "details") ? resultsJSON.details : "An API error occurred." />
<cfelse>
    <!--- Normal contact processing --->
    <cfset contactName = resultsJSON.givenName & " " & resultsJSON.surname />
    <!--- etc..... --->
<cfif>
PHP

This example uses cURL and is based on code found here.

// Token data hidden on your server
$_WSTOKEN = '[WEB_TOKEN]';
$_APITOKEN = '[API_TOKEN]';

// Set dynamic data here, could be from settings or a form etc.
$contactid = '123';

// Note for GET requests, all parameters are set in the URL
$service_url = 'https://stg.axcelerate.com.au/api/contact/'.$contactid;
$headers = array(
    'wstoken: '.$_WSTOKEN, 
    'apitoken: '.$_APITOKEN
);

$curl = curl_init($service_url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);

// Call API
$curl_response = curl_exec($curl);

// Error handling etc.. see the link above

aXcelerate RESTFul Service

RESTFul API for interfacing with aXcelerate. All responses are returned as JSON structures (XML is not supported at this time).

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api

API Return Formats

This service can detect the incoming resource extension in order to provide to you the resource represented according to the extension:

	resource.{format}
	resource.json
	resource.xml

Service Extension Detection: No
Allowed Extensions: json
Throw On Invalid Extension: Yes

API Global Headers

Header Type Required Default Description
apitoken string true Needed for request authentication.
wstoken string true Needed for request authentication. Relates to an aXcelerate user and permissions

API Global Parameters

No global parameters
Parameter Type Required Default Description

Resource Definitions

The following are all the resources defined in the aXcelerate RESTFul Service API

print   print

resource /accounting/invoice/:invoiceID

Description

Get the details of an invoice / Update an invoice (NOTE: Currently you can only Lock Items and Finalise)

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/accounting/invoice/:invoiceID

Pattern: /accounting/invoice/:invoiceID
Handler: api.accounting.invoice
Action: {PUT={update}, GET={read}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/accounting/invoice/:invoiceID
Placeholder Type Required Default Description
invoiceID numeric true The invoiceID to retrieve. Note that this is NOT the same as the invoice number
HTTP Request Methods

Supported: GET,PUT
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
lock boolean false Lock the items on this invoice. (No more changes can be made to line items.) You cannot unlock items by passing 'false'.
finalise boolean false Finalise this invoice. (No more changes can be made to this invoice.)
Response Default Response Format: JSON

Samples

Invoice returned in JSON format

{
	"INVOICENR": "INV0002",
	"CONTACTNAME": "Scott Jones",
	"PRICEGROSS": 20,
	"SHIPSTREET": "Williams Street",
	"HOUSENR": "61",
	"ISARCHIVED": true,
	"ADDRESS2": null,
	"ORDERDATE": "2014-06-02",
	"OWNERCONTACTID": 445036,
	"ORGANISATION": "My Org. (Geelong) Pty Ltd",
	"CONTACTID": 507615,
	"SHIPLASTNAME": "Jones",
	"SHIPHOUSENR": "61",
	"SHIPPRICEGROSS": 0,
	"SHIPCITY": "BREAKWATER",
	"SHIPPOSTCODE": "3219",
	"SHIPCOUNTRY": "AUSTRALIA",
	"SHIPCOUNTRYISO3166": "AU",
	"ISINVOICENRLOCKED": true,
	"SHIPTAXPERCENT": 0,
	"SHIPPRICETAX": 0,
	"STATE": "VIC",
	"FIRSTNAME": "Scott",
	"COMMENT": null,
	"SHIPADDRESS2": null,
	"PHONENR": "0393804116",
	"SHIPFIRSTNAME": "Scott",
	"CITY": "BREAKWATER",
	"COUNTRY": "AUSTRALIA",
	"COUNTRYISO3166": "AU",
	"PAYMENTS": [],
	"ORDERNR": null,
	"EMAIL": "sjones@abcd.com.au",
	"DUEDATE": "2014-06-09",
	"PRICENETT": 18.18,
	"SHIPORGANISATION": "My Org. (Geelong) Pty Ltd",
	"INVOICEID": 61645,
	"DUEDATEOFFSET": 7,"AREITEMSLOCKED": true,
	"LASTNAME": "Jones",
	"STREET": " Williams Street",
	"INVGUID": "8A47F4A9-AF26-46BC-9BA7F91D87C0C54E",
	"BALANCE": 0,
	"ITEMS": [
		{
			"TOTALTAX": 1.82,
			"UNITPRICETAX": 1.82,
			"DOMAINID": 0,
			"PARTID": 0,
			"UNITPRICENETT": 18.18,
			"QTY": 1,
			"TAXPERCENT": 10,
			"TOTALGROSS": 20,
			"ITEMCODE": "123",
			"FINANCECODE": null,
			"TOTALNETT": 18.18,
			"SERVICEDATE": null,
			"UNITPRICEGROSS": 20,
			"ITEMID": 114872,
			"DESCRIPTION": "test",
			"COSTCENTRECODE": null
		}
	],
	"INVOICEDATE": "2014-06-02",
	"CURRENCY": "AUD",
	"POSTCODE": "3219",
	"SHIPPRICENETT": 0,
	"ISPAID": false,
	"SHIPSTATE": "VIC"
}
print   print

resource /accounting/creditnote/:creditnoteID

Description

Get the details of a credit note / Update a credit note (NOTE: Currently you can only Lock Items and Finalise)

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/accounting/creditnote/:creditnoteID

Pattern: /accounting/creditnote/:creditnoteID
Handler: api.accounting.creditnote
Action: {PUT={update}, GET={read}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/accounting/creditnote/:creditnoteID
Placeholder Type Required Default Description
creditnoteID numeric true The creditnoteID to retrieve. Note that this is NOT the same as the credit note number
HTTP Request Methods

Supported: GET,PUT
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
lock boolean false Lock the items on this credit note. (No more changes can be made to line items.) You cannot unlock items by passing 'false'.
finalise boolean false Finalise this credit note. (No more changes can be made to this invoice.)
Response Default Response Format: JSON
No Response Definitions Defined
print   print

resource /accounting/transaction/

Description

Record a new transaction. This can optionally be applied against an invoice. Coming soon: Get transaction by GUID

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/accounting/transaction/

Pattern: /accounting/transaction/
Handler: api.accounting.transaction
Action: {POST={create}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/accounting/transaction/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers No Headers
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
amount numeric true Transaction amount in dollars
contactID numeric true The contact to record the transaction against. This should be the person who paid.
invoiceID numeric false If applied, this transaction will be recorded and then applied against this invoice.
paymentMethodID numeric false 2 Recorded payment method. The options are: 1=Cash, 2=Credit Card, 4=Direct Deposit, 5=Cheque, 6=EFTPOS
transDate datetime false Now() The date of the transaction.
reference string false An optional reference / reciept number
description string false An optional description
ChequeNr string false Optional. For cheque types (5)
ChequeDrawer string false Optional. For cheque types (5)
BankName string false Optional. For cheque types (5)
BankBSB string false Optional. For cheque types (5). Must be a 6-digit number if passed
Response Default Response Format:

Samples

Will return a transaction JSON object to represent the new transaction. To check if an amount was assigned to the invoice (if applicable), see the fragments array in the returned struct.

{
	"CHEQUENR": null,
	"CONTACTID": 445036,
	"GUID": "85052D7C-0F04-45CF-A2CEB425AC1C4EDD",
	"CHEQUEDRAWER": null,
	"START": "2014-06-02 15:32",
	"UNASSIGNEDAMOUNT": 0,
	"REFERENCE": "SC00123213",
	"ISCOMPLETED": true,
	"TRANSDATE": "2014-06-02 15:32","FINISH": "2014-06-02 15:32",
	"BANKNAME": null,
	"PAYMENTMETHODID": 2,
	"BANKBSB": null,
	"CURRENCY": "AUD",
	"FRAGMENTS": [
		{
		"INVOICEID": 61645,
		"LOCKEDDATE": null,
		"ISLOCKED": 61645,
		"AMOUNT": 20,
		"FRAGMENTID": 129746
		}
	],
	"DESCRIPTION": null,
	"AMOUNT": 20
}
print   print

resource /agent

Description

This endpoint is only available for clients using the Marketing/Sales Agents feature. It returns a structure representing the data set against a marketing/sales agent. This includes custom fields, if applicable. If the user has finance view permissions, this will also return the agent's default commission rate as a percentage. Without this permission, this key will not be returned. This endpoint only supports searching by contactID. If the contactID passed is not a marketing agent, a 204 No Content will be returned.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/agent

Pattern: /agent
Handler: api.agent
Action: {GET={read}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/agent
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
contactID numeric true The contact ID of the marketing agent
Response Default Response Format: json

Samples

This example shows an agent with a default commission rate of 3%

{
    "MARKETINGAGENTID": 711,
    "CONTACTID": 222233,
    "DEFAULTCOMMISSIONRATE": 3,
    "ACTIVE": true,
    "CUSTOMFIELD_REGIONS": [
        "North Sydney",
        "Sydney CSB"
    ]
    "CUSTOMFIELD_AGENCYNUMBER": "N004343"
}
print   print

resource /contact/:contactID

Description

Interacts with a specfic contact. You can read (GET) or update (PUT) contact details. The parameters below refer only to PUT requests.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contact/:contactID

Pattern: /contact/:contactID
Handler: api.contact
Action: {PUT={update}, GET={read}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contact/:contactID
Placeholder Type Required Default Description
contactID numeric true The resource contact ID to interact with
HTTP Request Methods

Supported: GET,PUT
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
givenName string false Given (first) name. Maximum 40 characters.
surname string false Surname (last name). Maximum 40 characters.
title string false Tile/salutation
emailAddress string false Email address. Must be a valid email address
ContactActive boolean false true Retrieve Active Contact Records. Passing false will return inactive records.
dob date false Date of Birth in the format YYYY-MM-DD. This cannot be dated in the future.
sex character false Must be only a single letter. Valid values are M, F or X (for Other)
middleName string false Middle name(s). Maximum 40 characters.
phone string false Home phone number
mobilephone string false Mobile phone number
workphone string false Work phone number
fax string false Fax number
organisation string false Organisation name
position string false Position within the organisation
section string false Section within the organisation
division string false Division within the organisation
SourceCodeID numeric false The client-specific sourceID from the list set up in aXcelerate and returned from the contact/sources resource.
Password string false An optional password that can be stored against the contact/student. This password could then be used to login to the student portal. No minimum strength checking is performed by the service. It is up to the API implementors to enforce their own password policies.
HistoricClientID string false The Historical ID used with the student record. IMPORTANT IF: you have reported a person previously with a different SMS.
USI string false Unique Student Identifier (USI). A 10-digit code. If passed, this code must conform to the minimum validation: It must be 10 digits in length and consist of only capital letters and numbers, excluding I, 1, 0 and O.
LUI string false The Queensland Studies Authority Learner Unique Identifier (LUI). A 10-digit, numeric code.
TFN string false The student's Tax File Number, used for VET Student Loans reporting. The number must pass the ATO's check alorithm.
VSN string false The Victorian Student Number The VSN is a student identification number that is assigned by the Department of Education and Early Childhood Development to all students in government and non���government schools, and students in Vocational Education and Training institutions.
WorkReadyParticipantNumber string false This field was formerly knows as 'Skills for All Number'. A South Australian student identifier.
SACEStudentID string false South Australian Certificate of Education student identifier. It should consist of six numbers and one alpha letter, for e.g., 123456A.
EmergencyContact string false Name of an emergency contact
EmergencyContactRelation string false The relationship of the emergency contact (eg sister)
EmergencyContactPhone string false The phone number of the emergency contact
buildingName string false AVETMISS 7.0 fields - will take these fields over address1 and address2 if passed. Note, you cannot search contacts by these discrete fields.
unitNo string false AVETMISS 7.0 fields
streetNo string false AVETMISS 7.0 fields
streetName string false AVETMISS 7.0 fields
POBox string false AVETMISS 7.0 fields
address1 string false First line of POSTAL address - address fields will be used only if AVETMISS 7.0 fields not passed. The return structure will also include these fields.
address2 string false Second line of postal address
city string false Postal suburb, locality or town
state string false Postal state / Territory. NOTE: This field is tailored for Australia and accepts only the following values: NSW, VIC, QLD, SA, WA, TAS, NT, ACT or OTH (which means 'Other Australian Territory') or OVS (which means 'Overseas')
postcode string false Postal postcode
countryID numeric false Postal Country - a 4-digit SACC code. This is only used if the full AVETMISS 7.0 address details are passed. Otherwise this field is ignored. Use Country instead.
country string false Postal Country
sbuildingName string false AVETMISS 7.0 fields - will take these fields over address1 and address2 if passed. Note, you cannot search contacts by these discrete fields.
sunitNo string false AVETMISS 7.0 fields
sstreetNo string false AVETMISS 7.0 fields
sstreetName string false AVETMISS 7.0 fields
sPOBox string false AVETMISS 7.0 fields
saddress1 string false First line of STREET / residential address - address fields will be deprecated with the coming of AVETMISS 7.0 which will break the address into further fields (eg Flat/unit number, Street Name)
saddress2 string false Second line of street / residential address - to be deprecated in the future
scity string false Residential suburb, locality or town
sstate string false Residential state / Territory. NOTE: This field is tailored for Australia and accepts only the following values: NSW, VIC, QLD, SA, WA, TAS, NT, ACT or OTH (which means 'Other Australian Territory') or OVS (which means 'Overseas')
spostcode string false Residential postcode
scountryID numeric false Residential Country - a 4-digit SACC code. This is only used if the full AVETMISS 7.0 address details are passed. Otherwise this field is ignored. Use SCountry instead.
scountry string false Residential Country
CountryofBirthID numeric false Country of Birth as a valid 4-digit SACC code. For a list of codes, please refer to NCVER website www.ncver.edu.au
CityofBirth string false City of Birth. This data is used if later creating a USI for this contact.
CountryofCitizenID numeric false Country of citizenship as a valid 4-digit SACC code. For a list of codes, please refer to NCVER website www.ncver.edu.au
CitizenStatusID numeric false Citizenship status. The valid values are numbers 1-11. For a list of the meanings of these numbers, please contact aXcelerate
LabourForceID numeric false AVETMISS Labour force status identifier. For valid values see the AVETMISS documentation
MainLanguageID numeric false AVETMISS Main language other than English spoken at home identifier as a valid 4-digit SACC code. For a list of codes, please refer to NCVER website www.ncver.edu.au
EnglishProficiencyID numeric false AVETMISS Proficiency in spoken English. For valid values see the AVETMISS documentation
EnglishAssistanceFlag boolean false A T/F flag to indicate whether English assistance is required
HighestSchoolLevelID numeric false AVETMISS highest school level completed identifier. For valid values see the AVETMISS documentation
HighestSchoolLevelYear numeric false The year the highest school level was completed. Must be a valid year no later than the current year
AtSchoolFlag boolean false A T/F AVETMISS flag to indicate whether the contact is currently at secondary school
AtSchoolName string false The name of the contact's current secondary school
PriorEducationStatus boolean false A T/F AVETMISS flag to indicate whether a contact has successfully completed some post-secondary education. A true value here will be ignored without also passing PriorEducationIDs.
PriorEducationIDs string false A comma delimited list of AVETMISS prior educational achievement identifiers to indicate prior higher education. For valid values see the AVETMISS documentation. The Victorian AVETMISS field Prior Educational Achievement Recognition Identifier may be appended (e.g. 420A). Also accepts @ if not specified.
DisabilityFlag boolean false A T/F AVETMISS flag to indicate whether the contact considers themselves to have a disability, impairment or long-term condition
DisabilityTypeIDs list false A comma delimited list of AVETMISS disability type identifiers. For valid values see the AVETMISS documentation
IndigenousStatusID numeric false AVETMISS indigenous status identifier to indicates a contact who self-identifies as being of Australian Aboriginal or Torres Strait Islander descent. For valid values see the AVETMISS documentation
ANZSCOCode string false Australian and New Zealand Standard Classification of Occupations (ANZSCO), ABS catalogue no.1220.0, 2009. The major group of this code is used for the Victorian AVETMISS field Client Occupation Identifier (left most digit)
ANZSICCode string false Australian and New Zealand Standard Industrial Classification (ANZSIC), ABS catalogue no.1292.0, 2006. The division of this code is used for the Victorian AVETMISS field Client Industry of Employment (see ABS catalogue)
SurveyContactStatusCode string false AVETMISS 8.0 Survey contact status - Survey contact status identifies reasons to exclude clients from the Student Outcomes Survey and other communications. For a list of possible codes, please refer to the data definitions on the NCVER website AVETMISS Data element definitions
EmailAddressAlternative string false AVETMISS 8.0 Alternate email address
employerContactID numeric false The ContactID of the Contact Record who is the Employer of this Contact.
payerContactID numeric false The ContactID of the Contact Record who is the Payer of this Contact.
supervisorContactID numeric false The ContactID of the Contact Record who is the Supervisor of this Contact.
agentContactID numeric false The ContactID of the Contact Record who is the Agent for this Contact.
coachContactID numeric false The ContactID of the Contact Record who is the Coach for this Contact.
internationalContactID numeric false The ContactID of the Contact Record who is the International Contact for this Contact (CRICOS).
optionalID string false An optional identifier to use for this Contact record.
categoryIDs array false A list of valid category IDs. (adds to Contact ONLY)
customField_[variableName] string false Replace [variableName] with the actual customField variable name to update a customField value against the contact. If updating a custom field that supports multiple values, you can use comma-delimited values or a JSON array. If using comma-delimited, it is expected the data is URL encoded first. For example, to get 2 values: 'A,B' and 'C' you would either pass: "['A,B','C']" or "A%2CB,C"
Response Default Response Format: json

Samples

The full contact information will be returned in an object.

{
    "CONTACTID": 708861,
    "GIVENNAME": "Joe",
    "SURNAME": "Bloggs",
    "EMAILADDRESS": "joe.bloggs@fakeemail.com.au",
    "SEX": "M",
    "DOB": "1986-05-02",
    "USI": "FAKE054321",
    "USI_VERIFIED": true,
    "USI_EXEMPTION": false,
    "TITLE": null,
    "MIDDLENAME": null,
    "PREFERREDNAME": "Joey",
    "LUI": "1234567890",
    "TFN_RECORDED": true,
    "OPTIONALID": null,
    "POSITION": "Web Guru",
    "SECTION": null,
    "DIVISION": null,
    "ORGANISATION": "VM Learning",
    "ADDRESS1": "123 Fake Street",
    "ADDRESS2": null,
    "CITY": "BRISBANE",
    "STATE": "QLD",
    "POSTCODE": "4000",
    "COUNTRY": "Australia",
    "SADDRESS1": "PO Box 1234",
    "SADDRESS2": null,
    "SCITY": "BRISBANE",
    "SSTATE": "QLD",
    "SPOSTCODE": "4000",
    "SCOUNTRY": "Australia",
    "PHONE": "(07) 9876 5432",
    "MOBILEPHONE": null,
    "WORKPHONE": "(07) 3215 8888",
    "FAX": null,
    "OTHERPHONE": null,
    "COMMENT": "This is an example contact for the API",
    "WEBSITE": "www.joebloggs.com.au",
    "CITIZENSTATUSID": 1,
    "CITIZENSTATUSNAME": "Australian Citizen",
    "COUNTRYOFBIRTHID": 8104,
    "COUNTRYOFBIRTHNAME": "United States of America",
    "CITYOFBIRTH": "New York",
    "COUNTRYOFCITIZENID": 1101,
    "COUNTRYOFCITIZENNAME": "Australia",
    "INDIGENOUSSTATUSID": 4,
    "INDIGENOUSSTATUSNAME": "No, Neither Aboriginal Nor Torres Strait Islander",
    "MAINLANGUAGEID": 1201,
    "MAINLANGUAGENAME": "English",
    "ENGLISHPROFICIENCYID": 1,
    "ENGLISHASSISTANCEFLAG": false,
    "HIGHESTSCHOOLLEVELID": 12,
    "HIGHESTSCHOOLLEVELYEAR": "2004",
    "CURRENTSCHOOLLEVEL": null,
    "ATSCHOOLFLAG": false,
    "ATSCHOOLNAME": null,
    "PRIOREDUCATIONIDS": [
        410
    ],
    "PRIOREDUCATIONNAMES": [
        "Advanced Diploma or Associate Degree Level"
    ],
    "DISABILITYFLAG": true,
    "DISABILITYTYPEIDS": [
        17
    ],
    "DISABILITYTYPENAMES": [
        "Vision"
    ],
    "LABOURFORCEID": 1,
    "LABOURFORCENAME": "Full-time employee",
    "EMERGENCYCONTACT": "Jane Bloggs",
    "EMERGENCYCONTACTRELATION": "Mother",
    "EMERGENCYCONTACTPHONE": "0433 123 123",
    "ANZSCOCODE": null,
    "ANZSICCODE": null,
    "EMPLOYERCONTACTID": 4321,
    "PAYERCONTACTID": 1234,
    "SUPERVISORCONTACTID": null,
    "COACHCONTACTID": null,
    "AGENTCONTACTID": null,
    "SACESTUDENTID": "123456A",
    "CUSTOMFIELD_MYFIELD": "Test Value",
    "CUSTOMFIELD_MYMULTIFIELD": [
        "Test Value 1",
        "Test Value 2",
    ],
    "CATEGORYIDS": [
        267,
        516,
        648,
        5868
    ]
}

If the student has full AVETMISS 7.0 discrete address fields, those fields will be returned. Note that these address fields will only be returned if the contact has data in these fields.

{
    "CONTACTID": 708861,
    "GIVENNAME": "Joe",
    "SURNAME": "Bloggs",
    "EMAILADDRESS": "joe.bloggs@fakeemail.com.au",
    "SEX": "M",
    "DOB": "1986-05-02",
    "USI": "FAKE054321",
    "USI_VERIFIED": true,
    "USI_EXEMPTION": false,
    "TITLE": null,
    "MIDDLENAME": null,
    "PREFERREDNAME": "Joey",
    "LUI": "1234567890",
    "TFN_RECORDED": false,
    "OPTIONALID": null,
    "POSITION": "Web Guru",
    "SECTION": null,
    "DIVISION": null,
    "ORGANISATION": "VM Learning",
    "BUILDINGNAME": null,
    "UNITNO": null,
    "STREETNO": "123",
    "STREETNAME": "Fake Street",
    "POBOX": null,
    "ADDRESS1": "123 Fake Street",
    "ADDRESS2": null,
    "CITY": "BRISBANE",
    "STATE": "QLD",
    "POSTCODE": "4000",
    "COUNTRYID": 1101,
    "COUNTRY": "Australia",
    "SBUILDINGNAME": null,
    "SUNITNO": null,
    "SSTREETNO": null,
    "SSTREETNAME": null,
    "SPOBOX": "PO Box 1234",
    "SADDRESS1": "PO Box 1234",
    "SADDRESS2": null,
    "SCITY": "BRISBANE",
    "SSTATE": "QLD",
    "SPOSTCODE": "4000",
    "SCOUNTRYID": 1101,
    "SCOUNTRY": "Australia",
    "PHONE": "(07) 9876 5432",
    "MOBILEPHONE": null,
    "WORKPHONE": "(07) 3215 8888",
    "FAX": null,
    "OTHERPHONE": null,
    "COMMENT": "This is an example contact for the API",
    "WEBSITE": "www.joebloggs.com.au",
    "CITIZENSTATUSID": 1,
    "CITIZENSTATUSNAME": "Australian Citizen",
    "COUNTRYOFBIRTHID": 8104,
    "COUNTRYOFBIRTHNAME": "United States of America",
    "CITYOFBIRTH": "New York",
    "COUNTRYOFCITIZENID": 1101,
    "COUNTRYOFCITIZENNAME": "Australia",
    "INDIGENOUSSTATUSID": 4,
    "INDIGENOUSSTATUSNAME": "No, Neither Aboriginal Nor Torres Strait Islander",
    "MAINLANGUAGEID": 1201,
    "MAINLANGUAGENAME": "English",
    "ENGLISHPROFICIENCYID": 1,
    "ENGLISHASSISTANCEFLAG": false,
    "HIGHESTSCHOOLLEVELID": 12,
    "HIGHESTSCHOOLLEVELYEAR": "2004",
    "CURRENTSCHOOLLEVEL": null,
    "ATSCHOOLFLAG": false,
    "ATSCHOOLNAME": null,
    "PRIOREDUCATIONIDS": [
        410
    ],
    "PRIOREDUCATIONNAMES": [
        "Advanced Diploma or Associate Degree Level"
    ],
    "DISABILITYFLAG": true,
    "DISABILITYTYPEIDS": [
        17
    ],
    "DISABILITYTYPENAMES": [
        "Vision"
    ],
    "LABOURFORCEID": 1,
    "LABOURFORCENAME": "Full-time employee",
    "EMERGENCYCONTACT": "Jane Bloggs",
    "EMERGENCYCONTACTRELATION": "Mother",
    "EMERGENCYCONTACTPHONE": "0433 123 123",
    "ANZSCOCODE": null,
    "ANZSICCODE": null,
    "EMPLOYERCONTACTID": 4321,
    "PAYERCONTACTID": 1234,
    "SUPERVISORCONTACTID": null,
    "COACHCONTACTID": null,
    "AGENTCONTACTID": null,
    "CUSTOMFIELD_MYFIELD": "Test Value",
    "CUSTOMFIELD_MYMULTIFIELD": [
        "Test Value 1",
        "Test Value 2",
        "Test Value 3",
    ],
    "CATEGORYIDS": [
        267,
        516,
        648,
        5868
    ]
}
print   print

resource /contact/

Description

Creates a new contact. This API will not try and search for any existing contact, but simply creates a new one. If you ended up creating duplicate contacts, they can be later merged by logging into aXcelerate.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contact/

Pattern: /contact/
Handler: api.contact
Action: {POST={create}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contact/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
givenName string true Given (first) name. Maximum 40 characters.
surname string true Surname (last name). Maximum 40 characters.
title string false Tile/salutation
emailAddress string false Email address. Must be a valid email address
ContactActive boolean false true Retrieve Active Contact Records. Passing false will return inactive records.
dob date false Date of Birth in the format YYYY-MM-DD. This cannot be dated in the future.
sex character false Must be only a single letter. Valid values are M, F or X (for Other)
middleName string false Middle name(s). Maximum 40 characters.
phone string false Home phone number
mobilephone string false Mobile phone number
workphone string false Work phone number
fax string false Fax number
organisation string false Organisation name
position string false Position within the organisation
section string false Section within the organisation
division string false Division within the organisation
SourceCodeID numeric false The client-specific sourceID from the list set up in aXcelerate and returned from the contact/sources resource.
Password string false An optional password that can be stored against the contact/student. This password could then be used to login to the student portal. No minimum strength checking is performed by the service. It is up to the API implementors to enforce their own password policies.
HistoricClientID string false The Historical ID used with the student record. IMPORTANT IF: you have reported a person previously with a different SMS.
USI string false Unique Student Identifier (USI). A 10-digit code. If passed, this code must conform to the minimum validation: It must be 10 digits in length and consist of only capital letters and numbers, excluding I, 1, 0 and O.
LUI string false The Queensland Studies Authority Learner Unique Identifier (LUI). A 10-digit, numeric code.
TFN string false The student's Tax File Number, used for VET Student Loans reporting. The number must pass the ATO's check alorithm.
VSN string false The Victorian Student Number The VSN is a student identification number that is assigned by the Department of Education and Early Childhood Development to all students in government and non���government schools, and students in Vocational Education and Training institutions.
WorkReadyParticipantNumber string false This field was formerly knows as 'Skills for All Number'. A South Australian student identifier.
SACEStudentID string false South Australian Certificate of Education student identifier. It should consist of six numbers and one alpha letter, for e.g., 123456A.
EmergencyContact string false Name of an emergency contact
EmergencyContactRelation string false The relationship of the emergency contact (eg sister)
EmergencyContactPhone string false The phone number of the emergency contact
buildingName string false AVETMISS 7.0 fields - will take these fields over address1 and address2 if passed. Note, you cannot search contacts by these discrete fields.
unitNo string false AVETMISS 7.0 fields
streetNo string false AVETMISS 7.0 fields
streetName string false AVETMISS 7.0 fields
POBox string false AVETMISS 7.0 fields
address1 string false First line of POSTAL address - address fields will be used only if AVETMISS 7.0 fields not passed. The return structure will also include these fields.
address2 string false Second line of postal address
city string false Postal suburb, locality or town
state string false Postal state / Territory. NOTE: This field is tailored for Australia and accepts only the following values: NSW, VIC, QLD, SA, WA, TAS, NT, ACT or OTH (which means 'Other Australian Territory') or OVS (which means 'Overseas')
postcode string false Postal postcode
countryID numeric false Postal Country - a 4-digit SACC code. This is only used if the full AVETMISS 7.0 address details are passed. Otherwise this field is ignored. Use Country instead.
country string false Postal Country
sbuildingName string false AVETMISS 7.0 fields - will take these fields over address1 and address2 if passed. Note, you cannot search contacts by these discrete fields.
sunitNo string false AVETMISS 7.0 fields
sstreetNo string false AVETMISS 7.0 fields
sstreetName string false AVETMISS 7.0 fields
sPOBox string false AVETMISS 7.0 fields
saddress1 string false First line of STREET / residential address - address fields will be deprecated with the coming of AVETMISS 7.0 which will break the address into further fields (eg Flat/unit number, Street Name)
saddress2 string false Second line of street / residential address - to be deprecated in the future
scity string false Residential suburb, locality or town
sstate string false Residential state / Territory. NOTE: This field is tailored for Australia and accepts only the following values: NSW, VIC, QLD, SA, WA, TAS, NT, ACT or OTH (which means 'Other Australian Territory') or OVS (which means 'Overseas')
spostcode string false Residential postcode
scountryID numeric false Residential Country - a 4-digit SACC code. This is only used if the full AVETMISS 7.0 address details are passed. Otherwise this field is ignored. Use SCountry instead.
scountry string false Residential Country
CountryofBirthID numeric false Country of Birth as a valid 4-digit SACC code. For a list of codes, please refer to NCVER website www.ncver.edu.au
CityofBirth string false City of Birth. This data is used if later creating a USI for this contact.
CountryofCitizenID numeric false Country of citizenship as a valid 4-digit SACC code. For a list of codes, please refer to NCVER website www.ncver.edu.au
CitizenStatusID numeric false Citizenship status. The valid values are numbers 1-11. For a list of the meanings of these numbers, please contact aXcelerate
LabourForceID numeric false AVETMISS Labour force status identifier. For valid values see the AVETMISS documentation
MainLanguageID numeric false AVETMISS Main language other than English spoken at home identifier as a valid 4-digit SACC code. For a list of codes, please refer to NCVER website www.ncver.edu.au
EnglishProficiencyID numeric false AVETMISS Proficiency in spoken English. For valid values see the AVETMISS documentation
EnglishAssistanceFlag boolean false A T/F flag to indicate whether English assistance is required
HighestSchoolLevelID numeric false AVETMISS highest school level completed identifier. For valid values see the AVETMISS documentation
HighestSchoolLevelYear numeric false The year the highest school level was completed. Must be a valid year no later than the current year
AtSchoolFlag boolean false A T/F AVETMISS flag to indicate whether the contact is currently at secondary school
AtSchoolName string false The name of the contact's current secondary school
PriorEducationStatus boolean false A T/F AVETMISS flag to indicate whether a contact has successfully completed some post-secondary education. A true value here will be ignored without also passing PriorEducationIDs.
PriorEducationIDs string false A comma delimited list of AVETMISS prior educational achievement identifiers to indicate prior higher education. For valid values see the AVETMISS documentation. The Victorian AVETMISS field Prior Educational Achievement Recognition Identifier may be appended (e.g. 420A). Also accepts @ if not specified.
DisabilityFlag boolean false A T/F AVETMISS flag to indicate whether the contact considers themselves to have a disability, impairment or long-term condition
DisabilityTypeIDs list false A comma delimited list of AVETMISS disability type identifiers. For valid values see the AVETMISS documentation
IndigenousStatusID numeric false AVETMISS indigenous status identifier to indicates a contact who self-identifies as being of Australian Aboriginal or Torres Strait Islander descent. For valid values see the AVETMISS documentation
ANZSCOCode string false Australian and New Zealand Standard Classification of Occupations (ANZSCO), ABS catalogue no.1220.0, 2009. The major group of this code is used for the Victorian AVETMISS field Client Occupation Identifier (left most digit)
ANZSICCode string false Australian and New Zealand Standard Industrial Classification (ANZSIC), ABS catalogue no.1292.0, 2006. The division of this code is used for the Victorian AVETMISS field Client Industry of Employment (see ABS catalogue)
SurveyContactStatusCode string false AVETMISS 8.0 Survey contact status - Survey contact status identifies reasons to exclude clients from the Student Outcomes Survey and other communications. For a list of possible codes, please refer to the data definitions on the NCVER website AVETMISS Data element definitions
EmailAddressAlternative string false AVETMISS 8.0 Alternate email address
employerContactID numeric false The ContactID of the Contact Record who is the Employer of this Contact.
payerContactID numeric false The ContactID of the Contact Record who is the Payer of this Contact.
supervisorContactID numeric false The ContactID of the Contact Record who is the Supervisor of this Contact.
agentContactID numeric false The ContactID of the Contact Record who is the Agent for this Contact.
coachContactID numeric false The ContactID of the Contact Record who is the Coach for this Contact.
internationalContactID numeric false The ContactID of the Contact Record who is the International Contact for this Contact (CRICOS).
optionalID string false An optional identifier to use for this Contact record.
categoryIDs list false A list of valid category IDs. (adds to Contact ONLY)
customField_[variableName] string false Replace [variableName] with the actual customField variable name to set a customField value against the contact. If updating a custom field that supports multiple values, you can use comma-delimited values or a JSON array. If using comma-delimited, it is expected the data is URL encoded first. For example, to get 2 values: 'A,B' and 'C' you would either pass: "['A,B','C']" or "A%2CB,C"
Response Default Response Format: json

Samples

Will return basic contact information in a flat object. If you want to return the full contact object, run a read request on the returned contactID

{
    "EMAILADDRESS": "jim@doors.com",
    "GIVENNAME": "Jim",
    "SURNAME": "Morrison",
    "CONTACTID": 634026
}
print   print

resource /contacts/ [DEPRECATED]

Description

DEPRECATED: Please use /contacts/search/

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contacts/ [DEPRECATED]

Pattern: /contacts/ [DEPRECATED]
Handler: api.contact
Action: {GET={search}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contacts/ [DEPRECATED]
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
displayLength numeric false 10 Maximum number of records to return (up to a system maximum of 100)
givenName string false Given (first) name
surname string false Surname (last name)
title string false Title/salutation
emailAddress string false Email address. Must be a valid email address
ContactActive boolean false true Retrieve Active Contact Records. Passing false will return inactive records.
dob date false Date of Birth in the format YYYY-MM-DD. This cannot be dated in the future.
sex character false Must be only a single letter. Valid values are M, F or X (for Other)
middleName string false Middle name(s). Maximum 40 characters.
phone string false Home phone number
mobilephone string false Mobile phone number
workphone string false Work phone number
fax string false Fax number
organisation string false Organisation name
position string false Position within the organisation
section string false Section within the organisation
division string false Division within the organisation
SourceCodeID numeric false The client-specific sourceID from the list set up in aXcelerate and returned from the contact/sources resource.
Password string false An optional password that can be stored against the contact/student. This password could then be used to login to the student portal. No minimum strength checking is performed by the service. It is up to the API implementors to enforce their own password policies.
HistoricClientID string false The Historical ID used with the student record. IMPORTANT IF: you have reported a person previously with a different SMS.
USI string false Unique Student Identifier (USI). A 10-digit code. If passed, this code must conform to the minimum validation: It must be 10 digits in length and consist of only capital letters and numbers, excluding I, 1, 0 and O.
LUI string false The Queensland Studies Authority Learner Unique Identifier (LUI). A 10-digit, numeric code.
TFN string false The student's Tax File Number, used for VET Student Loans reporting. The number must pass the ATO's check alorithm.
VSN string false The Victorian Student Number The VSN is a student identification number that is assigned by the Department of Education and Early Childhood Development to all students in government and non���government schools, and students in Vocational Education and Training institutions.
WorkReadyParticipantNumber string false This field was formerly knows as 'Skills for All Number'. A South Australian student identifier.
SACEStudentID string false South Australian Certificate of Education student identifier. It should consist of six numbers and one alpha letter, for e.g., 123456A.
EmergencyContact string false Name of an emergency contact
EmergencyContactRelation string false The relationship of the emergency contact (eg sister)
EmergencyContactPhone string false The phone number of the emergency contact
buildingName string false AVETMISS 7.0 fields - will take these fields over address1 and address2 if passed. Note, you cannot search contacts by these discrete fields.
unitNo string false AVETMISS 7.0 fields
streetNo string false AVETMISS 7.0 fields
streetName string false AVETMISS 7.0 fields
POBox string false AVETMISS 7.0 fields
address1 string false First line of POSTAL address - address fields will be used only if AVETMISS 7.0 fields not passed. The return structure will also include these fields.
address2 string false Second line of postal address
city string false Postal suburb, locality or town
state string false Postal state / Territory. NOTE: This field is tailored for Australia and accepts only the following values: NSW, VIC, QLD, SA, WA, TAS, NT, ACT or OTH (which means 'Other Australian Territory') or OVS (which means 'Overseas')
postcode string false Postal postcode
countryID numeric false Postal Country - a 4-digit SACC code. This is only used if the full AVETMISS 7.0 address details are passed. Otherwise this field is ignored. Use Country instead.
country string false Postal Country
sbuildingName string false AVETMISS 7.0 fields - will take these fields over address1 and address2 if passed. Note, you cannot search contacts by these discrete fields.
sunitNo string false AVETMISS 7.0 fields
sstreetNo string false AVETMISS 7.0 fields
sstreetName string false AVETMISS 7.0 fields
sPOBox string false AVETMISS 7.0 fields
saddress1 string false First line of STREET / residential address - address fields will be deprecated with the coming of AVETMISS 7.0 which will break the address into further fields (eg Flat/unit number, Street Name)
saddress2 string false Second line of street / residential address - to be deprecated in the future
scity string false Residential suburb, locality or town
sstate string false Residential state / Territory. NOTE: This field is tailored for Australia and accepts only the following values: NSW, VIC, QLD, SA, WA, TAS, NT, ACT or OTH (which means 'Other Australian Territory') or OVS (which means 'Overseas')
spostcode string false Residential postcode
scountryID numeric false Residential Country - a 4-digit SACC code. This is only used if the full AVETMISS 7.0 address details are passed. Otherwise this field is ignored. Use SCountry instead.
scountry string false Residential Country
CountryofBirthID numeric false Country of Birth as a valid 4-digit SACC code. For a list of codes, please refer to NCVER website www.ncver.edu.au
CityofBirth string false City of Birth. This data is used if later creating a USI for this contact.
CountryofCitizenID numeric false Country of citizenship as a valid 4-digit SACC code. For a list of codes, please refer to NCVER website www.ncver.edu.au
CitizenStatusID numeric false Citizenship status. The valid values are numbers 1-11. For a list of the meanings of these numbers, please contact aXcelerate
LabourForceID numeric false AVETMISS Labour force status identifier. For valid values see the AVETMISS documentation
MainLanguageID numeric false AVETMISS Main language other than English spoken at home identifier as a valid 4-digit SACC code. For a list of codes, please refer to NCVER website www.ncver.edu.au
EnglishProficiencyID numeric false AVETMISS Proficiency in spoken English. For valid values see the AVETMISS documentation
EnglishAssistanceFlag boolean false A T/F flag to indicate whether English assistance is required
HighestSchoolLevelID numeric false AVETMISS highest school level completed identifier. For valid values see the AVETMISS documentation
HighestSchoolLevelYear numeric false The year the highest school level was completed. Must be a valid year no later than the current year
AtSchoolFlag boolean false A T/F AVETMISS flag to indicate whether the contact is currently at secondary school
AtSchoolName string false The name of the contact's current secondary school
PriorEducationStatus boolean false A T/F AVETMISS flag to indicate whether a contact has successfully completed some post-secondary education. A true value here will be ignored without also passing PriorEducationIDs.
PriorEducationIDs string false A comma delimited list of AVETMISS prior educational achievement identifiers to indicate prior higher education. For valid values see the AVETMISS documentation. The Victorian AVETMISS field Prior Educational Achievement Recognition Identifier may be appended (e.g. 420A). Also accepts @ if not specified.
DisabilityFlag boolean false A T/F AVETMISS flag to indicate whether the contact considers themselves to have a disability, impairment or long-term condition
DisabilityTypeIDs list false A comma delimited list of AVETMISS disability type identifiers. For valid values see the AVETMISS documentation
IndigenousStatusID numeric false AVETMISS indigenous status identifier to indicates a contact who self-identifies as being of Australian Aboriginal or Torres Strait Islander descent. For valid values see the AVETMISS documentation
ANZSCOCode string false Australian and New Zealand Standard Classification of Occupations (ANZSCO), ABS catalogue no.1220.0, 2009. The major group of this code is used for the Victorian AVETMISS field Client Occupation Identifier (left most digit)
ANZSICCode string false Australian and New Zealand Standard Industrial Classification (ANZSIC), ABS catalogue no.1292.0, 2006. The division of this code is used for the Victorian AVETMISS field Client Industry of Employment (see ABS catalogue)
SurveyContactStatusCode string false AVETMISS 8.0 Survey contact status - Survey contact status identifies reasons to exclude clients from the Student Outcomes Survey and other communications. For a list of possible codes, please refer to the data definitions on the NCVER website AVETMISS Data element definitions
EmailAddressAlternative string false AVETMISS 8.0 Alternate email address
employerContactID numeric false The ContactID of the Contact Record who is the Employer of this Contact.
payerContactID numeric false The ContactID of the Contact Record who is the Payer of this Contact.
supervisorContactID numeric false The ContactID of the Contact Record who is the Supervisor of this Contact.
agentContactID numeric false The ContactID of the Contact Record who is the Agent for this Contact.
coachContactID numeric false The ContactID of the Contact Record who is the Coach for this Contact.
internationalContactID numeric false The ContactID of the Contact Record who is the International Contact for this Contact (CRICOS).
contactRoleID numeric false Filter contacts who are in a particular Contact Role.
Response Default Response Format: json

Samples

Returns an array of contact information. The following example was a search on givenName=Scott and displayLength=3. Note that the AVETMISS 7.0 address fields will also be returned if applicable to this contact. See the GET contact resource.

[
    {
        "CONTACTID": 5431,
        "GIVENNAME": "Scott",
        "SURNAME": "Whitehair  J.P.",
        "EMAILADDRESS": null,
        "SEX": null,
        "DOB": null,
        "USI": null,
        "USI_VERIFIED": false,
        "USI_EXEMPTION": false,
        "TITLE": "Mr",
        "MIDDLENAME": null,
        "PREFERREDNAME": null,
        "LUI": null,
        "TFN_RECORDED": false,
        "OPTIONALID": 917,
        "POSITION": null,
        "SECTION": null,
        "DIVISION": null,
        "ORGANISATION": "MacLeay Business Enterprise Centre Ltd",
        "ADDRESS1": "Shop 1\/28 Clyde Street",
        "ADDRESS2": null,
        "CITY": "KEMPSEY",
        "STATE": "NSW",
        "POSTCODE": "2440",
        "COUNTRY": "AUSTRALIA",
        "SADDRESS1": null,
        "SADDRESS2": null,
        "SCITY": null,
        "SSTATE": null,
        "SPOSTCODE": null,
        "SCOUNTRY": null,
        "PHONE": null,
        "MOBILEPHONE": null,
        "WORKPHONE": "065 888 888",
        "FAX": "065 888 888",
        "OTHERPHONE": null,
        "COMMENT": null,
        "WEBSITE": null,
        "CITIZENSTATUSID": null,
        "CITIZENSTATUSNAME": null,
        "COUNTRYOFBIRTHID": 1101,
        "COUNTRYOFBIRTHNAME": "Australia",
        "CITYOFBIRTH": "Cairns",
        "COUNTRYOFCITIZENID": 1101,
        "COUNTRYOFCITIZENNAME": "Australia",
        "INDIGENOUSSTATUSID": null,
        "INDIGENOUSSTATUSNAME": null,
        "MAINLANGUAGEID": null,
        "MAINLANGUAGENAME": null,
        "ENGLISHPROFICIENCYID": null,
        "ENGLISHASSISTANCEFLAG": null,
        "HIGHESTSCHOOLLEVELID": null,
        "HIGHESTSCHOOLLEVELYEAR": null,
        "CURRENTSCHOOLLEVEL": null,
        "ATSCHOOLFLAG": null,
        "ATSCHOOLNAME": null,
        "PRIOREDUCATIONIDS": [],
        "PRIOREDUCATIONNAMES": [],
        "DISABILITYFLAG": null,
        "DISABILITYTYPEIDS": [],
        "DISABILITYTYPENAMES": [],
        "LABOURFORCEID": null,
        "LABOURFORCENAME": null,
        "EMERGENCYCONTACT": null,
        "EMERGENCYCONTACTRELATION": null,
        "EMERGENCYCONTACTPHONE": null,
        "ANZSCOCODE": null,
        "ANZSICCODE": null,
	    "EMPLOYERCONTACTID": null,
	    "PAYERCONTACTID": null,
	    "SUPERVISORCONTACTID": null,
	    "COACHCONTACTID": null,
	    "AGENTCONTACTID": null,
	    "CUSTOMFIELD_MYFIELD": null,
        "CUSTOMFIELD_MYMULTIFIELD": [],
	    "CATEGORYIDS": []
    },
    },
    {
        "CONTACTID": 5653,
        "GIVENNAME": "Scott",
        "SURNAME": "Millson",
        "EMAILADDRESS": null,
        "SEX": null,
        "DOB": null,
        "USI": "FAKE512345",
        "USI_VERIFIED": false,
        "USI_EXEMPTION": false,
        "TITLE": "Mr",
        "MIDDLENAME": null,
        "PREFERREDNAME": null,
        "LUI": null,
        "TFN_RECORDED": false,
        "OPTIONALID": 1240,
        "POSITION": "Managing Editor",
        "SECTION": null,
        "DIVISION": null,
        "ORGANISATION": "The Bulletin",
        "ADDRESS1": "GPO Box 3957",
        "ADDRESS2": null,
        "CITY": "SYDNEY",
        "STATE": "NSW",
        "POSTCODE": "2000",
        "COUNTRY": "AUSTRALIA",
        "SADDRESS1": null,
        "SADDRESS2": null,
        "SCITY": null,
        "SSTATE": null,
        "SPOSTCODE": null,
        "SCOUNTRY": null,
        "PHONE": null,
        "MOBILEPHONE": null,
        "WORKPHONE": "02 9999 8000",
        "FAX": "02 9999 4359",
        "OTHERPHONE": null,
        "COMMENT": null,
        "WEBSITE": null,
        "CITIZENSTATUSID": null,
        "CITIZENSTATUSNAME": null,
        "COUNTRYOFBIRTHID": null,
        "COUNTRYOFBIRTHNAME": null,
        "CITYOFBIRTH": null,
        "COUNTRYOFCITIZENID": null,
        "COUNTRYOFCITIZENNAME": null,
        "INDIGENOUSSTATUSID": null,
        "INDIGENOUSSTATUSNAME": null,
        "MAINLANGUAGEID": null,
        "MAINLANGUAGENAME": null,
        "ENGLISHPROFICIENCYID": null,
        "ENGLISHASSISTANCEFLAG": null,
        "HIGHESTSCHOOLLEVELID": null,
        "HIGHESTSCHOOLLEVELYEAR": null,
        "CURRENTSCHOOLLEVEL": null,
        "ATSCHOOLFLAG": null,
        "ATSCHOOLNAME": null,
        "PRIOREDUCATIONIDS": [],
        "PRIOREDUCATIONNAMES": [],
        "DISABILITYFLAG": null,
        "DISABILITYTYPEIDS": [],
        "DISABILITYTYPENAMES": [],
        "LABOURFORCEID": null,
        "LABOURFORCENAME": null,
        "EMERGENCYCONTACT": null,
        "EMERGENCYCONTACTRELATION": null,
        "EMERGENCYCONTACTPHONE": null,
        "ANZSCOCODE": null,
        "ANZSICCODE": null,
	    "EMPLOYERCONTACTID": null,
	    "PAYERCONTACTID": null,
	    "SUPERVISORCONTACTID": null,
	    "COACHCONTACTID": null,
	    "AGENTCONTACTID": null,
	    "CUSTOMFIELD_MYFIELD": "Test Value",
        "CUSTOMFIELD_MYMULTIFIELD": [
            "Test Value 1",
            "Test Value 2",
        ],
	    "CATEGORYIDS": []
    },
    {
        "CONTACTID": 5691,
        "GIVENNAME": "Scott",
        "SURNAME": "Loose",
        "EMAILADDRESS": null,
        "SEX": null,
        "DOB": null,
        "USI": "FAKE912345",
        "USI_VERIFIED": true,
        "USI_EXEMPTION": false,
        "TITLE": "Mr",
        "MIDDLENAME": null,
        "PREFERREDNAME": null,
        "LUI": null,
        "TFN_RECORDED": false,
        "OPTIONALID": 1278,
        "POSITION": "Executive Director",
        "SECTION": null,
        "DIVISION": null,
        "ORGANISATION": "Queensland Manufacturing Institute",
        "ADDRESS1": "Cnr Miles Platting & Logan Road",
        "ADDRESS2": null,
        "CITY": "EIGHT MILE PLAINS",
        "STATE": "QLD",
        "POSTCODE": "4123",
        "COUNTRY": "AUSTRALIA",
        "SADDRESS1": null,
        "SADDRESS2": null,
        "SCITY": null,
        "SSTATE": null,
        "SPOSTCODE": null,
        "SCOUNTRY": null,
        "PHONE": null,
        "MOBILEPHONE": "041 999 9999",
        "WORKPHONE": "07 3333 3333",
        "FAX": "07 3333 3333",
        "OTHERPHONE": null,
        "COMMENT": "TEC Comment",
        "WEBSITE": null,
        "CITIZENSTATUSID": null,
        "CITIZENSTATUSNAME": null,
        "COUNTRYOFBIRTHID": null,
        "COUNTRYOFBIRTHNAME": null,
        "CITYOFBIRTH": null,
        "COUNTRYOFCITIZENID": null,
        "COUNTRYOFCITIZENNAME": null,
        "INDIGENOUSSTATUSID": null,
        "INDIGENOUSSTATUSNAME": null,
        "MAINLANGUAGEID": null,
        "MAINLANGUAGENAME": null,
        "ENGLISHPROFICIENCYID": null,
        "ENGLISHASSISTANCEFLAG": null,
        "HIGHESTSCHOOLLEVELID": null,
        "HIGHESTSCHOOLLEVELYEAR": null,
        "CURRENTSCHOOLLEVEL": null,
        "ATSCHOOLFLAG": null,
        "ATSCHOOLNAME": null,
        "PRIOREDUCATIONIDS": [],
        "PRIOREDUCATIONNAMES": [],
        "DISABILITYFLAG": null,
        "DISABILITYTYPEIDS": [],
        "DISABILITYTYPENAMES": [],
        "LABOURFORCEID": null,
        "LABOURFORCENAME": null,
        "EMERGENCYCONTACT": null,
        "EMERGENCYCONTACTRELATION": null,
        "EMERGENCYCONTACTPHONE": null,
        "ANZSCOCODE": null,
        "ANZSICCODE": null,
	    "EMPLOYERCONTACTID": null,
	    "PAYERCONTACTID": null,
	    "SUPERVISORCONTACTID": null,
	    "COACHCONTACTID": null,
	    "AGENTCONTACTID": null,
	    "CUSTOMFIELD_MYFIELD": "Some Other Value",
        "CUSTOMFIELD_MYMULTIFIELD": [
            "Test Value X",
        ],
	    "CATEGORYIDS": [
	    	99
	    ]
    }
]
print   print

resource /contacts/search

Description

A contact search. This method will return an array of contacts matching all the search parameters.
The field values must be an exact match OR start with the supplied parameters (i.e. wildcard on the right of the string).
You can choose to search on almost any field or use the param 'q' or 'search' to perform search across these fields: GIVENNAME, PREFERREDNAME, MIDDLENAME, SURNAME, EMAILADDRESS and MOBILEPHONE.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contacts/search

Pattern: /contacts/search
Handler: api.contact
Action: {GET={wildcardSearch}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contacts/search
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
q string false A Search String. i.e. q='Nathan Gordon'
offset numeric false 0 Record to start at.
displayLength numeric false 10 Maximum number of records to return (up to a system maximum of 100)
contactEntryDate date false yyyy-mm-dd formatted date
lastUpdated date false yyyy-mm-dd formatted date
givenName string false Given (first) name
surname string false Surname (last name)
emailAddress string false Email address. Must be a valid email address
contactRoleID numeric false Filter contacts who are in a particular Contact Role.
contactIDs numeric-list false A comma-delimited list of contactIDs to filter the result set by. This can be used in conjunction with other filters.
contactID numeric false Supplying a contact ID will perform an exact match search.
optionalID string false Supplying an Optional ID will perform an exact match search.
DOB string false yyyy-mm-dd formatted date
Response Default Response Format: json

Samples

Returns an array of contact information. The following example was a search on givenName=Scott and displayLength=3. Note that the AVETMISS 7.0 address fields will also be returned if applicable to this contact. See the GET contact resource.

[
    {
        "CONTACTID": 5431,
        "GIVENNAME": "Scott",
        "SURNAME": "Whitehair  J.P.",
        "EMAILADDRESS": null,
        "SEX": null,
        "DOB": null,
        "USI": null,
        "USI_VERIFIED": false,
        "USI_EXEMPTION": false,
        "TITLE": "Mr",
        "MIDDLENAME": null,
        "PREFERREDNAME": null,
        "LUI": null,
        "TFN_RECORDED": false,
        "OPTIONALID": 917,
        "POSITION": null,
        "SECTION": null,
        "DIVISION": null,
        "ORGANISATION": "MacLeay Business Enterprise Centre Ltd",
        "ADDRESS1": "Shop 1\/28 Clyde Street",
        "ADDRESS2": null,
        "CITY": "KEMPSEY",
        "STATE": "NSW",
        "POSTCODE": "2440",
        "COUNTRY": "AUSTRALIA",
        "SADDRESS1": null,
        "SADDRESS2": null,
        "SCITY": null,
        "SSTATE": null,
        "SPOSTCODE": null,
        "SCOUNTRY": null,
        "PHONE": null,
        "MOBILEPHONE": null,
        "WORKPHONE": "065 888 888",
        "FAX": "065 888 888",
        "OTHERPHONE": null,
        "COMMENT": null,
        "WEBSITE": null,
        "CITIZENSTATUSID": null,
        "CITIZENSTATUSNAME": null,
        "COUNTRYOFBIRTHID": 1101,
        "COUNTRYOFBIRTHNAME": "Australia",
        "CITYOFBIRTH": "Cairns",
        "COUNTRYOFCITIZENID": 1101,
        "COUNTRYOFCITIZENNAME": "Australia",
        "INDIGENOUSSTATUSID": null,
        "INDIGENOUSSTATUSNAME": null,
        "MAINLANGUAGEID": null,
        "MAINLANGUAGENAME": null,
        "ENGLISHPROFICIENCYID": null,
        "ENGLISHASSISTANCEFLAG": null,
        "HIGHESTSCHOOLLEVELID": null,
        "HIGHESTSCHOOLLEVELYEAR": null,
        "CURRENTSCHOOLLEVEL": null,
        "ATSCHOOLFLAG": null,
        "ATSCHOOLNAME": null,
        "PRIOREDUCATIONIDS": [],
        "PRIOREDUCATIONNAMES": [],
        "DISABILITYFLAG": null,
        "DISABILITYTYPEIDS": [],
        "DISABILITYTYPENAMES": [],
        "LABOURFORCEID": null,
        "LABOURFORCENAME": null,
        "EMERGENCYCONTACT": null,
        "EMERGENCYCONTACTRELATION": null,
        "EMERGENCYCONTACTPHONE": null,
        "ANZSCOCODE": null,
        "ANZSICCODE": null,
	    "EMPLOYERCONTACTID": null,
	    "PAYERCONTACTID": null,
	    "SUPERVISORCONTACTID": null,
	    "COACHCONTACTID": null,
	    "AGENTCONTACTID": null,
	    "CUSTOMFIELD_MYFIELD": null,
        "CUSTOMFIELD_MYMULTIFIELD": [],
	    "CATEGORYIDS": []
    },
    },
    {
        "CONTACTID": 5653,
        "GIVENNAME": "Scott",
        "SURNAME": "Millson",
        "EMAILADDRESS": null,
        "SEX": null,
        "DOB": null,
        "USI": "FAKE512345",
        "USI_VERIFIED": false,
        "USI_EXEMPTION": false,
        "TITLE": "Mr",
        "MIDDLENAME": null,
        "PREFERREDNAME": null,
        "LUI": null,
        "TFN_RECORDED": false,
        "OPTIONALID": 1240,
        "POSITION": "Managing Editor",
        "SECTION": null,
        "DIVISION": null,
        "ORGANISATION": "The Bulletin",
        "ADDRESS1": "GPO Box 3957",
        "ADDRESS2": null,
        "CITY": "SYDNEY",
        "STATE": "NSW",
        "POSTCODE": "2000",
        "COUNTRY": "AUSTRALIA",
        "SADDRESS1": null,
        "SADDRESS2": null,
        "SCITY": null,
        "SSTATE": null,
        "SPOSTCODE": null,
        "SCOUNTRY": null,
        "PHONE": null,
        "MOBILEPHONE": null,
        "WORKPHONE": "02 9999 8000",
        "FAX": "02 9999 4359",
        "OTHERPHONE": null,
        "COMMENT": null,
        "WEBSITE": null,
        "CITIZENSTATUSID": null,
        "CITIZENSTATUSNAME": null,
        "COUNTRYOFBIRTHID": null,
        "COUNTRYOFBIRTHNAME": null,
        "CITYOFBIRTH": null,
        "COUNTRYOFCITIZENID": null,
        "COUNTRYOFCITIZENNAME": null,
        "INDIGENOUSSTATUSID": null,
        "INDIGENOUSSTATUSNAME": null,
        "MAINLANGUAGEID": null,
        "MAINLANGUAGENAME": null,
        "ENGLISHPROFICIENCYID": null,
        "ENGLISHASSISTANCEFLAG": null,
        "HIGHESTSCHOOLLEVELID": null,
        "HIGHESTSCHOOLLEVELYEAR": null,
        "CURRENTSCHOOLLEVEL": null,
        "ATSCHOOLFLAG": null,
        "ATSCHOOLNAME": null,
        "PRIOREDUCATIONIDS": [],
        "PRIOREDUCATIONNAMES": [],
        "DISABILITYFLAG": null,
        "DISABILITYTYPEIDS": [],
        "DISABILITYTYPENAMES": [],
        "LABOURFORCEID": null,
        "LABOURFORCENAME": null,
        "EMERGENCYCONTACT": null,
        "EMERGENCYCONTACTRELATION": null,
        "EMERGENCYCONTACTPHONE": null,
        "ANZSCOCODE": null,
        "ANZSICCODE": null,
	    "EMPLOYERCONTACTID": null,
	    "PAYERCONTACTID": null,
	    "SUPERVISORCONTACTID": null,
	    "COACHCONTACTID": null,
	    "AGENTCONTACTID": null,
	    "CUSTOMFIELD_MYFIELD": "Test Value",
        "CUSTOMFIELD_MYMULTIFIELD": [
            "Test Value 1",
            "Test Value 2",
        ],
	    "CATEGORYIDS": []
    },
    {
        "CONTACTID": 5691,
        "GIVENNAME": "Scott",
        "SURNAME": "Loose",
        "EMAILADDRESS": null,
        "SEX": null,
        "DOB": null,
        "USI": "FAKE912345",
        "USI_VERIFIED": true,
        "USI_EXEMPTION": false,
        "TITLE": "Mr",
        "MIDDLENAME": null,
        "PREFERREDNAME": null,
        "LUI": null,
        "TFN_RECORDED": false,
        "OPTIONALID": 1278,
        "POSITION": "Executive Director",
        "SECTION": null,
        "DIVISION": null,
        "ORGANISATION": "Queensland Manufacturing Institute",
        "ADDRESS1": "Cnr Miles Platting & Logan Road",
        "ADDRESS2": null,
        "CITY": "EIGHT MILE PLAINS",
        "STATE": "QLD",
        "POSTCODE": "4123",
        "COUNTRY": "AUSTRALIA",
        "SADDRESS1": null,
        "SADDRESS2": null,
        "SCITY": null,
        "SSTATE": null,
        "SPOSTCODE": null,
        "SCOUNTRY": null,
        "PHONE": null,
        "MOBILEPHONE": "041 999 9999",
        "WORKPHONE": "07 3333 3333",
        "FAX": "07 3333 3333",
        "OTHERPHONE": null,
        "COMMENT": "TEC Comment",
        "WEBSITE": null,
        "CITIZENSTATUSID": null,
        "CITIZENSTATUSNAME": null,
        "COUNTRYOFBIRTHID": null,
        "COUNTRYOFBIRTHNAME": null,
        "CITYOFBIRTH": null,
        "COUNTRYOFCITIZENID": null,
        "COUNTRYOFCITIZENNAME": null,
        "INDIGENOUSSTATUSID": null,
        "INDIGENOUSSTATUSNAME": null,
        "MAINLANGUAGEID": null,
        "MAINLANGUAGENAME": null,
        "ENGLISHPROFICIENCYID": null,
        "ENGLISHASSISTANCEFLAG": null,
        "HIGHESTSCHOOLLEVELID": null,
        "HIGHESTSCHOOLLEVELYEAR": null,
        "CURRENTSCHOOLLEVEL": null,
        "ATSCHOOLFLAG": null,
        "ATSCHOOLNAME": null,
        "PRIOREDUCATIONIDS": [],
        "PRIOREDUCATIONNAMES": [],
        "DISABILITYFLAG": null,
        "DISABILITYTYPEIDS": [],
        "DISABILITYTYPENAMES": [],
        "LABOURFORCEID": null,
        "LABOURFORCENAME": null,
        "EMERGENCYCONTACT": null,
        "EMERGENCYCONTACTRELATION": null,
        "EMERGENCYCONTACTPHONE": null,
        "ANZSCOCODE": null,
        "ANZSICCODE": null,
	    "EMPLOYERCONTACTID": null,
	    "PAYERCONTACTID": null,
	    "SUPERVISORCONTACTID": null,
	    "COACHCONTACTID": null,
	    "AGENTCONTACTID": null,
	    "CUSTOMFIELD_MYFIELD": "Some Other Value",
        "CUSTOMFIELD_MYMULTIFIELD": [
            "Test Value X",
        ],
	    "CATEGORYIDS": [
	    	99
	    ]
    }
]
print   print

resource /contact/allocatedActivities/:contactID

Description

Returns enrolments for a specific contact.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contact/allocatedActivities/:contactID

Pattern: /contact/allocatedActivities/:contactID
Handler: api.contact
Action: {GET={getAllocatedActivities}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contact/allocatedActivities/:contactID
Placeholder Type Required Default Description
contactID numeric true The contact ID to interact with
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json

Samples

The allocation information will be returned in an object - NOTE: Where there instanceID is 0; the Skill Group was applied to the type.

{
    "EL": [],
    "ASC": [
        {
            "LOCATION": "",
            "DELIVERY": "Face-to-Face",
            "INSTANCEID": 157228,
            "STARTDATE": "",
            "STATUS": "Not Enrolled",
            "DATECOMMENCED": "",
            "FINISHDATE": "",
            "ENROLID": 0,
            "MANDATORY": true,
            "NAME": "CUS10101 - 1111 Test Qualification",
            "ID": 4369,
            "TYPE": "accredited"
        },
        {
            "LOCATION": "",
            "DELIVERY": "Face-to-Face",
            "INSTANCEID": 157232,
            "STARTDATE": "18/07/2015",
            "STATUS": "Not Enrolled",
            "DATECOMMENCED": "",
            "FINISHDATE": "19/07/2015",
            "ENROLID": 0,
            "MANDATORY": true,
            "NAME": "CPCCLDG3001A - Licence to perform dogging",
            "ID": 3285,
            "TYPE": "accredited"
        }
    ],
    "NASC": [
        {
            "LOCATION": "",
            "DELIVERY": "Face-to-Face",
            "INSTANCEID": 0,
            "STARTDATE": "17/07/2015",
            "STATUS": "Not Enrolled",
            "DATECOMMENCED": "",
            "FINISHDATE": "17/07/2015",
            "ENROLID": 0,
            "MANDATORY": true,
            "NAME": "test - test",
            "ID": 18714,
            "TYPE": "Non-accredited"
        }
    ]
}
print   print

resource /contact/enrolments/:contactID

Description

Returns enrolments for a specific contact.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contact/enrolments/:contactID

Pattern: /contact/enrolments/:contactID
Handler: api.contact
Action: {GET={getEnrolments}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contact/enrolments/:contactID
Placeholder Type Required Default Description
contactID numeric true The resource contact ID to interact with
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
status string false Filter enrolments by status.
type string false Filter enrolments by type.
Response Default Response Format: json

Samples

The enrolment information will be returned in an object.

[
    {
        "ROWID": 1,
        "TYPE": "p",
        "ID": 3296,
        "INSTANCEID": 27495,
        "ENROLID": 913741,
		"INVOICEID": 12344,
		"INVOICEPAID": true,
		"LEARNERID": 913741,
        "CODE": "",
        "LOCATION": "",
        "DELIVERY": "Unknown",
        "ACTIVITYTYPE": "Axcelerate Training Program",
        "NAME": "May Intake 2013",
        "STARTDATE": "2013-05-01",
        "FINISHDATE": "2013-05-31",
        "MANDATORY": false,
        "STATUS": "Enrolled",
        "SCHOOLTYPEID": "25",
        "SCHOOLORGID": 538562,
        "COUNT": 3,
        "CUSTOMFIELD_TESTINGDATE": "2013-08-31",
        "CUSTOMFIELD_CLASSFIELD": [
            "Multi field at class level",
            "Some other value"
        ]
    },
    {
        "ROWID": 2,
        "TYPE": "el",
        "ID": 1670,
        "INSTANCEID": 1670,
        "ENROLID": 6202,
		"INVOICEID": null,
		"INVOICEPAID": false,
		"LEARNERID": 6202,
        "CODE": "",
        "LOCATION": "Online",
        "DELIVERY": "Online",
        "ACTIVITYTYPE": "moodle",
        "NAME": "Hospitality for Cruise Ships b",
        "STARTDATE": "2014-03-27",
        "FINISHDATE": "",
        "MANDATORY": false,
        "STATUS": "Booked",
        "SCHOOLTYPEID": null,
        "SCHOOLORGID": null,
        "COUNT": 3,
        "LAUNCHURL": "http:\/\/moodle01.axcelerate.com.au\/login\/?axtoken=oQKBPj%2FuWV0rWzAlnkl59Q%3D%3D&courseid=937"
    },
    {
        "ROWID": 3,
        "TYPE": "w",
        "ID": 1727,
        "INSTANCEID": 12297,
        "ENROLID": 56937,
		"INVOICEID": null,
		"INVOICEPAID": false,
        "LEARNERID": 56937,
        "CODE": "",
        "LOCATION": "Yeppoon",
        "DELIVERY": "Face-to-Face",
        "ACTIVITYTYPE": "aXcelerate Training - Web-based (Mark)",
        "NAME": "aXcelerate Training",
        "STARTDATE": "2011-10-18",
        "FINISHDATE": "2011-10-19",
        "MANDATORY": true,
        "STATUS": "Booked",
        "SCHOOLTYPEID": null,
        "SCHOOLORGID": null,
        "COUNT": 3,
        "COMPLEXDATES": [
            {
                "DATE": "2011-10-18",
                "STARTTIME": "09:00:00",
                "ENDTIME": "15:00:00",
                "TRAINERCONTACTID": 28619,
                "LOCATION": "",
                "ROOMID": 0
            },
            {
                "DATE": "2011-10-19",
                "STARTTIME": "09:00:00",
                "ENDTIME": "12:00:00",
                "TRAINERCONTACTID": 28619,
                "LOCATION": "",
                "ROOMID": 0
            }
        ]
    },
	{
        "ROWID": 4,
        "TYPE": "s",
        "ID": 118809,
        "INSTANCEID": 118809,
        "ENROLID": 1503065,
		"INVOICEID": null,
		"INVOICEPAID": false,
        "LEARNERID": 1503065,
  		"CODE": "BSBITU201A",
        "LOCATION": "VM Learning Offices",
        "DELIVERY": "Unknown",
        "NAME": "Produce simple word processed documents",
        "STARTDATE": "2013-01-01",
        "FINISHDATE": "2014-12-31",
        "MANDATORY": false,
        "STATUS": "C",
        "OUTCOMECODE": "20",
        "SCHOOLTYPEID": null,
        "SCHOOLORGID": null,
        "COUNT": 11
	},
    {
        "ROWID": 5,
        "TYPE": "s",
        "ID": 118810,
        "INSTANCEID": 118810,
        "ENROLID": 1503065,
		"INVOICEID": null,
		"INVOICEPAID": false,
        "LEARNERID": 1503065,
        "CODE": "BSBADM101A",
        "LOCATION": "VM Learning Offices",
        "DELIVERY": "Unknown",
        "ACTIVITYTYPE": "Certificate I in Business",
        "NAME": "Use business equipment and resources",
        "STARTDATE": "2013-01-01",
        "FINISHDATE": "2014-12-31",
        "MANDATORY": false,
        "STATUS": "C",
        "OUTCOMECODE": "20",
        "SCHOOLTYPEID": null,
        "SCHOOLORGID": null,
        "COUNT": 11
    }
]
print   print

resource /contact/enrolment/certificate

Description

Returns an issued certificate for a completed enrolment.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contact/enrolment/certificate

Pattern: /contact/enrolment/certificate
Handler: api.contact
Action: {GET={getCertificate}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contact/enrolment/certificate
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
enrolID numeric false The accredited enrolmentID
statusID numeric false The non-accredited enrolmentID
Response Default Response Format: json

Samples

The PDF will be returned as a base64 string.

{
	CERTIFICATE: "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoID..."
}
print   print

resource /contact/enrolment/verifyCertificate/:ID

Description

Checks the system for a certificate issued by the Client.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contact/enrolment/verifyCertificate/:ID

Pattern: /contact/enrolment/verifyCertificate/:ID
Handler: api.contact
Action: {GET={verifyCertificate}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contact/enrolment/verifyCertificate/:ID
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json

Samples

An example of a successful certificate verification. The 'HaveFile' property refers to the generated PDF; it will be false if the certificate was issued but not saved (on the server). The ID is the last set of digits in the Certificate ID (found on the printed certificate) - i.e.: '116482-54321-12345'

{
    "DOCUMENT": {
        "HAVEFILE": true,
        "DETAIL": {
            "AWARDTYPE": "Certificate of Training (Non-accred.)",
            "STATUSID": 12345,
            "CONTACTID": 116482,
            "SURNAME": "Gordon",
            "ISSUEDBY": "VM Learning / aXcelerate",
            "ACTIVITYNAME": "aXcelerate Contact Management",
            "GIVENNAME": "Nathan"
        }
    },
    "RESULT": true,
    "MSG": "Certificate verification successful! Certificate has been generated."
}
print   print

resource /contact/portfolio/

Description

Returns, updates and creates meta data and documents against a contact's portfolio

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contact/portfolio/

Pattern: /contact/portfolio/
Handler: api.portfolio
Action: {PUT={update}, GET={read}, POST={create}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contact/portfolio/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET,POST,PUT
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
contactID numeric true The ID of the Contact to interact with.
portfolioID numeric false The ID of the portfolio object to interact with. Only requried for PUT (update) requests. For GET requests, if passed, a single structure will be returned - otherwise an array of results will be returned.
portfolioTypeID numeric false The ID of the client defined portfolio document type to use. You can also filter GET results by this type for a contact. These can be found by checking endpoint api/portfolio/types
portfolioChecklistID numeric false GET only. If passed, portfolio objects will be returned which match those in the checklist. Missing items will be returned as placeholders with PORTFOLIOID = 0. These can be found by checking endpoint api/portfolio/checklists
isCRICOS boolean false GET only. If passed, will return the documents against the defined CRICOS checklist. The output is the same as passing a portfolioChecklistID. This feature must be enabled and the checklist must defined in the client's System Settings or an error will be thrown.
number string false This and the parameters below are for PUT and POST requests only. The portfolio number. Used only all but Qualification type portfolio objects.
registration string false Used only for Registration type portfolio objects.
name string false Used only for Qualification type portfolio objects.
specialty string false Used only for Qualification type portfolio objects.
startDate date false Used only for Qualification type portfolio objects.
status string false Used only for Qualification type portfolio objects and only for clients who have enabled the system setting. Valid values are: Completed, Commenced, Attended, Suspended, Canceled, Withdrawn, and Pending
dateIssued date false
dateExpires date false
issuedBy string false
details string false
Response Default Response Format: json

Samples

The structure of a portfolio object returned when using POST, PUT, or GET with a portfolioID

{
    "PORTFOLIOTYPE": "Licence",
    "PORTFOLIOTYPENAME": "Driver Licence",
    "CONTACTID": 12345,
    "NUMBER": "ABC0034323",
    "PORTFOLIOID": 34242,
    "FILES": [
        {
            "FILENAME": "licence_screenshot04.png",
            "FOLDER": "licence",
            "PORTFOLIODOCID": 79,
            "ACCESSMIN": 30,
            "TEMPORARYACCESSURL": "https://admin.axcelerate.com.au/example_only/9999"
        }
    ],
    "PORTFOLIOTYPEID": 6783,
    "DATEEXPIRES": "2021-09-05",
    "ISSUEDBY": "Queensland Transport",
    "DATEISSUED": "2016-09-06",
    "DETAILS": null,
    "CUSTOMFIELD_LICENCESTATE": "QLD",
    "CUSTOMFIELD_PHOTOQUALITY": "Average",
    "CUSTOMFIELD_MULTIFIELD": [
        "Example A",
        "Example X"
    ]
}

An array of portfolio objects, returned when searching for all objects for a contact

[
    {
        "PORTFOLIOTYPE": "Licence",
        "PORTFOLIOTYPENAME": "Driver Licence",
        "CONTACTID": 12345,
        "NUMBER": "ABC0034323",
        "PORTFOLIOID": 34242,
        "FILES": [
            {
                "FILENAME": "licence_screenshot04.png",
                "FOLDER": "licence",
                "PORTFOLIODOCID": 579,
                "ACCESSMIN": 30,
                "TEMPORARYACCESSURL": "https://admin.axcelerate.com.au/example_only/9999"
            }
        ],
        "PORTFOLIOTYPEID": 6783,
        "DATEEXPIRES": "2021-09-05",
        "ISSUEDBY": "Queensland Transport",
        "DATEISSUED": "2016-09-06",
        "DETAILS": null,
        "CUSTOMFIELD_LICENCESTATE": "QLD",
        "CUSTOMFIELD_PHOTOQUALITY": "Average",
        "CUSTOMFIELD_MULTIFIELD": [
            "Example A",
            "Example X"
        ]
    },
    {
        "PORTFOLIOTYPE": "Membership",
        "CUSTOMFIELD_PHOBIAS": null,
        "PORTFOLIOTYPENAME": "XYZ Corporate Membership",
        "CONTACTID": 12345,
        "NUMBER": null,
        "PORTFOLIOID": 33576,
        "FILES": [],
        "PORTFOLIOTYPEID": 74,
        "DATEEXPIRES": null,
        "ISSUEDBY": "My Corp",
        "DATEISSUED": "2014-04-02",
        "DETAILS": "Membership required for this example"
    },
    {
        "PORTFOLIOTYPE": "Registration",
        "PORTFOLIOTYPENAME": "Example Reg Type",
        "REGISTRATION": "2AA",
        "CONTACTID": 12345,
        "NUMBER": null,
        "PORTFOLIOID": 333399,
        "FILES": [
            {
                "FILENAME": "refapplication.pdf",
                "FOLDER": "certificate",
                "PORTFOLIODOCID": 344,
                "ACCESSMIN": 30,
                "TEMPORARYACCESSURL": "https://admin.axcelerate.com.au/example_only/7577"
            },
            {
                "FILENAME": "invoice_doc23.pdf",
                "FOLDER": "tax",
                "PORTFOLIODOCID": 345,
                "ACCESSMIN": 30,
                "TEMPORARYACCESSURL": "https://admin.axcelerate.com.au/example_only/4344"
            }
        ],
        "PORTFOLIOTYPEID": 190,
        "DATEEXPIRES": null,
        "ISSUEDBY": "Sam Spaceman",
        "DATEISSUED": "2016-09-06",
        "DETAILS": null
    }
]

An array of portfolio objects, returned when searching by a checklist. In this example, the checklist has 2 items, a membership and a licence, but the contact only has a membership recorded.

[
    {
        "PORTFOLIOTYPE": "Licence",
        "PORTFOLIOTYPENAME": "Driver Licence",
        "CONTACTID": 12345,
        "NUMBER": null,
        "PORTFOLIOID": 0,
        "FILES": [],
        "PORTFOLIOTYPEID": 6783,
        "DATEEXPIRES": null,
        "ISSUEDBY": null,
        "DATEISSUED": null,
        "DETAILS": null,
        "CUSTOMFIELD_LICENCESTATE": null,
        "CUSTOMFIELD_PHOTOQUALITY": null,
        "CUSTOMFIELD_MULTIFIELD": [
            "Example A",
            "Example X"
        ]
    },
    {
        "PORTFOLIOTYPE": "Membership",
        "CUSTOMFIELD_PHOBIAS": null,
        "PORTFOLIOTYPENAME": "XYZ Corporate Membership",
        "CONTACTID": 12345,
        "NUMBER": null,
        "PORTFOLIOID": 33576,
        "FILES": [],
        "PORTFOLIOTYPEID": 74,
        "DATEEXPIRES": null,
        "ISSUEDBY": "My Corp",
        "DATEISSUED": "2014-04-02",
        "DETAILS": "Membership required for this example"
    }
]
print   print

resource /contact/portfolio/file

Description

Uploads or returns a link for a file against a contact's portfolio record. For GET, this endpont returns a temporary access URL to allow the file to be downloaded. This link is also available in the GET /contact/portfolio endpoint, but it is important to remember the link is only good for a set number of minutes (normally 30, but this value is returned as well). For POST (upload), this endpoint only accepts requests encoded using multipart/form-data. Note that you CANNOT test the POST part of this endpoint in the Relax console as it does not support file type parameters or multipart encoding.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contact/portfolio/file

Pattern: /contact/portfolio/file
Handler: api.portfolio
Action: {GET={getFileURL}, POST={upload}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contact/portfolio/file
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET,POST
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
contactID numeric true The ID of the Contact to interact with.
portfolioID numeric true The ID of the portfolio object to interact with.
portfolioDocID numeric true GET requests only. To read the specified file. All 3 IDs contactID, portfolioID, and portfolioDocID must match up, or you will get a 404 not found.
addFile string false Only for POST (upload). The file field for the file to upload.
addFileFolder string false other Only for POST (upload). The 'folder' in which to place the file within the portfolio record. This will be made lowercase and will be stripped of all but letters. Any values are acceptable, but the folder-naming convention used in the management portal is (by portfolio type in bold): Licence: licence; Membership: membership; Qualification: resume, certificate, testamur, academic; Registration: certificate, correspondence, tax; Other: other.
Response Default Response Format: json

Samples

After a GET request, the endpoint returns an access URL. The URL is good for a specified number of minutes (also returned as ACCESSMIN).

{
    "FILENAME": "licence_screenshot04.png",
    "FOLDER": "licence",
    "PORTFOLIODOCID": 79,
    "ACCESSMIN": 30,
    "TEMPORARYACCESSURL": "https://admin.axcelerate.com.au/example_only/9999"
}

After a POST request, the endpoint returns the structure of a portfolio object upon a successful upload. The is the same as GET api/contact/portfolio

{
    "PORTFOLIOTYPE": "Licence",
    "PORTFOLIOTYPENAME": "Driver Licence",
    "CONTACTID": 12345,
    "NUMBER": "ABC0034323",
    "PORTFOLIOID": 34242,
    "FILES": [
        {
            "FILENAME": "licence_screenshot04.png",
            "FOLDER": "licence",
            "PORTFOLIODOCID": 79,
            "ACCESSMIN": 30,
            "TEMPORARYACCESSURL": "https://admin.axcelerate.com.au/example_only/9999"
        },
        {
            "FILENAME": "MY_NEW_UPLOAD.jpg",
            "FOLDER": "licence",
            "PORTFOLIODOCID": 233,
            "ACCESSMIN": 30,
            "TEMPORARYACCESSURL": "https://admin.axcelerate.com.au/example_only/6754"
        }
    ],
    "PORTFOLIOTYPEID": 6783,
    "DATEEXPIRES": "2021-09-05",
    "ISSUEDBY": "Queensland Transport",
    "DATEISSUED": "2016-09-06",
    "DETAILS": null,
    "CUSTOMFIELD_LICENCESTATE": "QLD",
    "CUSTOMFIELD_PHOTOQUALITY": "Average",
    "CUSTOMFIELD_MULTIFIELD": [
        "Example A",
        "Example X"
    ]
}
print   print

resource /contact/notes/:contactID

Description

Returns notes for a specific contact.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contact/notes/:contactID

Pattern: /contact/notes/:contactID
Handler: api.contact
Action: {GET={getContactNotes}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contact/notes/:contactID
Placeholder Type Required Default Description
contactID numeric true The ID of the Contact to interact with.
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
search string false The search string.
hideSystemNotes boolean false false Hide system generated notes.
purgeCache boolean false false Force the system to retrieve data from the database (don't use cached query).
offset numeric false 0 The record to start at.
displayLength numeric false 10 The amount of records to display.
Response Default Response Format: json

Samples

The enrolment information will be returned in an object.

[
    {
        "ROWID": 1,
        "ID": 3287782,
        "TEXT": "\r\n\tMerge Document emailed by Jade\r\n\tSubject: Testing Victorian AVETMISS 2015 Format Updates\r\n View Email",
        "TYPE": "System Generated Note",
        "DATEINSERTED": "2014-12-16 13:17",
        "ADDEDBY": "Jade Steffensen",
        "ADDEDBYCONTACTID": 4746,
        "ATTACHMENT": null,
        "COUNT": 5
    },
    {
        "ROWID": 2,
        "ID": 734371,
        "TEXT": "\r\n\tTesting notes 123\r\n",
        "TYPE": "Appointment Made - Existing Contact",
        "DATEINSERTED": "2013-04-24 11:34",
        "ADDEDBY": "Nathan Gordon",
        "ADDEDBYCONTACTID": 116482,
        "ATTACHMENT": null,
        "COUNT": 5
    },
    {
        "ROWID": 3,
        "ID": 2206415,
        "TEXT": "Organisation changed from TESTING 123 to VM Learning / aXcelerate by Nathan1",
        "TYPE": "System Generated Note",
        "DATEINSERTED": "2014-08-01 12:20",
        "ADDEDBY": "SYSTEM",
        "ADDEDBYCONTACTID": null,
        "ATTACHMENT": null,
        "COUNT": 5
    },
    {
        "ROWID": 4,
        "ID": 2196207,
        "TEXT": "Organisation changed to TESTING 123 by Nathan1",
        "TYPE": "System Generated Note",
        "DATEINSERTED": "2014-07-31 09:17",
        "ADDEDBY": "SYSTEM",
        "ADDEDBYCONTACTID": null,
        "ATTACHMENT": null,
        "COUNT": 5
    },
    {
        "ROWID": 5,
        "ID": 1411408,
        "TEXT": "Testing 123",
        "TYPE": "aXcelerate - Client Service - Heart Day",
        "DATEINSERTED": "2014-02-19 19:10",
        "ADDEDBY": "Nathan Gordon",
        "ADDEDBYCONTACTID": 116482,
        "ATTACHMENT": "rlssa-logo.png",
        "COUNT": 5
    }
]
print   print

resource /contact/note/

Description

Adds a note against a specific Contact.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contact/note/

Pattern: /contact/note/
Handler: api.contact
Action: {POST={addContactNote}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contact/note/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
contactID numeric true The ContactID to add the note to.
contactNote string true The note to add to the Contact.
noteTypeID numeric false 88 The type of note to add to the Contact. This defaults to System Note
emailNote numeric-list false A list of ContactIDs to email the note to.
Response Default Response Format: json

Samples

The result will look like this if the call was successful.

{
    "MESSAGE": "Note was added to Contact: 116482.",
    "STATUS": "success"
    "NOTEID" : 1234
}
print   print

resource /contact/noteTypes/

Description

Get Note Types configured in the account.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contact/noteTypes/

Pattern: /contact/noteTypes/
Handler: api.contact
Action: {GET={getContactNoteCodes}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contact/noteTypes/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json

Samples

The enrolment information will be returned in an object.

[
    {
        "COLOUR": null,
        "ENTRYDATE": "2009-11-11 08:47",
        "NOTETYPEID": 165,
        "ACTIVE": true,
        "DESCRIPTOR": "Appointment Made - New Contact"
    },
    {
        "COLOUR": null,
        "ENTRYDATE": "2009-11-11 08:48",
        "NOTETYPEID": 166,
        "ACTIVE": true,
        "DESCRIPTOR": "General Client Conversation"
    }
]
print   print

resource /contact/sources

Description

Returns a JSON array of client specific contact sources. A source is a marketing tool that lets you track how contacts heard about your organisation or service. The sources are setup and pulled from aXcelerate and each element in the array is a structure that contains the Source name and the SourceCodeID. The SourceCodeID can be passed to the POST and PUT contact methods.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contact/sources

Pattern: /contact/sources
Handler: api.contact
Action: {GET={getSources}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contact/sources
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
onlyPublic boolean false true Set to true to return only publicly exposed marketing sources.
onlyActive boolean false true Set to true to return only currently active marketing sources.
Response Default Response Format: json

Samples

The list is returned as an array of source structures. This list is different for every client and can be completely controlled in aXcelerate under Settings > Contact Sources.

[
    {
        "SOURCECODEID": 138,
        "SOURCE": "Client Referral",
        "ISACTIVE": true,
        "ISPUBLIC": true
    },
    {
        "SOURCECODEID": 5,
        "SOURCE": "Colleague",
        "ISACTIVE": true,
        "ISPUBLIC": true
    },
    {
        "SOURCECODEID": 15,
        "SOURCE": "Email promotion",
        "ISACTIVE": true,
        "ISPUBLIC": true
    },
    {
        "SOURCECODEID": 213,
        "SOURCE": "Employer organisation",
        "ISACTIVE": true,
        "ISPUBLIC": true
    },
    {
        "SOURCECODEID": 136,
        "SOURCE": "Google AdWords",
        "ISACTIVE": true,
        "ISPUBLIC": true
    },
    {
        "SOURCECODEID": 13,
        "SOURCE": "Manager referral",
        "ISACTIVE": true,
        "ISPUBLIC": true
    },
    {
        "SOURCECODEID": 75,
        "SOURCE": "Networking event",
        "ISACTIVE": true,
        "ISPUBLIC": true
    },
    {
        "SOURCECODEID": 4,
        "SOURCE": "Newspaper Advertisement",
        "ISACTIVE": true,
        "ISPUBLIC": true
    },
    {
        "SOURCECODEID": 7,
        "SOURCE": "Other",
        "ISACTIVE": true,
        "ISPUBLIC": true
    },
    {
        "SOURCECODEID": 219,
        "SOURCE": "Radio Station advertising",
        "ISACTIVE": true,
        "ISPUBLIC": true
    },
    {
        "SOURCECODEID": 201,
        "SOURCE": "Shopping Centre Promotion",
        "ISACTIVE": true,
        "ISPUBLIC": true
    },
    {
        "SOURCECODEID": 42,
        "SOURCE": "Television Ad",
        "ISACTIVE": true,
        "ISPUBLIC": true
    },
    {
        "SOURCECODEID": 975,
        "SOURCE": "Trainer",
        "ISACTIVE": true,
        "ISPUBLIC": true
    },
    {
        "SOURCECODEID": 574,
        "SOURCE": "Training Magazine",
        "ISACTIVE": true,
        "ISPUBLIC": true
    },
    {
        "SOURCECODEID": 3,
        "SOURCE": "Web Search",
        "ISACTIVE": true,
        "ISPUBLIC": true
    },
    {
        "SOURCECODEID": 1316,
        "SOURCE": "Website",
        "ISACTIVE": true,
        "ISPUBLIC": true
    },
    {
        "SOURCECODEID": 964,
        "SOURCE": "Word of Mouth",
        "ISACTIVE": true,
        "ISPUBLIC": true
    },
    {
        "SOURCECODEID": 177,
        "SOURCE": "Yellow Pages",
        "ISACTIVE": true,
        "ISPUBLIC": true
    }
]
print   print

resource /contact/verifyUSI

Description

A wrapper for the USI Service verify USI call. It will return a structure with the boolean key USI_VERIFED and a MSG with any errors.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contact/verifyUSI

Pattern: /contact/verifyUSI
Handler: api.contact
Action: {POST={verifyUSI}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contact/verifyUSI
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
contactID numeric true The contactID of the contact to verify.
Response Default Response Format: json

Samples

An example successful call. The USI was correctly verified.

{
    "USI_VERIFIED": true,
    "DATA": {
        "usiStatus": "Valid",
        "firstName": "MATCH",
        "familyName": "MATCH",
        "dateOfBirth": "MATCH"
    },
    "MSG": "USI Verified successfully"
}

An example unsuccessful call. The USI was not verified because the first name did not match. The actual data returned by the USI Service is in the DATA key.

{
    "USI_VERIFIED": false,
    "DATA": {
        "usiStatus": "Valid",
        "firstName": "NO_MATCH",
        "familyName": "MATCH",
        "dateOfBirth": "MATCH"
    },
    "MSG": "USI Valid but the student's personal data does not match. This must be fixed before their USI can be marked as verified. Please check: First Name. "
}

An example unsuccessful call. An attempt was not made to verify the USI because data was missing.

{
    "USI_VERIFIED": false,
    "MSG": "An error exists for this contact and must be corrected before calling the USI Service. Date of birth is required. "
}
print   print

resource /contactRole/:contactRoleID

Description

Interacts with a specfic contact role. You can read (GET) or update (PUT) a Contact Role. The parameters below refer only to PUT requests.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contactRole/:contactRoleID

Pattern: /contactRole/:contactRoleID
Handler: api.contactRole
Action: {PUT={update}, GET={read}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contactRole/:contactRoleID
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET,PUT
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
name string false The name of the Contact Role.
type string false The type of the Contact Role
posNumber string false The number associated with the Contact Role
posDescription string false The description for the Contact Role
posstart date false The start date of the Contact Role
posend date false The end date of the Contact Role
dateCommenced date false The commencement date of the Contact Role
directManager boolean false The Direct Manager Flag: set this (to 1) if the role is intended to be used as a manager
managerContactRoleID numeric false A valid ContactRoleID which this Contact Role reports to
costCentreID numeric false A valid cost centre ID
skillGroupIDs string false A list of valid Skill Group IDs to assign to the Contact Role (comma separated)
orgID numeric false A valid Organisation ID.
Response Default Response Format: json

Samples

Contact Role returned in JSON format

{
    "POSDESCRIPTION": "",
    "ISACTIVE": true,
    "DATEUPDATED": "2015-03-05 13:28",
    "POSEND": "",
    "NAME": "Developer",
    "DIRECTMANAGER": false,
    "DATEINSERTED": "2015-03-03 11:16",
    "POSSTART": "2015-03-03 11:16",
    "CONTACTROLEID": 1579,
    "ORGID": 36590,
    "POSNUMBER": "DEV01",
    "MANAGER": {
        "POSDESCRIPTION": "",
        "ISACTIVE": true,
        "DATEUPDATED": "2015-03-05 13:31",
        "POSEND": "",
        "NAME": "Operations Manager",
        "DIRECTMANAGER": true,
        "DATEINSERTED": "2015-03-05 13:16",
        "POSSTART": "2015-03-05 13:16",
        "CONTACTROLEID": 1580,
        "ORGID": 36590,
        "POSNUMBER": "OPMAN01",
        "MANAGER": {},
        "DATECOMMENCED": "",
        "COSTCENTREID": null,
        "TYPE": "manager",
        "COSTCENTRE": {},
        "SKILLGROUPS": [
            {
                "ISACTIVE": true,
                "DATEUPDATED": null,
                "NAME": "people Management",
                "TYPE": "management",
                "SKILLGROUPID": 111,
                "DATEINSERTED": "2015-03-05 13:29"
            }
        ]
    },
    "DATECOMMENCED": "",
    "COSTCENTREID": null,
    "TYPE": "IT",
    "COSTCENTRE": {},
    "SKILLGROUPS": [
        {
            "ISACTIVE": false,
            "DATEUPDATED": "2013-06-26 18:22",
            "NAME": "BLAH",
            "TYPE": "BLAH",
            "SKILLGROUPID": 19,
            "DATEINSERTED": "2013-06-07 15:55"
        },
        {
            "ISACTIVE": true,
            "DATEUPDATED": null,
            "NAME": "Programming",
            "TYPE": "IT",
            "SKILLGROUPID": 110,
            "DATEINSERTED": "2015-03-05 13:27"
        }
    ]
}
print   print

resource /contactRole/

Description

Creates a new Contact Role. This API will not try and search for any existing contact role (of the same name), but simply creates a new one.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contactRole/

Pattern: /contactRole/
Handler: api.contactRole
Action: {POST={create}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contactRole/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
name string false The name of the Contact Role.
type string false The type of the Contact Role
posNumber string false The number associated with the Contact Role
posDescription string false The description for the Contact Role
posstart date false The start date of the Contact Role
posend date false The end date of the Contact Role
dateCommenced date false The commencement date of the Contact Role
directManager boolean false The Direct Manager Flag: set this (to 1) if the role is intended to be used as a manager
managerContactRoleID numeric false A valid ContactRoleID which this Contact Role reports to
costCentreID numeric false A valid cost centre ID
skillGroupIDs string false A list of valid Skill Group IDs to assign to the Contact Role (comma separated)
orgID numeric false A valid Organisation ID.
Response Default Response Format: json

Samples

Message returned in JSON format

{
    "MESSAGE": "Contact Role Created Successfully",
    "STATUS": "success",
    "CONTACTROLEID": 1579
}
print   print

resource /contactRole/assign

Description

Assigns a Contact Role to 1 or many Contact IDs OR if ContactRoleID = 0 it will remove any Contact Role from 1 or many Contact IDs

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contactRole/assign

Pattern: /contactRole/assign
Handler: api.contactRole
Action: {POST={assign}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contactRole/assign
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
contactRoleID numeric false 0 The Contact Role ID.
contactIDs string true A list of valid Contact IDs to assign the Contact Role to (comma separated)
Response Default Response Format: json

Samples

Contact Role returned in JSON format

{
    "MESSAGE": "5 Contacts have been assigned to ContactRoleID:1579 Successfully",
    "STATUS": "success",
    "CONTACTROLEID": 1579
}
print   print

resource /contactRole/subordinateOrgs/:contactRoleID

Description

Retrieves a list of Organisations related to a Manager's direct reports.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contactRole/subordinateOrgs/:contactRoleID

Pattern: /contactRole/subordinateOrgs/:contactRoleID
Handler: api.contactRole
Action: {GET={getSubordinateOrgs}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contactRole/subordinateOrgs/:contactRoleID
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json

Samples

Contact Role returned in JSON format

[
    {
        "CONTACTROLEID": 2386,
        "ORGID": 36590
    },
    {
        "CONTACTROLEID": 5740,
        "ORGID": 36590
    }
]
print   print

resource /contactRoles/

Description

Contact Role Search (paged results)

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/contactRoles/

Pattern: /contactRoles/
Handler: api.contactRole
Action: {GET={search}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/contactRoles/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
name string false The name or part of the name to search for
type string false The type or part of the type to search for
posNumber string false The number (or part of) associated with the Contact Role
posDescription string false The description (or part of) for the Contact Role
isActive boolean false 1 Search for Active or Inactive Roles.
directManager boolean false Search for Direct Managers (only) = 1 OR All Other = 0
managerContactRoleID numeric false Search roles which have this ContactRoleID as their manager.
orgID numeric false Search roles which are related to this Organisation ID.
offset numeric false 0 Used for paging - start at record.
displayLength numeric false 10 Used for paging - total records to retrieve.
sortColumn numeric false 1 The column index to sort by.
sortDirection string false ASC The sort by direction 'ASC' OR 'DESC'.
purgeCache boolean false true Currently the API will cache the query for 30 seconds ��� Setting this flag to true gets the latest data.
Response Default Response Format: json

Samples

Contact Role returned in JSON format

[
    {
        "ROWID": 1,
        "CONTACTROLEID": 1584,
        "NAME": "API Endpoint Test #1",
        "TYPE": "aXcelerateDevTest",
        "POSNUMBER": "AXAPITEST001",
        "POSDESCRIPTION": null,
        "POSSTART": null,
        "POSEND": null,
        "DATECOMMENCED": null,
        "DIRECTMANAGER": true,
        "DATEINSERTED": "2015-03-09 12:24",
        "DATEUPDATED": "2015-03-09 12:37",
        "MANAGERROLEID": null,
		"ORGID": 36590,
        "ISACTIVE": true,
        "COUNT": 4
    },
    {
        "ROWID": 2,
        "CONTACTROLEID": 1585,
        "NAME": "API Endpoint Test #2",
        "TYPE": "aXcelerateDevTest",
        "POSNUMBER": "AXAPITEST002",
        "POSDESCRIPTION": null,
        "POSSTART": null,
        "POSEND": null,
        "DATECOMMENCED": null,
        "DIRECTMANAGER": false,
        "DATEINSERTED": "2015-03-09 12:25",
        "DATEUPDATED": "2015-03-09 12:44",
        "MANAGERROLEID": 1584,
        "ORGID": 36590,
        "ISACTIVE": true,
        "COUNT": 4
    },
    {
        "ROWID": 3,
        "CONTACTROLEID": 1579,
        "NAME": "Developer",
        "TYPE": "IT",
        "POSNUMBER": "DEV01",
        "POSDESCRIPTION": null,
        "POSSTART": "2015-03-03 11:16",
        "POSEND": null,
        "DATECOMMENCED": null,
        "DIRECTMANAGER": false,
        "DATEINSERTED": "2015-03-03 11:16",
        "DATEUPDATED": "2015-03-05 13:28",
        "MANAGERROLEID": 1580,
        "ORGID": 36590,
        "ISACTIVE": true,
        "COUNT": 4
    },
    {
        "ROWID": 4,
        "CONTACTROLEID": 1580,
        "NAME": "Operations Manager",
        "TYPE": "manager",
        "POSNUMBER": "OPMAN01",
        "POSDESCRIPTION": null,
        "POSSTART": "2015-03-05 13:16",
        "POSEND": null,
        "DATECOMMENCED": null,
        "DIRECTMANAGER": true,
        "DATEINSERTED": "2015-03-05 13:16",
        "DATEUPDATED": "2015-03-05 13:31",
        "MANAGERROLEID": null,
        "ORGID": 36590,
        "ISACTIVE": true,
        "COUNT": 4
    }
]
print   print

resource /courses/

Description

Returns a list of courses. Returns accredited, Non-accredited and e-learning courses seperately or returns all together

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/courses/

Pattern: /courses/
Handler: api.course
Action: {GET={getCourses}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/courses/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
ID numeric false The ID of the Course to filter.
searchTerm string false The term to use when filtering activities.
type string false all The course type to return. w = workshop, p = accredited program, el = e-learning, all = All types.
trainingArea string false The Training Area to Search
offset numeric false 0 Used for paging - start at record.
displayLength numeric false 10 Used for paging - total records to retrieve.
sortColumn numeric false 1 The column index to sort by.
sortDirection string false ASC The sort by direction 'ASC' OR 'DESC'.
current boolean false true Current courses flag. True to show only current courses
public boolean false true Whether to include public courses only. If false, returns all couse types regardless of public settings.
lastUpdated_min datetime false In 'YYYY-MM-DD hh:mm' format. The course last updated date must be greater than or equal to this datetime. Courses last updated prior to Nov 2018 may not appear. Time is optional and in client's current timezone. Only applicable to w or p types.
lastUpdated_max datetime false In 'YYYY-MM-DD hh:mm' format. The course last updated date must be less than or equal to this datetime. Courses last updated prior to Nov 2018 may not appear. Time is optional and in client's current timezone. Only applicable to w or p types.
isActive boolean false Whether to include active/inactive courses only. By default both will be included
Response Default Response Format: json

Samples

Courses returned in JSON format

[
    {
        "ROWID": 1,
        "ID": 3426,
        "COUNT": 5,
        "NAME": "Certificate II in Surface Extraction Operations",
        "STREAMNAME": null,
        "CODE": "RII20209",
        "DELIVERY": "Face-to-Face",
        "ISACTIVE": true,
        "TYPE": "p",
        "SHORTDESCRIPTION": null,
        "PRIMARYIMAGE": null,
        "SECONDARYIMAGE": null
    },
    {
        "ROWID": 2,
        "ID": 3296,
        "COUNT": 5,
        "NAME": "Certificate IV in Superannuation",
        "STREAMNAME": null,
        "CODE": "FNS40911",
        "DELIVERY": "Face-to-Face",
        "TYPE": "p",
        "SHORTDESCRIPTION": "<span style=\"color: rgb(51, 51, 51); font-family: sans-serif; line-height: 18px; \">
Certificate IV in Superannuation (ASFA 100) provides a comprehensive introduction to the Australian superannuation
system for those with little or no knowledge.<\/span>",
        "PRIMARYIMAGE": null,
        "SECONDARYIMAGE": null
    },
    {
        "ROWID": 3,
        "ID": 3285,
        "COUNT": 5,
        "NAME": "Licence to perform dogging",
        "STREAMNAME": null,
        "CODE": "CPCCLDG3001A",
        "DELIVERY": "Face-to-Face",
        "ISACTIVE": true,
        "TYPE": "p",
        "SHORTDESCRIPTION": null,
        "PRIMARYIMAGE": null,
        "SECONDARYIMAGE": null
    },
    {
        "ROWID": 4,
        "ID": 168,
        "COUNT": 5,
        "NAME": "Axcelerate Training Program",
        "STREAMNAME": null,
        "CODE": "AXCEL_2010",
        "DELIVERY": "Face-to-Face",
        "ISACTIVE": true,
        "TYPE": "p",
        "SHORTDESCRIPTION": "<p class=\"title\">The Academy Summer School starts in February and there has never 
        been a better time to become an Accredited Wedding Planner.<\/p>",
        "PRIMARYIMAGE": null,
        "SECONDARYIMAGE": null
    },
    {
        "ROWID": 5,
        "ID": 211,
        "COUNT": 5,
        "NAME": "Assertiveness Skills",
        "STREAMNAME": null,
        "CODE": "ASSERT",
        "DELIVERY": "Face-to-Face",
        "ISACTIVE": true,
        "TYPE": "w",
        "SHORTDESCRIPTION": "The key to effective human relating is maintaining respect in communication with others. Learning to act assertively is vital in gaining influence and developing successful relationships. \r\n\r\n",
        "PRIMARYIMAGE": null,
        "SECONDARYIMAGE": null
    }
]
print   print

resource /course/detail

Description

Returns details of an activity.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/course/detail

Pattern: /course/detail
Handler: api.course
Action: {GET={getCourseDetails}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/course/detail
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
ID numeric true The ID of the activity you want details from.
type string true The type of the activity. w = workshop, p = accredited program, el = e-learning.
Response Default Response Format: json

Samples

Course detail example for a Qualification/Program (type=p)

{
    "OUTLINE": "This is the outline....",
    "CODE": "CUF40107",
    "COST": 3000,
    "NAME": "Certificate IV in Screen and Media",
    "ID": 4539,
    "TYPE": "p",
    "DESCRIPTION": "This certificate will allow you to work in the exciting screen and media industry"
}

Course detail example for a Workshop Type (type=w). Note that for workshops, the outline is broken into elements.

{
    "OUTLINE": "<div id='workshopOutlineContainer'>\r\n\t\t\t\t\t<div class='workshopOutlineData'>...."
    "CODE": "AX-API-101",
    "COST": 200,
    "OUTLINEELEMENTS": {
        "CONTENT": [
            "What is REST?",
            "API documentation is your friend",
            "Setting up data in aXcelerate FIRST"
        ],
        "SHORTDESCRIPTION": "This course doesn't actually exist. It is only a test.",
        "INTRODUCTION": "Ever wondered how to code against <strong>aXcelerate's APIs</strong>? Well, this fake workshop could teach you how!",
        "IMAGES": [],
        "TARGETAUDIENCE": "Developers",
        "ADDITIONALINFORMATION": "Price includes a complementary drink of water",
        "LEARNINGMETHODS": "You will learn by seeing, hearing and doing",
        "LEARNINGOUTCOMES": [
            "Learn how to read our API documentation",
            "Learn the difference between a workshop, class, and E-learning activity",
            "Code an amazing integration against the aXcelerate API"
        ],
        "PROGRAMBENEFITS": [
            "Better API and Relax understanding",
            "Increased happiness"
        ]
    },
    "NAME": "Learning how to use the aXcelerate API",
    "ID": 26825,
    "TYPE": "w",
    "DESCRIPTION": "This course doesn't actually exist. It is only a test."
}
print   print

resource /course/instances

Description

Returns instances of an activity type.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/course/instances

Pattern: /course/instances
Handler: api.course
Action: {GET={getCourseInstances}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/course/instances
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
ID numeric true The activity ID.
type string true The type of the activity. w = workshop, p = accredited program, el = e-learning.
public boolean false true Whether to include public courses only. If false, returns ALL course instances for type 'w' and 'el'. For type 'p', passing false will return ONLY non-public classes.
current boolean false true Whether to include only current courses. A current course instance is a course that is currently running, or coming up. If false, returns all couse instances.
isActive boolean false Whether to include active/inactive courses instances only. By default both will be included
lastUpdated_min datetime false In 'YYYY-MM-DD hh:mm' format. The course instance last updated date must be greater than or equal to this datetime. Instances last updated prior to Nov 2018 may not appear. Time is optional and in client's current timezone. Only applicable to w or p types.
lastUpdated_max datetime false In 'YYYY-MM-DD hh:mm' format. The course instance last updated date must be less than or equal to this datetime. Instances last updated prior to Nov 2018 may not appear. Time is optional and in client's current timezone. Only applicable to w or p types.
Response Default Response Format: json

Samples

Courses Instance data returned in JSON format. Note that some of these fields (those dealing with participant numbers) only apply to workshop instances. The example below is for workshops.

[
    {
        "ID": 16380,
        "INSTANCEID": 407209,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-03-06 09:00",
        "FINISHDATE": "2017-03-09 12:30",
        "DATEDESCRIPTOR": "6 - 9 March 2017",
        "LOCATION": "Sydney CBD",
        "COST": 20,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 4744,
        "NOTICES": null,
        "PARTICIPANTS": 18,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 2,
        "ENROLMENTOPEN": false,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 423316,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-03-14 09:30",
        "FINISHDATE": "2017-03-14 13:00",
        "DATEDESCRIPTOR": "14 March 2017",
        "LOCATION": "Melbourne",
        "COST": 0,
        "OWNERCONTACTID": 4744,
        "TRAINERCONTACTID": 4744,
        "NOTICES": null,
        "PARTICIPANTS": 1,
        "MAXPARTICIPANTS": 12,
        "MINPARTICIPANTS": 5,
        "PARTICIPANTVACANCY": 11,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 407217,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-05-11 09:00",
        "FINISHDATE": "2017-05-11 12:30",
        "DATEDESCRIPTOR": "11 May 2017",
        "LOCATION": "Brisbane City",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 8694,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 407219,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-05-16 09:00",
        "FINISHDATE": "2017-05-16 12:30",
        "DATEDESCRIPTOR": "16 May 2017",
        "LOCATION": "Adelaide",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 4744,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 407225,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-05-18 09:00",
        "FINISHDATE": "2017-05-18 12:30",
        "DATEDESCRIPTOR": "18 May 2017",
        "LOCATION": "Perth",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 4744,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 407214,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-05-25 09:00",
        "FINISHDATE": "2017-05-25 12:30",
        "DATEDESCRIPTOR": "25 May 2017",
        "LOCATION": "Melbourne CBD",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 4744,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 424374,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-06-15 09:30",
        "FINISHDATE": "2017-06-15 13:00",
        "DATEDESCRIPTOR": "15 June 2017",
        "LOCATION": "Sydney CBD",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 8694,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 424392,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-08-08 09:30",
        "FINISHDATE": "2017-08-08 13:00",
        "DATEDESCRIPTOR": "8 August 2017",
        "LOCATION": "Brisbane Inner City",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 8694,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 424385,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-08-10 09:30",
        "FINISHDATE": "2017-08-10 13:00",
        "DATEDESCRIPTOR": "10 August 2017",
        "LOCATION": "Melbourne Inner City",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 4744,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 424407,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-09-26 09:30",
        "FINISHDATE": "2017-09-26 13:00",
        "DATEDESCRIPTOR": "26 September 2017",
        "LOCATION": "Sydney Inner City",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 8694,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 424421,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-11-07 09:30",
        "FINISHDATE": "2017-11-07 13:00",
        "DATEDESCRIPTOR": "7 November 2017",
        "LOCATION": "Brisbane Inner City",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 8694,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 424419,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-11-09 09:30",
        "FINISHDATE": "2017-11-09 13:00",
        "DATEDESCRIPTOR": "9 November 2017",
        "LOCATION": "Melbourne Inner City",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 4744,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 424422,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-11-14 09:30",
        "FINISHDATE": "2017-11-14 13:00",
        "DATEDESCRIPTOR": "14 November 2017",
        "LOCATION": "Sydney CBD",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 8694,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    }
]
print   print

resource /course/instance/attendance

Description

Gets / Sets attendance for a Course Instance.
NOTE: You cannot set attendance records against workshops that do not have Complex Dates.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/course/instance/attendance

Pattern: /course/instance/attendance
Handler: api.course
Action: {PUT={setAttendance}, GET={getAttendance}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/course/instance/attendance
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET, PUT
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
instanceID numeric true The Instance ID of the activity you want to retrieve the attendance for (currently only works for workshops [type=w]).
type string false w The activity type of the activity. w = workshop [ not currently availabile: p = accredited program & el = e-learning].
contactID string false The contactID of the Enrollee. (required when updating)
attended string false The attended flag, 1 = attended, 0 = did not attend. (required when updating)
complexID string false The complexID of the Session. (required when updating)
duration string false This field is no longer supported for PUT or POST requests. aXcelerate will calculate the session duration from the Start and Finish times.
arrival dateTime false The date & time the student arrived (yyyy-mm-dd hh:mm)
departure dateTime false The date & time the student departed (yyyy-mm-dd hh:mm)
comment string false Associate a comment with this attendance record.
Response Default Response Format: json

Samples

Upon a successful call of this endpoint, the API will return the Sessions and Enrollees related to the Instance.

[
    {
        "INSTANCEID": 175740,
        "TYPE": "w",
        "COMPLEXID": 468817,
        "DATE": "2015-08-27",
        "STARTTIME": "08:30 AM",
        "FINISHTIME": "04:30 PM",
        "DURATION": 480,
        "ENROLLEES": [
            {
                "ENROLID": 830308,
                "CONTACTID": 1981857,
                "GIVENNAME": "Letitia",
                "SURNAME": "Vink",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": false,
                "ATTENDANCEID": 1433877,
                "ATTENDEDDURATION": 480,
                "COMMENT": ""
            },
            {
                "ENROLID": 868632,
                "CONTACTID": 2010891,
                "GIVENNAME": "Maxine",
                "SURNAME": "Knox",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": true,
                "ATTENDANCEID": 1433878,
                "ATTENDEDDURATION": 120,
                "COMMENT": "Testing 321"
            },
            {
                "ENROLID": 899944,
                "CONTACTID": 2104754,
                "GIVENNAME": "Melissa",
                "SURNAME": "Williams",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 900312,
                "CONTACTID": 1038809,
                "GIVENNAME": "Emily",
                "SURNAME": "Harris",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 901375,
                "CONTACTID": 2083804,
                "GIVENNAME": "Gemma",
                "SURNAME": "Willis",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 913946,
                "CONTACTID": 539585,
                "GIVENNAME": "Danielle",
                "SURNAME": "O'Neil",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 1027760,
                "CONTACTID": 2399446,
                "GIVENNAME": "Catherine",
                "SURNAME": "Tan",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 1027761,
                "CONTACTID": 2399470,
                "GIVENNAME": "Maxine",
                "SURNAME": "Fairholm",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 1027762,
                "CONTACTID": 2403549,
                "GIVENNAME": "Heidi",
                "SURNAME": "McKellar",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 1029508,
                "CONTACTID": 2293648,
                "GIVENNAME": "Elizabeth",
                "SURNAME": "Harding",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 1071001,
                "CONTACTID": 2399413,
                "GIVENNAME": "Serena",
                "SURNAME": "Hoffman",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 1071058,
                "CONTACTID": 20614,
                "GIVENNAME": "Suzette",
                "SURNAME": "Powell",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            }
        ]
    },
    {
        "INSTANCEID": 175740,
        "TYPE": "w",
        "COMPLEXID": 468818,
        "DATE": "2015-09-03",
        "STARTTIME": "08:30 AM",
        "FINISHTIME": "04:30 PM",
        "DURATION": 480,
        "ENROLLEES": [
            {
                "ENROLID": 1071058,
                "CONTACTID": 20614,
                "GIVENNAME": "Suzette",
                "SURNAME": "Powell",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 1071001,
                "CONTACTID": 2399413,
                "GIVENNAME": "Serena",
                "SURNAME": "Hoffman",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 1029508,
                "CONTACTID": 2293648,
                "GIVENNAME": "Elizabeth",
                "SURNAME": "Harding",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 1027762,
                "CONTACTID": 2403549,
                "GIVENNAME": "Heidi",
                "SURNAME": "McKellar",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 1027761,
                "CONTACTID": 2399470,
                "GIVENNAME": "Maxine",
                "SURNAME": "Fairholm",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 1027760,
                "CONTACTID": 2399446,
                "GIVENNAME": "Catherine",
                "SURNAME": "Tan",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 913946,
                "CONTACTID": 539585,
                "GIVENNAME": "Danielle",
                "SURNAME": "O'Neil",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 901375,
                "CONTACTID": 2083804,
                "GIVENNAME": "Gemma",
                "SURNAME": "Willis",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 900312,
                "CONTACTID": 1038809,
                "GIVENNAME": "Emily",
                "SURNAME": "Harris",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 899944,
                "CONTACTID": 2104754,
                "GIVENNAME": "Melissa",
                "SURNAME": "Williams",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 868632,
                "CONTACTID": 2010891,
                "GIVENNAME": "Maxine",
                "SURNAME": "Knox",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            },
            {
                "ENROLID": 830308,
                "CONTACTID": 1981857,
                "GIVENNAME": "Letitia",
                "SURNAME": "Vink",
                "COMPLETEDFLAG": false,
                "ATTENDEDFLAG": null,
                "ATTENDANCEID": null,
                "ATTENDEDDURATION": null,
                "COMMENT": ""
            }
        ]
    } 
]
print   print

resource /course/instance/search

Description

Advanced Course Instance Search - Returns instances.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/course/instance/search

Pattern: /course/instance/search
Handler: api.course
Action: {POST={searchCourseInstances}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/course/instance/search
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
ID numeric false The Activity Type ID.
InstanceID numeric false The Instance ID.
type string false The type of the activity. w = workshop, p = accredited program, el = e-learning, all = workshops, accredited programs and e-learning.
trainingCategory string false The Training Category to Search ��� Uses Like operator %name%
location string false The course location to search ��� Uses Like operator %name%. Only works with type 'w' instances.
state string false The course State to search ��� works with type 'w' & 'p' instances.
code string false The course code to search ��� Uses Like operator: code%
name string false The course name to search ��� Uses Like operator %name%
searchTerm string false For a general search use this param
enrolmentOpen boolean false true Return Course Instances that are open for enrolment.
startDate_min date false 3 months ago The course start date must be greater than this date. Null values will also be returned for el and p types. Ignored if instanceID is passed.
startDate_max date false 3 months ahead The course start date must be less than this date. Null values will also be returned for el and p types. Ignored if instanceID is passed.
finishDate_min date false 3 months ago The course finish date must be greater than this date. Null values will also be returned for el and p types.
finishDate_max date false 3 months ahead The course finish date must be less than this date. Null values will also be returned for el and p types.
lastUpdated_min datetime false In 'YYYY-MM-DD hh:mm' format with time optional. The course instance last updated date must be greater than or equal to this datetime. NOTE: lastUpdated_min & max must be used together (unless ID is passed) and can be up to 90 days apart. These fields are mutually exclusive with start and finish date min/max searches and are both ignored if instanceID is passed.
lastUpdated_max datetime false In 'YYYY-MM-DD hh:mm' format with time optional. The course instance last updated date must be less than or equal to this datetime.
trainerContactID numeric false The ContactID of the Trainer/Consultant the instance is assigned to.
domainID numeric false The DomainID the instance belongs to (the domainID of the user).
deliveryLocationID numeric false For type = p only. The unique ID of an accredited delivery location, reported to NCVER. Refers to locations listed under the course/deliveryLocations endpoint.
orgID numeric false The organisation ID of the Client Contact of the course.
orgIDTree numeric false The Client Contact of the course is either this Organisation ID or a child organisation of this Organisation ID.
offset numeric false 0 Used for paging - start at record.
displayLength numeric false 10 Used for paging - total records to retrieve.
sortColumn numeric false 1 The column index to sort by.
sortDirection string false ASC The sort by direction 'ASC' OR 'DESC'.
public boolean false true Whether to include public courses only. If false, returns all course instances.
isActive boolean false You can chose to include or exclude Deleted / Archived and Inactive courses.
purgeCache boolean false true Currently the API will cache the query for 30 seconds ��� Setting this flag to true gets the latest data.
groupedCourseName string false If the Grouped Workshop Data flag is on in your account, you can search by the Grouped Course Name (Type W Only)
groupedCourseID string false If the Grouped Workshop Data flag is on in your account, you can search by the Grouped Course ID (Type W Only)
Response Default Response Format: json

Samples

Courses Instance data returned in JSON format. Note that some of these fields (those dealing with participant numbers) only apply to workshop instances.

[
    {
        "ID": 16380,
        "INSTANCEID": 407209,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-03-06 09:00",
        "FINISHDATE": "2017-03-09 12:30",
        "DATEDESCRIPTOR": "6 - 9 March 2017",
        "LOCATION": "Sydney CBD",
        "COST": 20,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 4744,
        "NOTICES": null,
        "PARTICIPANTS": 18,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 2,
        "ENROLMENTOPEN": false,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 423316,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-03-14 09:30",
        "FINISHDATE": "2017-03-14 13:00",
        "DATEDESCRIPTOR": "14 March 2017",
        "LOCATION": "Melbourne",
        "COST": 0,
        "OWNERCONTACTID": 4744,
        "TRAINERCONTACTID": 4744,
        "NOTICES": null,
        "PARTICIPANTS": 1,
        "MAXPARTICIPANTS": 12,
        "MINPARTICIPANTS": 5,
        "PARTICIPANTVACANCY": 11,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 407217,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-05-11 09:00",
        "FINISHDATE": "2017-05-11 12:30",
        "DATEDESCRIPTOR": "11 May 2017",
        "LOCATION": "Brisbane City",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 8694,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 407219,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-05-16 09:00",
        "FINISHDATE": "2017-05-16 12:30",
        "DATEDESCRIPTOR": "16 May 2017",
        "LOCATION": "Adelaide",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 4744,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 407225,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-05-18 09:00",
        "FINISHDATE": "2017-05-18 12:30",
        "DATEDESCRIPTOR": "18 May 2017",
        "LOCATION": "Perth",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 4744,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 407214,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-05-25 09:00",
        "FINISHDATE": "2017-05-25 12:30",
        "DATEDESCRIPTOR": "25 May 2017",
        "LOCATION": "Melbourne CBD",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 4744,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 424374,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-06-15 09:30",
        "FINISHDATE": "2017-06-15 13:00",
        "DATEDESCRIPTOR": "15 June 2017",
        "LOCATION": "Sydney CBD",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 8694,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 424392,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-08-08 09:30",
        "FINISHDATE": "2017-08-08 13:00",
        "DATEDESCRIPTOR": "8 August 2017",
        "LOCATION": "Brisbane Inner City",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 8694,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 424385,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-08-10 09:30",
        "FINISHDATE": "2017-08-10 13:00",
        "DATEDESCRIPTOR": "10 August 2017",
        "LOCATION": "Melbourne Inner City",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 4744,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 424407,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-09-26 09:30",
        "FINISHDATE": "2017-09-26 13:00",
        "DATEDESCRIPTOR": "26 September 2017",
        "LOCATION": "Sydney Inner City",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 8694,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 424421,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-11-07 09:30",
        "FINISHDATE": "2017-11-07 13:00",
        "DATEDESCRIPTOR": "7 November 2017",
        "LOCATION": "Brisbane Inner City",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 8694,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 424419,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-11-09 09:30",
        "FINISHDATE": "2017-11-09 13:00",
        "DATEDESCRIPTOR": "9 November 2017",
        "LOCATION": "Melbourne Inner City",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 4744,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    },
    {
        "ID": 16380,
        "INSTANCEID": 424422,
        "NAME": "aXcelerate Client Forum",
        "STARTDATE": "2017-11-14 09:30",
        "FINISHDATE": "2017-11-14 13:00",
        "DATEDESCRIPTOR": "14 November 2017",
        "LOCATION": "Sydney CBD",
        "COST": 0,
        "OWNERCONTACTID": 1038809,
        "TRAINERCONTACTID": 8694,
        "NOTICES": null,
        "PARTICIPANTS": 0,
        "MAXPARTICIPANTS": 20,
        "MINPARTICIPANTS": 1,
        "PARTICIPANTVACANCY": 20,
        "ENROLMENTOPEN": true,
        "ISACTIVE": true
    }
]
print   print

resource /course/instance/detail

Description

Returns details of an activity instance.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/course/instance/detail

Pattern: /course/instance/detail
Handler: api.course
Action: {GET={getCourseInstanceDetails}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/course/instance/detail
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
instanceID numeric true The instanceID of the activity you want details from.
type string true The activity type of the activity. w = workshop, p = accredited program, el = e-learning.
Response Default Response Format: json

Samples

Courses returned in JSON format. The example below is for an accredited program (type=p)

{
    "UNITS": [
        {
            "MODULE": {},
            "UNITID": 35668,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Implement and monitor environmentally sustainable work practices",
            "UNITCODE": "BSBSUS301A",
            "UNITORDER": 1,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        },
        {
            "MODULE": {},
            "UNITID": 37713,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Provide technical advice",
            "UNITCODE": "DEFCM008B",
            "UNITORDER": 2,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        },
        {
            "MODULE": {},
            "UNITID": 37707,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Supervise contractors",
            "UNITCODE": "DEFRM209B",
            "UNITORDER": 3,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        },
        {
            "MODULE": {},
            "UNITID": 37706,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Conduct testing processes",
            "UNITCODE": "DEFTE003A",
            "UNITORDER": 4,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        },
        {
            "MODULE": {},
            "UNITID": 37702,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Use public sector financial processes",
            "UNITCODE": "PSPFIN401A",
            "UNITORDER": 5,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        },
        {
            "MODULE": {},
            "UNITID": 37712,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Gather and analyse information",
            "UNITCODE": "PSPGOV406B",
            "UNITORDER": 6,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        },
        {
            "MODULE": {},
            "UNITID": 37703,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Compose complex workplace documents",
            "UNITCODE": "PSPGOV413A",
            "UNITORDER": 7,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        },
        {
            "MODULE": {},
            "UNITID": 37701,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Undertake research and analysis",
            "UNITCODE": "PSPGOV504B",
            "UNITORDER": 8,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        },
        {
            "MODULE": {},
            "UNITID": 37704,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Refine complex workplace documents",
            "UNITCODE": "PSPGOV513A",
            "UNITORDER": 9,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        },
        {
            "MODULE": {},
            "UNITID": 37710,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Design simple projects",
            "UNITCODE": "PSPPM401B",
            "UNITORDER": 10,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        },
        {
            "MODULE": {},
            "UNITID": 37711,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Manage simple projects",
            "UNITCODE": "PSPPM402B",
            "UNITORDER": 11,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        },
        {
            "MODULE": {},
            "UNITID": 37700,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Close simple projects",
            "UNITCODE": "PSPPM403B",
            "UNITORDER": 12,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        },
        {
            "MODULE": {},
            "UNITID": 37698,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Carry out simple project activities",
            "UNITCODE": "PSPPM404A",
            "UNITORDER": 13,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        },
        {
            "MODULE": {},
            "UNITID": 37715,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Administer simple projects",
            "UNITCODE": "PSPPM405A",
            "UNITORDER": 14,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        },
        {
            "MODULE": {},
            "UNITID": 37705,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Provide services to clients",
            "UNITCODE": "PUACOM002B",
            "UNITORDER": 15,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        },
        {
            "MODULE": {},
            "UNITID": 37699,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Liaise with other organisations",
            "UNITCODE": "PUACOM007B",
            "UNITORDER": 16,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        },
        {
            "MODULE": {},
            "UNITID": 37714,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Conduct risk assessment",
            "UNITCODE": "PUAEMR007B",
            "UNITORDER": 17,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        },
        {
            "MODULE": {},
            "UNITID": 37708,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Treat operational risk",
            "UNITCODE": "PUAEMR026",
            "UNITORDER": 18,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        },
        {
            "MODULE": {},
            "UNITID": 37697,
            "SCHEDULEDSTARTDATE": null,
            "UNIT": "Assess operational risk",
            "UNITCODE": "PUAEMR027",
            "UNITORDER": 19,
            "SCHEDULEDENDDATE": null,
            "ELECTIVE": 0
        }
    ],
    "REPORTINGSTANDARD": "QLD DETE (DETConnect)",
    "OWNERCONTACTID": 1100635,
    "ENROLMENTOPEN": false,
    "LOCATION": "VM Learning Offices",
    "DELIVERYLOCATIONID": 701,
    "INSTANCEID": 67569,
    "TRAINERCONTACTID": null,
    "STARTDATE": "2014-05-22 00:00",
    "FINISHDATE": "2014-05-22 00:00",
    "COST": 0,
    "NAME": "AAAAA test",
    "ID": 4109,
    "DATEDESCRIPTOR": "22/05/2014 - 22/05/2014",
    "PUBLIC": false,
    "NOTICES": null
}
print   print

resource /course/instance/

Description

Creates an activity instance.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/course/instance/

Pattern: /course/instance/
Handler: api.course
Action: {POST={create}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/course/instance/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
ID numeric true The Type ID of the activity you want to Create - For now: the API can only create Workshop Instances (accredited [a linked class will be created] / non-accredited).
type string true The activity type of the activity. w = workshop, p = accredited program, el = e-learning.
name string true The activity name.
startDate string true The activity Start Date.
finishDate string true The activity Finish Date.
startTime string true The activity Start Time.
finishTime string true The activity Finish Time.
trainerContactID string true The activity trainer.
location string false The activity location.
contactID string true The activity owner.
cost string false The Cost Per Participant / Student.
domainID string false The activity domain ID.
comments string false Any Comments for the Activity Instance.
public string false Public or Private - For type 'w' it is the coordination type: In-House (0) or Public Workshop (1).
dateDescriptor string false Specific to type 'w' - The Date Descriptor - i.e Between 2-5 PM on Thursday the 20/11/2014.
minParticipants string false Specific to type 'w' - The Minimum Participants.
maxParticipants string false Specific to type 'w' - The Maxium Participants.
estimatedParticipants string false Specific to type 'w' - The Estimated Participants expected to enrol.
duration string false Specific to Workshops - The Duration numerical value.
durationType string false Specific to Workshops - The Duration Type i.e: hour, hours, day, days, half-day, session, sessions.
Response Default Response Format: json

Samples

Upon a successful creation of an Instance, the API will return the InstanceID.

{
    "MESSAGE": "",
    "STATUS": "success"
	"INSTANCEID": 136293
}
print   print

resource /course/enrol

Description

Enrols a Contact in an Activity Instance. This method will also send an email to the student, the payer, and a notification to your administrator.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/course/enrol

Pattern: /course/enrol
Handler: api.course
Action: {POST={enrol}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/course/enrol
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
contactID numeric true The ID of the Contact you are enrolling.
instanceID numeric true The ID of the Activity Instance you are enrolling the contact into.
type string true The type of the activity. w = workshop, p = accredited program, el = e-learning.
tentative boolean false Enrol the Contact as Tentative.
payerID numeric false The ID of the Contact that is paying for the course. If omitted, it will be assumed that the student (contactID) is paying.
invoiceID numeric false 0 The ID of the invoice created for this Contact (created during payment) OR the ID of the invoice you wish to add this enrolment to. If the invoiceID is not passed, or is 0, the booking will still go ahead and the contact will be invoiced for it.
PONumber string false If a new invoice is generated as a result of this booking, use this as the Purchase Order Number.
generateInvoice boolean false true Determines whether you'd like a new invoice to be generated as a result of this booking. This will only work if the course cost is greater than $0. This also will not work if your aXcelerate System Settings are set to 'Free Online Bookings'.
lockInvoiceItems boolean false true If an new invoice is generated, determines whether the items are locked. Items must be locked before a payment can be applied against an invoice. However, some invoice details can later be changed, such as address and purchase order numbers.
archiveInvoice boolean false false If an new invoice is generated, determines whether it is completely locked and archived. Once archived, no invoice details can later be changed.
forceBooking boolean false false Don't check to see if the enrolment is closed first.
bookOnDefaultWorkshops boolean false true Applicable only to program bookings (type=p), this will book the contact into any workshops linked to the class's units. For this to work, each unit in the class can only be linked to a single workshop. An error will be thrown if more than one workshop is against a class unit and this parameter is set to true.
syncDatesWithWorkshop boolean false true Applicable only to program bookings (type=p) and where bookOnDefaultWorkshops is true. This will set unit start/end dates to the same as that of the linked workshops.
syncWithClassSchedule boolean false false Applicable only to program bookings (type=p) and passing the dateCommenced parameter. This will offset all unit start/end dates based on the offset between the student's date commenced and the class start.
applyGST boolean false false Applicable only to program bookings (type=p) - if true will mark the cost as includes GST. Normally, accredited training should be GST-free.
dateCommenced date false Applicable only to program bookings (type=p) - The enrolment Commencement Date.
dateCompletionExpected date false Applicable only to program bookings (type=p) - The Expected Completion Date. Ignored if using syncWithClassSchedule
suppressNotifications boolean false false Don't send any email booking notifications. Auto-generate user emails will still send.
useRegistrationFormDefaults boolean false false Used for direct or linked accredited program bookings (type p). If true, the system will apply the default enrolment form values set against the system settings. This form can be edited under Settings > Registration Form > Class Enrolment Form.
StudyReasonID numeric false AVETMISS Study Reason (For Accredited enrolments).
FundingNational numeric false AVETMISS Funding Source - National (For Accredited enrolments) - See sample table below for values.
marketingAgentContactID numeric false The ID of the Contact that should be set as the marketing agent for the enrolment.
serviceDate string false The (invoice item) Service date.
cost numeric false The Discounted Cost.
discountIDList string false A list of valid discountIDs for this booking. Required when 'cost' is passed.
customField_[variableName] string false Replace [variableName] with the actual customField variable name to set a customField value against the enrolment (if enabled and set up). If updating a custom field that supports multiple values, you can use comma-delimited values or a JSON array. If using comma-delimited, it is expected the data is URL encoded first. For example, to get 2 values: 'A,B' and 'C' you would either pass: "['A,B','C']" or "A%2CB,C"
FundingState string false AVETMISS Funding Source - State (For Accredited enrolments) - See sample table below for values.
PSTACDateVIC date false [Type=P] Program Supervised Teaching Activity Completion Date for Victorian AVETMISS reporting.
Response Default Response Format: json

Samples

FundingNational

					Revenue from government
					11 - Commonwealth and state general purpose recurrent
					13 - Commonwealth specific purpose programs
					15 - State specific purpose programs

					Other revenue
					20 - Domestic full fee-paying client
					30 - International full fee-paying client
					31 - International Onshore Student
					32 - International Offshore Student
					80 - Revenue earned from another training organisation

FundingState

					03 - Fee for Service
					11 - Commonwealth and State General purpose Recurrent
					13 - Commonwealth Specific Purpose programs
					15 - State Specific Purpose programs
					1GT - Gap Training
					1SA - Skills Assessments
					20 - Domestic full fee-paying student
					2GT - Gap Training
					2SA - Skills Assessments
					30 - International full fee-paying student
					9GT - Gap Training
					9SA - Skills Assessments
					BMI - Mining Industry
					CCP - Civil Construction Brokerage Pilot
					CHL - Civil Construction Higher Level Skills
					CLG - Cert III Guarantee - Community Learning
					CLI - Community Learning Intervention
					CLP - Community Literacy Program
					CSG - Civil Construction Skills Assessment and Gap Training
					CSP - Community Services Skilling Plan
					CSQ - Construction Skills Queensland
					ENH - Higher Level Skills program - Mainstream student
					ENT - Cert III Guarantee - Mainstream students
					ETR - ETRF Accredited Training & Employment Youth Initiatives
					F2 - Strategic Purchasing Program
					F3 - User Choice competitively funded - Apprenticeships
					GK - User Choice competitively funded - Trainees
					GS1 - Cert III Guarantee - Year 12 graduates
					GS2 - Cert III Guarantee - User Choice Full Fee
					GS3 - Cert III Guarantee - User Choice Partial Exemption
					GS4 - Cert III Guarantee - User Choice Full Exemption
					HLT - Higher Level Skills program - Student accessing VET FEE-HELP loan
					HS1 - Higher Skills Program 1
					IFF - Strategic Investment Fund Fees
					IFN - Strategic Investment Fund NoIFP - Indigenous Funding Program
					IP3 - Cert III Guarantee - Industry Partnerships Strategy
					IPH - Higher Level Skills program - Industry Partnerships Strategy
					IT3 - Cert III Guarantee - Indigenous Training Strategy
					ITH - Higher Level Skills program - Indigenous Training Strategy
					LLN - Language Literacy and Numeracy
					NWC - National Workforce Critical Skills
					NWE - National Workforce Existing Worker
					NWJ - National Workforce Jobseeker
					PBJ - Productivity Brokerage Job Seeker
					PBW - Productivity Brokerage Existing Worker
					PEW - Productivity Places Program - Existing Workers (Enterprise)
					PPP - Productivity Places Program
					PRJ - PPP (Job Seekers)
					PRW - PPP (Existing Workers)
					PSJ - PPP Skilling Queenslanders for Work (Job Seekers)
					PT1 - Post-Trade Training Program
					RWF - Regional Workforce Development Initiative
					RWN - Regional Workforce Development Initiative
					SAT - User Choice competitively funded - School-based
					SC1 - Short Courses Program 1
					SJ3 - training delivered under the Single and Teenage Parent Program (STPP) - Fees paid by Government
					SQW - Skilling Queenslanders for Work
					SSQ - Skilling Solutions Queensland
					ST3 - training delivered under the Single and Teenage Parent Program (STPP)
					ST5 - training delivered under the Single and Teenage Parent Program (STPP)
					TFW - Training For Work
					TIF - Training Initiative for Indigenous Adults Regional/Remote (TIFIARRC)
					TRA - Training Skills Assessment and Gap Training
					TSC - Trade Start - Civil Construction Program
					TSG - Trade Start General
					VSS - VET in Schools (secondary school students)
					IT5 - Indigenous VET Partnerships
					SQI - Training funded under Skilling QLD for Work
					SQT - Training funded under Certificate 3 Guarentee
					T02 - TAFE User Choice
					20 - Domestic full fee-paying client
					SPP - Schools Private Provider

Study Reason IDs

Values for National AND VET Student Loans
					studyReasons = [
					{code = 1, description = 'To get a job'},
					{code = 2, description = 'To develop my existing business'},
					{code = 3, description = 'To start my own business'},
					{code = 4, description = 'To try for a different career'},
					{code = 5, description = 'To get a better job or promotion'},
					{code = 6, description = 'It was a requirement of my job'},
					{code = 7, description = 'I wanted extra skills for my job'},
					{code = 8, description = 'To get into another course of study'},
					{code = 11, description = 'Other reasons'},
					{code = 12, description = 'For personal interest or self-development'}
					{code = 13, description = 'To get skills for community/voluntary work'}
					]


					WA RAPT Values
					studyReasons = [
					{code = 1, description = 'To get a job'},
					{code = 3, description = 'To get a promotion/improve my career'},
					{code = 4, description = 'To start a different career'},
					{code = 6, description = 'To get into another course at TAFE or University'},
					{code = 8, description = 'Other reasons'},
					{code = 22, description = 'To develop my own business'},
					{code = 23, description = 'To start my own business'},
					{code = 26, description = 'It was a requirement for my job'},
					{code = 27, description = 'I wanted extra skills for my job'},
					{code = 29, description = 'For personal interest'},
					{code = 30, description = 'For self development'}
					])

Upon a successful enrolment, this returns the unique learnerID for this student's enrolment. It also returns an invoiceID, amount and the contactID. Note that for type p bookings, where an invoice has not yet been created, one will not automatically be created by the API, so the invoiceID will remain 0.

{
    "INVOICEID": 61648,
    "CONTACTID": 952989,
    "LEARNERID": 507096,
    "AMOUNT": 490
}
print   print

resource /course/enrolMultiple

Description

Enrols one or more Contacts in a workshop activity Instance. For this enrolment function only workshops [type=w] is allowed. This method will also send an email to the students, the payer, and a notification to your administrator.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/course/enrolMultiple

Pattern: /course/enrolMultiple
Handler: api.course
Action: {POST={enrolmultiple}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/course/enrolMultiple
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
contactID list true The IDs of the Contacts you are enrolling. This can be 1 or more.
instanceID numeric true The ID of the Activity Instance you are enrolling the contact into.
type string false w The type of the activity. w = workshop, p = accredited program, el = e-learning. For this method ONLY w is valid.
payerID numeric true The ID of the Contact that is paying for the course. This must be passed for a multiple enrolment.
invoiceID numeric false 0 The ID of the invoice created for this Contact (created during payment). If the invoiceID is not passed, or is 0, the booking will still go ahead and the contact will be invoiced for it.
PONumber string false If a new invoice is generated as a result of these bookings, use this as the Purchase Order Number.
generateInvoice boolean false true Determines whether you'd like a new invoice to be generated as a result of this booking. This will only work if the course cost is greater than $0. This also will not work if your aXcelerate System Settings are set to 'Free Online Bookings'.
lockInvoiceItems boolean false true If an new invoice is generated, determines whether the items are locked. Items must be locked before a payment can be applied against an invoice. However, some invoice details can later be changed, such as address and purchase order numbers.
archiveInvoice boolean false false If an new invoice is generated, determines whether it is completely locked and archived. Once archived, no invoice details can later be changed.
suppressNotifications boolean false false Don't send any email booking notifications. Auto-generate user emails will still send.
useRegistrationFormDefaults boolean false false Used for direct or linked accredited program bookings (type p). If true, the system will apply the default enrolment form values set against the system settings. This form can be edited under Settings > Registration Form > Class Enrolment Form.
marketingAgentContactID numeric false The ID of the Contact that should be set as the marketing agent for the enrolments.
serviceDate string false The (invoice item) Service date.
PSTACDateVIC date false [Type=P] Program Supervised Teaching Activity Completion Date for Victorian AVETMISS reporting.
bookOnDefaultWorkshops boolean false true Applicable only to program bookings (type=p), this will book the contact into any workshops linked to the class's units. For this to work, each unit in the class can only be linked to a single workshop. An error will be thrown if more than one workshop is against a class unit and this parameter is set to true.
syncDatesWithWorkshop boolean false true Applicable only to program bookings (type=p) and where bookOnDefaultWorkshops is true. This will set unit start/end dates to the same as that of the linked workshops.
syncWithClassSchedule boolean false false Applicable only to program bookings (type=p) and passing the dateCommenced parameter. This will offset all unit start/end dates based on the offset between the student's date commenced and the class start.
applyGST boolean false false Applicable only to program bookings (type=p) - if true will mark the cost as includes GST. Normally, accredited training should be GST-free.
dateCommenced date false Applicable only to program bookings (type=p) - The enrolment Commencement Date.
dateCompletionExpected date false Applicable only to program bookings (type=p) - The Expected Completion Date. Ignored if using syncWithClassSchedule
Response Default Response Format: json

Samples

Upon a successful enrolment, this returns an array of structs containing the unique learnerID and contactID for each student's enrolment

[
    {
        "INVOICEID": 61649,
        "CONTACTID": 14605,
        "LEARNERID": 507097,
        "AMOUNT": 490
    },
    {
        "INVOICEID": 61649,
        "CONTACTID": 15656,
        "LEARNERID": 507098,
        "AMOUNT": 490
    }
]
print   print

resource /course/enrolments

Description

Return one or more Contacts enrolled in an activity Instance. NB: This currently works on Program and Workshop (type=p & type=w) courses only!

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/course/enrolments

Pattern: /course/enrolments
Handler: api.course
Action: {GET={getEnrolments}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/course/enrolments
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
contactID numeric false The ID of the Contact.
orgID numeric false The ID of the Organisation.
instanceID numeric false The ID of the Activity Instance.
ID numeric false The ID Activity Type - Use this in combination with enrolmentDateOlderThan for speed.
enrolmentDateOlderThan date false Get enrolments after this date - alternate param 'enrolmentDateLaterThan' (for sanity).
NOTE: this is now restricted to 30 days. If you wish to retrieve enroments older than 30 days, please use the lastUpdated or enrolmentDate min/max params.
WARNING:Results will be limited to 25 unless also passing an ID parameter.
lastUpdated_min datetime false In 'YYYY-MM-DD hh:mm' format. The enrolment last updated date must be greater than or equal to this datetime. Enrolments last updated prior to Nov 2018 may not appear. Time is optional and in client's current timezone. NOTE: lastUpdated_min & max must be used together and can be up to 90 days apart.
lastUpdated_max datetime false In 'YYYY-MM-DD hh:mm' format. The enrolment last updated date must be less than or equal to this datetime. Enrolments last updated prior to Nov 2018 may not appear. Time is optional and in client's current timezone.
enrolmentDate_min datetime false In 'YYYY-MM-DD hh:mm' format. The enrolment date must be greater than or equal to this datetime. Time is optional and in client's current timezone. NOTE: enrolmentDate_min & max must be used together and can be up to 30 days apart.
enrolmentDate_max datetime false In 'YYYY-MM-DD hh:mm' format. The enrolment date must be less than or equal to this datetime. Time is optional and in client's current timezone.
type string false p The type of the activity. w = workshop, p = accredited program, el = e-learning. Only p & w work at this time
filterType string false Filter related activities. s = show Subjects and related eLearning, el = show related eLearning only. Only s & el works at this time. To use this filter you must also pass a contactID for the student.
Response Default Response Format: json

Samples

This returns an array of structs containing the unique learnerID and contactID for each student's enrolment

[
    {
        "ENROLMENTDATE": "2013-07-24 00:00",
        "MOBILEPHONE": null,
        "INSTANCEID": 32373,
        "CONTACTID": 620392,
        "STARTDATE": "2013-07-24 00:00",
        "SURNAME": "Forrest",
        "ACTIVITIES": [
            {
                "ENROLMENTDATE": "2013-07-24 00:00",
               	"MOBILEPHONE": null,
                "DELIVERY": {
                    "CODE": 10,
                    "DESCRIPTION": "Classroom-based"
                },
                "INSTANCEID": 214324,
                "CONTACTID": 620392,
                "STARTDATE": "2013-07-24 00:00",
                "SURNAME": "Forrest",
                "ACTIVITIES": [
                    {
                        "ENROLMENTDATE": "2013-07-24 10:17",
                        "MOBILEPHONE": null,
		                "DELIVERY": {
		                    "CODE": 10,
		                    "DESCRIPTION": "Classroom-based"
		                },
                        "INSTANCEID": 55827,
                        "CONTACTID": 620392,
                        "STARTDATE": "2013-07-24 00:00",
                        "SURNAME": "Forrest",
                        "ACTIVITIES": [],
                        "AMOUNTPAID": 0,
                        "FINISHDATE": "2013-07-24 00:00",
                        "CODE": "ASSERT",
                        "LEARNERID": 283486,
                        "NAME": "Assertiveness Skills",
                        "ID": 211,
                        "TYPE": "w",
                        "GIVENNAME": "Brad",
                        "EMAIL": "brad.forrest@vmlearning.com.au"
                    }
                ],
                "STATUS": "C",
                "OUTCOMECODE": "20",
                "AMOUNTPAID": null,
                "FINISHDATE": "2013-07-31 00:00",
                "CODE": "1111TUOC",
                "LEARNERID": 2140554,
                "NAME": "1111 Test Unit of Competency",
                "ID": 41862,
                "TYPE": "s",
                "GIVENNAME": "Brad",
                "EMAIL": "brad.forrest@vmlearning.com.au"
            }
        ],
        "AMOUNTPAID": 0,
        "FINISHDATE": null,
        "CODE": "CUS10101",
        "LEARNERID": 417245,
        "NAME": "Assertiveness Skills (linked class)",
        "ID": 4369,
        "TYPE": "p",
        "GIVENNAME": "Brad",
        "EMAIL": "brad.forrest@vmlearning.com.au",
        "SCHOOLTYPEID": "25",
        "SCHOOLORGID": 538562
    },
    {
        "ENROLMENTDATE": "2014-03-31 00:00",
        "INSTANCEID": 27495,
        "CONTACTID": 116482,
        "STARTDATE": "2013-05-01 00:00",
        "SURNAME": "Gordon",
        "ACTIVITIES": [
            {
                "ENROLMENTDATE": "2013-05-01 00:00",
                "MOBILEPHONE": null,
                "DELIVERY": {
                    "CODE": 10,
                    "DESCRIPTION": "Classroom-based"
                },
                "INSTANCEID": 187987,
                "CONTACTID": 116482,
                "STARTDATE": "2013-05-01 00:00",
                "SURNAME": "Gordon",
                "ACTIVITIES": [],
                "STATUS": "C",
                "OUTCOMECODE": "20",
                "AMOUNTPAID": null,
                "FINISHDATE": null,
                "CODE": "BSBCCO405A",
                "LEARNERID": 3135016,
                "NAME": "Survey stakeholders to gather and record information",
                "ID": 30593,
                "TYPE": "s",
                "GIVENNAME": "Nathan",
                "EMAIL": "nathan.gordon@vmlearning.com.au"
            },
            {
                "ENROLMENTDATE": "2013-05-23 00:00",
                "MOBILEPHONE": null,
                "DELIVERY": {
                    "CODE": 10,
                    "DESCRIPTION": "Classroom-based"
                },
                "INSTANCEID": 187988,
                "CONTACTID": 116482,
                "STARTDATE": "2013-05-23 00:00",
                "SURNAME": "Gordon",
                "ACTIVITIES": [
                    {
                        "ENROLMENTDATE": "2014-03-31 13:50",
		                "MOBILEPHONE": null,
		                "DELIVERY": {
		                    "CODE": 10,
		                    "DESCRIPTION": "Classroom-based"
		                },
                        "INSTANCEID": 47706,
                        "CONTACTID": 116482,
                        "STARTDATE": "2013-05-23 00:00",
                        "SURNAME": "Gordon",
                        "ACTIVITIES": [],
                        "AMOUNTPAID": 0,
                        "FINISHDATE": "2013-05-23 00:00",
                        "CODE": "aXweb",
                        "LEARNERID": 469157,
                        "NAME": "aXcelerate Webinar Advanced! - Accredited Workshops",
                        "ID": 4400,
                        "TYPE": "w",
                        "GIVENNAME": "Nathan",
                        "EMAIL": "nathan.gordon@vmlearning.com.au"
                    }
                ],
                "STATUS": "C",
                "OUTCOMECODE": "20",
                "AMOUNTPAID": null,
                "FINISHDATE": null,
                "CODE": "BSBCUS301A",
                "LEARNERID": 3135017,
                "NAME": "Deliver and monitor a service to customers",
                "ID": 30601,
                "TYPE": "s",
                "GIVENNAME": "Nathan",
                "EMAIL": "nathan.gordon@vmlearning.com.au"
            },
            {
                "ENROLMENTDATE": "2013-05-23 00:00",
                "MOBILEPHONE": null,
                "DELIVERY": {
                    "CODE": 10,
                    "DESCRIPTION": "Classroom-based"
                },
                "INSTANCEID": 187989,
                "CONTACTID": 116482,
                "STARTDATE": "2013-05-23 00:00",
                "SURNAME": "Gordon",
                "ACTIVITIES": [
                    {
                        "ENROLMENTDATE": "2014-03-31 13:50",
		                "MOBILEPHONE": null,
		                "DELIVERY": {
		                    "CODE": 10,
		                    "DESCRIPTION": "Classroom-based"
		                },
                        "INSTANCEID": 47706,
                        "CONTACTID": 116482,
                        "STARTDATE": "2013-05-23 00:00",
                        "SURNAME": "Gordon",
                        "ACTIVITIES": [],
                        "AMOUNTPAID": 0,
                        "FINISHDATE": "2013-05-23 00:00",
                        "CODE": "aXweb",
                        "LEARNERID": 469157,
                        "NAME": "aXcelerate Webinar Advanced! - Accredited Workshops",
                        "ID": 4400,
                        "TYPE": "w",
                        "GIVENNAME": "Nathan",
                        "EMAIL": "nathan.gordon@vmlearning.com.au"
                    }
                ],
                "STATUS": "CNA",
                "OUTCOMECODE": "30",
                "AMOUNTPAID": null,
                "FINISHDATE": null,
                "CODE": "BSBCUS403A",
                "LEARNERID": 3135018,
                "NAME": "Implement customer service standards",
                "ID": 30602,
                "TYPE": "s",
                "GIVENNAME": "Nathan",
                "EMAIL": "nathan.gordon@vmlearning.com.au"
            },
            {
                "ENROLMENTDATE": "2013-05-23 00:00",
                "MOBILEPHONE": null,
                "DELIVERY": {
                    "CODE": 10,
                    "DESCRIPTION": "Classroom-based"
                },
                "INSTANCEID": 187990,
                "CONTACTID": 116482,
                "STARTDATE": "2013-05-23 00:00",
                "SURNAME": "Gordon",
                "ACTIVITIES": [
                    {
                        "ENROLMENTDATE": "2014-03-31 13:50",
		                "MOBILEPHONE": null,
		                "DELIVERY": {
		                    "CODE": 10,
		                    "DESCRIPTION": "Classroom-based"
		                },
                        "INSTANCEID": 47706,
                        "CONTACTID": 116482,
                        "STARTDATE": "2013-05-23 00:00",
                        "SURNAME": "Gordon",
                        "ACTIVITIES": [],
                        "AMOUNTPAID": 0,
                        "FINISHDATE": "2013-05-23 00:00",
                        "CODE": "aXweb",
                        "LEARNERID": 469157,
                        "NAME": "aXcelerate Webinar Advanced! - Accredited Workshops",
                        "ID": 4400,
                        "TYPE": "w",
                        "GIVENNAME": "Nathan",
                        "EMAIL": "nathan.gordon@vmlearning.com.au"
                    }
                ],
                "STATUS": "C",
                "OUTCOMECODE": "20",
                "AMOUNTPAID": null,
                "FINISHDATE": null,
                "CODE": "BSBOHS404B",
                "LEARNERID": 3135019,
                "NAME": "Contribute to the implementation of strategies to control OHS risk",
                "ID": 30592,
                "TYPE": "s",
                "GIVENNAME": "Nathan",
                "EMAIL": "nathan.gordon@vmlearning.com.au"
            },
            {
                "ENROLMENTDATE": "2013-05-23 00:00",
                "MOBILEPHONE": null,
                "DELIVERY": {
                    "CODE": 10,
                    "DESCRIPTION": "Classroom-based"
                },
                "INSTANCEID": 187991,
                "CONTACTID": 116482,
                "STARTDATE": "2013-05-23 00:00",
                "SURNAME": "Gordon",
                "ACTIVITIES": [
                    {
                        "ENROLMENTDATE": "2014-03-31 13:50",
		                "MOBILEPHONE": null,
		                "DELIVERY": {
		                    "CODE": 10,
		                    "DESCRIPTION": "Classroom-based"
		                },
                        "INSTANCEID": 47706,
                        "CONTACTID": 116482,
                        "STARTDATE": "2013-05-23 00:00",
                        "SURNAME": "Gordon",
                        "ACTIVITIES": [],
                        "AMOUNTPAID": 0,
                        "FINISHDATE": "2013-05-23 00:00",
                        "CODE": "aXweb",
                        "LEARNERID": 469157,
                        "NAME": "aXcelerate Webinar Advanced! - Accredited Workshops",
                        "ID": 4400,
                        "TYPE": "w",
                        "GIVENNAME": "Nathan",
                        "EMAIL": "nathan.gordon@vmlearning.com.au"
                    },
                    {
                        "ENROLMENTDATE": "2014-04-01 17:05",
		                "MOBILEPHONE": null,
		                "DELIVERY": {
		                    "CODE": 10,
		                    "DESCRIPTION": "Classroom-based"
		                },
                        "INSTANCEID": 2598,
                        "CONTACTID": 116482,
                        "STARTDATE": "2014-04-01 00:00",
                        "SURNAME": "Gordon",
                        "ACTIVITIES": [],
                        "AMOUNTPAID": null,
                        "FINISHDATE": null,
                        "CODE": null,
                        "LEARNERID": 821,
                        "NAME": "May Intake test",
                        "ID": 2598,
                        "TYPE": "el",
                        "GIVENNAME": "Nathan",
                        "EMAIL": "nathan.gordon@vmlearning.com.au"
                    }
                ],
                "STATUS": "C",
                "OUTCOMECODE": "20",
                "AMOUNTPAID": null,
                "FINISHDATE": null,
                "CODE": "FNSCUS402A",
                "LEARNERID": 3135020,
                "NAME": "Resolve disputes",
                "ID": 30590,
                "TYPE": "s",
                "GIVENNAME": "Nathan",
                "EMAIL": "nathan.gordon@vmlearning.com.au"
            },
            {
                "ENROLMENTDATE": "2013-05-23 00:00",
                "MOBILEPHONE": null,
                "DELIVERY": {
                    "CODE": 10,
                    "DESCRIPTION": "Classroom-based"
                },
                "INSTANCEID": 187992,
                "CONTACTID": 116482,
                "STARTDATE": "2013-05-23 00:00",
                "SURNAME": "Gordon",
                "ACTIVITIES": [
                    {
                        "ENROLMENTDATE": "2014-03-31 13:50",
		                "MOBILEPHONE": null,
		                "DELIVERY": {
		                    "CODE": 10,
		                    "DESCRIPTION": "Classroom-based"
		                },
                        "INSTANCEID": 47706,
                        "CONTACTID": 116482,
                        "STARTDATE": "2013-05-23 00:00",
                        "SURNAME": "Gordon",
                        "ACTIVITIES": [],
                        "AMOUNTPAID": 0,
                        "FINISHDATE": "2013-05-23 00:00",
                        "CODE": "aXweb",
                        "LEARNERID": 469157,
                        "NAME": "aXcelerate Webinar Advanced! - Accredited Workshops",
                        "ID": 4400,
                        "TYPE": "w",
                        "GIVENNAME": "Nathan",
                        "EMAIL": "nathan.gordon@vmlearning.com.au"
                    }
                ],
                "STATUS": "C",
                "OUTCOMECODE": "20",
                "AMOUNTPAID": null,
                "FINISHDATE": null,
                "CODE": "FNSINC401A",
                "LEARNERID": 3135021,
                "NAME": "Apply principles of professional practice to work in the financial services industry",
                "ID": 30591,
                "TYPE": "s",
                "GIVENNAME": "Nathan",
                "EMAIL": "nathan.gordon@vmlearning.com.au"
            },
            {
                "ENROLMENTDATE": "2013-05-23 00:00",
                "MOBILEPHONE": null,
                "DELIVERY": {
                    "CODE": 10,
                    "DESCRIPTION": "Classroom-based"
                },
                "INSTANCEID": 187993,
                "CONTACTID": 116482,
                "STARTDATE": "2013-05-23 00:00",
                "SURNAME": "Gordon",
                "ACTIVITIES": [
                    {
                        "ENROLMENTDATE": "2014-03-31 13:50",
		                "MOBILEPHONE": null,
		                "DELIVERY": {
		                    "CODE": 10,
		                    "DESCRIPTION": "Classroom-based"
		                },
                        "INSTANCEID": 47706,
                        "CONTACTID": 116482,
                        "STARTDATE": "2013-05-23 00:00",
                        "SURNAME": "Gordon",
                        "ACTIVITIES": [],
                        "AMOUNTPAID": 0,
                        "FINISHDATE": "2013-05-23 00:00",
                        "CODE": "aXweb",
                        "LEARNERID": 469157,
                        "NAME": "aXcelerate Webinar Advanced! - Accredited Workshops",
                        "ID": 4400,
                        "TYPE": "w",
                        "GIVENNAME": "Nathan",
                        "EMAIL": "nathan.gordon@vmlearning.com.au"
                    }
                ],
                "STATUS": "C",
                "OUTCOMECODE": "20",
                "AMOUNTPAID": null,
                "FINISHDATE": null,
                "CODE": "FNSINC402A",
                "LEARNERID": 3135022,
                "NAME": "Develop and maintain in-depth knowledge of products and services used by an organisation or sector",
                "ID": 30596,
                "TYPE": "s",
                "GIVENNAME": "Nathan",
                "EMAIL": "nathan.gordon@vmlearning.com.au"
            },
            {
                "ENROLMENTDATE": "2013-05-23 00:00",
                "MOBILEPHONE": null,
                "DELIVERY": {
                    "CODE": 10,
                    "DESCRIPTION": "Classroom-based"
                },
                "INSTANCEID": 187994,
                "CONTACTID": 116482,
                "STARTDATE": "2013-05-23 00:00",
                "SURNAME": "Gordon",
                "ACTIVITIES": [
                    {
                        "ENROLMENTDATE": "2014-03-31 13:50",
		                "MOBILEPHONE": null,
		                "DELIVERY": {
		                    "CODE": 10,
		                    "DESCRIPTION": "Classroom-based"
		                },
                        "INSTANCEID": 47706,
                        "CONTACTID": 116482,
                        "STARTDATE": "2013-05-23 00:00",
                        "SURNAME": "Gordon",
                        "ACTIVITIES": [],
                        "AMOUNTPAID": 0,
                        "FINISHDATE": "2013-05-23 00:00",
                        "CODE": "aXweb",
                        "LEARNERID": 469157,
                        "NAME": "aXcelerate Webinar Advanced! - Accredited Workshops",
                        "ID": 4400,
                        "TYPE": "w",
                        "GIVENNAME": "Nathan",
                        "EMAIL": "nathan.gordon@vmlearning.com.au"
                    }
                ],
                "STATUS": "C",
                "OUTCOMECODE": "20",
                "AMOUNTPAID": null,
                "FINISHDATE": null,
                "CODE": "FNSSMS401A",
                "LEARNERID": 3135023,
                "NAME": "Process self-managed superannuation contribution",
                "ID": 30600,
                "TYPE": "s",
                "GIVENNAME": "Nathan",
                "EMAIL": "nathan.gordon@vmlearning.com.au"
            },
            {
                "ENROLMENTDATE": "2013-05-23 00:00",
                "MOBILEPHONE": null,
                "DELIVERY": {
                    "CODE": 10,
                    "DESCRIPTION": "Classroom-based"
                },
                "INSTANCEID": 187995,
                "CONTACTID": 116482,
                "STARTDATE": "2013-05-23 00:00",
                "SURNAME": "Gordon",
                "ACTIVITIES": [
                    {
                        "ENROLMENTDATE": "2014-03-31 13:50",
		                "MOBILEPHONE": null,
		                "DELIVERY": {
		                    "CODE": 10,
		                    "DESCRIPTION": "Classroom-based"
		                },
                        "INSTANCEID": 47706,
                        "CONTACTID": 116482,
                        "STARTDATE": "2013-05-23 00:00",
                        "SURNAME": "Gordon",
                        "ACTIVITIES": [],
                        "AMOUNTPAID": 0,
                        "FINISHDATE": "2013-05-23 00:00",
                        "CODE": "aXweb",
                        "LEARNERID": 469157,
                        "NAME": "aXcelerate Webinar Advanced! - Accredited Workshops",
                        "ID": 4400,
                        "TYPE": "w",
                        "GIVENNAME": "Nathan",
                        "EMAIL": "nathan.gordon@vmlearning.com.au"
                    }
                ],
                "STATUS": "C",
                "OUTCOMECODE": "20",
                "AMOUNTPAID": null,
                "FINISHDATE": null,
                "CODE": "FNSSUP301A",
                "LEARNERID": 3135024,
                "NAME": "Process superannuation fund payments",
                "ID": 30594,
                "TYPE": "s",
                "GIVENNAME": "Nathan",
                "EMAIL": "nathan.gordon@vmlearning.com.au"
            },
            {
                "ENROLMENTDATE": "2013-05-23 00:00",
                "MOBILEPHONE": null,
                "DELIVERY": {
                    "CODE": 10,
                    "DESCRIPTION": "Classroom-based"
                },
                "INSTANCEID": 187996,
                "CONTACTID": 116482,
                "STARTDATE": "2013-05-23 00:00",
                "SURNAME": "Gordon",
                "ACTIVITIES": [
                    {
                        "ENROLMENTDATE": "2014-03-31 13:50",
		                "MOBILEPHONE": null,
		                "DELIVERY": {
		                    "CODE": 10,
		                    "DESCRIPTION": "Classroom-based"
		                },
                        "INSTANCEID": 47706,
                        "CONTACTID": 116482,
                        "STARTDATE": "2013-05-23 00:00",
                        "SURNAME": "Gordon",
                        "ACTIVITIES": [],
                        "AMOUNTPAID": 0,
                        "FINISHDATE": "2013-05-23 00:00",
                        "CODE": "aXweb",
                        "LEARNERID": 469157,
                        "NAME": "aXcelerate Webinar Advanced! - Accredited Workshops",
                        "ID": 4400,
                        "TYPE": "w",
                        "GIVENNAME": "Nathan",
                        "EMAIL": "nathan.gordon@vmlearning.com.au"
                    }
                ],
                "STATUS": "C",
                "OUTCOMECODE": "20",
                "AMOUNTPAID": null,
                "FINISHDATE": null,
                "CODE": "FNSSUP401A",
                "LEARNERID": 3135025,
                "NAME": "Process complex superannuation benefit or insurance claim",
                "ID": 30597,
                "TYPE": "s",
                "GIVENNAME": "Nathan",
                "EMAIL": "nathan.gordon@vmlearning.com.au"
            },
            {
                "ENROLMENTDATE": "2013-05-23 00:00",
                "MOBILEPHONE": null,
                "DELIVERY": {
                    "CODE": 10,
                    "DESCRIPTION": "Classroom-based"
                },
                "INSTANCEID": 187997,
                "CONTACTID": 116482,
                "STARTDATE": "2013-05-23 00:00",
                "SURNAME": "Gordon",
                "ACTIVITIES": [
                    {
                        "ENROLMENTDATE": "2014-03-31 13:50",
		                "MOBILEPHONE": null,
		                "DELIVERY": {
		                    "CODE": 10,
		                    "DESCRIPTION": "Classroom-based"
		                },
                        "INSTANCEID": 47706,
                        "CONTACTID": 116482,
                        "STARTDATE": "2013-05-23 00:00",
                        "SURNAME": "Gordon",
                        "ACTIVITIES": [],
                        "AMOUNTPAID": 0,
                        "FINISHDATE": "2013-05-23 00:00",
                        "CODE": "aXweb",
                        "LEARNERID": 469157,
                        "NAME": "aXcelerate Webinar Advanced! - Accredited Workshops",
                        "ID": 4400,
                        "TYPE": "w",
                        "GIVENNAME": "Nathan",
                        "EMAIL": "nathan.gordon@vmlearning.com.au"
                    }
                ],
                "STATUS": "C",
                "OUTCOMECODE": "20",
                "AMOUNTPAID": null,
                "FINISHDATE": null,
                "CODE": "FNSSUP403A",
                "LEARNERID": 3135026,
                "NAME": "Administer retirement income streams",
                "ID": 30595,
                "TYPE": "s",
                "GIVENNAME": "Nathan",
                "EMAIL": "nathan.gordon@vmlearning.com.au"
            },
            {
                "ENROLMENTDATE": "2013-05-23 00:00",
                "MOBILEPHONE": null,
                "DELIVERY": {
                    "CODE": 10,
                    "DESCRIPTION": "Classroom-based"
                },
                "INSTANCEID": 187998,
                "CONTACTID": 116482,
                "STARTDATE": "2013-05-23 00:00",
                "SURNAME": "Gordon",
                "ACTIVITIES": [
                    {
                        "ENROLMENTDATE": "2014-03-31 13:50",
		                "MOBILEPHONE": null,
		                "DELIVERY": {
		                    "CODE": 10,
		                    "DESCRIPTION": "Classroom-based"
		                },
                        "INSTANCEID": 47706,
                        "CONTACTID": 116482,
                        "STARTDATE": "2013-05-23 00:00",
                        "SURNAME": "Gordon",
                        "ACTIVITIES": [],
                        "AMOUNTPAID": 0,
                        "FINISHDATE": "2013-05-23 00:00",
                        "CODE": "aXweb",
                        "LEARNERID": 469157,
                        "NAME": "aXcelerate Webinar Advanced! - Accredited Workshops",
                        "ID": 4400,
                        "TYPE": "w",
                        "GIVENNAME": "Nathan",
                        "EMAIL": "nathan.gordon@vmlearning.com.au"
                    }
                ],
                "STATUS": "C",
                "OUTCOMECODE": "20",
                "AMOUNTPAID": null,
                "FINISHDATE": null,
                "CODE": "FNSSUP404A",
                "LEARNERID": 3135027,
                "NAME": "Establish and customise complex employer accounts",
                "ID": 30599,
                "TYPE": "s",
                "GIVENNAME": "Nathan",
                "EMAIL": "nathan.gordon@vmlearning.com.au"
            },
            {
                "ENROLMENTDATE": "2013-05-23 00:00",
                "MOBILEPHONE": null,
                "DELIVERY": {
                    "CODE": 10,
                    "DESCRIPTION": "Classroom-based"
                },
                "INSTANCEID": 187999,
                "CONTACTID": 116482,
                "STARTDATE": "2013-05-23 00:00",
                "SURNAME": "Gordon",
                "ACTIVITIES": [
                    {
                        "ENROLMENTDATE": "2014-03-31 13:50",
		                "MOBILEPHONE": null,
		                "DELIVERY": {
		                    "CODE": 10,
		                    "DESCRIPTION": "Classroom-based"
		                },
                        "INSTANCEID": 47706,
                        "CONTACTID": 116482,
                        "STARTDATE": "2013-05-23 00:00",
                        "SURNAME": "Gordon",
                        "ACTIVITIES": [],
                        "AMOUNTPAID": 0,
                        "FINISHDATE": "2013-05-23 00:00",
                        "CODE": "aXweb",
                        "LEARNERID": 469157,
                        "NAME": "aXcelerate Webinar Advanced! - Accredited Workshops",
                        "ID": 4400,
                        "TYPE": "w",
                        "GIVENNAME": "Nathan",
                        "EMAIL": "nathan.gordon@vmlearning.com.au"
                    }
                ],
                "STATUS": "C",
                "OUTCOMECODE": "20",
                "AMOUNTPAID": null,
                "FINISHDATE": null,
                "CODE": "FNSSUP508A",
                "LEARNERID": 3135028,
                "NAME": "Provide effective information to members",
                "ID": 30598,
                "TYPE": "s",
                "GIVENNAME": "Nathan",
                "EMAIL": "nathan.gordon@vmlearning.com.au"
            }
        ],
        "AMOUNTPAID": 775,
        "FINISHDATE": null,
        "CODE": "FNS40910",
        "LEARNERID": 657234,
        "NAME": "May Intake 2013",
        "ID": 3296,
        "TYPE": "p",
        "GIVENNAME": "Nathan",
        "EMAIL": "nathan.gordon@vmlearning.com.au",
        "SCHOOLTYPEID": "25",
        "SCHOOLORGID": 538562
    },
    {
        "ENROLMENTDATE": "2014-04-02 00:00",
        "MOBILEPHONE": null,
        "DELIVERY": {
            "CODE": 10,
            "DESCRIPTION": "Classroom-based"
        },
        "INSTANCEID": 60743,
        "CONTACTID": 1043609,
        "STARTDATE": "2014-03-27 00:00",
        "SURNAME": "Gilmore",
        "ACTIVITIES": [],
        "AMOUNTPAID": 5,
        "FINISHDATE": null,
        "CODE": "UNIT_TEST",
        "LEARNERID": 657560,
        "NAME": "UNIT TESTING CLASS - ClassEnrolment",
        "ID": 9666,
        "TYPE": "p",
        "GIVENNAME": "Mark",
        "EMAIL": "mark.gilmore2@vmlearning.com.au",
        "SCHOOLTYPEID": "25",
        "SCHOOLORGID": 538562
    }
]
print   print

resource /course/enrolment

Description

Update an enrolment

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/course/enrolment

Pattern: /course/enrolment
Handler: api.course
Action: {PUT={updateEnrolment}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/course/enrolment
Route Pattern has no Placeholders
HTTP Request Methods

Supported: PUT
Default: PUT

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
contactID numeric true The ID of the Contact.
instanceID numeric true The ID of the Activity Instance. (Not required when using subjectCode)
programInstanceID numeric false This is required when updating a subject enrolment. (InstanceID of the Accredited Program)
subjectCode string false This can be used to update a subject enrolment (instead of InstanceID).
type string true The type of the activity. w = workshop, p = accredited program, s = subject (of an accredited program), el = e-learning.
logType string false [Type=W] Change/add status entry for a Participant:
  • 'Tentative' - Tentative.
  • 'Booked' - Booked / In Progress.
  • 'Cancelled' - Cancelled.
  • 'Invoiced' - Invoice has been sent.
  • 'Paid' - Invoice has been paid.
  • 'Completed' - Completed.
logEntryDate string false Now [Type=W,Type=EL] The date the new status was requested
theMethod string false Online [Type=W] How the new status was requested: 'Phone,Email,Fax,In Person,Online,Other'
allowDuplicateEntry string false false [Type=W] Allow duplicate status entry for a Participant.
cost string false [Type=W] Workshop Cost for Participant.
PONum string false [Type=W] Purchase Order Number.
discountIDs string false [Type=W] Any discount IDs that should apply to the Participant.
invoiceNum string false [Type=W] The Invoice ID associated with the Participant.
finCodeID string false [Type=W & P] The Finance Code ID associated with the Participant.
financeModelID string false [Type=P] The Finance Model ID to be associated with the Participant.
additionalComments string false [Type=W] Participant Enrolment (General) Comments (see also 'comments' for Status related commets).
DateEnrolled date false [Type=P,Type=S] The Date the Contact Enrolled.
DateCommenced date false [Type=P] The Activity Commencement Date.
DateCompletionExpected date false [Type=P] The Expected Completion Date.
DateCompleted date false [Type=P] The Actual Completion Date.
isCancelled boolean false [Type=P] DEPRECATED - Please use the enrolmentStatus parameter
trainerID numeric false [Type=P,Type=S] The Contact ID of the Trainer associated with this enrolment.
enrolmentStatus string false Updates the enrolment to one of the following statuses:
[Type=P]
  • 'tent' - Tentative. Rules: No subject enrolments may exist
  • 'ip' - In Progress.
  • 'canc' - Cancelled. Rules: No interim subject enrolments may exist
  • 'def' - Deferred.
  • 'susp' - Suspended.
  • 'comp' - Completed. Rules: No interim subject enrolments may exist

[Type=EL]
  • 'A' - Approved
  • 'Cm' - Commenced / In Progress.
  • 'C' - Cancelled.
  • 'F' - Failed.
  • 'Co' - Completed.
If an enrolment status change is not successful, no changes will be applied to the enrolment.
vicProgramStatusIDCode string false [Type=P] The Victorian Program Status Identifier field for AVETMISS reporting. See Samples below for a full list of options.
stageDate_[currentStage] string false [Type=P] Useage: 'stageDate_1'='2014-12-12' to change the stage 1 date
AddUnitCompetency string false [Type=P] List of Unit IDs to add to the enrolment
AddElectiveUnit string false [Type=P] List of Unit IDs to add to the elective list
AddUnitCompetencyByCode string false [Type=P] List of Unit/Subject Codes to add to the enrolment
AddElectiveUnitByCode string false [Type=P] List of Unit/Subject Codes to add to the elective list
ModuleIDList string false [Type=P] List of Module IDs to add (VSL only)
hasRPL string false [Type=P] Update VET Student Loans RPL data (VSL only)
competent numeric false [Type=S] competency code - To update a Subject use the UnitID as the InstanceID & ContactID. See Competency Code table below (use the integer value)
outcomeTrainingOrg string false [Type=S] competency code - internal (outcome identifier - training organisation)
activityStartDate date false [Type=S,Type=EL] Activity Start Date
proposedEndDate date false [Type=S] Proposed End Date
activityEndDate date false [Type=S,Type=EL] Activity End Date
deliveryModeAVETMISS string false [Type=S] Delivery Mode - AVETMISS. This is to be used for AVETMISS 8.0 reporting. Provide a comma-delimited list of the applicable delivery modes character codes listed under "Samples" below. The first value will be treated as the predominant delivery mode for reporting purposes. Note that delivery mode is typically stored against a subject OR a course insteance (type=P), so these values will not be affected by this endpoint. Examples: "I", "W,E", "E,I,W"
deliveryModeRAPT string false [Type=S] Delivery Mode - RAPT. This is to be used for RAPT 3.0+ reporting. Provide a comma-delimited list of the applicable delivery modes character codes listed under "Samples" below. The second and third values will be reported as supplementary delivery modes. All values after that will not be reported. Note that the value "Z - Not Applicable" cannot be supplied, as this is calculated dynamically based on the competency status. Note also that delivery mode is typically stored against a subject OR a course insteance (type=P), so these values will not be affected by this endpoint. Examples: "C", "E,S".
vet_DeliveryMode string false [Type=S] DEPRECATED from 2018. Delivery Mode - Legacy (AVETMISS 7.0)
doNotReportAvetmiss boolean false [Type=S] A flag to prevent this record from being exported in AVETMISS reports.
comments string false [Type=S,Type=W,Type=EL] Comments (Brief Comment)
waEnrolmentCategoryID numeric false [Type=S] WA Enrolment Category ID
hoursAttended numeric false [Type=S] Hours attended
deliveryLocationId numeric false [Type=S] Delivery Location ID
noFunding boolean false [Type=S] Not Funded / RAPT Funding Removed flag
scheduledHours numeric false [Type=S] Scheduled Hours
cost numeric false [Type=S] Subject Cost
scheduleID numeric false [Type=S] Schedule ID
concessionTypeID numeric false [Type=S] Concesssion Type ID
primaryScheduleID numeric false [Type=S] Primary Schedule ID
subcontractedOrgID numeric false [Type=S] Subcontracted organisation ID
pleaseSyncLADates boolean false [Type=S] Flag to synchronise (related) Learning Activity Dates
updateClassEnrolmentCompletedOrExpectedDate boolean false [Type=S] Flag to update class enrolment Completed or Expected completion date (depending on compentency status)
costHourlyRate numeric false [Type=S] Cost Hourly Rate - Victoria
fundingEligibilityKeyVIC string false [Type=P] Funding Eligibility Key - Victoria. Maximum 10 characters alphanumeric.
programUniqueSupervisedHoursVIC numeric false [Type=P] Program Unique Supervised Hours - Victoria. Must be within range 0-99999.5
PSTACDateVIC date false [Type=P] Program Supervised Teaching Activity Completion Date - Victoria. Must be a valid date and should be less than or equal to the final subject activity end date
studyReason numeric false AVETMISS Study Reason - National (For Accredited enrolments) - See sample table below for values.
customField_[variableName] string false Replace [variableName] with the actual customField variable name to update a customField value against the enrolment (if enabled and set up). If updating a custom field that supports multiple values, you can use comma-delimited values or a JSON array. If using comma-delimited, it is expected the data is URL encoded first. For example, to get 2 values: 'A,B' and 'C' you would either pass: "['A,B','C']" or "A%2CB,C"
FundingNational numeric false AVETMISS Funding Source - National (For Accredited enrolments) - See sample table below for values.
FundingState string false AVETMISS Funding Source - State (For Accredited enrolments) - See sample table below for values.
schoolTypeID numeric false [Type=P] School Type Identifier AVETMISS field. See samples below for valid values.
schoolOrgID numeric false [Type=P] Organisation that represents the school for this enrolment
Response Default Response Format: json

Samples

Program Status Identifiers (VIC)

10 - Program completed (issued)
20 - Program completed (not issued)
25 - Successfully achieved intended outcome
30 - In training
40 - Withdrawn - Official
41 - Withdrawn - Apparent
42 - Withdrawn - Deferred
50 - Completion of lower level of program
60 - Nested program
70 - Superseded program
80 - Streamed program
85 - Not yet started

deliveryModeAVETMISS

					I - Internal delivery
					E - External delivery
					W - Workplace-based

deliveryModeRAPT

					C - Local classroom
					R - Remote conferencing
					S - Self-paced - on-site
					E - Self-paced - external
					W - Workplace delivery
					A - Workplace assessment
					P - Auspiced partnership

studyReason

					1 - To get a job
					2 - To develop my existing business
					3 - To start my own business
					4 - To try for a different career
					5 - To get a better job or promotion
					6 - It was a requirement of my job
					7 - I wanted extra skills for my job
					8 - To get into another course of study
					11 - Other reasons
					12 - For personal interest or self-development
					13 - To get skills for community/voluntary work

FundingNational

					Revenue from government
					11 - Commonwealth and state general purpose recurrent
					13 - Commonwealth specific purpose programs
					15 - State specific purpose programs

					Other revenue
					20 - Domestic full fee-paying client
					30 - International full fee-paying client
					31 - International Onshore Student
					32 - International Offshore Student
					80 - Revenue earned from another training organisation

FundingState

					03 - Fee for Service
					11 - Commonwealth and State General purpose Recurrent
					13 - Commonwealth Specific Purpose programs
					15 - State Specific Purpose programs
					1GT - Gap Training
					1SA - Skills Assessments
					20 - Domestic full fee-paying student
					2GT - Gap Training
					2SA - Skills Assessments
					30 - International full fee-paying student
					9GT - Gap Training
					9SA - Skills Assessments
					BMI - Mining Industry
					CCP - Civil Construction Brokerage Pilot
					CHL - Civil Construction Higher Level Skills
					CLG - Cert III Guarantee - Community Learning
					CLI - Community Learning Intervention
					CLP - Community Literacy Program
					CSG - Civil Construction Skills Assessment and Gap Training
					CSP - Community Services Skilling Plan
					CSQ - Construction Skills Queensland
					ENH - Higher Level Skills program - Mainstream student
					ENT - Cert III Guarantee - Mainstream students
					ETR - ETRF Accredited Training & Employment Youth Initiatives
					F2 - Strategic Purchasing Program
					F3 - User Choice competitively funded - Apprenticeships
					GK - User Choice competitively funded - Trainees
					GS1 - Cert III Guarantee - Year 12 graduates
					GS2 - Cert III Guarantee - User Choice Full Fee
					GS3 - Cert III Guarantee - User Choice Partial Exemption
					GS4 - Cert III Guarantee - User Choice Full Exemption
					HLT - Higher Level Skills program - Student accessing VET FEE-HELP loan
					HS1 - Higher Skills Program 1
					IFF - Strategic Investment Fund Fees
					IFN - Strategic Investment Fund NoIFP - Indigenous Funding Program
					IP3 - Cert III Guarantee - Industry Partnerships Strategy
					IPH - Higher Level Skills program - Industry Partnerships Strategy
					IT3 - Cert III Guarantee - Indigenous Training Strategy
					ITH - Higher Level Skills program - Indigenous Training Strategy
					LLN - Language Literacy and Numeracy
					NWC - National Workforce Critical Skills
					NWE - National Workforce Existing Worker
					NWJ - National Workforce Jobseeker
					PBJ - Productivity Brokerage Job Seeker
					PBW - Productivity Brokerage Existing Worker
					PEW - Productivity Places Program - Existing Workers (Enterprise)
					PPP - Productivity Places Program
					PRJ - PPP (Job Seekers)
					PRW - PPP (Existing Workers)
					PSJ - PPP Skilling Queenslanders for Work (Job Seekers)
					PT1 - Post-Trade Training Program
					RWF - Regional Workforce Development Initiative
					RWN - Regional Workforce Development Initiative
					SAT - User Choice competitively funded - School-based
					SC1 - Short Courses Program 1
					SJ3 - training delivered under the Single and Teenage Parent Program (STPP) - Fees paid by Government
					SQW - Skilling Queenslanders for Work
					SSQ - Skilling Solutions Queensland
					ST3 - training delivered under the Single and Teenage Parent Program (STPP)
					ST5 - training delivered under the Single and Teenage Parent Program (STPP)
					TFW - Training For Work
					TIF - Training Initiative for Indigenous Adults Regional/Remote (TIFIARRC)
					TRA - Training Skills Assessment and Gap Training
					TSC - Trade Start - Civil Construction Program
					TSG - Trade Start General
					VSS - VET in Schools (secondary school students)
					IT5 - Indigenous VET Partnerships
					SQI - Training funded under Skilling QLD for Work
					SQT - Training funded under Certificate 3 Guarentee
					T02 - TAFE User Choice
					20 - Domestic full fee-paying client
					SPP - Schools Private Provider

Competency Codes

			
			
				  , "Blank", "Training Not Yet Commenced/Still Occurring", (NSW_ACE, NSW)
			
				0, "N.R.", "Not Reported for AVETMISS", (NSW, VIC, QLD, SA, WA_RAPT, TAS, NT, ACT, NSW_ACE, NAT, NSW_SS)
			
				1, "C", "Competent", (WA_RAPT)
			
				10, "W-FP", "Withdrawn formally (after some participation)", (WA_RAPT)
			
				100, "W-N", "Never started - no participation", (WA_RAPT)
			
				105, "NoSt", "Not yet started", (WA_RAPT)
			
				11, "W-P", "Discontinued - no formal withdrawal (after some participation)", (WA_RAPT)
			
				2, "NC", "Not competent", (WA_RAPT)
			
				20, "C", "Competency achieved/pass", (NSW, VIC, QLD, SA, TAS, NT, ACT, NSW_ACE, NAT, NSW_SS)
			
				25, "C-GAP", "Competency Achieved/Pass as determined via Gap Training and Assessment", (VIC)
			
				3, "NAS", "Non-assessable enrolment - withdrawn or not satisfactorily completed", (WA_RAPT)
			
				30, "CNA", "Competency not achieved/fail", (NSW, VIC, QLD, SA, TAS, NT, ACT, NSW_ACE, NAT, NSW_SS)
			
				4, "NAS", "Non-assessable enrolment - satisfactorily completed", (WA_RAPT)
			
				40, "W", "Withdrawn/discontinued", (NSW, VIC, QLD, SA, TAS, NT, ACT, NSW_ACE, NAT, NSW_SS)
			
				41, "CLOS", "Incomplete due to RTO closure", (VIC, QLD, SA, TAS, NT, ACT, NSW_ACE, NAT, NSW_SS)
			
				5, "P+E", "Participating but studies not finished (with evidence)", (WA_RAPT)
			
				50, "RPL-IP", "Recognition of prior learning - in progress", (VIC)
			
				51, "RPL-G", "Recognition of prior learning - granted", (NSW, VIC, QLD, SA, TAS, NT, ACT, NSW_ACE, NAT, NSW_SS)
			
				52, "RPL-NG", "Recognition of prior learning - not granted", (NSW, VIC, QLD, SA, TAS, NT, ACT, NSW_ACE, NAT)
			
				53, "RCC-G", "Recognition of current competency - granted", (VIC)
			
				54, "RCC-NG", "Recognition of current competency - not granted", (VIC)
			
				55, "P", "Participating but studies not finished (NO evidence)", (WA_RAPT)
			
				6, "RPL-G", "Status granted by RPL (Recognition of Prior Learning)", (WA_RAPT)
			
				60, "CT", "Credit transfer/national recognition", (NSW, VIC, QLD, SA, TAS, NT, ACT, NSW_ACE, NAT, NSW_SS)
			
				61, "SUP", "Superseded subject", (NSW, VIC, QLD, SA, WA_RAPT, TAS, NT, ACT, NSW_ACE, NAT, NSW_SS)
			
				65, "C-GAP", "Gap Training (superseded qualification)", (QLD)
			
				66, "No Start", "Did Not Start", (NSW)
			
				7, "RPL-NG", "Recognition of Prior Learning (RPL) not granted", (WA_RAPT)
			
				70, "CA", "Continuing activity", (NSW, VIC, QLD, SA, TAS, NT, ACT, NSW_ACE, NAT, NSW_SS)
			
				81, "NAS", "Non-assessable activity - satisfactorily completed", (NSW, VIC, QLD, SA, TAS, NT, ACT, NSW_ACE, NAT)
			
				82, "NAS", "Non-assessable activity - withdrawn or not satisfactorily completed", (NSW, VIC, QLD, SA, TAS, NT, ACT, NSW_ACE, NAT)
			
				85, "NYS", "Not yet started", (VIC, QLD, SA, TAS, NT, ACT, NSW_ACE, NAT, NSW_SS)
			
				9, "CT", "Credit Transfer granted", (WA_RAPT)
			
				15, "RCC-G", "Recognition of Current Competencies (RCC) granted", (WA_RAPT (deprecated))
			
				16, "RCC-NG", "Recognition of Current Competencies (RCC) not granted", (WA_RAPT (deprecated))
			
				8, "CJOB", "Provisionally competent off the job (apprentices only)", (WA_RAPT (deprecated))
			
				90, "NYA", "Not yet available", (VIC (deprecated), QLD (deprecated), SA (deprecated), TAS (deprecated), NT (deprecated), ACT (deprecated), NSW_ACE (deprecated), NAT (deprecated), NSW_SS (deprecated))
			
				  , "Blank", "Training Not Yet Commenced/Still Occurring", (NSW_SS (deprecated))
			
			
		

This returns a status and a message

{
	STATUS:	"success",
	MSG: 	"Enrolment was updated successfully."
}

School Type Identifier

21 - School - Government
25 - School - Catholic
27 - School - Independent
31 - Technical and Further Education institute
61 - Community-based adult education provider
91 - Privately operated registered training organisation
92 - Home school arrangement
print   print

resource /course/discounts

Description

Calculates potential discount values given a course instance, a contact, an originalPrice and any other additional information, including group booking size, promo codes etc. It also brings back information on the discounts that were applied. This discountIDs as well as the revisedPrice should be passed into the enrol method to properly apply these discounts to the enrolment.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/course/discounts

Pattern: /course/discounts
Handler: api.discount
Action: {GET={getCourseDiscounts}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/course/discounts
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
contactID numeric true The contactID - will check against membership, category and organisation discounts
type string true The type of course (w, p, el)
instanceID numeric true The instanceID of the course
originalPrice numeric true The original price of the course. This is the value that will be used to calculate the correct discounted price (returned as revisedPrice in the return struct)
GroupBookingSize numeric false The size of a group booking. Used to find any applicable group booking discounts
BookingDate date false TODAY The date of the booking. Used to calculate expiries and early bird specials
PromoCode string false Used to find promo discounts
ConcessionDiscountIDs string false A list of discountIDs of specific concession discounts. Only concession type discounts will apply here and only those that are linked to this course will be considered.
Response Default Response Format: json

Samples

{
    "ORIGINALPRICE": 600,
    "REVISEDPRICE": 526.50,
    "TOTALSAVING": 73.50,
    "DISCOUNTSAPPLIED": [
        {
	        "DISCOUNTID": 6543,
	        "NAME": "$15 off for booking two weeks in advance",
	        "CALCULATIONDESCRIPTION": "$15 off",
	        "CALCULATIONMETHOD": "Flat rate off",
	        "CALCULATIONVALUE": 15,
	        "DISCOUNTTYPEID": 1,
	        "DISCOUNTTYPEDESCRIPTION": "Early Bird",
	        "NOTINCONJUNCTION": false,
	        "GLOBALCOURSES": false,
	        "GLOBALSHOPPINGCART": false,
	        "STATUS": "ACTIVE",
	        "EXPIRYDATE": null,
	        "CRITERIA": [
	            {
	                "TEXT": "14 days",
	                "VALUE": 14
	            },
		    "ORIGINALPRICE": 600,
		    "REVISEDPRICE": 585,
		    "SAVING": 15
	        ]
	    },
	    {
	        "DISCOUNTID": 6172,
	        "NAME": "A special 10% off discount for members",
	        "CALCULATIONDESCRIPTION": "10% off",
	        "CALCULATIONMETHOD": "Percent off",
	        "CALCULATIONVALUE": 10,
	        "DISCOUNTTYPEID": 2,
	        "DISCOUNTTYPEDESCRIPTION": "Membership",
	        "NOTINCONJUNCTION": false,
	        "GLOBALCOURSES": false,
	        "GLOBALSHOPPINGCART": false,
	        "STATUS": "ACTIVE",
	        "EXPIRYDATE": null,
	        "CRITERIA": [
	            {
	                "DOCUMENTNAME": "Membership Card",
	                "ISMEMBERSHIP": true,
	                "CERTTYPEID": 2577
	            },
		    "ORIGINALPRICE": 585,
		    "REVISEDPRICE": 526.5,
		    "SAVING": 58.50
	        ]
	    }
	]
}
print   print

resource /course/enquire

Description

Allows an established contact to enquire on a course, or send a general enquiry. This must be called with a valid aXcelerate contactID.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/course/enquire

Pattern: /course/enquire
Handler: api.course
Action: {POST={enquire}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/course/enquire
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
contactID string true The contactID of the user. This is the value returned by the create contact API method.
noteCodeID string true The noteCodeID for the aXcelerate note to attach to the contact. If left blank will default to leaving a system message
comments string false The content of the enquiry.
type string false The course type. w = workshop, p = accredited program, el = e-learning. Don't use this param for a general enquiry.
ID string false The ID relating to the course type. Leave blank or don't include for a general enquiry.
emailTo string false An email to send the enquiry to. It can be a comma delimited list of emails. If blank, an email will not be sent.
Response Default Response Format: json

Samples

The response is a simple success value. On error, however, the success variable will not be present and the standard error structure will be returned instead.

{"SUCCESS":true}
print   print

resource /course/calendar

Description

Returns JSON structure for FullCalendar.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/course/calendar

Pattern: /course/calendar
Handler: api.course
Action: {GET={getCalendar}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/course/calendar
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
monthFrom string false The current month Where the Calendar should start.
monthTo string false The next month Where the Calendar should end.
year string false current year The Year
location string false Filter Calendar Data by location.
type string false all The type of workshops. a = accredited, na = Non-accredited, all = all.
Response Default Response Format: json

Samples

Courses Instance data returned in JSON format. By default: returns results for the current and next month. The format includes a GUID id for use with the Full Calendar jQuery plugin

[
    {
        "id": "36162BE3-7907-46A6-8670470275E5D926",
        "title": "aXc Day: Session Three - For existing aXcelerate Users (Operational level)",
        "start": "2013-07-24 13:30",
        "allDay": false,
        "type": "non-accredited",
        "location": "Brisbane",
        "courseInstanceID": 40505,
        "courseID": 5089,
        "end": "2013-07-24 15:30"
    },
    {
        "id": "D59EAC05-A4FE-48B8-BE261964D3645012",
        "title": "aXc Day: Session Two - For RTO Managers and Business Owners (Strategic Level)",
        "start": "2013-07-24 11:00",
        "allDay": false,
        "type": "non-accredited",
        "location": "Brisbane",
        "courseInstanceID": 40504,
        "courseID": 5088,
        "end": "2013-07-24 12:30"
    },
    {
        "id": "24CDF04D-82B1-474D-A4D143023EE3D0A3",
        "title": "aXc Day: Session One - For aXcelerate Prospects & RTO Consultants",
        "start": "2013-07-24 08:30",
        "allDay": false,
        "type": "non-accredited",
        "location": "Brisbane",
        "courseInstanceID": 40503,
        "courseID": 5087,
        "end": "2013-07-24 10:30"
    },
    {te
        "id": "052D1703-1A55-48CE-9EAC8AA685E104A1",
        "title": "aXcelerate Training",
        "start": "2013-07-25 09:00",
        "allDay": false,
        "type": "non-accredited",
        "location": "Olympus Mons, Mars",
        "courseInstanceID": 44604,
        "courseID": 1727,
        "end": "2013-07-25 11:00"
    }
 ]
print   print

resource /course/locations

Description

Returns a JSON array of course locations. The locations are pulled from aXcelerate to match any and all locations used for workshops. Used to pass to the calendar service as a filter.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/course/locations

Pattern: /course/locations
Handler: api.course
Action: {GET={getLocations}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/course/locations
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
public boolean false Only show Public locations (any location attached to a public activity)
onlyFuture boolean false Only show locations with a future activity related to it.
Response Default Response Format: json

Samples

The list is returned as an alphabetical array of location strings and is different for every client.

[
    "108 Fairley St",
    "Adelaide",
    "Armidale",
    "Beenleigh",
    "Bendigo",
    "Blacktown",
    "Brendale",
    "Bribie Island",
    "Brisbane",
    "Brisbane - Logan",
    "Brisbane - Northside",
    "Brisbane - Southside",
    "Brisbane - Westside",
    "Brisbane Convention & Exhibition Centre",
    "Bundaberg",
    "Burswood",
    "Cairns",
    "Caloundra",
    "Campbelltown",
    "Canberra",
    "Cannon Hill",
    "Chinchilla",
    "Classroom",
    "Cleveland",
    "Coffs Harbour",
    "Darwin",
    "Gatton",
    "Gippsland",
    "Gold Coast",
    "Gumdale",
    "Gympie",
    "Hamilton Island",
    "Hampton",
    "Helensvale",
    "Indooroopilly",
    "Ipswich",
    "Joondalup",
    "Karratha",
    "Landsborough",
    "Laurieton",
    "Lismore",
    "Mackay",
    "Maleny",
    "Mapleton",
    "Maroochydore",
    "Melbourne",
    "Melbourne Convention Centre",
    "Milton",
    "Morningside",
    "Mt Gravatt",
    "Mt Isa",
    "MURARRIE",
    "Nambour",
    "New Farm",
    "Newcastle",
    "Not specified",
    "Onsite",
    "Orange",
    "Palm Beach",
    "Parramatta",
    "Perth",
    "Port Macquarie",
    "Richmond",
    "Robina",
    "Rockhampton",
    "Rosalie",
    "Salisbury",
    "Samford",
    "Spring Hill",
    "Springfeild",
    "Strathpine",
    "Sunshine Coast",
    "Sydney",
    "Sydney CBD",
    "Toowong",
    "Toowoomba",
    "Townsville",
    "Various",
    "Virginia",
    "VM Learning",
    "Wagga Wagga",
    "Wangaratta",
    "Warragul",
    "West End",
    "Wickham Terrace",
    "Wilston",
    "Wollongong",
    "Woolloongabba",
    "Woorim - Bribie Island",
    "Yeppoon"
]
print   print

resource /course/resources

Description

Return relevant resources for an activity or a contact.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/course/resources

Pattern: /course/resources
Handler: api.course
Action: {GET={getResources}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/course/resources
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
contactID numeric false The ID of the Contact.
ID numeric false The ID of the Activity Type
type string false true The type of the activity. w = workshop, p = accredited program, s = subject. Only required if you use ID
forceStudentAccessOnly boolean false Only return resources that are for Students
Response Default Response Format: json

Samples

This returns an array of structs containing the documentID and documentName. When using the CONTACTID only: this will return a structure containing arrays (Use the /resource/ endpoint to retrieve the file).

{
    "UNITS": [],
    "TRAININGRELATED": [
        {
            "DOCUMENTID": 1834,
            "DOCUMENTNAME": "Time Master - Weekly Action Plan",
            "DOCUMENTFILENAME": "Time Master - Weekly Action Plan - Example.pdf",
            "ISPROGRAMRELATED": 1,
            "DELETED": 0,
            "FORMGROUP": "",
            "POLICYGROUP": "",
            "CATEGORY": "",
            "SUBGROUP": "",
            "STUDENTACCESS": 1,
            "TRAINERACCESS": 1,
            "PUBLICACCESS": 0,
            "ROOTDOCUMENT": 1276,
            "VERMAJOR": 1,
            "VERMINOR": 2,
            "CREATEDATE": "September, 14 2010 15:07:29 +0000",
            "USERID": 5101,
            "REVIEWPERIOD": "",
            "GIVENNAME": "Bianca",
            "SURNAME": "Guz",
            "USERNAME": "Bianca Guz"
        }
    ],
    "DIPLOMAS": [],
    "WORKSHOPS": [],
    "POLICIESFORMS": [
        {
            "DOCUMENTID": 75934,
            "DOCUMENTNAME": "aXcelerate Database Input Rules",
            "DOCUMENTFILENAME": "aXcelerate Database Input Rules1.pdf",
            "ISPROGRAMRELATED": 0,
            "DELETED": 0,
            "FORMGROUP": "",
            "POLICYGROUP": "Marketing",
            "CATEGORY": "Marketing",
            "SUBGROUP": "Client Service",
            "STUDENTACCESS": 1,
            "TRAINERACCESS": 1,
            "PUBLICACCESS": 0,
            "ROOTDOCUMENT": 4763,
            "VERMAJOR": 1,
            "VERMINOR": 2,
            "CREATEDATE": "June, 29 2015 04:54:46 +0000",
            "USERID": 4746,
            "REVIEWPERIOD": 12,
            "GIVENNAME": "Jade",
            "SURNAME": "Steffensen",
            "USERNAME": "Jade Steffensen"
        },
        {
            "DOCUMENTID": 75137,
            "DOCUMENTNAME": "Consolidated Data Migrations Spreadsheet",
            "DOCUMENTFILENAME": "Consolidated Data Migrations Spreadsheet.v1.0.xlsx",
            "ISPROGRAMRELATED": 0,
            "DELETED": 0,
            "FORMGROUP": "",
            "POLICYGROUP": "aXcelerate",
            "CATEGORY": "aXcelerate",
            "SUBGROUP": "",
            "STUDENTACCESS": 1,
            "TRAINERACCESS": 1,
            "PUBLICACCESS": 1,
            "ROOTDOCUMENT": 75136,
            "VERMAJOR": 1,
            "VERMINOR": 1,
            "CREATEDATE": "May, 21 2015 16:53:27 +0000",
            "USERID": 12345,
            "REVIEWPERIOD": "",
            "GIVENNAME": "Mark",
            "SURNAME": "Gilmore",
            "USERNAME": "Mark Gilmore"
        }
	]
}
   
print   print

resource /customFields/

Description

Returns an array of defined Custom Fields.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/customFields/

Pattern: /customFields/
Handler: api.customField
Action: {GET={read}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/customFields/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
linkTo string false Where the Custom Field links to.
options string false For Custom Fields where the type includes a list of options, for example 'select'.
variableName string false The internal name of the Custom Field, used for setting the value in other endpoints i.e. customField_ant : red
ID numeric false The ID of the Custom Field
active boolean false Whether the field is active or not - This endpoint returns Active Custom Fields by default
type string false The Type of Custom Field - i.e. Text, Select, Radio
label string false The Label for the Custom Field
Response Default Response Format: json

Samples

A successful call will give you a response like this:

[
    {
        "LINKTO": "contact",
        "OPTIONS": "red,black",
        "VARIABLENAME": "ant",
        "ID": 531,
        "ACTIVE": true,
        "TYPE": "select",
        "LABEL": "Ant Colour"
    },
    {
        "LINKTO": "contact",
        "OPTIONS": null,
        "VARIABLENAME": "personalEmail",
        "ID": 483,
        "ACTIVE": true,
        "TYPE": "text",
        "LABEL": "Personal Email"
    },
    {
        "LINKTO": "contact",
        "OPTIONS": null,
        "VARIABLENAME": "Test",
        "ID": 498,
        "ACTIVE": true,
        "TYPE": "text",
        "LABEL": "test"
    },
    {
        "LINKTO": "contact",
        "OPTIONS": "test,values,that,are,set",
        "VARIABLENAME": "Test_Select",
        "ID": 537,
        "ACTIVE": true,
        "TYPE": "select",
        "LABEL": "Test_Select"
    },
    {
        "LINKTO": "contact",
        "OPTIONS": null,
        "VARIABLENAME": "TestTestTest",
        "ID": 500,
        "ACTIVE": true,
        "TYPE": "text",
        "LABEL": "TestTestTest"
    }
]
print   print

resource /accounting/external/debit_success/paymentrecord

Description

Creates a new debitsuccess payment record. Returns a payment reference and a URL where the user can supply his payment information.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/accounting/external/debit_success/paymentrecord

Pattern: /accounting/external/debit_success/paymentrecord
Handler: api.accounting.external.debit_success.flow
Action: {POST={setupPaymentRecord}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/accounting/external/debit_success/paymentrecord
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
reference string true Unique identifier used to detect duplicate purchases. Max 35 characters.
paymentMethod string true The payment method to be used. Possible values:[credit_card,bank_account]
termID numeric true The ID of the payment terms that are to be applied to this payment.
invoiceGUID string true The unique identifier of invoice to which this payment will be applied.
callback string false The URL the client is returned to after the payment flow is completed. *To do: Move this to a Web Setting.
passthrough string false This value is appended to the specified callback in a URL paramater named:ax_custom
mobileCountryCode string false Optional field to overwrite the invoice mobileCountryCode
mobileNr string false Optional field to overwrite the invoice mobileNr
Response Default Response Format: json

Samples

PROVIDER: The service provider that is processing the payment. Valid Values:[debit_success]
AX_REFERENCE_NO:The aXcelerate reference number for this payment record.
REDIRECT:The URL of the payment page to which a client should be redirect to proceed with collection payment information.
META: Contains meta data specific to a payment provider. Meta data provides insight to the attempted operations and is intended for troubleshooting.
Specific to debit_success
META.RETRY: True when attempting to retry account creation.
META.PAID_IN_FULL_ACCOUNT: True when trying to callect the full payment amount in one transaction. False when creating a payment scheduled.
META.EXISTING_CONTACT: True when a payment record was for an existing account.

{
	"PROVIDER":"debit_success",
	"AX_REFERENCE_NO":"",
	"META":
	{
		"RETRY":false,
		"PAID_IN_FULL_ACCOUNT":false,
		"EXISTING_CONTACT":false
	},
	"REDIRECT":"https://oc-test.debitsuccess.com/PayNow/T/8jnTdoiW"
}
print   print

resource /accounting/external/debit_success/process:process

Description

Returns the status of the given epayments process.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/accounting/external/debit_success/process:process

Pattern: /accounting/external/debit_success/process:process
Handler: api.accounting.external.debit_success.flow
Action: {GET={checkProcess}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/accounting/external/debit_success/process:process
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json

Samples

PROCESS: The unique process identifier.
REFERENCE:The aXcelerate reference number for this payment record.
STATUS:The current status of the process. UNBEGUN: The process has not yet started, RUNNING: The process is still running (possibly from another request),FATAL:A non recoverable error occured, FAILED: A recoverable error occured (e.g time out), CHARGED: The amount has been collected, DECLINED: The payment was declined, PAYMENT_METHOD_MISSING: No payment method has been loaded into the account. PAYMENT_METHOD_PRESENT: At least one payment method has been loaded but no payments have been received.
AMOUNT: The amount of money collected by the process (zero if the status is not CHARGED).
MSG: Any system generated messages.
PAYMENT: Only exists when status is CHARGED. Contains data relevant to the payments.
PAYMENT.PAYMENTTYPE: The type of payment.
PAYMENT.PAYMENTDATE: The date the provider processed the transaction.
PAYMENT.PAYMENTID: The providers transaction identifier.

{
	"AMOUNT":55.49,
	"MSG":"",
	"PROCESS":"B4A3C9C0-F6CB-429D-86494CCD5F69509E",
	"REFERENCE":"MyReference",
	"STATUS":"CHARGED",
	"PAYMENT":
	{
		PAYMENTTYPE:"CreditCard",
		PAYMENTDATE:"{ts '2018-01-16 01:27:56'}",
		PAYMENTID:"1469307574",
	}
}
print   print

resource /accounting/external/debit_success/term/search

Description

Returns an array of payment terms that specify the available payment options for a passed in moneytary value.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/accounting/external/debit_success/term/search

Pattern: /accounting/external/debit_success/term/search
Handler: api.accounting.external.debit_success.term
Action: {GET={search}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/accounting/external/debit_success/term/search
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
amount string true The amount of money that is to be collected.
Response Default Response Format: json

Samples

TERM_ID:The identifier for the payment terms.
LABEL:The user defined label describing the terms to the end user in plain text.
INITIAL_PAYMENT_AMOUNT:The fixed amount of money that will be due at checkout. (zero if a INITIAL_PAYMENT_PERCENTAGE has been set)
INITIAL_PAYMENT_PERCENTAGE:The percentage of the total amount to be collected that will be due at checkout. (zero if INITIAL_PAYMENT_AMOUNT has been set.)
AVAILABLE_PAYMENT_METHODS:The payment methods that can be used to pay for the outstanding amount. Valid values are: CREDIT_CARD,BANK_ACCOUNT.


Depending on the available payment methods the following keys will also exist. The name of these keys are returned in the AVAILABLE_PAYMENT_METHODS field.
CREDIT_CARD: Information related to paying using a credit card. This key only exists if CREDIT_CARD is one of the available payment methods.

BANK_ACCOUNT: Information related to paying using direct debit from a bank account. This key only exists if BANK_ACCOUNT is one of the available payment methods.



The CREDIT_CARD and BANK_ACCOUNT keys have the following sub key:
SURCHARGE:The surcharge applied for using this payment method.
SURCHARGE.TYPE:0 No Surcharge, 1:Percentage of each transaction amount. 2:Fixed amount per transaction.
SURCHARGE.PERCENT:Percentage of surcharge applied.
SURCHARGE.AMOUNT:Fixed surcharge amount.


{
	"TERM":
	[
		{
			"SETUP_FEE":0,
			"CREDIT_CARD":
			{
				"SURCHARGE":
				{
					"PERCENT":2.5,
					"TYPE":2,"AMOUNT":0
				}
			},
			"TERM_ID":42,
			"INITIAL_PAYMENT_AMOUNT":0,
			"FREQUENCY":
			{
				"UNIT":"DD",
				"PERIOD":0
			},
			"AVAILABLE_PAYMENT_METHODS":["CREDIT_CARD","BANK_ACCOUNT"],
			"INITIAL_PAYMENT_PERCENTAGE":0,
			"BANK_ACCOUNT":
			{
				"SURCHARGE":
				{
					"PERCENT":0,
					"TYPE":2,
					"AMOUNT":3.25
				}
			}
		},
		{
			"SETUP_FEE":40,
			"CREDIT_CARD":
			{	
				"SURCHARGE":
				{
					"PERCENT":2.5,
					"TYPE":1,
					"AMOUNT":0
				}
			},
			"TERM_ID":44,
			"INITIAL_PAYMENT_AMOUNT":50,
			"FREQUENCY":
			{
				"UNIT":"WK",
				"PERIOD":1
			},
			"AVAILABLE_PAYMENT_METHODS":["CREDIT_CARD","BANK_ACCOUNT"],
			"INITIAL_PAYMENT_PERCENTAGE":0,
			"BANK_ACCOUNT":
			{
				"SURCHARGE":
				{
					"PERCENT":0,
					"TYPE":2,
					"AMOUNT":3.25
				}
			}
		}
	]
}
print   print

resource /accounting/external/debit_success/checkcredentials

Description

Returns true if a debit success api request which requires authentication can be successfully completed.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/accounting/external/debit_success/checkcredentials

Pattern: /accounting/external/debit_success/checkcredentials
Handler: api.accounting.external.debit_success.flow
Action: {GET={checkCredentials}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/accounting/external/debit_success/checkcredentials
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json

Samples

Confirms that a connection requiring authentication can be established with the debitsuccess api.

{"success"=true}
print   print

resource /course/deliveryLocations/

Description

Returns a list accredited Delivery Locations. These are the locations reported to NCVER through the AVETMISS reports and are attached to classes (type=p) and units only. The results are ordered by active first, then identifier and name.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/course/deliveryLocations/

Pattern: /course/deliveryLocations/
Handler: api.deliveryLocation
Action: {GET={search}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/course/deliveryLocations/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
active boolean false True to return the active Delivery Locations only
deliveryLocationCode string false To search on the Delivery Location Code, which is not the unique numeric ID, but the identifier reported to NCVER
Response Default Response Format: json

Samples

[
    {
        "ID": 4566,
        "CODE": "3000",
        "NAME": "MELBOURNE",
        "BUILDINGNAME": "E Building",
        "UNITNO": "99A",
        "STREETNO": "35",
        "STREETNAME": "Vic Lane",
        "CITY": "MELBOURNE",
        "STATE": "VIC",
        "POSTCODE": "3000",
        "COUNTRY": "Australia",
        "COUNTRYID": 1101,
        "ACTIVE": true
    },
    {
        "ID": 23222,
        "CODE": "4680",
        "NAME": "GLADSTONE",
        "BUILDINGNAME": null,
        "UNITNO": null,
        "STREETNO": null,
        "STREETNAME": null,
        "CITY": "GLADSTONE",
        "STATE": "QLD",
        "POSTCODE": "4680",
        "COUNTRY": "Australia",
        "COUNTRYID": 1101,
        "ACTIVE": true
    },
    {
        "ID": 33259,
        "CODE": "OSPC",
        "NAME": "Overseas example - NZ",
        "BUILDINGNAME": null,
        "UNITNO": null,
        "STREETNO": null,
        "STREETNAME": null,
        "CITY": "Overseas address",
        "STATE": "OVS",
        "POSTCODE": "OSPC",
        "COUNTRY": "New Zealand",
        "COUNTRYID": 1201,
        "ACTIVE": true
    },
    {
        "ID": 13533,
        "CODE": "4070",
        "NAME": "Moggill Hall",
        "BUILDINGNAME": "Moggill Hall",
        "UNITNO": null,
        "STREETNO": "33",
        "STREETNAME": "Moggill Rd",
        "CITY": "MOGGILL",
        "STATE": "QLD",
        "POSTCODE": "4070",
        "COUNTRY": "Australia",
        "COUNTRYID": 1101,
        "ACTIVE": false
    }
]
print   print

resource /course/deliveryLocation/

Description

Returns a single accredited delivery location. These are the locations reported to NCVER through the AVETMISS reports and are attached to classes (type=p) and units only.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/course/deliveryLocation/

Pattern: /course/deliveryLocation/
Handler: api.deliveryLocation
Action: {GET={read}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/course/deliveryLocation/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
ID numeric true The ID of Delivery Location to read.
Response Default Response Format: json

Samples

{
    "ID": 4566,
    "CODE": "3000",
    "NAME": "MELBOURNE",
    "BUILDINGNAME": "E Building",
    "UNITNO": "99A",
    "STREETNO": "35",
    "STREETNAME": "Vic Lane",
    "CITY": "MELBOURNE",
    "STATE": "VIC",
    "POSTCODE": "3000",
    "COUNTRY": "Australia",
    "COUNTRYID": 1101,
    "ACTIVE": true
}
print   print

resource /discounts

Description

Searches and returns system discounts. To calculate a discount for a course, use discounts/course

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/discounts

Pattern: /discounts
Handler: api.discount
Action: {GET={getDiscounts}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/discounts
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
status string false Used for searching the status of a discount. Possible values are: ACTIVE, INACTIVE, and EXPIRED
discountTypeID numeric false The type of discount you are looking for (eg '1=Early Bird'). See below for a list of discount types. This field also supports more than one value as a list.
globalCourses boolean false If 'true', the discount applies to all courses
type string false The type of course (w, p, el). If passed with one of instanceID or ID, you can return all discounts linked to that course.
instanceID numeric false The instanceID of the course
ID numeric false The ID of the course type
directlyLinkedOnly boolean false Used when searching via courses to pull back discounts that are directly linked only - not those only linked to the type or global
Response Default Response Format: json

Samples

This is an example return. The discounts are ordered by status, then type, then name.

[
    {
        "DISCOUNTID": 6543,
        "NAME": "$15 off for booking two weeks in advance",
        "CALCULATIONDESCRIPTION": "$15 off",
        "CALCULATIONMETHOD": "Flat rate off",
        "CALCULATIONVALUE": 15,
        "DISCOUNTTYPEID": 1,
        "DISCOUNTTYPEDESCRIPTION": "Early Bird",
        "NOTINCONJUNCTION": false,
        "GLOBALCOURSES": false,
        "GLOBALSHOPPINGCART": false,
        "STATUS": "ACTIVE",
        "EXPIRYDATE": null,
        "CRITERIA": [
            {
                "TEXT": "14 days",
                "VALUE": 14
            }
        ]
    },
    {
        "DISCOUNTID": 6172,
        "NAME": "A special 10% off discount for members",
        "CALCULATIONDESCRIPTION": "10% off",
        "CALCULATIONMETHOD": "Percent off",
        "CALCULATIONVALUE": 10,
        "DISCOUNTTYPEID": 2,
        "DISCOUNTTYPEDESCRIPTION": "Membership",
        "NOTINCONJUNCTION": false,
        "GLOBALCOURSES": false,
        "GLOBALSHOPPINGCART": false,
        "STATUS": "ACTIVE",
        "EXPIRYDATE": null,
        "CRITERIA": [
            {
                "DOCUMENTNAME": "Membership Card",
                "ISMEMBERSHIP": true,
                "CERTTYPEID": 2577
            }
        ]
    },
    {
        "DISCOUNTID": 5171,
        "NAME": "Discount for all contacts in category ABC",
        "CALCULATIONDESCRIPTION": "$25.00 flat rate",
        "CALCULATIONMETHOD": "Flat rate",
        "CALCULATIONVALUE": 25,
        "DISCOUNTTYPEID": 3,
        "DISCOUNTTYPEDESCRIPTION": "Category",
        "NOTINCONJUNCTION": false,
        "GLOBALCOURSES": false,
        "GLOBALSHOPPINGCART": false,
        "STATUS": "ACTIVE",
        "EXPIRYDATE": "2016-04-30",
        "CRITERIA": [
            {
                "CATEGORYID": 16737,
                "CATEGORYNAME": "ABC Category",
                "CATEGORYCODE": "ABC"
            }
        ]
    },    
    {
        "DISCOUNTID": 5177,
        "NAME": "Discount for all staff",
        "CALCULATIONDESCRIPTION": "$666.00 flat rate",
        "CALCULATIONMETHOD": "Flat rate",
        "CALCULATIONVALUE": 666,
        "DISCOUNTTYPEID": 4,
        "DISCOUNTTYPEDESCRIPTION": "Organisation",
        "NOTINCONJUNCTION": false,
        "GLOBALCOURSES": false,
        "GLOBALSHOPPINGCART": false,
        "STATUS": "ACTIVE",
        "EXPIRYDATE": null,
        "CRITERIA": [
            {
                "ORGID": 3434,
                "ORGANISATIONNAME": "ABC ORG",
            },
            {
                "ORGID": 445,
                "ORGANISATIONNAME": "ABC other ORG",
            }
        ]
    },
    {
        "DISCOUNTID": 5170,
        "NAME": "Another Test - flat rate for groups of 6",
        "CALCULATIONDESCRIPTION": "$100.00 flat rate",
        "CALCULATIONMETHOD": "Flat rate",
        "CALCULATIONVALUE": 100,
        "DISCOUNTTYPEID": 5,
        "DISCOUNTTYPEDESCRIPTION": "Group Discount",
        "NOTINCONJUNCTION": false,
        "GLOBALCOURSES": false,
        "GLOBALSHOPPINGCART": false,
        "STATUS": "ACTIVE",
        "EXPIRYDATE": "2016-04-30",
        "CRITERIA": [
            {
                "TEXT": "Group Booking of 6 or more",
                "VALUE": 6
            }
        ]
    },
    {
        "DISCOUNTID": 5178,
        "NAME": "Special Promo offer",
        "CALCULATIONDESCRIPTION": "3% off",
        "CALCULATIONMETHOD": "Percent off",
        "CALCULATIONVALUE": 3,
        "DISCOUNTTYPEID": 6,
        "DISCOUNTTYPEDESCRIPTION": "Promo Code",
        "NOTINCONJUNCTION": true,
        "GLOBALCOURSES": false,
        "GLOBALSHOPPINGCART": false,
        "STATUS": "ACTIVE",
        "EXPIRYDATE": null,
        "CRITERIA": [
            {
                "PROMOCODE": "PROMO-123-456"
            }
        ]
    }
]

Discount Types. You must pass the typeID, not the type name into the discountTypeID field.

	1	Early Bird
	2	Membership
	3	Category
	4	Organisation
	5	Group Discount
	6	Promo Code
	7	Concession
print   print

resource /domains/

Description

Returns an array of defined Domains.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/domains/

Pattern: /domains/
Handler: api.domain
Action: {GET={search}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/domains/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json

Samples

A successful call will give you a response like this:

[
    {
        "DOMAINID": 472,
        "DOMAINNAME": "VM Learning"
    },
    {
        "DOMAINID": 473,
        "DOMAINNAME": "aXcelerate"
    }
]
print   print

resource /domain/:domainID

Description

Returns an array of defined Domains.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/domain/:domainID

Pattern: /domain/:domainID
Handler: api.domain
Action: {GET={read}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/domain/:domainID
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
domainID string true The ID of the Domain.
Response Default Response Format: json

Samples

A successful call will give you a response like this:

{
    "DOMAINID": 773,
    "DOMAINNAME": "Testing 123"
}
print   print

resource /domain/

Description

Returns an array of defined Domains.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/domain/

Pattern: /domain/
Handler: api.domain
Action: {POST={create}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/domain/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
name string true The Name of the Domain.
Response Default Response Format: json

Samples

A successful call will give you a response like this:

{
    "DOMAINID": 773,
    "DOMAINNAME": "Testing 123"
}
print   print

resource /accounting/external/ezypay/plan/search

Description

Returns an array of ezypay payment plans that are available for paying the passed in moneytary value.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/accounting/external/ezypay/plan/search

Pattern: /accounting/external/ezypay/plan/search
Handler: api.accounting.external.ezypay.plan
Action: {GET={search}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/accounting/external/ezypay/plan/search
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
amount string true The amount of money that is to be collected.
Response Default Response Format: json

Samples

TERM_ID:The identifier for the payment terms.
LABEL:The user defined label describing the terms to the end user in plain text.
INITIAL_PAYMENT_AMOUNT:The fixed amount of money that will be due at checkout. (zero if a INITIAL_PAYMENT_PERCENTAGE has been set)
AVAILABLE_PAYMENT_METHODS:The payment methods that can be used to pay for the outstanding amount. Valid values are: CREDIT_CARD,BANK_ACCOUNT.


Depending on the available payment methods the following keys will also exist. The name of these keys are returned in the AVAILABLE_PAYMENT_METHODS field.
CREDIT_CARD: Information related to paying using a credit card. This key only exists if CREDIT_CARD is one of the available payment methods.

BANK_ACCOUNT: Information related to paying using direct debit from a bank account. This key only exists if BANK_ACCOUNT is one of the available payment methods.



The CREDIT_CARD and BANK_ACCOUNT keys have the following sub key:
SURCHARGE:The surcharge applied for using this payment method.
SURCHARGE.TYPE:0 No Surcharge, 1:Percentage of each transaction amount. 2:Fixed amount per transaction.
SURCHARGE.PERCENT:Percentage of surcharge applied.
SURCHARGE.AMOUNT:Fixed surcharge amount.


{
    "TERM": [
        {
            "CREDIT_CARD": {
                "SURCHARGE": {
                    "PERCENT": 0,
                    "TYPE": 0,
                    "AMOUNT": 0
                }
            },
            "INITIAL_PAYMENT_AMOUNT": 0,
            "FREQUENCY": {
                "UNIT": "w"
            },
            "AVAILABLE_PAYMENT_METHODS": [
                "CREDIT_CARD",
                "BANK_ACCOUNT"
            ],
            "TERM_ID": "e045d1e5-7398-4356-ba1b-e6bfce109a79",
            "LABEL": "Weekly Payments",
            "INITIAL_ONE_OF_PAYMENT": 0,
            "BANK_ACCOUNT": {
                "SURCHARGE": {
                    "PERCENT": 0,
                    "TYPE": 0,
                    "AMOUNT": 0
                }
            }
        },
        {
            "CREDIT_CARD": {
                "SURCHARGE": {
                    "PERCENT": 0,
                    "TYPE": 0,
                    "AMOUNT": 0
                }
            },
            "INITIAL_PAYMENT_AMOUNT": 0,
            "FREQUENCY": {
                "UNIT": "m"
            },
            "AVAILABLE_PAYMENT_METHODS": [
                "CREDIT_CARD",
                "BANK_ACCOUNT"
            ],
            "TERM_ID": "64b9eb32-e6b6-47be-bd05-e4029ac2bd4b",
            "LABEL": "Monthly Payment",
            "INITIAL_ONE_OF_PAYMENT": 0,
            "BANK_ACCOUNT": {
                "SURCHARGE": {
                    "PERCENT": 0,
                    "TYPE": 0,
                    "AMOUNT": 0
                }
            }
        }
    ]
}
print   print

resource /financeModel/:modelID

Description

Get (GET) a Finance Model.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/financeModel/:modelID

Pattern: /financeModel/:modelID
Handler: api.financeModel
Action: {GET={read}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/financeModel/:modelID
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json

Samples

A successful GET call will give you a response like this:

[
    {
        "ROWID": 1,
        "MODELID": 4067,
        "NAME": "Cert I in Business",
        "ID": 11238,
        "TYPE": "p",
        "COST": 5000,
        "COMBINEDFORTUITIONFEE": false,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Unit",
            "FUNDPERCENTAGE": 0,
            "FUNDVALUE": 400,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {},
        "COUNT": 11
    },
    {
        "ROWID": 2,
        "MODELID": 1866,
        "NAME": "Certificate IV in Superannuation - Member - Flexible online",
        "ID": 3296,
        "TYPE": "p",
        "COST": 1750,
        "COMBINEDFORTUITIONFEE": false,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 0,
            "FUNDVALUE": 775,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {},
        "COUNT": 11
    },
    {
        "ROWID": 3,
        "MODELID": 4672,
        "NAME": "Certificate IV in Superannuation - Member - Flexible online {Duplicated}",
        "ID": 3296,
        "TYPE": "p",
        "COST": null,
        "COMBINEDFORTUITIONFEE": true,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 0,
            "FUNDVALUE": 775,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {},
        "COUNT": 11
    },
    {
        "ROWID": 4,
        "MODELID": 4673,
        "NAME": "Certificate IV in Superannuation - Member - Flexible online {Duplicated}",
        "ID": 3296,
        "TYPE": "p",
        "COST": null,
        "COMBINEDFORTUITIONFEE": true,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 0,
            "FUNDVALUE": 775,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {},
        "COUNT": 11
    },
    {
        "ROWID": 5,
        "MODELID": 1863,
        "NAME": "Certificate IV in Superannuation - Member - Public Workshop",
        "ID": 3296,
        "TYPE": "p",
        "COST": 1650,
        "COMBINEDFORTUITIONFEE": true,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 0,
            "FUNDVALUE": 1650,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {},
        "COUNT": 11
    },
    {
        "ROWID": 6,
        "MODELID": 1865,
        "NAME": "Certificate IV in Superannuation - Non-member - Flexible online",
        "ID": 3296,
        "TYPE": "p",
        "COST": 875,
        "COMBINEDFORTUITIONFEE": true,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 0,
            "FUNDVALUE": 875,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {},
        "COUNT": 11
    },
    {
        "ROWID": 7,
        "MODELID": 1864,
        "NAME": "Certificate IV in Superannuation - Non-member - Public Workshop",
        "ID": 3296,
        "TYPE": "p",
        "COST": 1750,
        "COMBINEDFORTUITIONFEE": true,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 0,
            "FUNDVALUE": 1750,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {},
        "COUNT": 11
    },
    {
        "ROWID": 8,
        "MODELID": 1317,
        "NAME": "Test demo model",
        "ID": 168,
        "TYPE": "p",
        "COST": 5100,
        "COMBINEDFORTUITIONFEE": false,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Hour",
            "FUNDPERCENTAGE": 0,
            "FUNDVALUE": 10.05,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 0,
            "FUNDVALUE": 0,
            "ID": 28993,
            "NAME": null
        },
        "COUNT": 11
    },
    {
        "ROWID": 9,
        "MODELID": 4674,
        "NAME": "Test demo model {Duplicated}",
        "ID": 168,
        "TYPE": "p",
        "COST": null,
        "COMBINEDFORTUITIONFEE": true,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 50,
            "FUNDVALUE": 0,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 50,
            "FUNDVALUE": 0,
            "ID": 28993,
            "NAME": null
        },
        "COUNT": 11
    },
    {
        "ROWID": 10,
        "MODELID": 4670,
        "NAME": "Test demo model {Duplicated}",
        "ID": 168,
        "TYPE": "p",
        "COST": null,
        "COMBINEDFORTUITIONFEE": true,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 50,
            "FUNDVALUE": 0,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 50,
            "FUNDVALUE": 0,
            "ID": 28993,
            "NAME": null
        },
        "COUNT": 11
    }
]
print   print

resource /financeModels/

Description

Search (GET) for a Finance Model.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/financeModels/

Pattern: /financeModels/
Handler: api.financeModel
Action: {GET={search}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/financeModels/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
name string false The Name or part of the Finance Model Name.
modelID string false The Model ID to search on.
ID string false The Qualification Type ID to search by.
search string false The search term
Response Default Response Format: json

Samples

A successful GET call will give you a response like this:

[
    {
        "ROWID": 1,
        "MODELID": 4067,
        "NAME": "Cert I in Business",
        "ID": 11238,
        "TYPE": "p",
        "COST": 5000,
        "COMBINEDFORTUITIONFEE": false,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Unit",
            "FUNDPERCENTAGE": 0,
            "FUNDVALUE": 400,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {},
        "COUNT": 11
    },
    {
        "ROWID": 2,
        "MODELID": 1866,
        "NAME": "Certificate IV in Superannuation - Member - Flexible online",
        "ID": 3296,
        "TYPE": "p",
        "COST": 1750,
        "COMBINEDFORTUITIONFEE": false,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 0,
            "FUNDVALUE": 775,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {},
        "COUNT": 11
    },
    {
        "ROWID": 3,
        "MODELID": 4672,
        "NAME": "Certificate IV in Superannuation - Member - Flexible online {Duplicated}",
        "ID": 3296,
        "TYPE": "p",
        "COST": null,
        "COMBINEDFORTUITIONFEE": true,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 0,
            "FUNDVALUE": 775,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {},
        "COUNT": 11
    },
    {
        "ROWID": 4,
        "MODELID": 4673,
        "NAME": "Certificate IV in Superannuation - Member - Flexible online {Duplicated}",
        "ID": 3296,
        "TYPE": "p",
        "COST": null,
        "COMBINEDFORTUITIONFEE": true,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 0,
            "FUNDVALUE": 775,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {},
        "COUNT": 11
    },
    {
        "ROWID": 5,
        "MODELID": 1863,
        "NAME": "Certificate IV in Superannuation - Member - Public Workshop",
        "ID": 3296,
        "TYPE": "p",
        "COST": 1650,
        "COMBINEDFORTUITIONFEE": true,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 0,
            "FUNDVALUE": 1650,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {},
        "COUNT": 11
    },
    {
        "ROWID": 6,
        "MODELID": 1865,
        "NAME": "Certificate IV in Superannuation - Non-member - Flexible online",
        "ID": 3296,
        "TYPE": "p",
        "COST": 875,
        "COMBINEDFORTUITIONFEE": true,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 0,
            "FUNDVALUE": 875,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {},
        "COUNT": 11
    },
    {
        "ROWID": 7,
        "MODELID": 1864,
        "NAME": "Certificate IV in Superannuation - Non-member - Public Workshop",
        "ID": 3296,
        "TYPE": "p",
        "COST": 1750,
        "COMBINEDFORTUITIONFEE": true,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 0,
            "FUNDVALUE": 1750,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {},
        "COUNT": 11
    },
    {
        "ROWID": 8,
        "MODELID": 1317,
        "NAME": "Test demo model",
        "ID": 168,
        "TYPE": "p",
        "COST": 5100,
        "COMBINEDFORTUITIONFEE": false,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Hour",
            "FUNDPERCENTAGE": 0,
            "FUNDVALUE": 10.05,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 0,
            "FUNDVALUE": 0,
            "ID": 28993,
            "NAME": null
        },
        "COUNT": 11
    },
    {
        "ROWID": 9,
        "MODELID": 4674,
        "NAME": "Test demo model {Duplicated}",
        "ID": 168,
        "TYPE": "p",
        "COST": null,
        "COMBINEDFORTUITIONFEE": true,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 50,
            "FUNDVALUE": 0,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 50,
            "FUNDVALUE": 0,
            "ID": 28993,
            "NAME": null
        },
        "COUNT": 11
    },
    {
        "ROWID": 10,
        "MODELID": 4670,
        "NAME": "Test demo model {Duplicated}",
        "ID": 168,
        "TYPE": "p",
        "COST": null,
        "COMBINEDFORTUITIONFEE": true,
        "GOVERNMENT": {},
        "EMPLOYER": {},
        "STUDENT": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 50,
            "FUNDVALUE": 0,
            "MINFUND": 0,
            "MAXFUND": 0
        },
        "OTHER": {
            "FUNDTYPE": "Per Qualification",
            "FUNDPERCENTAGE": 50,
            "FUNDVALUE": 0,
            "ID": 28993,
            "NAME": null
        },
        "COUNT": 11
    }
]
print   print

resource /followUp/:mtaskID

Description

Get (GET) or Update (PUT) a follow up task (Marketing Tasks).

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/followUp/:mtaskID

Pattern: /followUp/:mtaskID
Handler: api.followUp
Action: {PUT={update}, GET={read}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/followUp/:mtaskID
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET,PUT
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
legacyTask boolean false true Read/Update a Legacy or New Follow Up Task.
FollowUpStatus string false Update the Follow Up Status (new task system): 'Not Started', 'Commenced', 'Pending' and 'Completed'.
OppertunityStatus string false Update the Opportunity Status: 'Lost', 'Pending', 'Scheduled', 'Abandoned', 'Won' + (NEW ONLY) 'Qualified Lead' and 'Prospect'
CompletedDate string false now() The Completed Date (if not passed with the 'Completed' Follow Up status; todays date will be used).
ForecastValue numeric false Update the Opportunity Forecast Value.
Response Default Response Format: json

Samples

A successful GET call will give you a response like this:

Legacy:
{
    "FORECASTVALUE": "",
    "NOTESID": 1064352,
    "CONTACTID": 22627,
    "COLOR": "#F60EE0",
    "FORECASTPROBABILITY": "",
    "FOLLOWUPCONTACTID": 23423,
    "OPPORTUNITYSTATUS": "",
    "MTASKID": 48642,
    "LASTNOTE": {
        "NOTETEXT": "Called Suzie following an email complaint from her that her AVETMISS reports were being rejected. She was correct that there are over 1500 records missing from the reports when she generates them from aXcelerate. I looked into the issue - her last zip file she sent for importing had the correct number of participants, however there were some previous imports that had poor data. Perhaps the new import is not overwriting old data when it should. She indicated that she could get a list of students missing from the report so I emailed her after the call to see if she could send that through. I will set a follow up if she cannot supply the file for Monday. ",
        "NOTEDATE": "2013-10-10 03:19 PM",
        "ENTEREDBY": "Michael Smith"
    },
    "FOLLOWUPDATE": "2013-10-14 12:00 AM",
    "OPPORTUNITY": ""
}

New (Workflow Engine):
{
    "MARKETINGCONTACTID": 1372669,
    "MARKETINGLEARNINGACTIVITYID": null,
    "DUEDATE": "2015-06-23",
    "FORECASTDISTRIBUTION": [
        {
            "MONTH": "2015-05-01",
            "VALUE": 4.99
        },
        {
            "MONTH": "2015-06-01",
            "VALUE": 5
        }
    ],
    "STATUSDISPLAYNAME": "Not Started",
    "FORECASTVALUE": 9.99,
    "OWNERCONTACTID": 4744,
    "TASKID": 1049,
    "MARKETINGNOTESID": 4777887,
    "STATUS": 1,
    "CATEGORIES": [
        20
    ],
    "PRIORITY": 4,
    "FORECASTPROBABILITY": 50,
    "COMPLETEDDATE": "",
    "NAME": "Follow-up: Billy Bloggs",
    "CREATIONDATE": "2015-06-16 01:46 PM",
    "OPPORTUNITYSTATUS": "Pending",
    "OWNER": "Reay Mackay",
    "LASTNOTE": {
        "NOTETEXT": "For testing report - pending",
        "NOTEDATE": "2015-06-16 01:46 PM",
        "NOTESID": 4777887,
        "NOTE_ENTEREDBYID": 445036,
        "NOTE_ENTEREDBY": "Scott O'Connell"
    },
    "DETAILS": ""
}
print   print

resource /followUp/

Description

Create legacy follow up task (Marketing Tasks).

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/followUp/

Pattern: /followUp/
Handler: api.followUp
Action: {POST={create}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/followUp/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
followUpContactID numeric true The contactID to create the Follow Up (task) against (Task Owner)
contactID numeric true The contactID to create the Follow Up for (Client)
followUpDate string true The Follow Up date
note numeric true The Note
noteCodeID numeric true The NoteCodeID (from aXcelerate)
color string false The Follow-up Colour - HEX i.e #FF0000
Response Default Response Format: json

Samples

A successful POST call will give you a response like this:

{
    "MTASKID": 1234,
    "STATUS": "success",
    "MESSAGE": "Follow Up Created Successfully"
}
print   print

resource /followUps/

Description

List/search follow up tasks (Marketing Tasks).

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/followUps/

Pattern: /followUps/
Handler: api.followUp
Action: {GET={search}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/followUps/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
search string false The search term
WhoseTask_ContactID numeric false The contactID the Follow Up (task) is against (Task Owner)
contactID numeric false The contactID the Follow Up was created for (Client)
Response Default Response Format: json

Samples

A successful GET call will give you a response like this:

[
    {
        "ROWID": 1,
        "LEGACYTASK": true,
        "MTASKID": 165424,
        "CONTACTID": 1895844,
        "FOLLOWUPDATE": "2015-02-16 12:00 AM",
        "WHOSETASK_CONTACTID": "",
        "WHOSETASK_GIVENNAME": "",
        "WHOSETASK_SURNAME": "",
        "FORECASTVALUE": "",
        "FORECASTPROBABILITY": "",
        "OPPORTUNITY": "Online Enquiry",
        "OPPORTUNITYSTATUS": "Pending",
        "COLOR": "",
        "CONTACT_NAME": "test test",
        "ORGID": "",
        "ORGANISATION": "",
        "EMAILADDRESS": "testing@lucidsolutions.in",
        "WORKPHONE": "",
        "WHOSETASK_ORDER": "",
        "COUNT": 359
    },
    {
        "ROWID": 2,
        "LEGACYTASK": true,
        "MTASKID": 169127,
        "CONTACTID": 1895770,
        "FOLLOWUPDATE": "2015-08-18 12:00 AM",
        "WHOSETASK_CONTACTID": 8801,
        "WHOSETASK_GIVENNAME": "Chris",
        "WHOSETASK_SURNAME": "Verner",
        "FORECASTVALUE": "",
        "FORECASTPROBABILITY": 50,
        "OPPORTUNITY": "",
        "OPPORTUNITYSTATUS": "Pending",
        "COLOR": "#fff",
        "CONTACT_NAME": "Ming Thompson",
        "ORGID": "",
        "ORGANISATION": "",
        "EMAILADDRESS": "ming@eims.com.au",
        "WORKPHONE": "",
        "WHOSETASK_ORDER": "VernerChris",
        "COUNT": 359
    },
    {
        "ROWID": 3,
        "LEGACYTASK": true,
        "MTASKID": 178292,
        "CONTACTID": 107224,
        "FOLLOWUPDATE": "2015-08-11 12:00 AM",
        "WHOSETASK_CONTACTID": 8694,
        "WHOSETASK_GIVENNAME": "Katie",
        "WHOSETASK_SURNAME": "Mackay",
        "FORECASTVALUE": "",
        "FORECASTPROBABILITY": 50,
        "OPPORTUNITY": "",
        "OPPORTUNITYSTATUS": "Pending",
        "COLOR": "#FE0000",
        "CONTACT_NAME": "Louise Vause",
        "ORGID": "",
        "ORGANISATION": "",
        "EMAILADDRESS": "lv@sitedu.com.au",
        "WORKPHONE": "(07) 3844 3478",
        "WHOSETASK_ORDER": "MackayKatie",
        "COUNT": 359
    },
    {
        "ROWID": 4,
        "LEGACYTASK": true,
        "MTASKID": 186801,
        "CONTACTID": 2023775,
        "FOLLOWUPDATE": "2016-01-04 12:00 AM",
        "WHOSETASK_CONTACTID": 1038809,
        "WHOSETASK_GIVENNAME": "Emily",
        "WHOSETASK_SURNAME": "Harris",
        "FORECASTVALUE": "",
        "FORECASTPROBABILITY": "",
        "OPPORTUNITY": "",
        "OPPORTUNITYSTATUS": "",
        "COLOR": "#fff",
        "CONTACT_NAME": "Sue Dean",
        "ORGID": "",
        "ORGANISATION": "",
        "EMAILADDRESS": "ozlady_5@hotmail.com",
        "WORKPHONE": "",
        "WHOSETASK_ORDER": "HarrisEmily",
        "COUNT": 359
    },
    {
        "ROWID": 5,
        "LEGACYTASK": true,
        "MTASKID": 212131,
        "CONTACTID": 2084741,
        "FOLLOWUPDATE": "2015-06-03 12:00 AM",
        "WHOSETASK_CONTACTID": 1038809,
        "WHOSETASK_GIVENNAME": "Emily",
        "WHOSETASK_SURNAME": "Harris",
        "FORECASTVALUE": "",
        "FORECASTPROBABILITY": 50,
        "OPPORTUNITY": "",
        "OPPORTUNITYSTATUS": "Pending",
        "COLOR": "#fff",
        "CONTACT_NAME": "Janet Hewitt",
        "ORGID": "",
        "ORGANISATION": "",
        "EMAILADDRESS": "janet.hewitt@dsitia.qld.gov.au",
        "WORKPHONE": "(07) 3719 7750",
        "WHOSETASK_ORDER": "HarrisEmily",
        "COUNT": 359
    },
    {
        "ROWID": 6,
        "LEGACYTASK": true,
        "MTASKID": 223554,
        "CONTACTID": 2194140,
        "FOLLOWUPDATE": "2015-08-07 12:00 AM",
        "WHOSETASK_CONTACTID": 8694,
        "WHOSETASK_GIVENNAME": "Katie",
        "WHOSETASK_SURNAME": "Mackay",
        "FORECASTVALUE": "",
        "FORECASTPROBABILITY": "",
        "OPPORTUNITY": "",
        "OPPORTUNITYSTATUS": "",
        "COLOR": "#fff",
        "CONTACT_NAME": "Brad Lyall",
        "ORGID": "",
        "ORGANISATION": "",
        "EMAILADDRESS": "bslyall@icloud.com",
        "WORKPHONE": "",
        "WHOSETASK_ORDER": "MackayKatie",
        "COUNT": 359
    },
    {
        "ROWID": 7,
        "LEGACYTASK": true,
        "MTASKID": 227880,
        "CONTACTID": 2265291,
        "FOLLOWUPDATE": "2015-07-14 12:00 AM",
        "WHOSETASK_CONTACTID": 8694,
        "WHOSETASK_GIVENNAME": "Katie",
        "WHOSETASK_SURNAME": "Mackay",
        "FORECASTVALUE": "",
        "FORECASTPROBABILITY": "",
        "OPPORTUNITY": "",
        "OPPORTUNITYSTATUS": "",
        "COLOR": "#fff",
        "CONTACT_NAME": "Paul Timms",
        "ORGID": "",
        "ORGANISATION": "",
        "EMAILADDRESS": "paultimms@me.com",
        "WORKPHONE": "",
        "WHOSETASK_ORDER": "MackayKatie",
        "COUNT": 359
    },
    {
        "ROWID": 8,
        "LEGACYTASK": true,
        "MTASKID": 219770,
        "CONTACTID": 2083323,
        "FOLLOWUPDATE": "2015-07-06 12:00 AM",
        "WHOSETASK_CONTACTID": 4744,
        "WHOSETASK_GIVENNAME": "Reay",
        "WHOSETASK_SURNAME": "Mackay",
        "FORECASTVALUE": "",
        "FORECASTPROBABILITY": 50,
        "OPPORTUNITY": "",
        "OPPORTUNITYSTATUS": "Pending",
        "COLOR": "#FF8CCE",
        "CONTACT_NAME": "Vicki Walker",
        "ORGID": 110769,
        "ORGANISATION": " Byron Community College",
        "EMAILADDRESS": "vicki@byroncollege.org.au",
        "WORKPHONE": "02 6684 3374",
        "WHOSETASK_ORDER": "MackayReay",
        "COUNT": 359
    },
    {
        "ROWID": 9,
        "LEGACYTASK": true,
        "MTASKID": 38191,
        "CONTACTID": 599448,
        "FOLLOWUPDATE": "2015-08-20 12:00 AM",
        "WHOSETASK_CONTACTID": 8801,
        "WHOSETASK_GIVENNAME": "Chris",
        "WHOSETASK_SURNAME": "Verner",
        "FORECASTVALUE": "",
        "FORECASTPROBABILITY": 50,
        "OPPORTUNITY": "",
        "OPPORTUNITYSTATUS": "Pending",
        "COLOR": "#FFFFFF",
        "CONTACT_NAME": "Marie Keating",
        "ORGID": 113787,
        "ORGANISATION": " Capricornia Training Company Ltd",
        "EMAILADDRESS": "ceo@ctcltd.com.au",
        "WORKPHONE": "07 4922 2008",
        "WHOSETASK_ORDER": "VernerChris",
        "COUNT": 359
    },
    {
        "ROWID": 10,
        "LEGACYTASK": true,
        "MTASKID": 37777,
        "CONTACTID": 597371,
        "FOLLOWUPDATE": "2015-02-11 12:00 AM",
        "WHOSETASK_CONTACTID": 2123568,
        "WHOSETASK_GIVENNAME": "Claire",
        "WHOSETASK_SURNAME": "Jordan",
        "FORECASTVALUE": "",
        "FORECASTPROBABILITY": 50,
        "OPPORTUNITY": "",
        "OPPORTUNITYSTATUS": "Pending",
        "COLOR": "#FFFFFF",
        "CONTACT_NAME": "Bruce Cameron",
        "ORGID": 106679,
        "ORGANISATION": "4Life Personal Medical Training",
        "EMAILADDRESS": "info@4lifetraining.com.au",
        "WORKPHONE": "08 8338 7723",
        "WHOSETASK_ORDER": "JordanClaire",
        "COUNT": 359
    }
]
print   print

resource /organisation/:orgID

Description

Read (GET) or Update (PUT) an Organisation record. The parameters below refer only to PUT requests.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/organisation/:orgID

Pattern: /organisation/:orgID
Handler: api.organisation
Action: {PUT={update}, GET={read}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/organisation/:orgID
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET,PUT
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
orgID numeric true The organisation ID
parentOrgID numeric false The parent organisation ID
employerContactID numeric false The Contact ID of the Employer
payerContactID numeric false The Contact ID of the Payer
name string false The name of the organisation
legalName string false The legal name of the organisation
ABN numeric false The Australian Business Number
orgNameAccounting string false The name of the organisation (for accounting / finance engine)
organisationNotes string false Notes field stored against the organisation
purchaseOrderRequired boolean false Is a purchase order required when invoicing this organisation?
schoolTypeID numeric false School Type Identifier AVETMISS field. See samples below for valid values.
active boolean false The organisation's active status
Response Default Response Format: json

Samples

School Type Identifier

21 - School - Government
25 - School - Catholic
27 - School - Independent
31 - Technical and Further Education institute
61 - Community-based adult education provider
91 - Privately operated registered training organisation
92 - Home school arrangement

Returns a structure of organisation information.

{
    "HIERACHYDEPTH": 2,
    "HIERACHYPATH": "/264487/264488/",
    "NWDF_ORGSIZEBRACKET": null,
    "BANNER": "<img src='/images/logo.png'>",
    "ORGNAMEACCOUNTING": null,
    "PURCHASEORDERREQUIRED": 0,
    "SCHOOLTYPEID": "91",
    "BOOKING_NOTES": null,
    "LEGALNAME": null,
    "FINANCESYSTEMCARDID": null,
    "HIERACHYROOT": 264487,
    "PAYERCONTACTID": null,
    "NAME": "DO Tha VooDoo2",
    "ORGID": 264488,
    "PARENT": {
        "HIERACHYDEPTH": 1,
        "HIERACHYPATH": "/264487/",
        "NWDF_ORGSIZEBRACKET": null,
        "ORGNAMEACCOUNTING": null,
        "PURCHASEORDERREQUIRED": 0,
        "BOOKING_NOTES": null,
        "LEGALNAME": null,
        "FINANCESYSTEMCARDID": null,
        "HIERACHYROOT": 264487,
        "PAYERCONTACTID": null,
        "NAME": "DO Tha VooDoo",
        "ORGID": 264487,
        "EMPLOYERCONTACTID": null,
        "ABN": null,
        "ANZSIC": null,
        "PARENTORGID": null,
        "ORGANISATIONNOTES": "Testing 543210"
    },
    "EMPLOYERCONTACTID": null,
    "ABN": null,
    "ANZSIC": null,
    "PARENTORGID": 264487,
    "ORGANISATIONNOTES": "Testing 9876543210",
    "DETAILS": []
}
print   print

resource /organisation/

Description

Create an Organisation.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/organisation/

Pattern: /organisation/
Handler: api.organisation
Action: {POST={create}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/organisation/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
name string true The name of the organisation
legalName string false The legal name of the organisation
parentOrgID numeric false The parent organisation ID
employerContactID numeric false The Contact ID of the Employer
payerContactID numeric false The Contact ID of the Payer
ABN numeric false The Australian Business Number
orgNameAccounting string false The name of the organisation (for accounting / finance engine)
organisationNotes string false Notes field stored against the organisation
purchaseOrderRequired boolean false Is a purchase order required when invoicing this organisation?
schoolTypeID numeric false School Type Identifier AVETMISS field. See samples below for valid values.
active boolean false The organisation's active status
Response Default Response Format: json

Samples

School Type Identifier

21 - School - Government
25 - School - Catholic
27 - School - Independent
31 - Technical and Further Education institute
61 - Community-based adult education provider
91 - Privately operated registered training organisation
92 - Home school arrangement

Returns a structure of organisation information.

{
    "MESSAGE": "Organisation Created Successfully",
    "STATUS": "success",
    "ORGID": 9999
}
print   print

resource /organisations/

Description

An Organisation search. This method will return an array of organisations. You can search on most fields.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/organisations/

Pattern: /organisations/
Handler: api.organisation
Action: {GET={search}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/organisations/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
search string false The search term
active boolean false The organisation's active status. If not provided, both active and inactive organisations will be returned.
offset numeric false 0 The record to start at
displayLength numeric false 10 Maximum number of records to return.
Response Default Response Format: json

Samples

Returns an array of organisation information. The following example was a search on name=test and displayLength=3.

 [
    {
        "ROWID": 1,
        "ORGID": 264487,
        "NAME": "DO Tha VooDoo",
        "LEGALNAME": null,
        "ANZSIC": null,
        "ORGANISATIONNOTES": "Testing 543210",
        "HIERACHYROOT": 264487,
        "HIERACHYPATH": "/264487/",
        "HIERACHYDEPTH": 1,
        "SCHOOLTYPEID": "91",
        "BOOKING_NOTES": null,
        "FINANCESYSTEMCARDID": null,
        "ORGNAMEACCOUNTING": null,
        "ABN": null,
        "PURCHASEORDERREQUIRED": 0,
        "NWDF_ORGSIZEBRACKET": null,
        "BANNER": "<img src='/images/VooDoo.png'>",
        "COUNT": 2,
 		"DETAILS": [
            {
                "DETAILID": 55241,
                "ORGID": 276322,
                "TYPE": "Street Address",
                "PHONE": "07 9161 3500",
                "FAX": "07 9161 3599",
                "EMAILADDRESS": "everythingisawesome@lego.net.au",
                "WEBSITE": null,
                "ADDRESS1": "PO Box 41",
                "ADDRESS2": null,
                "CITY": "WARNER",
                "STATE": "QLD",
                "POSTCODE": "4500",
                "COUNTRY": "Australia",
                "ADDRESSLINE1": null,
                "ADDRESSLINE2": null
            },
            {
                "DETAILID": 55242,
                "ORGID": 276322,
                "TYPE": "Postal Address",
                "PHONE": "07 9161 3500",
                "FAX": "07 9161 3599",
                "EMAILADDRESS": "everythingiscoolwhenyourepartofateam@lego.net",
                "WEBSITE": null,
                "ADDRESS1": "PO Box 42",
                "ADDRESS2": null,
                "CITY": "BRAY PARK",
                "STATE": "QLD",
                "POSTCODE": "4500",
                "COUNTRY": "Australia",
                "ADDRESSLINE1": null,
                "ADDRESSLINE2": null
            }
        ],
        "PARENT": {},
        "PARENTORGID": null,
        "PAYERCONTACTID": null,
        "EMPLOYERCONTACTID": null
    },
    {
        "ROWID": 2,
        "ORGID": 264488,
        "NAME": "DO Tha VooDoo2",
        "LEGALNAME": null,
        "ANZSIC": null,
        "ORGANISATIONNOTES": "Testing 9876543210",
        "HIERACHYROOT": 264487,
        "HIERACHYPATH": "/264487/264488/",
        "HIERACHYDEPTH": 2,
        "SCHOOLTYPEID": "92",
        "BOOKING_NOTES": null,
        "FINANCESYSTEMCARDID": null,
        "ORGNAMEACCOUNTING": null,
        "ABN": null,
        "PURCHASEORDERREQUIRED": 0,
        "NWDF_ORGSIZEBRACKET": null,
        "BANNER": "<img src='/images/testing.png'>",
        "COUNT": 2,
        "DETAILS": [],
        "PARENT": {
            "HIERACHYDEPTH": 1,
            "HIERACHYPATH": "/264487/",
            "NWDF_ORGSIZEBRACKET": null,
            "ORGNAMEACCOUNTING": null,
            "PURCHASEORDERREQUIRED": 0,
            "BOOKING_NOTES": null,
            "LEGALNAME": null,
            "FINANCESYSTEMCARDID": null,
            "HIERACHYROOT": 264487,
            "PAYERCONTACTID": null,
            "NAME": "DO Tha VooDoo",
            "ORGID": 264487,
            "EMPLOYERCONTACTID": null,
            "ABN": null,
            "ANZSIC": null,
            "PARENTORGID": null,
            "ORGANISATIONNOTES": "Testing 543210"
        },
        "PARENTORGID": 264487,
        "PAYERCONTACTID": null,
        "EMPLOYERCONTACTID": null
    }
]
print   print

resource /organisation/:orgID/detail/:detailID

Description

Read (GET) or Update (PUT) an Organisation Detail record. The parameters below refer only to PUT requests.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/organisation/:orgID/detail/:detailID

Pattern: /organisation/:orgID/detail/:detailID
Handler: api.organisation
Action: {PUT={updateDetail}, GET={readDetail}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/organisation/:orgID/detail/:detailID
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET,PUT
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
phone string false The organisation phone number
fax string false The organisation fax number
emailAddress string false The organisation email address
address1 string false The organisation address (line 1)
address2 string false The organisation address (line 2)
city string false The organisation city / suburb
state string false The organisation state
postCode string false The organisation post code
country string false The organisation country
Response Default Response Format: json

Samples

Organisation details (GET) OR a confirmation message that the update was successful in JSON Format.

{
    "DETAILID": 99999,
    "ORGID": 99991,
    "TYPE": "Street Address",
    "PHONE": "0401 010 101",
    "FAX": null,
    "EMAILADDRESS": "admin@test.com.au",
    "WEBSITE": "www.test.com.au",
    "ADDRESS1": "1 Testing Ave",
    "ADDRESS2": null,
    "CITY": "Testerville",
    "STATE": "QLD",
    "POSTCODE": "4000",
    "COUNTRY": "Australia"
}
print   print

resource /organisation/:orgID/detail/

Description

Create (POST) an Organisation Detail record.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/organisation/:orgID/detail/

Pattern: /organisation/:orgID/detail/
Handler: api.organisation
Action: {POST={createDetail}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/organisation/:orgID/detail/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET,PUT
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
type string true The Detail type: 'Street Address' or 'Postal Address'.
phone string false The organisation phone number
fax string false The organisation fax number
emailAddress string false The organisation email address
address1 string true The organisation address (line 1)
address2 string false The organisation address (line 2)
city string false The organisation city / suburb
state string false The organisation state
postCode string false The organisation post code
country string false The organisation country
Response Default Response Format: json

Samples

Organisation details (GET) OR a confirmation message that the update was successful in JSON Format.

{
    "DETAILID": 99999,
    "ORGID": 99991,
    "TYPE": "Street Address",
    "PHONE": "0401 010 101",
    "FAX": null,
    "EMAILADDRESS": "admin@test.com.au",
    "WEBSITE": "www.test.com.au",
    "ADDRESS1": "1 Testing Ave",
    "ADDRESS2": null,
    "CITY": "Testerville",
    "STATE": "QLD",
    "POSTCODE": "4000",
    "COUNTRY": "Australia"
}
print   print

resource /organisation/:orgID/children/

Description

Get (GET) Child Organisations.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/organisation/:orgID/children/

Pattern: /organisation/:orgID/children/
Handler: api.organisation
Action: {GET={getChildren}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/organisation/:orgID/children/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
orgID numeric true The (parent) organisation ID
Response Default Response Format: json

Samples

Organisations that are 'under' the organisation (ID) passed.

{
    "HIERACHYDEPTH": 1,
    "NWDF_ORGSIZEBRACKET": null,
    "HIERACHYPATH": "/351300/",
    "BOOKING_DISCOUNT": 0,
    "ORGNAMEACCOUNTING": null,
    "PURCHASEORDERREQUIRED": 0,
    "SCHOOLTYPEID": "91",
    "BOOKING_NOTES": null,
    "LEGALNAME": "Nathan Robert Gordon Digital Solutions",
    "FINANCESYSTEMCARDID": null,
    "HIERACHYROOT": 351300,
    "NAME": "NRG Digital Solutions",
    "ORGID": 351300,
    "HTMLBADGE": null,
    "ABN": null,
    "ANZSIC": null,
    "ORGANISATIONNOTES": null,
    "DETAILS": [],
    "CHILDREN": [
        {
            "ORGID": 33534,
            "NAME": "NRG Online Pty Ltd",
            "LEGALNAME": null,
            "ANZSIC": null,
            "ORGANISATIONNOTES": null,
            "HIERACHYROOT": 351300,
            "HIERACHYPATH": "/351300/33534/",
            "HIERACHYDEPTH": 2,
            "BOOKING_NOTES": null,
            "SCHOOLTYPEID": null,
            "BOOKING_DISCOUNT": 0,
            "FINANCESYSTEMCARDID": null,
            "ORGNAMEACCOUNTING": null,
            "ABN": null,
            "PURCHASEORDERREQUIRED": 0,
            "NWDF_ORGSIZEBRACKET": null,
            "HTMLBADGE": null,
            "HASCHILDREN": false,
            "PARENTORGID": 351300,
            "PAYERCONTACTID": 0,
            "EMPLOYERCONTACTID": null
        },
        {
            "ORGID": 351301,
            "NAME": "NRG Automotive Solutions",
            "LEGALNAME": "Nathan Robert Gordon Automotive",
            "ANZSIC": null,
            "ORGANISATIONNOTES": null,
            "HIERACHYROOT": 351300,
            "HIERACHYPATH": "/351300/351301/",
            "HIERACHYDEPTH": 2,
            "BOOKING_NOTES": null,
            "SCHOOLTYPEID": null,
            "BOOKING_DISCOUNT": 0,
            "FINANCESYSTEMCARDID": null,
            "ORGNAMEACCOUNTING": null,
            "ABN": null,
            "PURCHASEORDERREQUIRED": 0,
            "NWDF_ORGSIZEBRACKET": null,
            "HTMLBADGE": null,
            "HASCHILDREN": false,
            "PARENTORGID": 351300,
            "PAYERCONTACTID": 0,
            "EMPLOYERCONTACTID": null
        }
    ],
    "PARENTORGID": null,
    "PAYERCONTACTID": 0,
    "EMPLOYERCONTACTID": null
}
print   print

resource /payment/

Description

Processes a credit card payment for an online booking. Currently we offer this service through eWay or SqID. A client will have to register an account with their provider and fill in their merchant details in aXcelerate. Only the Production environment will process a real credit card transaction. This API method supports both multiple and single course bookings. It does not yet support other types of payments (eg shopping cart items).

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/payment/

Pattern: /payment/
Handler: api.payment
Action: {POST={processPayment}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/payment/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
paymentAmount numeric true Payment amount in dollars
contactID numeric false The subject of the payment; the ID of the Contact that will be booking onto the course. This can be a single ID, or a list of IDs. If passing a list, be sure to then use the course/enrolMultiple function to finalise the enrolment. Required when using InstanceID & Type
payerID numeric false The ID of the Contact that is paying for the course. If omitted, it will be assumed that the student (contactID) is paying. Note that if you are doing a multiple booking (where you are passing a list of contactIDs) OR you are paying for an invoice, the payerID parameter is required.
invoiceID numeric false The ID of the Invoice you are paying for. Required if not passing InstanceID and Type.
instanceID numeric false The ID of the Activity Instance you are paying for. Required if not passing InvoiceID.
type string false The type of the activity. w = workshop, p = accredited program, el = e-learning. . Required if not passing InvoiceID.
nameOnCard string true Name on credit card
cardNumber numeric true A valid credit card number. Numbers only.
cardCCV numeric true The 3 or 4 digit security code found on the back of the credit card
expiryMonth numeric true Card expiry month, from 1-12
expiryYear string true Card expiry year, 2 or 4 digits
customerIP string false Pass through the IP Address of the customer making the payment to be recorded with the gateway. This is for fraud detection and is currently only used in the SqID payment gateway. If not included, this value will default to the IP address of the system making the API call, which for example, could be your Web Server IP address.
PONumber string false An optional Purchase Order Number to attach to the invoice.
finaliseInvoice boolean false true Whether to finalise the invoice or not.
totalAmount numeric true Total of the invoice in dollars. This differs from the required paymentAmount field as this represents the total debit, whereas the payment amount is the amount to charge against the credit card. For example, an invoice could be raised for $5000 but only an initial $100 deposit is taken at the time of booking using this endpoint (paymentAmound=100, totalAmount=5000).
addSurcharge numeric false If passed, this amount will be added to the final payment as a credit card surchage. Also, the invoice will have an additional surchage line item appended - so ensure if you are passing invoiceID, the invoice does not yet have the line items locked. If you want to add a $1.50 surcharge to the above example, the contact would end up with an invoice for $5001.50 and an initial payment of $101.50 (paymentAmound=100, totalAmount=5000, addSurcharge=1.50).
Response Default Response Format: json

Samples

Payment status returned in JSON format

{
    "MESSAGE": "Thank you. The payment has been received successfully.",
    "AMOUNT": 100,
    "INVOICENO": "INV000032",
    "STATUS": true,
    "INVOICEID": 7192
}
print   print

resource /portfolio/types

Description

Returns a list of Contact Portfolio document types as defined in the system. These types are used when accessing /api/contact/portfolio. Currently the entire list is returned for a client. No filters are supported.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/portfolio/types

Pattern: /portfolio/types
Handler: api.portfolio
Action: {GET={types}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/portfolio/types
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json

Samples

[
    {
        "PORTFOLIOTYPE": "Licence",
        "PORTFOLIOTYPENAME": "Driver Licence",
        "PORTFOLIOTYPEID": 6783
    },
    {
        "PORTFOLIOTYPE": "Licence",
        "PORTFOLIOTYPENAME": "Some other licence",
        "PORTFOLIOTYPEID": 1339
    },
    {
        "PORTFOLIOTYPE": "Membership",
        "PORTFOLIOTYPENAME": "XYZ Corporate Membership",
        "PORTFOLIOTYPEID": 74
    },
    {
        "PORTFOLIOTYPE": "Other",
        "PORTFOLIOTYPENAME": "Academic Records",
        "PORTFOLIOTYPEID": 3176
    },
    {
        "PORTFOLIOTYPE": "Other",
        "PORTFOLIOTYPENAME": "Cover Letter",
        "PORTFOLIOTYPEID": 2059
    },
    {
        "PORTFOLIOTYPE": "Other",
        "PORTFOLIOTYPENAME": "Resume",
        "PORTFOLIOTYPEID": 2058
    },
    {
        "PORTFOLIOTYPE": "Qualification",
        "PORTFOLIOTYPENAME": "Qualification Certificate",
        "PORTFOLIOTYPEID": 5897
    },
    {
        "PORTFOLIOTYPE": "Registration",
        "PORTFOLIOTYPENAME": "Example Reg Type",
        "PORTFOLIOTYPEID": 190
    }
]
print   print

resource /portfolio/checklist

Description

Returns a single Contact Portfolio Checklist, along with the array of Portfolio document types that make up the checklist. These checklists can be used when searching for a contact's documents using GET /api/contact/portfolio.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/portfolio/checklist

Pattern: /portfolio/checklist
Handler: api.portfolio
Action: {GET={checklist}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/portfolio/checklist
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
portfolioChecklistID numeric true The ID of the Contact Portfolio Checklist to read. One of this or isCRICOS is required
isCRICOS boolean false If passed, will return the defined CRICOS checklist. This feature must be enabled and the checklist must defined in the client's System Settings or an error will be thrown.
Response Default Response Format: json

Samples

This is an example checklist with 2 item types. It is set as the CRICOS checklist so was retrieved using isCRICOS=1. In this example, this same response would be returned if using portfolioChecklistID=37

{
    "PORTFOLIOCHECKLISTID": 37,
    "POINTSREQUIRED": 0,
    "TYPES": [
        {
            "PORTFOLIOTYPE": "Licence",
            "POINTS": 0,
            "PORTFOLIOTYPENAME": "Driver Licence",
            "PORTFOLIOTYPEID": 6783
        },
        {
            "PORTFOLIOTYPE": "Membership",
            "POINTS": 0,
            "PORTFOLIOTYPENAME": "XYZ Corporate Membership",
            "PORTFOLIOTYPEID": 74
        }
    ],
    "NAME": "Our pretend CRICOS Checklist"
},
print   print

resource /portfolio/checklists

Description

Returns a list of Contact Portfolio Checklists, along with the array of Portfolio document types that make up the checklist. These checklists can be used when searching for a contact's documents using GET /api/contact/portfolio.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/portfolio/checklists

Pattern: /portfolio/checklists
Handler: api.portfolio
Action: {GET={checklists}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/portfolio/checklists
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
portfolioChecklistID numeric false A Contact Portfolio Checklist ID. Although this is supported, more likely you will use /api/portfolio/checklist if you want to return a single checklist.
Response Default Response Format: json

Samples

This example returns all checklists defined in the account. In this case, there are 2.

[
    {
        "PORTFOLIOCHECKLISTID": 37,
        "POINTSREQUIRED": 0,
        "TYPES": [
            {
                "PORTFOLIOTYPE": "Licence",
                "POINTS": 0,
                "PORTFOLIOTYPENAME": "Driver Licence",
                "PORTFOLIOTYPEID": 6783
            },
            {
                "PORTFOLIOTYPE": "Membership",
                "POINTS": 0,
                "PORTFOLIOTYPENAME": "XYZ Corporate Membership",
                "PORTFOLIOTYPEID": 74
            }
        ],
        "NAME": "Our pretend CRICOS Checklist"
    },
    {
        "PORTFOLIOCHECKLISTID": 95,
        "POINTSREQUIRED": 20,
        "TYPES": [
            {
                "PORTFOLIOTYPE": "Licence",
                "POINTS": 15,
                "PORTFOLIOTYPENAME": "Some other licence",
                "PORTFOLIOTYPEID": 1339
            },
            {
                "PORTFOLIOTYPE": "Membership",
                "POINTS": 10,
                "PORTFOLIOTYPENAME": "XYZ Corporate Membership",
                "PORTFOLIOTYPEID": 74
            },
            {
                "PORTFOLIOTYPE": "Other",
                "POINTS": 10,
                "PORTFOLIOTYPENAME": "Academic Records",
                "PORTFOLIOTYPEID": 3176
            },
            {
                "PORTFOLIOTYPE": "Other",
                "POINTS": 10,
                "PORTFOLIOTYPENAME": "Cover Letter",
                "PORTFOLIOTYPEID": 2059
            },
        ],
        "NAME": "Random checklist"
    }
]
print   print

resource /savedReport/:reportID [DEPRECATED]

Description

DEPRECATED: Please use POST: /report/saved/run

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/savedReport/:reportID [DEPRECATED]

Pattern: /savedReport/:reportID [DEPRECATED]
Handler: api.report
Action: {GET={runReport}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/savedReport/:reportID [DEPRECATED]
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
filterOverride json false Override the standard filter value(s):
i.e: To override the Enrolment Status Value you can pass:
[{NAME:'enrolments.enrolstatus', VALUE:'canc', VALUE2:''}]
NOTE: You cannot test/use this in the API Simulator
Response Default Response Format: json

Samples

An example report returned in JSON format

{
    "DATA": [
        {
            "Qualification Name": "Certificate I in Business",
            "Organisation": "VM Learning / aXcelerate",
            "Class Descriptor": "# W OUT DATES",
            "Trainer Full Name": "",
            "Actual Completion Date": "",
            "Full Name": "Nathan Gordon",
            "Commencement Date": "2015-07-17",
            "USI": "",
            "Qualification Code": "BSB10112",
            "Enrolment Date": "2015-07-17",
            "Expected Completion Date": "2015-07-17"
        }
    ],
    "ERRORMSG": "",
    "REPORTNAME": "Qualification Enrolments and Outcomes",
    "PATH": "",
    "SUCCESS": true,
    "COUNT": 1,
    "CONTENTTYPE": "application/json",
    "FILTERS": [
        {
            "VALUE2": "",
            "NAME": "enrolments.enrolstatus",
            "VALUE": "comp"
        },
        {
            "VALUE2": "",
            "NAME": "enrolments.dateenrolled",
            "VALUE": "01/01/2015"
        },
        {
            "VALUE2": "",
            "NAME": "contacts.givenname",
            "VALUE": "Nathan"
        },
        {
            "VALUE2": "",
            "NAME": "contacts.surname",
            "VALUE": "Gordon"
        }
    ],
    "DESCRIPTION": "JSON/Collection"
}
print   print

resource /report/run

Description

Interacts with the aXcelerate Report Builder. You can run any Report, provide selected view fields and filters and it will return the results in JSON format.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/report/run

Pattern: /report/run
Handler: api.report
Action: {POST={runReport}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/report/run
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
reportReference string true The reference for the desired report. This can be found by either querying the api/report/list API, or as the ref parameter in the URL when running the report in aXcelerate. For example, for the Contact Details report is the value is: contactsSimple
selectedViewFields list false Each report has default view fields A comma-separated list of field names to include in the report. The list of available fields can be found for a report by querying the api/report/fields API. An example value could be: vmcontacts.surname, vmcontacts.givenName
selectedFilterFields json true A JSON representation of an array of filter structs to pass to the report. The structs must have the keys: name, value, and operator. For a list of available filters for a report, query the API api/report/fields. For a more comprehensive list of the values and operators available for a field, query the API api/report/field and pass the field name as 'fieldReference'. The string is not case sensitive. An example value for the contactsSimple report, to return all contacts with the surname 'Jones' would be: [{name:'vmcontacts.surname', value:'Jones', operator:'IS'}]
reportID numeric false If passed, this endpoint acts the same as api/report/saved/run.
Response Default Response Format: json

Samples

An example report returned in JSON format

{
    "DATA": [
        {
            "Qualification Name": "Certificate I in Business",
            "Organisation": "VM Learning / aXcelerate",
            "Class Descriptor": "# W OUT DATES",
            "Trainer Full Name": "",
            "Actual Completion Date": "",
            "Full Name": "Nathan Gordon",
            "Commencement Date": "2015-07-17",
            "USI": "",
            "Qualification Code": "BSB10112",
            "Enrolment Date": "2015-07-17",
            "Expected Completion Date": "2015-07-17"
        }
    ],
    "ERRORMSG": "",
    "REPORTNAME": "Qualification Enrolments and Outcomes",
    "PATH": "",
    "SUCCESS": true,
    "COUNT": 1,
    "CONTENTTYPE": "application/json",
    "FILTERS": [
        {
            "VALUE2": "",
            "NAME": "enrolments.enrolstatus",
            "VALUE": "comp"
        },
        {
            "VALUE2": "",
            "NAME": "enrolments.dateenrolled",
            "VALUE": "01/01/2015"
        },
        {
            "VALUE2": "",
            "NAME": "contacts.givenname",
            "VALUE": "Nathan"
        },
        {
            "VALUE2": "",
            "NAME": "contacts.surname",
            "VALUE": "Gordon"
        }
    ],
    "DESCRIPTION": "JSON/Collection"
}
print   print

resource /report/list

Description

Returns an array of available reports, their names and descriptions. The values returned in the warehoused_ReportReference and live_ReportReference are the reference values required in the other report APIs (e.g. api/report/run, api/report/fields)

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/report/list

Pattern: /report/list
Handler: api.report
Action: {GET={list}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/report/list
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json

Samples

An example report returned in JSON format.

[
    {
        "NAME": "Classes",
        "WAREHOUSED_REPORTREFERENCE": "classDetails_withAggregates",
        "LIVE_REPORTREFERENCE": "classDetails",
        "DESCRIPTION": "This report will display data relating to Classes.",
        "GROUP": "Accredited Training"
    },
    {
        "NAME": "Class Enrolments",
        "WAREHOUSED_REPORTREFERENCE": "classEnrolmentDetailsCached",
        "LIVE_REPORTREFERENCE": "classEnrolmentDetails",
        "DESCRIPTION": "This report will display data relating to ....",
        "GROUP": "Accredited Training"
    }
]
print   print

resource /report/fields

Description

Returns details on the view fields and filters available for a given report. The names and operators can be using when running the report (api/report/run).

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/report/fields

Pattern: /report/fields
Handler: api.report
Action: {GET={fields}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/report/fields
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
reportReference string true The reference for the desired report. This can be found by either querying the api/report/list API, or as the ref parameter in the URL when running the report in aXcelerate. For example, for the Contact Details report is the value is: contactsSimple
Response Default Response Format: json

Samples

An example for the fields available for the contactsSimple report. This example displays only a small subset of the full list of fields.

{
    "VIEWFIELDS": [
        {
            "DISPLAY": "Contact ID",
            "NAME": "vmcontacts.contactid",
            "GROUP": "Contact"
        },
        {
            "DISPLAY": "Optional ID",
            "NAME": "vmcontacts.optionalid",
            "GROUP": "Contact"
        },
        {
            "DISPLAY": "Title",
            "NAME": "vmcontacts.title",
            "GROUP": "Contact"
        },
        {
            "DISPLAY": "Given Name",
            "NAME": "vmcontacts.givenname",
            "GROUP": "Contact"
        },
        {
            "DISPLAY": "Gender",
            "NAME": "participantdetails.gender",
            "GROUP": "Contact"
        },
    ],
    "FILTERFIELDS": [
        {
            "DISPLAY": "Contact ID Filter",
            "NAME": "vmcontacts.contactid",
            "GROUP": "Contact"
        },
        {
            "DISPLAY": "Given Name",
            "NAME": "vmcontacts.givenname",
            "GROUP": "Contact"
        },
        {
            "DISPLAY": "Gender",
            "NAME": "participantdetails.gender",
            "GROUP": "Contact"
        }
    ],
}
print   print

resource /report/field

Description

More detailed information for a given report field. This will include the list of possible operators and values for fields, if applicable. Note that fields are general and can be used by more than one report, however, not all fields that are filters are available as filters for all reports. Check api/report/fields for the filters and fields available for a given report

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/report/field

Pattern: /report/field
Handler: api.report
Action: {GET={field}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/report/field
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
fieldReference string true The reference for the desired field. This can be found by querying api/report/fields and is the NAME parameter.
Response Default Response Format: json

Samples

This is an example when querying the api with fieldReference = participantdetails.gender. Note that these field names are internal references for aXcelerate, and so there may be aliases for the same field. This example is also called contacts.gender, however, you must use the name required by the individual report.

{
    "OPERATOROPTIONS": [
        {
            "REQUIRESVALUE2": false,
            "DISPLAY": "Equals",
            "OPTGROUP": "",
            "VALUE": "IS"
        }
    ],
    "VALUEOPTIONS": [
        {
            "REQUIRESVALUE2": false,
            "DISPLAY": "Male",
            "OPTGROUP": "",
            "VALUE": "M"
        },
        {
            "REQUIRESVALUE2": false,
            "DISPLAY": "Female",
            "OPTGROUP": "",
            "VALUE": "F"
        },
        {
            "REQUIRESVALUE2": false,
            "DISPLAY": "Other",
            "OPTGROUP": "",
            "VALUE": "X"
        }
    ],
    "DISPLAY": "Gender",
    "NAME": "participantdetails.gender"
}
print   print

resource /report/saved

Description

Returns details on the view fields and filters set for a given saved report. Note that this does not run the report. It returns the definition of the report. To run it, use api/report/saved/run

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/report/saved

Pattern: /report/saved
Handler: api.report
Action: {GET={getSavedReport}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/report/saved
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
reportID numeric true The reportID of the saved report.
Response Default Response Format: json

Samples

An example of fields and filters that might be set for a saved Enrolment Warehoused report.

{
    "VIEWFIELDS": [
        {
            "DISPLAY": "Qualification Code",
            "NAME": "classes.diplomacode"
        },
        {
            "DISPLAY": "Class Descriptor",
            "NAME": "classes.classdescriptor"
        },
        {
            "DISPLAY": "USI",
            "NAME": "contactsaggregates.usi"
        },
        {
            "DISPLAY": "Full Name",
            "NAME": "contactsaggregates.fullname"
        },
        {
            "DISPLAY": "Enrolment Date",
            "NAME": "enrolments.dateenrolled"
        },
        {
            "DISPLAY": "Commencement Date",
            "NAME": "enrolments.datecommenced"
        },
        {
            "DISPLAY": "Expected Completion Date",
            "NAME": "enrolments.datecompletionexpected"
        },
        {
            "DISPLAY": "Competent %",
            "NAME": "enrolmentaggregates.competencyachievedpercent"
        },
        {
            "DISPLAY": "Enrolment Status",
            "NAME": "enrolments.enrolstatusdescriptor"
        },
        {
            "DISPLAY": "Skype Username",
            "NAME": "contact_custom.skypeuname"
        }
    ],
    "REPORTNAME": "Progress of last year's business students",
    "CREATEDBYCONTACTID": 2630274,
    "CREATEDBY": "Shary Bobbins",
    "REPORTID": 4479,
    "FILTERFIELDS": [
        {
            "VALUE2": "",
            "OPERATOR": "IN",
            "DISPLAY": "Qualification",
            "NAME": "classes.diplomaid",
            "VALUE": "11238,15584"
        },
        {
            "VALUE2": "31/12/2015",
            "OPERATOR": "LAST Year",
            "DISPLAY": "Enrolment Date",
            "NAME": "enrolments.dateenrolled",
            "VALUE": "01/01/2015"
        }
    ],
    "REPORTREFERENCE": "classEnrolmentDetailsCached",
    "ACTIVE": true,
    "REPORTVERSION": "1.2",
    "DESCRIPTION": "Returns the current progress of last year's business students"
}
print   print

resource /report/saved/run

Description

Interacts with the aXcelerate Report Builder to run a specified saved report. It will return the results in JSON format.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/report/saved/run

Pattern: /report/saved/run
Handler: api.report
Action: {POST={runReport}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/report/saved/run
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
reportID numeric true ReportID of the saved report to run.
filterOverride json false Override the standard filter value(s):
e.g: To override the Enrolment Status Value you can pass:
[{NAME:'enrolments.enrolstatus', VALUE:'canc', VALUE2:''}]
NOTE: You cannot test/use this in our API relax console simulator
Response Default Response Format: json

Samples

An example report returned in JSON format

{
    "DATA": [
        {
            "Qualification Name": "Certificate I in Business",
            "Organisation": "VM Learning / aXcelerate",
            "Class Descriptor": "# W OUT DATES",
            "Trainer Full Name": "",
            "Actual Completion Date": "",
            "Full Name": "Nathan Gordon",
            "Commencement Date": "2015-07-17",
            "USI": "",
            "Qualification Code": "BSB10112",
            "Enrolment Date": "2015-07-17",
            "Expected Completion Date": "2015-07-17"
        }
    ],
    "ERRORMSG": "",
    "REPORTNAME": "Qualification Enrolments and Outcomes",
    "PATH": "",
    "SUCCESS": true,
    "COUNT": 1,
    "CONTENTTYPE": "application/json",
    "FILTERS": [
        {
            "VALUE2": "",
            "NAME": "enrolments.enrolstatus",
            "VALUE": "comp"
        },
        {
            "VALUE2": "",
            "NAME": "enrolments.dateenrolled",
            "VALUE": "01/01/2015"
        },
        {
            "VALUE2": "",
            "NAME": "contacts.givenname",
            "VALUE": "Nathan"
        },
        {
            "VALUE2": "",
            "NAME": "contacts.surname",
            "VALUE": "Gordon"
        }
    ],
    "DESCRIPTION": "JSON/Collection"
}
print   print

resource /report/saved/list

Description

Returns an array of available reports, their names and descriptions.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/report/saved/list

Pattern: /report/saved/list
Handler: api.report
Action: {GET={listSavedReports}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/report/saved/list
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json

Samples

An example report returned in JSON format.

[
    {
        "REPORTNAME": "Progress of last year's business students",
        "CREATEDBYCONTACTID": 2630274,
        "CREATEDBY": "Shary Bobbins",
        "REPORTID": 4479,
        "REPORTREFERENCE": "classEnrolmentDetailsCached",
        "ACTIVE": true,
        "REPORTVERSION": "1.2",
        "DESCRIPTION": "Returns the current progress of last year's business students"
    },
    {
        "REPORTNAME": "Class Details for Frank",
        "CREATEDBYCONTACTID": 2630274,
        "CREATEDBY": "Shary Bobbins",
        "REPORTID": 1840,
        "REPORTREFERENCE": "classDetails_withAggregates",
        "ACTIVE": true,
        "REPORTVERSION": "1.0",
        "DESCRIPTION": "My class details"
    },
    {
        "REPORTNAME": "Class Enrolments with outstanding debts",
        "CREATEDBYCONTACTID": 2630274,
        "CREATEDBY": "Shary Bobbins",
        "REPORTID": 3445,
        "REPORTREFERENCE": "classEnrolmentDetailsCached",
        "ACTIVE": true,
        "REPORTVERSION": "1.2",
        "DESCRIPTION": "Students that owe more than $1000"
    },
    {
        "REPORTNAME": "Contact Portfolio - with custom fields - All staff to use",
        "CREATEDBYCONTACTID": 4745,
        "CREATEDBY": "Kym Boss",
        "REPORTID": 4445,
        "REPORTREFERENCE": "portfolioCached",
        "ACTIVE": true,
        "REPORTVERSION": "1.0",
        "DESCRIPTION": "Run this report before calling students"
    },
    {
        "REPORTNAME": "End of Month - for Workflow",
        "CREATEDBYCONTACTID": 2630274,
        "CREATEDBY": "Shary Bobbins",
        "REPORTID": 557,
        "REPORTREFERENCE": "classEnrolmentDetailsCached",
        "ACTIVE": true,
        "REPORTVERSION": "1.1",
        "DESCRIPTION": ""
    }
]
print   print

resource /resource/:documentID

Description

Interacts with a specfic Resource Library Document. You can download (GET) a document with this endpoint.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/resource/:documentID

Pattern: /resource/:documentID
Handler: api.resource
Action: {GET={get}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/resource/:documentID
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json

Samples

Document returned in JSON format

{
    "MESSAGE": null,
    "FILENAME": "aXcelerateLogo.v1.0.png",
    "CONTYPE": "image/png",
    "STATUS": "success",
    "DOCUMENT": "iVBORw0KGgoAAAANSUhEUgAAASwAAAAwCAYAAACrHkchAAAACXBIWXMAAAsTAAALEwEAmpwYAAAKT2lDQ1BQaG90b3Nob3AgSUNDIHByb2ZpbGUAAHjanVNnVFPpFj333vRCS4iAlEtvUhUIIFJCi4AUkSYqIQkQSoghodkVUcERRUUEG8igiAOOjoCMFVEsDIoK2AfkIaKOg6OIisr74Xuja9a89+bN/rXXPues852zzwfACAyWSDNRNYAMqUIeEeCDx8TG4eQuQIEKJHAAEAizZCFz/SMBAPh+PDwrIsAHvgABeNMLCADATZvAMByH/w/qQplcAYCEAcB0kThLCIAUAEB6jkKmAEBGAYCdmCZTAKAEAGDLY2LjAFAtAGAnf+bTAICd+Jl7AQBblCEVAaCRACATZYhEAGg7AKzPVopFAFgwABRmS8Q5ANgtADBJV2ZIALC3AMDOEAuyAAgMADBRiIUpAAR7AGDIIyN4AISZABRG8lc88SuuEOcqAAB4mbI8uSQ5RYFbCC1xB1dXLh4ozkkXKxQ2YQJhmkAuwnmZGTKBNA/g88wAAKCRFRHgg/P9eM4Ors7ONo62Dl8t6r8G/yJiYuP+5c+rcEAAAOF0ftH+LC+zGoA7BoBt/qIl7gRoXgugdfeLZrIPQLUAoOnaV/Nw+H48PEWhkLnZ2eXk5NhKxEJbYcpXff5nwl/AV/1s+X48/Pf14L7iJIEyXYFHBPjgwsz0TKUcz5IJhGLc5o9H/LcL//wd0yLESWK5WCoU41EScY5EmozzMqUiiUKSKcUl0v9k4t8s+wM+3zUAsGo+AXuRLahdYwP2SycQWHTA4vcAAPK7b8HUKAgDgGiD4c93/+8//UegJQCAZkmScQAAXkQkLlTKsz/HCAAARKCBKrBBG/TBGCzABhzBBdzBC/xgNoRCJMTCQhBCCmSAHHJgKayCQiiGzbAdKmAv1EAdNMBRaIaTcA4uwlW4Dj1wD/phCJ7BKLyBCQRByAgTYSHaiAFiilgjjggXmYX4IcFIBBKLJCDJiBRRIkuRNUgxUopUIFVIHfI9cgI5h1xGupE7yAAygvyGvEcxlIGyUT3UDLVDuag3GoRGogvQZHQxmo8WoJvQcrQaPYw2oefQq2gP2o8+Q8cwwOgYBzPEbDAuxsNCsTgsCZNjy7EirAyrxhqwVqwDu4n1Y8+xdwQSgUXACTYEd0IgYR5BSFhMWE7YSKggHCQ0EdoJNwkDhFHCJyKTqEu0JroR+cQYYjIxh1hILCPWEo8TLxB7iEPENyQSiUMyJ7mQAkmxpFTSEtJG0m5SI+ksqZs0SBojk8naZGuyBzmULCAryIXkneTD5DPkG+Qh8lsKnWJAcaT4U+IoUspqShnlEOU05QZlmDJBVaOaUt2ooVQRNY9aQq2htlKvUYeoEzR1mjnNgxZJS6WtopXTGmgXaPdpr+h0uhHdlR5Ol9BX0svpR+iX6AP0dwwNhhWDx4hnKBmbGAcYZxl3GK+YTKYZ04sZx1QwNzHrmOeZD5lvVVgqtip8FZHKCpVKlSaVGyovVKmqpqreqgtV81XLVI+pXlN9rkZVM1PjqQnUlqtVqp1Q61MbU2epO6iHqmeob1Q/pH5Z/YkGWcNMw09DpFGgsV/jvMYgC2MZs3gsIWsNq4Z1gTXEJrHN2Xx2KruY/R27iz2qqaE5QzNKM1ezUvOUZj8H45hx+Jx0TgnnKKeX836K3hTvKeIpG6Y0TLkxZVxrqpaXllirSKtRq0frvTau7aedpr1Fu1n7gQ5Bx0onXCdHZ4/OBZ3nU9lT3acKpxZNPTr1ri6qa6UbobtEd79up+6Ynr5egJ5Mb6feeb3n+hx9L/1U/W36p/VHDFgGswwkBtsMzhg8xTVxbzwdL8fb8VFDXcNAQ6VhlWGX4YSRudE8o9VGjUYPjGnGXOMk423GbcajJgYmISZLTepN7ppSTbmmKaY7TDtMx83MzaLN1pk1mz0x1zLnm+eb15vft2BaeFostqi2uGVJsuRaplnutrxuhVo5WaVYVVpds0atna0l1rutu6cRp7lOk06rntZnw7Dxtsm2qbcZsOXYBtuutm22fWFnYhdnt8Wuw+6TvZN9un2N/T0HDYfZDqsdWh1+c7RyFDpWOt6azpzuP33F9JbpL2dYzxDP2DPjthPLKcRpnVOb00dnF2e5c4PziIuJS4LLLpc+Lpsbxt3IveRKdPVxXeF60vWdm7Obwu2o26/uNu5p7ofcn8w0nymeWTNz0MPIQ+BR5dE/C5+VMGvfrH5PQ0+BZ7XnIy9jL5FXrdewt6V3qvdh7xc+9j5yn+M+4zw33jLeWV/MN8C3yLfLT8Nvnl+F30N/I/9k/3r/0QCngCUBZwOJgUGBWwL7+Hp8Ib+OPzrbZfay2e1BjKC5QRVBj4KtguXBrSFoyOyQrSH355jOkc5pDoVQfujW0Adh5mGLw34MJ4WHhVeGP45wiFga0TGXNXfR3ENz30T6RJZE3ptnMU85ry1KNSo+qi5qPNo3ujS6P8YuZlnM1VidWElsSxw5LiquNm5svt/87fOH4p3iC+N7F5gvyF1weaHOwvSFpxapLhIsOpZATIhOOJTwQRAqqBaMJfITdyWOCnnCHcJnIi/RNtGI2ENcKh5O8kgqTXqS7JG8NXkkxTOlLOW5hCepkLxMDUzdmzqeFpp2IG0yPTq9MYOSkZBxQqohTZO2Z+pn5mZ2y6xlhbL+xW6Lty8elQfJa7OQrAVZLQq2QqboVFoo1yoHsmdlV2a/zYnKOZarnivN7cyzytuQN5zvn//tEsIS4ZK2pYZLVy0dWOa9rGo5sjxxedsK4xUFK4ZWBqw8uIq2Km3VT6vtV5eufr0mek1rgV7ByoLBtQFr6wtVCuWFfevc1+1dT1gvWd+1YfqGnRs+FYmKrhTbF5cVf9go3HjlG4dvyr+Z3JS0qavEuWTPZtJm6ebeLZ5bDpaql+aXDm4N2dq0Dd9WtO319kXbL5fNKNu7g7ZDuaO/PLi8ZafJzs07P1SkVPRU+lQ27tLdtWHX+G7R7ht7vPY07NXbW7z3/T7JvttVAVVN1WbVZftJ+7P3P66Jqun4lvttXa1ObXHtxwPSA/0HIw6217nU1R3SPVRSj9Yr60cOxx++/p3vdy0NNg1VjZzG4iNwRHnk6fcJ3/ceDTradox7rOEH0x92HWcdL2pCmvKaRptTmvtbYlu6T8w+0dbq3nr8R9sfD5w0PFl5SvNUyWna6YLTk2fyz4ydlZ19fi753GDborZ752PO32oPb++6EHTh0kX/i+c7vDvOXPK4dPKy2+UTV7hXmq86X23qdOo8/pPTT8e7nLuarrlca7nuer21e2b36RueN87d9L158Rb/1tWeOT3dvfN6b/fF9/XfFt1+cif9zsu72Xcn7q28T7xf9EDtQdlD3YfVP1v+3Njv3H9qwHeg89HcR/cGhYPP/pH1jw9DBY+Zj8uGDYbrnjg+OTniP3L96fynQ89kzyaeF/6i/suuFxYvfvjV69fO0ZjRoZfyl5O/bXyl/erA6xmv28bCxh6+yXgzMV70VvvtwXfcdx3vo98PT+R8IH8o/2j5sfVT0Kf7kxmTk/8EA5jz/GMzLdsAADo3aVRYdFhNTDpjb20uYWRvYmUueG1wAAAAAAA8P3hwYWNrZXQgYmVnaW49Iu+7vyIgaWQ9Ilc1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCI/Pgo8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJBZG9iZSBYTVAgQ29yZSA1LjUtYzAyMSA3OS4xNTU3NzIsIDIwMTQvMDEvMTMtMTk6NDQ6MDAgICAgICAgICI+CiAgIDxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyI+CiAgICAgIDxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiCiAgICAgICAgICAgIHhtbG5zOnhtcD0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLyIKICAgICAgICAgICAgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iCiAgICAgICAgICAgIHhtbG5zOnN0RXZ0PSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VFdmVudCMiCiAgICAgICAgICAgIHhtbG5zOmRjPSJodHRwOi8vcHVybC5vcmcvZGMvZWxlbWVudHMvMS4xLyIKICAgICAgICAgICAgeG1sbnM6cGhvdG9zaG9wPSJodHRwOi8vbnMuYWRvYmUuY29tL3Bob3Rvc2hvcC8xLjAvIgogICAgICAgICAgICB4bWxuczp0aWZmPSJodHRwOi8vbnMuYWRvYmUuY29tL3RpZmYvMS4wLyIKICAgICAgICAgICAgeG1sbnM6ZXhpZj0iaHR0cDovL25zLmFkb2JlLmNvbS9leGlmLzEuMC8iPgogICAgICAgICA8eG1wOkNyZWF0b3JUb29sPkFkb2JlIFBob3Rvc2hvcCBDQyAyMDE0IChNYWNpbnRvc2gpPC94bXA6Q3JlYXRvclRvb2w+CiAgICAgICAgIDx4bXA6Q3JlYXRlRGF0ZT4yMDE1LTA1LTA0VDE0OjIwOjA0KzEwOjAwPC94bXA6Q3JlYXRlRGF0ZT4KICAgICAgICAgPHhtcDpNZXRhZGF0YURhdGU+MjAxNS0wNS0wNFQxNDoyMDowNCsxMDowMDwveG1wOk1ldGFkYXRhRGF0ZT4KICAgICAgICAgPHhtcDpNb2RpZnlEYXRlPjIwMTUtMDUtMDRUMTQ6MjA6MDQrMTA6MDA8L3htcDpNb2RpZnlEYXRlPgogICAgICAgICA8eG1wTU06SW5zdGFuY2VJRD54bXAuaWlkOjIxYTkwNzFjLWYxNmYtNDZkMi05ZjM3LWY0MTcyNWE3OGI0NTwveG1wTU06SW5zdGFuY2VJRD4KICAgICAgICAgPHhtcE1NOkRvY3VtZW50SUQ+YWRvYmU6ZG9jaWQ6cGhvdG9zaG9wOjMzZGIzNmQwLTMyYTMtMTE3OC1iZWNlLTkyZjY0OWNmMDIxYTwveG1wTU06RG9jdW1lbnRJRD4KICAgICAgICAgPHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD54bXAuZGlkOmIyYmYzMjRiLWJkMzctNDc4Yi1hOTA2LTFmZjVlNzc4MWE4MzwveG1wTU06T3JpZ2luYWxEb2N1bWVudElEPgogICAgICAgICA8eG1wTU06SGlzdG9yeT4KICAgICAgICAgICAgPHJkZjpTZXE+CiAgICAgICAgICAgICAgIDxyZGY6bGkgcmRmOnBhcnNlVHlwZT0iUmVzb3VyY2UiPgogICAgICAgICAgICAgICAgICA8c3RFdnQ6YWN0aW9uPmNyZWF0ZWQ8L3N0RXZ0OmFjdGlvbj4KICAgICAgICAgICAgICAgICAgPHN0RXZ0Omluc3RhbmNlSUQ+eG1wLmlpZDpiMmJmMzI0Yi1iZDM3LTQ3OGItYTkwNi0xZmY1ZTc3ODFhODM8L3N0RXZ0Omluc3RhbmNlSUQ+CiAgICAgICAgICAgICAgICAgIDxzdEV2dDp3aGVuPjIwMTUtMDUtMDRUMTQ6MjA6MDQrMTA6MDA8L3N0RXZ0OndoZW4+CiAgICAgICAgICAgICAgICAgIDxzdEV2dDpzb2Z0d2FyZUFnZW50PkFkb2JlIFBob3Rvc2hvcCBDQyAyMDE0IChNYWNpbnRvc2gpPC9zdEV2dDpzb2Z0d2FyZUFnZW50PgogICAgICAgICAgICAgICA8L3JkZjpsaT4KICAgICAgICAgICAgICAgPHJkZjpsaSByZGY6cGFyc2VUeXBlPSJSZXNvdXJjZSI+CiAgICAgICAgICAgICAgICAgIDxzdEV2dDphY3Rpb24+c2F2ZWQ8L3N0RXZ0OmFjdGlvbj4KICAgICAgICAgICAgICAgICAgPHN0RXZ0Omluc3RhbmNlSUQ+eG1wLmlpZDoyMWE5MDcxYy1mMTZmLTQ2ZDItOWYzNy1mNDE3MjVhNzhiNDU8L3N0RXZ0Omluc3RhbmNlSUQ+CiAgICAgICAgICAgICAgICAgIDxzdEV2dDp3aGVuPjIwMTUtMDUtMDRUMTQ6MjA6MDQrMTA6MDA8L3N0RXZ0OndoZW4+CiAgICAgICAgICAgICAgICAgIDxzdEV2dDpzb2Z0d2FyZUFnZW50PkFkb2JlIFBob3Rvc2hvcCBDQyAyMDE0IChNYWNpbnRvc2gpPC9zdEV2dDpzb2Z0d2FyZUFnZW50PgogICAgICAgICAgICAgICAgICA8c3RFdnQ6Y2hhbmdlZD4vPC9zdEV2dDpjaGFuZ2VkPgogICAgICAgICAgICAgICA8L3JkZjpsaT4KICAgICAgICAgICAgPC9yZGY6U2VxPgogICAgICAgICA8L3htcE1NOkhpc3Rvcnk+CiAgICAgICAgIDxkYzpmb3JtYXQ+aW1hZ2UvcG5nPC9kYzpmb3JtYXQ+CiAgICAgICAgIDxwaG90b3Nob3A6Q29sb3JNb2RlPjM8L3Bob3Rvc2hvcDpDb2xvck1vZGU+CiAgICAgICAgIDxwaG90b3Nob3A6SUNDUHJvZmlsZT5zUkdCIElFQzYxOTY2LTIuMTwvcGhvdG9zaG9wOklDQ1Byb2ZpbGU+CiAgICAgICAgIDx0aWZmOk9yaWVudGF0aW9uPjE8L3RpZmY6T3JpZW50YXRpb24+CiAgICAgICAgIDx0aWZmOlhSZXNvbHV0aW9uPjcyMDAwMC8xMDAwMDwvdGlmZjpYUmVzb2x1dGlvbj4KICAgICAgICAgPHRpZmY6WVJlc29sdXRpb24+NzIwMDAwLzEwMDAwPC90aWZmOllSZXNvbHV0aW9uPgogICAgICAgICA8dGlmZjpSZXNvbHV0aW9uVW5pdD4yPC90aWZmOlJlc29sdXRpb25Vbml0PgogICAgICAgICA8ZXhpZjpDb2xvclNwYWNlPjE8L2V4aWY6Q29sb3JTcGFjZT4KICAgICAgICAgPGV4aWY6UGl4ZWxYRGltZW5zaW9uPjMwMDwvZXhpZjpQaXhlbFhEaW1lbnNpb24+CiAgICAgICAgIDxleGlmOlBpeGVsWURpbWVuc2lvbj40ODwvZXhpZjpQaXhlbFlEaW1lbnNpb24+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgIAo8P3hwYWNrZXQgZW5kPSJ3Ij8+iKn4WwAAACBjSFJNAAB6JQAAgIMAAPn/AACA6QAAdTAAAOpgAAA6mAAAF2+SX8VGAAAWlklEQVR42uydd7wURbbHv/dyCQqKOmAERR0UFFEUFBd3tNqwK+gq6LqKCX2uCdfwMIcVdzE+VwxrWgwYUIyouGa7ZAQUTKiYR0FcBMUhiwhc2D/qXB3Gru6e7p47F9/8Pp/7EbtrqiucOnXqnFPn1FBFKOQz6S2AQcADqWzus+qI/AylnOnAFkWPF2jtrlcdnSqSRF11CHyZVDPgQOBE4PfAhVVmVUUVVYbV1BhVR+B/5K+DPH4auLo6OlVUUWVYTUWa6ivSVF+gtuD1dOCYVDa3qjpSVfxKjvGjgd4er7pr7S6sMqymy6g2FUnqz0BHjyLLgMNS2dy8KplX8SvCxvxS70jRRl1lWD6Mo13B8cuGb1PZ3NcJfW9fYDBwANDMp+hZqWzujSp9V1FFlWEVohnwItDOp8xX+Ux6u1Q2tzgms+oNPA/UBBQdncrmbqmSSRVVNA00GfEvlc19A5wSUKwjcGVMZtUKGBmCWX0ix8QqqqiiyrA8mdajwAMBxQbnM+k+MT7zV2DbgDJLgEPiSnJVVFHFr5hhCU4D/PRUNcCdIimVKl31BM4NUfTkVDb3QZU8qqiiyrCCpKx5wAkBxbYFLimRWTUH7sRfwQ4wIpXN3VcljSqqaHooWemulLMWsJ78rQQWAwu1dhclyLSezWfSI/DXIZ2bz6QfSWVzU0JWexHQPaDMO8DpSfRBKWcdoDOwCdAc4x4xD5gDTNParW+sSVbKWRdoA9QD87V2f1wTiVUpp4X0ow3m6s+CJtKutYENgDlxxlYpp6Zgba0LLAAWyfpavqYzG6Wc1jJ3zYQOl5RaR02Ij7QFBgC/A3YB0pai3wEfAG8BTwHj4yzKfCbdBngf6ORT7G1gt1Q2tyKgrm5StrlPsQXALqls7vMYE9IBOA44CNjZZ3yXAK8BjwEPau3OT5gwegMHAxlgeyH+QsyQeXoGeEJr97uY35tOGe4SKuVsAPwR2Fdob/OiU8ESoZFxwBit3ddjfi8N7OHx6lGt3cVFZXsAZ2CcjNsXvNpRa/e9Er7ZU/q4O9BDFnQxVgCfyvp6GXhKa3dWCd/YHHCKHp+Pty53sIxrIaZo7U6JMJ7bAIcBe4qwsGFRkTnAFIzF/nGt3WmRGZZSzlZy7DoCaBlh/r8FbgaGR5W+8pl0BnglgLGen8rmrvapow54XQjeDwNS2dyYiIS+HnC5SITNS/z598B1wJVauz/E3J37A38TJhUWS4FRwDCt3elNgWEp5XQUifg4oEUJP30Xc31qtNbuqgjfHQTc7fFqy4axEWnqRoyzsRd6BC1upZxa4BjgPKBLhCFahXEBGqa1+2qIfh0MjCE6LtPaHVrCOO6GsearEvs0Vvr0RmgdllJOrVLORcBHmOgELSN2ckPgMuBTpZx9Ix4Ns8D1QYOZz6S38Xk/JASz+kcMZrWn7HynRmBWAK1lY3hbdqQobdgEc9fxsRKZFUArWXwfKeVcqpTTjApCKedEob2TSmRWADtirMwTlXK6lKFtbQHXh1mFqaML8KYwxqhtrAH2A7JKOfcKE20SR2OlnJtFQFAR+vQHYJJSzl2iUvFnWLJL3wsMi0AsNmwMPKOUc0jE31+I8YmyoSVwRz6TrvGQrroI0/TDBOCCiBM0UHa6TRMYpy7ABKWcziW2oYcsgL4xv98KGAq8LAuzsYm9mVLOv4DbhYnHQW/gTaWcPyasf3kB2C1GHT2BSXL0SwpHAy+KbrmSzGoTICsbdxzUiGT9tlLOtkES1pnAkQEVzi3QG4yTfwf5K9UB9yrlbBFByloKHIVRGNvwW4qcTvOZdC3GKugnIc4BDk9lc8sjTNBBwH0hpKr5wJdyRF4RULYd8LhSTsuQbdgBeCkkwwx73NxTdu71G5HYa4B7COeouxIIo9huDYxWyjkigSbWiOS2a0zp7HF+qU8sRD2QE6Y2TiSVL+W45IffAP9XQWbVXpj5LiGKLwtYyw1IA+OVcroWM5LCj/7d8uPloo+6U2t3qqXR22OU82cAKY8ia8vR54QITOvNfCZ9Bf6uDFflM+mnU9ncDPn/02Ui/Qj/yFQ2958IE9QVuB+7W8g04FrgSa3dmQW/ayFE/ydMVAgvKbabbBxXhyCSZzHWKS/MBm6Vo+KnDUpj0Q/1Ag6X+fI6AnYH7lbK6R9FFxQBQ302ylWif7lfFvC3Wrv1cgzaHhOn7ASMQt5rQ75bKeejKErjApwkx5U4OB/vy/UA7wFXAM946XtFutsXOBlj/PLCyUo511r0kG+L1FLcntBKdx86bC6MuJulyPciODwCfKS1m5ffpYTB9RcpsbVlA39MKWfXBvqtKfjwuZZF8h3we63dt0rYSR4D9vZ4vQhIRTHRih/VG6KnsOGZVDbXL59Jbyl6JT8x+bJUNjc0ArOqlYXTy1LkZmBIkHlbpKNngc0skl8Hrd1lPr9/VharF24ELggyG0sbHvAhtmO0du8LMSbTiah0V8pxREr0MqzkgCO1dicH1NESuFj+bAxh5yCrtY/SfakcmVejNWC00OQ3WrvzxKq5uHjepH2zAC+pdQRwqtbuipD011++67XZna+1e3XIel4RaboY65ditVbKucJHpfJv4ASt3dkhjpN3+Kg1hmvt/m/xkdC2gwwMy6wAxDdmAPCNx+t1KF0p3CBlLZej4TKfYn3zmfTRwF0BzOpFjDUtCo73YVbDtXZPC+OLo7X7PnCo5ZjYHhPp1DbBR/gwq1O1ds8I4+MibegjO7AXrhCpsFxHiRbAbRZm9SawaxCzkn78qLV7CXZleHehnTj6vQZ8CfTR2u2ntXuf1u7HWrvzpB1zLZvMby3MajxwclhmJd8Y43PS2L2Rj4LdgHMsr28DDgxiVtKnWcJ/HrIU+YtSTqefGJZSTp1FmThea/fFUjsiAcBGWV5vHnWAUtncVMxdQD/cBezl834mMDCVza2MMEF1Ikp7YZLP5NnG6XXgJsvrA33aYDu6X6G1e2uEueov0m8xOmB8hMqF4zHOtcX4GjiggRGU0Je7RGLxwpAE2jsN2F1rd2KJv7PdfR2qtbsyQjvusGx0m9O4GIa38/kzwOBS1Aki/R6Lt4GtDnNl7ycJa0vLhx+P0RmbL0Xc60DXYpwubfDz3l+BCcYX1VHyd8DWlndnRnSUvdJCfHtayh9macP7wKVROqW1OwO4xvL6qHJQuhytbcz/FK3dbyJWfZ7oTYqxgxyBo2IF8KdSHDYL4OWuMg/jYxhlvuYCn5dhbZUyf10xDtLFWAgcF4URy8nEtrEMVMqpbehgylJocow+lSXSQSqba+DEUZwsz01lcxNjfN6mGH41qpe11u4cjIWlGJ1EJ1IM27Hn0lKOFh641cI4nTKZzPfBO+Ll61q7T0WtVKSykZbXB8Ro7z/9HBqDyNbj2Vsxr2dVOpKIjQ5v1Nr9Nka9z2C8+ouxCbBTA8OaIlJW8d+kGB/eqFwjJZlrzinxZ2MIdkINkghsFpq4l6W15Xm6qA0py3F3PuY6FDEWeh7jFFmMFiTrN9QAm1/evQnU/ajlee+I9dVjbiNExSCPtRXX3WIjKosBluf3xKTDBquwF3avk0JLMYkWGqNDSeEW0b3sHaLsF8BxMZNIdMPuQvBUzL6MwFjKvHQmq0k7FrH/xYQuU4/DeFAXowcwMeH5s91+eDaBuieJtFisHtgpYn2va+1+FWMRzk5y4JRyehEcTrycx8HOwnSL8bnWbi4hOjzP4/lOdWXoTHvMPbC+5Ry0VDa3Kp9JHy/io5+j5SpMML64N/ttxJ6LoW9pIOgF+Pi6FMDmuPhOQsM6pQQdTBwaaWch+IVR7zMWjecPSjkf8EsXmM2VclrJBl0KJtIEIFL+XhjDUiVhs5K/lVD9NnreJkp4mRo5T3Yq+NtK/tsg7tY00sD1JPiuY40M8JSY3+pqef5uIxKKzV/qPwnVb9sdN064HzuUuR/IiWFHiy5kWol1fd1YEywOsZ0s66sz/p7yjQXb/M1MonKt3dlKOUswzuarzV1dwOC1lSPCzjL5aYyitEWlRyyfSbfH3DsLg+vymfRLqWxuWoxPbuazMBoLnWx6H6Wce8v43VTC9dnM79sp5ZTbsz7KPcn5ZWJOO2N8tHbC+Cd2YvVQNU0Vtvk7SynnrDJ+t12dZSB7Y0zO+zcF5mTBCPwz7BSiDXB3PpN2ovhfBUgZMxuxz5VStCatOti4gnTTqpJEq5TTBuNT9GeRnNZEVGr+auuKBnNjkVri3ptaitEtdS9Hq/OZ9LF4+4D4YU/M/cLrI37WxrgbM0vuWr+SRV7JyAIVY1hKOUcDwxOQWKcA21VQmKjUGLauLRjMHTDKrqjMagHGwvMXERnvLhOz6gjcEPHnV0nImShYx/K8/v8BoVRUKkkYzRv7g0o5NUo5N2FcNqIwq1WYu7G3YJTuOxPNDzExxlEpSb9OBrQTxgcn6Ii1DBNc7ROMq8A0+fsE+KrQFV8ppxzMqgZz89tPD/EJ9jReLYH78pn07kFhlT3wveV5Ywa8+95CLGMxYX/KhRmN1L8Z2H3SEiOjCiy0a+QYGIRZwIcY48cXGP1oDvhEa/f7IiZYSaZvs7hPwG64SVQ34acPWorxHB4NTIpgEk4Sp2L33wF4DhN69kOf/vTE3C7/e4Rjrhca02qzxMKwbtTafWkNknJsXtofa+0O+hVJcyjl7AGcHXC8ux0TWmbGGtIt2+X+J7V2yxqXq04GdB/L+zeBQ5rCQOYz6c7Y77s1SB8npbK5OflMejD2m98Af81n0mNLyLgDdtP2Zo04DLPwtiK1W8PWsc1Q0Z5fH4Zanq/E6FRvaaSYY40xf2WnwzrsVwRmAPvESKWUmGUpn0k3EynPL3b1RQ3B+1LZ3MP5THogdsV8HXB/PpPeJZXNhU3L9IXl+Q5x+yfZdnp6vHqtyCl1Ot6GjM5rGMFPtzzvrJRTGzGCQVOUrjbil9lqGjBEa/fmBE5HlYBNgNmm3B+uxfiBeOHymHnfkjTBD8E/eugbwD+Lnp2Mv15n+xKPhTZprId4IMfBKZj7U8V/xTuWzUm19xq2lqfiHfa3DXYH3TURffB2ov7Kg15LYYStqZziG+ye6LuV+8N12PMMPh+z7p4JSVfdAhjLCuAEieLwE1LZ3Ox8Jj0Ef2vlkHwm/WQqm5sQoinjRYyv9TjG9AFejdHN/T2e/cAvb63broj0UcppGTdBqlLO6XgHNjxMa/eFpIhOa3eRUs5Ui3S6L8YiFqcfa4lEXOw+MUFrt18jLmzb2no5ZmSNnlQWtvBOmyjldNXa/Sjm/Cm8L0APq8XuE/N1jA9uikniGZdZNcfE8vbzN7kmlc15Jq5MZXMjMeEq/CTMkflMunWIRTYXExrZC0fHGKud8I6GMNkjlPQ4vJX/bSndL624HTWY2Ohti/7WIbk7YoWwXXI+JoG6B2CcG4v78n4jL+y1k15bgsMrya1ETWGTso5N4BODPOauLfCW31Emjsh5CckEE/sr/jHcPwtxrDsJ72iahbvgNSHbYwsjM0iy60bBRZbnYz0I5QfsoVNOjznW/S0Sz8sNiQMSxv0+R+w+MRhvHfbY7qObyFGxdYz+dZIFXWnYIgofJ978UfvXGW+9+ixgfC3esdeJKiFJ/sGTE5CudiU4X+CJkgbMCsmKExQe99R8Jr1fyEXmtXibY7KelDpW+2HiuhdjpQ9jutXnWHhExDlrh0lc4YXrykHtEk9+vOX1DcJ4om6WXs7B42JmzomC2QmvrbWF6ZbTkTfsuI/E2zdxQyJGvpU5vxtv597btHaX1/qIdheXmgVYKecU4MEEmFUrjFew3/fvTGVzr4Ss8g68402tVl8+k14vYJEtBq6yvD5SKee0Esaqs8+O/4TW7peWNkzE+Jt54bZSwwAr5ayHyW7i5Z4xUWv3uTIuDlsyhV2A4XJMLaUvx/jUeUkFpJB3fKTIA0vsWwehYT/FdinjZfOUD3VSEKnblo9giGT3KaV/zTDB/7yk6znI7ZZa4ElLHb2AUWHEO6WcPko5GnN1IOjqQ5jAY1dh91ZHpMKzww6GBO47Ebu3ekO7wlz5uQHjmOqFm5RyhvuNmVzTOATjFby+RboaGtCG0y0Ety7wiiR5DUMku2OC3XnF2apP4JgZRPSvYNKMeeE04H5hqEH9aKOUc4MQvNeiHaW1+2oFGNYbcpTxlNaVcvYO0be2SjkXYgwRQVlxNi2Byc+3PP+bUk5YCe5yvF1UaoCHlHLODGNBV8rZSpjxQEuRcxo8FmpkcU3D7vT1FebC5r+BL7R2V8gRoquItofiHdxuIt6uCB9gkjV+jclY/EZhSqp8Jr0X5pqQ38AflsrmHokguQ0m2JzcP5XNPREwwN0x8e5tsbjmYRxXX8WkhVqBsSbuDByMf8jhK7V2LwwxyYPwt4BOECk1K/O2TETuTjIvfqnCAC7R2h0WkvFNJ3pewvUxxoxtfMbyLqG/9woScW6A8Unri8m+Y7ujNwOTkzAfY0yP09odGfGYc56PVA4mwegIWQfzJYfhFkIrfTEGhGKd13JMrkWvTMsXYSxsLYGVWrvvWdp1oTAcLyzAGFoWYQxej2vt3mGppzcmmYZtLXws8/cycsVImGoHaf+hmMQqNkFnjNbugNVESKWcY7EH7o+C1zCm+qkhJKotG6JM5jPpdTG+Rp18yo9NZXORLmhL+vpxwB4+xb4Dtktlc3MCCPFQYUpJZip5AegbNtyxUs4w7Er7OBgFHB3WAzsOw5Lfby3zkvStgYVARmv33ZDtKAfDaoXJ+5iUf9lyTBbnVqLq8MM9tqtOEosrrPX3Mq3doT59PExoJmln1skY5/WfjGa1Iprfg8lYnARG87OHfKn6j38EMKtFmPuEkSCxsI7H/6Z7O0IEBtTafVRE2OUJjdsYoH8psdm1di/GJONI0jP8X8CxjXldRGv3c0wUgs8SrPZrYK+wzKqMfVuKSbjxXQLVfYfJ1zhKNrdVMdr1NgmFftbafRhjZf4+waFzgf0KmRVF0sEZwjCiYhZwlNbuEQVHvGswF3bDSD/9MH5AfrhArH7EYFqfEayA7Z/PpI8KMVEPibQWZ6EtlrE/JEy2Zo82XCtHh7iBBBcAJ2rtnpRQQotS+5ETXdqDCVQ3FuiltfsOTQDiSOkQL+rFw0D3BgdeSYoxImbTTiOhMDVau09jblxMiVnVCkyuzv29btrUFnywXmv3bKAf3tlXbZiJiU66jXD+wk58FmZ3yWfSLUSv9a7P3+PYTfql4nrgiYDvnZDPpNuEmKjJmFjrp+Od3NKGb2Ri0lq7N8aRaLR2n8cEdLuM0sP5LsQkp+2itRt1AXzoMX7vR+jHfK3dgRhv99citCML9NPa/YPWbhTnzLkWWpibwIJ+H+NTeHsJUvkqjFHsN1q7XklczxQdWNQ2vSNM5mUfKb1e9Ihh6puKMdadEoE5L8foXLtr7V6otbvMq1CN5UxaK0RzEOYaQCdRvq2UycthTLbPYdLZ1wec49uIFNAFc19ssSzu8Tbz/ZoIUSb2AhTmrmJHjOWuXiSYmaLXm4DxZK8vQxvWwqS530/mbmsZc0TaXYCJafYuxjLjVjhkkF9fumGUzhmM1XhT2WTrhYa+FMY4CRibRMadRurXphhvdSW6rXYF8zNb+jQeeDpMpmlxZdkHk2BjqczxZIwif2nINrUVhtoeowBfiHEnmCoOy6X2sVba1FeYYmd+TpP3o6h3PpW+vgI8p7UbuNn+dwBfQrcJFZz4VAAAAABJRU5ErkJggg=="
}
print   print

resource /skillGroup/:skillGroupID

Description

Interacts with a specfic Skill Group. You can read (GET) or update (PUT) a Skill Group. The parameters below refer only to PUT requests.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/skillGroup/:skillGroupID

Pattern: /skillGroup/:skillGroupID
Handler: api.skillGroup
Action: {PUT={update}, GET={read}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/skillGroup/:skillGroupID
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET,PUT
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
name string false The name of the Skill Group.
type string false The type of the Skill Group.
Response Default Response Format: json

Samples

Skill Group returned in JSON format

{
    "SKILLGROUPID": 9999,
    "NAME": "All Staff",
	"TYPE": "Staff",
    "ISACTIVE": true,
    "DATEUPDATED": "2015-03-05 13:28",
    "DATEINSERTED": "2015-03-03 11:16"
}
print   print

resource /skillGroup/

Description

Creates a new Skill Group. This API will not try and search for any existing Skill Group (of the same name), but simply creates a new one.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/skillGroup/

Pattern: /skillGroup/
Handler: api.skillGroup
Action: {POST={create}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/skillGroup/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
name string true The name of the Skill Group.
type string false The type of the Skill Group
Response Default Response Format: json

Samples

Message returned in JSON format

{
    "MESSAGE": "Skill Group Created Successfully",
    "STATUS": "success",
    "CONTACTROLEID": 9999
}
print   print

resource /skillGroups/

Description

Skill Group Search (paged results)

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/skillGroups/

Pattern: /skillGroups/
Handler: api.skillGroup
Action: {GET={search}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/skillGroups/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
name string false The name or part of the name to search for
type string false The type or part of the type to search for
isActive boolean false 1 Search for Active or Inactive Skill Groups.
offset numeric false 0 Used for paging - start at record.
displayLength numeric false 10 Used for paging - total records to retrieve.
sortColumn numeric false 1 The column index to sort by.
sortDirection string false ASC The sort by direction 'ASC' OR 'DESC'.
purgeCache boolean false true Currently the API will cache the query for 30 seconds ��� Setting this flag to true gets the latest data.
Response Default Response Format: json

Samples

Contact Role returned in JSON format

[
    {
        "ROWID": 1,
        "SKILLGROUPID": 9999,
        "NAME": "API Endpoint Test #1",
        "TYPE": "aXcelerateDevTest",
        "DATEINSERTED": "2015-03-09 12:24",
        "DATEUPDATED": "2015-03-09 12:37",
        "ISACTIVE": true,
        "COUNT": 4
    },
    {
        "ROWID": 2,
        "SKILLGROUPID": 9998,
        "NAME": "API Endpoint Test #2",
        "TYPE": "aXcelerateDevTest",
        "DATEINSERTED": "2015-03-09 12:25",
        "DATEUPDATED": "2015-03-09 12:44",
        "ISACTIVE": true,
        "COUNT": 4
    },
    {
        "ROWID": 3,
        "SKILLGROUPID": 9997,
        "NAME": "All Developers",
        "TYPE": "IT",
        "DATEINSERTED": "2015-03-03 11:16",
        "DATEUPDATED": "2015-03-05 13:28",
        "ISACTIVE": true,
        "COUNT": 4
    },
    {
        "ROWID": 4,
        "SKILLGROUPID": 9996,
        "NAME": "All Managers",
        "TYPE": "manager",
        "DATEINSERTED": "2015-03-05 13:16",
        "DATEUPDATED": "2015-03-05 13:31",
        "ISACTIVE": true,
        "COUNT": 4
    }
]
print   print

resource /task/

Description

Interacts with workflow user tasks. These are tasks that can be found when going to Settings > Workflow.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/task/

Pattern: /task/
Handler: api.task
Action: {PUT={update}, DELETE={delete}, GET={read}, POST={create}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/task/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET,POST,PUT,DELETE
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
taskID numeric false The ID for the task. Required for GET, PUT and DELETE. Not valid for POST requests. Can also be added to the URL, as in: api/task/:taskID
name string false The task - required when creating a new task.
details string false Optional additional details for the task
dueDate date false The task due date. This should be set using the format: YYYY-MM-DD
ownerID numeric false The contactID of the user responsible for the task
status numeric false 1 The status for the task. Possible statuses are from 1-4. See endpoint api/task/statuses for a list of statuses
priority numeric false 2 The priority for the task. Possible priorities are from 1 (Low) to 4 (Urgent). See endpoint api/task/priorities for a list
completedDate date false Only valid for status 4 (Completed). Use format: YYYY-MM-DD
categoryID numeric false A category for the task. Task categories are user-defined and can be managed using the task/category endpoint.
reminderDate datetime false A date and time to set an email reminder. Only valid for users with the Workflow Engine feature. Format: YYYY-MM-DD hh:mm
PDataID numeric false To link a task to a workshop instance. You can also use the parameters, type='w' and instanceID
ProgramCodeID numeric false To link a task to a workshop type. You can also use the parameters, type='w' and ID
classID numeric false To link a task to a class instance. You can also use the parameters, type='p' and instanceID
diplomaID numeric false To link a task to a qualification or class type. You can also use the parameters, type='p' and ID
marketingLearningActivityID numeric false To link a task to an E-Learning instance.
marketingContactID numeric false To link a task to a contact. If this field is set, the task is considered to be a marketing Follow-up task. If this field is not set, all forecast and opportunity fields will be ignored.
OpportunityStatus numeric false The opportunity status of a marketing task. See endpoint task/opportunityStatuses for a list of valid values. This field is required if you give the task a Forecast value
ForecastValue numeric false The monetary value of a task, for forecast calculation purposes.
ForecastProbability numeric false The percentage chance of the forecast task being converted. It must be a value between 0 and 100. If, for example, you attempt to set this value to 200 - an error will not be thrown, it will simply set it to 100.
ForecastDistribution_Month date false Works with the ForecastDistribution_Value parameter and you can have more than one (a list). It is the forecast month. You can specify in YYYY-MM or YYYY-MM-DD format. Day will be truncated to the first.
ForecastDistribution_Value numeric false The monetary value of a task for the matching ForecastDistribution_Month
Response Default Response Format: json

Samples

The main task JSON returned for a standard task.

{
    "REMINDERSCHEDULEID": 2898,
    "DUEDATE": "2014-09-18 08:30",
    "REMINDERAUTOTASKID": 2425,
    "STATUSDISPLAYNAME": "Not Started",
    "PDATAID": 345345,
    "REMINDERDATE": "2014-09-17 08:30",
    "TASKID": 88,
    "PROGRAMCODEID": null,
    "STATUS": 1,
    "CATEGORY": "Sales",
    "CATEGORYID": 534,
    "PRIORITY": 2,
    "COMPLETEDDATE": null,
    "OWNERID": 3534534,
    "REQUESTERID": 435222,
    "NAME": "Check trainer availability",
    "CREATIONDATE": "2014-09-17 08:30",
    "OWNER": "Johnny Tester",
    "REQUESTER": "Jill Tester",
    "DETAILS": "This is a test task only."
}

The main task JSON returned for a marketing task.

{
    "MARKETINGCONTACTID": 79071,
    "REMINDERSCHEDULEID": 3504,
    "FORECASTDISTRIBUTION": [
        {
            "MONTH": "2015-07-01 00:00",
            "VALUE": 33.34
        },
        {
            "MONTH": "2015-08-01 00:00",
            "VALUE": 33.33
        },
        {
            "MONTH": "2015-09-01 00:00",
            "VALUE": 33.33
        }
    ],
    "REMINDERAUTOTASKID": 3055,
    "STATUSDISPLAYNAME": "Not Started",
    "FORECASTVALUE": 100,
    "MARKETINGNOTESID": 4778423,
    "DIPLOMAID": 3296,
    "STATUS": 1,
    "OWNERID": 564654,
    "REQUESTERID": 32424,
    "NAME": "Test task with marketing details",
    "CREATIONDATE": "2015-07-06 04:45",
    "OPPORTUNITYSTATUS": "Pending",
    "DETAILS": null,
    "MARKETINGLEARNINGACTIVITYID": null,
    "DUEDATE": "2015-07-15 00:00",
    "REMINDERDATE": "2015-07-14 12:00",
    "TASKID": 2725,
    "CLASSID": 27495,
    "ISQUOTETASK": null,
    "MARKETINGLASTCONTACTNOTE": {
        "NOTETEXT": "This shows the last note added that is non-system",
        "NOTEDATE": "2015-07-06 04:46",
        "NOTESID": 4778423,
        "NOTE_ENTEREDBYID": 564654,
        "NOTE_ENTEREDBY": "Bob Dyla"
    },
    "ENROLID": null,
    "CATEGORY": null,
    "CATEGORYID": null,
    "PRIORITY": 2,
    "FORECASTPROBABILITY": 45,
    "COMPLETEDDATE": null,
    "OWNER": "Bob Dylan",
    "REQUESTER": "Paul McCartney"
}
print   print

resource /tasks

Description

Search for workflow user tasks. You can do an exact search by any of the main parameters for a task (name, ownerID, PDataID, etc.)

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/tasks

Pattern: /tasks
Handler: api.task
Action: {GET={search}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/tasks
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
searchTerm string false Will search name (starts with only), owner's name, status, and category.
incomplete boolean false If passed, will return any statuses that are or are not Complete (4) based on the value passed.
Response Default Response Format: json

Samples

JSON returned for a task search. This structure is different from those returned by drilling directly into the task. This example was returned by searching on ownerID=99 and incomplete=0

[
    {
        "DUEDATE": "2015-06-25 00:00",
        "CATEGORY": null,
        "CATEGORYID": null,
        "STATUS": "Completed",
        "SUCCESS": true,
        "PRIORITY": 2,
        "COMPLETEDDATE": "2015-07-21 00:00",
        "OWNERID": 999,
        "REQUESTERID": 775,
        "NAME": "Kermit marketing task",
        "ID": 1050,
        "OWNER": "Frank Grimes",
        "REQUESTER": "Herbert Powell",
        "STATUS_CODE": 4,
        "TYPE": "task"
    },
    {
        "DUEDATE": "2015-07-03 00:00",
        "CATEGORY": null,
        "CATEGORYID": null,
        "STATUS": "Completed",
        "SUCCESS": true,
        "PRIORITY": 4,
        "COMPLETEDDATE": "2015-08-27 00:00",
        "OWNERID": 999,
        "REQUESTERID": 775,
        "NAME": "Certificate I in Business - Qualification - Online Enquiry",
        "ID": 1275,
        "OWNER": "Frank Grimes",
        "REQUESTER": "Herbert Powell",
        "STATUS_CODE": 4,
        "TYPE": "task"
    },
    {
        "DUEDATE": "2015-07-03 00:00",
        "CATEGORY": "Marketing",
        "CATEGORYID": 4984,
        "STATUS": "Completed",
        "SUCCESS": true,
        "PRIORITY": 4,
        "COMPLETEDDATE": "2015-07-15 00:00",
        "OWNERID": 999,
        "REQUESTERID": 775,
        "NAME": "Test Course - E-Learning - Online Enquiry",
        "ID": 1276,
        "OWNER": "Frank Grimes",
        "REQUESTER": "Herbert Powell",
        "STATUS_CODE": 4,
        "TYPE": "task"
    },
    {
        "DUEDATE": "2015-07-20 00:00",
        "CATEGORY": "Sales",
        "CATEGORYID": 534,
        "STATUS": "Completed",
        "SUCCESS": true,
        "PRIORITY": 2,
        "COMPLETEDDATE": "2015-07-27 00:00",
        "OWNERID": 999,
        "REQUESTERID": 775,
        "NAME": "Follow-up: Kermit Frog",
        "ID": 3003,
        "OWNER": "Frank Grimes",
        "REQUESTER": "Herbert Powell",
        "STATUS_CODE": 4,
        "TYPE": "task"
    },
    {
        "DUEDATE": "2015-08-27 00:00",
        "CATEGORY": null,
        "CATEGORYID": null,
        "STATUS": "Completed",
        "SUCCESS": true,
        "PRIORITY": 2,
        "COMPLETEDDATE": "2015-08-10 00:00",
        "OWNERID": 999,
        "REQUESTERID": 775,
        "NAME": "Marketing task for Wayne",
        "ID": 3408,
        "OWNER": "Frank Grimes",
        "REQUESTER": "Herbert Powell",
        "STATUS_CODE": 4,
        "TYPE": "task"
    }
]
print   print

resource /task/category

Description

Interacts with workflow user task categories.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/task/category

Pattern: /task/category
Handler: api.task
Action: {PUT={updateCategory}, DELETE={deleteCategory}, GET={getCategory}, POST={createCategory}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/task/category
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET,POST,PUT,DELETE
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
categoryID numeric false The ID for the task category. Required for GET, PUT and DELETE. Not valid for POST requests. Can also be added to the URL, as in: api/task/category/:categoryID
name string false The category name
colour string false #ffffff A colour for the category. This column is not used in the main aXcelerate interface.
Response Default Response Format: json
No Response Definitions Defined
print   print

resource /task/categories

Description

Pull back a list of workflow user task categories

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/task/categories

Pattern: /task/categories
Handler: api.task
Action: {GET={categories}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/task/categories
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json
No Response Definitions Defined
print   print

resource /task/priorities

Description

Pull back a list of workflow user task priorities

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/task/priorities

Pattern: /task/priorities
Handler: api.task
Action: {GET={categories}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/task/priorities
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json
No Response Definitions Defined
print   print

resource /task/statuses

Description

Pull back the list of workflow user task statues

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/task/statuses

Pattern: /task/statuses
Handler: api.task
Action: {GET={categories}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/task/statuses
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json
No Response Definitions Defined
print   print

resource /task/opportunityStatuses

Description

Pull back the list of workflow user task Opportunity Statuses

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/task/opportunityStatuses

Pattern: /task/opportunityStatuses
Handler: api.task
Action: {GET={categories}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/task/opportunityStatuses
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json
No Response Definitions Defined
print   print

resource /template/

Description

Returns the results of a template filled in given the parameters. You can pass either a planID from the system to use a saved template, or you can pass the actual content of the template. It returns an array of results with two keys, CONTACTID and CONTENT. If attachmentPlanID is passed, it will also include the key ATTACHMENT.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/template/

Pattern: /template/
Handler: api.template
Action: {GET={getTemplate}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/template/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
planID numeric false The ID of a template to use. One of planID or content is required.
content string false The template content to use. For example, anywhere you use the text [Trainee Full Name] it will replace that text with the contact's name. One of planID or content is required.
contactID numeric false The contact to generate the template for. Either contactID must be passed, or a search parameter to determine contacts (instanceID/type, userRoleID, etc.)
type string false The type of course to generate the template for. Use with the instanceID or ID parameters. Either a course type and ID must be passed or a contactID.
instanceID numeric false The course instance to generate the template for. If you pass an instanceID and type, you can generate an array of templates for each student on the course. Use the includeStatus parameter to determine which students you generate the template for. Either a course type and ID must be passed or another parameter which determines contacts (contactID, skillGroupID, contactRoleID, userRoleID).
ID numeric false The course to generate the template for. It is preferable to use instanceID as a course at the ID level does not have students. If you pass type and ID you must also pass a contactID.
includeStatus string false Enrolled,Completed A list of statuses to generate a template for. The available statuses are: [All,Enrolled,Completed,Tentative,Cancelled,Suspended,Deferred]. This is used in combination with type and instanceID in order to generate templates for students.
attachmentPlanID numeric false The ID of a template to use as an attachment. Will populate a key ATTACHMENT in the return.
invoiceID numeric false An invoiceID. Passing this will correctly parse any invoice related fields.
userRoleID numeric false Return contacts who are users in this role. Can be a list.
contactRoleID numeric false Enterprise only. Return contacts who belong to this contact role. Can be a list.
skillGroupID numeric false Enterprise only. Return contacts whose contact role contains this skill group. Can be a list.
Response Default Response Format: json

Samples

This is an example of a return when getting a template for a workshop. The parameters passed were: type=w, instanceID=123, includeStatus=All, and content=Hello [Trainee Full Name]

[
    {
        "CONTENT": "Hello Lisa Jones",
        "CONTACTID": 438788
    },
    {
        "CONTENT": "Hello Julie Smith",
        "CONTACTID": 508599
    },
    {
        "CONTENT": "Hello Jill Watston",
        "CONTACTID": 323099
    }
]

This is an example of using a type and ID parameter with a contactID and a planID from a saved template in the system.

[
    {
        "CONTENT": "Hello Jill Watston<br>\r\n<br>\r\nThank you for your interest in Certificate I in Business.<br>
\r\n<br>\r\nHere are the units:\n\t\t\<table border="\\"0\\"" cellpadding="\\"1\\"" cellspacing="\\"1\\"" style="\\"width:" 500px;\\"="">
<tbody><tr><td><strong>Name</strong></td><td><strong>Code</strong></td></tr><tr class="\\"units\\""><td>BSBADM101A</td>
<td>Use business equipment and resources</td></tr><tr class="\\"units\\""><td>BSBCMM101A</td><td>Apply basic communication skills</td>
</tr><tr class="\\"units\\""><td>BSBIND201A</td><td>Work effectively in a business environment</td></tr><tr class="\\"units\\""><td>BSBITU101A</td>
<td>Operate a personal computer</td></tr><tr class="\\"units\\""><td>BSBITU102A</td><td>Develop keyboard skills</td></tr><tr class="\\"units\\"">
<td>BSBITU201A</td><td>Produce simple word processed documents</td></tr><tr class="\\"units\\""><td>BSBITU202A</td><td>Create and use spreadsheets</td>
</tr><tr class="\\"units\\""><td>BSBLED101A</td><td>Plan skills development</td></tr><tr class="\\"units\\""><td>BSBSUS201A</td>
<td>Participate in environmentally sustainable work practices</td></tr><tr class="\\"units\\""><td>BSBWHS201A</td>
<td>Contribute to health and safety of self and others</td></tr><tr class="\\"units\\""><td>BSBWOR202A</td><td>Organise and complete daily work activities</td>
</tr></tbody></table>\r\n<br>\r\n<br>\r\nHave a nice day,<br>\r\nTracey Benussi<br>\r\n<strong>VM Learning</strong><br>\r\naccounts@vmlearning.com.au",
        "CONTACTID": 323099
    }
]
print   print

resource /template/email

Description

Emails the selected template to the selected contacts. Returns a report of the results. As with /api/template you can pass either a planID from the system to use a saved template, or you can pass the actual content of the template.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/template/email

Pattern: /template/email
Handler: api.template
Action: {POST={email}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/template/email
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
verbose boolean false false If passed, an additional key REPORT will be passed which will be an array with information on each contact emailed.
planID numeric false The ID of a template to use. One of planID or content is required.
content string false The template content to use. For example, anywhere you use the text [Trainee Full Name] it will replace that text with the contact's name. One of planID or content is required.
subject string false The email subject. This must be passed if content is used. If planID is used and this parameter is not passed, it will default to the name of the template.
from string false Must either be a valid email address or the contactID of a contact with a valid email address. If not passed, it will default to the API user.
to string false student Only used in conjunction with type=w or p and an instanceID. Normally templates are generated and emailed to students, however, you can also email other contacts related to the course. The valid values include: [student,creator,client,owner,trainer]. Note that if emailing non-students without a contactID they become the subject of the template. In other words, if you chose to=trainer, they will recieve the template for themselves without any fields populated with student data.
contactID numeric false The contact to email the template to. Either contactID must be passed, or a search parameter to determine contacts (instanceID/type, userRoleID, etc.)
type string false The type of course to use. Use with the instanceID or ID parameters. Either a course type and ID must be passed or a contactID.
instanceID numeric false The course instance. If you pass an instanceID and type, you can email a templates to each student on the course with the one call. Use the includeStatus parameter to determine which students to email.
ID numeric false The courseID to use. It is preferable to use instanceID as a course at the ID level does not have students. If you pass type and ID you must also pass a contactID.
includeStatus string false Enrolled,Completed A list of statuses. Students that fall under the status will get the email. The available statuses are: [All,Enrolled,Completed,Tentative,Cancelled,Suspended,Deferred]. This is used in combination with type and instanceID.
honourUnsubscribed boolean false false If passed, any student that has unsubscribed from merge documents will NOT receive an email.
attachmentPlanID numeric false The ID of a template to use to attach as a PDF to the email. The filename will be the template name.
invoiceID numeric false The invoiceID associated with this email. Passing this will correctly parse any invoice related fields. To include an invoice as a separate PDF attachment, you must also pass invoiceAttachmentPlanID.
invoiceAttachmentPlanID numeric false The ID of a template to use to attach an invoiceID as a PDF to the email. If used with invoiceID, it will attach the template to the email with the filename Invoice_[N].pdf, where [N] is the invoice number.
attachAccreditedCertificate boolean false false If true, the system will attach the latest accredited certificate issed to the student. In the case of an enrolment having mulitple certificates, it will attach the most recent Completed Qualification certificate by issue date. Statement of Attainments will only be considered if there are no Completed Qualification Certificates. Also note that this only works when an accredited instance ID is passed (type=p) or a workshop instance linked to an accredited unit enrolment (type=w). It also only works when emailing the student (to=student)
attachWorkshopCertificate boolean false false If true, the system will attach the latest non-accredited certificate associated with the student. In the case of an enrolment having mulitple certificates, it will attach the most recent by issue date. Also note that this only works when a workshop instanceID (type=w) is passed and when emailing the student (to=student).
userRoleID numeric false Email contacts who are users in this role. Can be a list.
contactRoleID numeric false Enterprise only. Email contacts who belong to this contact role. Can be a list.
skillGroupID numeric false Enterprise only. Email contacts whose contact role contains this skill group. Can be a list.
Response Default Response Format: json

Samples

This is an example of emailing students in a workshop. The parameters passed were: type=w, instanceID=123, includeStatus='Enrolled,Completed', planID=123, subject='Here is your email', and verbose=1

{
    "FAILEDCOUNT": 2,
    "MESSAGE": "2 Email(s) sent successfully. 1 Email(s) not sent because the contact did not have a valid email address. 1 Email(s) not sent because the contact has unsubscribed. ",
    "ATTEMPTEDCOUNT": 4,
    "SUCCESSCOUNT": 2,
    "REPORT": [
        {
            "SUBJECT": "Here is your email",
            "CONTACTID": 434324,
            "TO": [
                {
                    "EMAILADDRESS": "lisa.jones@abc.org.au",
                    "MESSAGE": "Email sent successfully. ",
                    "EMAILED": true,
                    "CONTACTID": 434324
                }
            ],
            "FROM": "no-reply@axcelerate.com.au"
        },
        {
            "SUBJECT": "Here is your email",
            "CONTACTID": 234234,
            "TO": [
                {
                    "EMAILADDRESS": "j.smith@fake.edu.au",
                    "MESSAGE": "Email sent successfully. ",
                    "EMAILED": true,
                    "CONTACTID": 234234
                }
            ],
            "FROM": "no-reply@axcelerate.com.au"
        },
        {
            "SUBJECT": "Here is your email",
            "CONTACTID": 234342,
            "TO": [
                {
                    "EMAILADDRESS": "bad.email.com.au",
                    "MESSAGE": "Invalid email address. ",
                    "EMAILED": false,
                    "CONTACTID": 234342
                }
            ],
            "FROM": "no-reply@axcelerate.com.au"
        },
        {
            "SUBJECT": "Here is your email",
            "CONTACTID": 98797,
            "TO": [
                {
                    "EMAILADDRESS": "mr.parker@fake.com.au",
                    "MESSAGE": "This contact has unsubscribed. ",
                    "EMAILED": false,
                    "CONTACTID": 98797
                }
            ],
            "FROM": "no-reply@axcelerate.com.au"
        }
    ]
}
print   print

resource /template/sms

Description

Will SMS the selected template to the selected contacts. Returns a report of the results. You must have an SMS provider (such as SMS Global) defined in your system settings in order for this endpoint to work. Due to the shorter nature of SMS, it is likely you would prefer the content parameter for this endpoint, however, as with /api/template you can pass either a planID from the system to use a saved template.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/template/sms

Pattern: /template/sms
Handler: api.template
Action: {POST={sms}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/template/sms
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
verbose boolean false false If passed, an additional key REPORT will be passed which will be an array with information on each student SMSed.
planID numeric false The ID of a template to use. One of planID or content is required.
content string false The template content to use. For example, anywhere you use the text [Trainee Full Name] it will replace that text with the contact's name. One of planID or content is required.
to string false student Only used in conjunction with type=w or p and an instanceID. Normally templates are generated for students, however, you can also SMS other contacts related to the workshop. The valid values include: [student,creator,client,owner,trainer].
contactID numeric false The contact to SMS. Either contactID must be passed, or a search parameter to determine contacts (instanceID/type, userRoleID, etc.)
type string false The type of course to use. Use with the instanceID or ID parameters. Either a course type and ID must be passed or a contactID.
instanceID numeric false The course instance. If you pass an instanceID and type, you can SMS each student on the course with the one call. Use the includeStatus parameter to determine which students to SMS.
ID numeric false The courseID to use. It is preferable to use instanceID as a course at the ID level does not have students. If you pass type and ID you must also pass a contactID.
includeStatus string false Enrolled,Completed A list of statuses. Students that fall under the status will get the SMS. The available statuses are: [All,Enrolled,Completed,Tentative,Cancelled,Suspended,Deferred]. This is used in combination with type and instanceID.
invoiceID numeric false An invoiceID. Passing this will correctly parse any invoice related fields.
userRoleID numeric false SMS contacts who are users in this role. Can be a list.
contactRoleID numeric false Enterprise only. SMS contacts who belong to this contact role. Can be a list.
skillGroupID numeric false Enterprise only. SMS contacts whose contact role contains this skill group. Can be a list.
Response Default Response Format: json

Samples

This is an example of SMSing students in a workshop. The parameters passed were: type=w, instanceID=123, includeStatus=Enrolled,Completed, content='Hello [Trainee Full name] - your course [Workshop Name] will start on [Workshop Start Date]', and verbose=1

{
    "FAILEDCOUNT": 1,
    "MESSAGE": "2 SMS(es) sent successfully. 1 SMS(es) not sent because the contact did not have a valid mobile phone number. ",
    "ATTEMPTEDCOUNT": 3,
    "SUCCESSCOUNT": 2,
    "REPORT": [
        {
            "TEXT": "Hello Lisa Jones - your course aXcelerate Day: Part One will start on 09/07/2015",
            "CONTACTID": 438788,
            "TO": [
                {
                    "MESSAGE": "SMS sent successfully. ",
                    "MOBILEPHONE": "0411555555",
                    "CONTACTID": 438788,
                    "SENT": true
                }
            ]
        },
        {
            "TEXT": "Hello Julie Smith - your course aXcelerate Day: Part One will start on 09/07/2015",
            "CONTACTID": 508599,
            "TO": [
                {
                    "MESSAGE": "SMS sent successfully. ",
                    "MOBILEPHONE": "0422555555",
                    "CONTACTID": 508599,
                    "SENT": true
                }
            ]
        },
        {
            "TEXT": "Hello Jill Watston - your course aXcelerate Day: Part One will start on 09/07/2015",
            "CONTACTID": 323099,
            "TO": [
                {
                    "MESSAGE": "Invalid mobile number",
                    "MOBILEPHONE": "",
                    "CONTACTID": 323099,
                    "SENT": false
                }
            ]
        }
    ]
}
print   print

resource /trainer/:contactID

Description

Returns a Trainer.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/trainer/:contactID

Pattern: /trainer/:contactID
Handler: api.trainer
Action: {GET={read}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/trainer/:contactID
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json

Samples

A successful call will give you a response like this:

{
    "INACTIVE": false,
    "CONSULTANTID": 6912,
    "CONTACTHRSTIMEFRAME": "",
    "EMPTYPE": "",
    "DOMAINID": "",
    "CONENTRYDATE": "2014-12-03 09:58",
    "CONTACTHRS": "",
    "CONTACTID": 116482,
    "IMAGE": "",
    "RATEAMOUNT": "",
    "NAME": "Nathan Gordon",
    "EXPERIENCE": "",
    "PAYTIMEFRAME": "",
    "FILLINONLY": false,
    "PAGE": ""
}
print   print

resource /trainer/availability/

Description

Check a Trainer's availability - returns an array of 'clashes' if unavailable.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/trainer/availability/

Pattern: /trainer/availability/
Handler: api.trainer
Action: {POST={getAvailability}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/trainer/availability/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
contactID numeric true The ID of the Contact (who is a Trainer).
date date true The Date to check.
startTime string true The Start Time to check.
finishTime string true The End Time to check.
Response Default Response Format: json

Samples

A successful call will give you a response like this:

{
    "INACTIVE": false,
    "CONSULTANTID": 6912,
    "CONTACTHRSTIMEFRAME": "",
    "EMPTYPE": "",
    "DOMAINID": "",
    "CONENTRYDATE": "2014-12-03 09:58",
    "CONTACTHRS": "",
    "CONTACTID": 116482,
    "IMAGE": "",
    "RATEAMOUNT": "",
    "NAME": "Nathan Gordon",
    "EXPERIENCE": "",
    "PAYTIMEFRAME": "",
    "FILLINONLY": false,
    "PAGE": ""
}
print   print

resource /trainer/

Description

Create a Trainer.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/trainer/

Pattern: /trainer/
Handler: api.trainer
Action: {POST={create}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/trainer/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
contactID numeric true The ID of the Contact.
name string false The Trainer's Name.
Experience string false The Trainer's Experience.
ContactHrs numeric false The Trainer's Contact Hours.
ContactHrsTimeFrame string false The Trainer's Contact Hours - Time Frame.
EmpType string false The Trainer's Employment Type.
RateAmount numeric false The Trainer's Rate.
fillInOnly boolean false false Is this Trainer a 'fill-in'?.
Response Default Response Format: json

Samples

A successful call will give you a response like this:

{
    "INACTIVE": false,
    "CONSULTANTID": 6912,
    "CONTACTHRSTIMEFRAME": "",
    "EMPTYPE": "",
    "DOMAINID": "",
    "CONENTRYDATE": "2014-12-03 09:58",
    "CONTACTHRS": "",
    "CONTACTID": 116482,
    "IMAGE": "",
    "RATEAMOUNT": "",
    "NAME": "Nathan Gordon",
    "EXPERIENCE": "",
    "PAYTIMEFRAME": "",
    "FILLINONLY": false,
    "PAGE": ""
}
print   print

resource /trainingCategories/

Description

Returns a list of defined Training Categories.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/trainingCategories/

Pattern: /trainingCategories/
Handler: api.trainingCategory
Action: {GET={read}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/trainingCategories/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json

Samples

A successful call will give you a response like this:

[
	{
		"AREAID":64,
		"AREA":"Leadership",
		"BGCOLOURHEX":"de7fe8",
		"BORDERCOLOURHEX":"000000",
		"CORE":1
	},
	{
		"AREAID":75,
		"AREA":"Professional Development",
		"BGCOLOURHEX":"ADD8E6",
		"BORDERCOLOURHEX":"000000",
		"CORE":0
	},
	{
		"AREAID":139,
		"AREA":"Graduate Programs",
		"BGCOLOURHEX":"F5DEB3",
		"BORDERCOLOURHEX":"000000",
		"CORE":1
	},
	{
		"AREAID":273,
		"AREA":"FaHCSIA Programs",
		"BGCOLOURHEX":"FF69B4",
		"BORDERCOLOURHEX":"000000",
		"CORE":1
	}
]
print   print

resource /user/

Description

Creates a new User. The parameters below refer only to POST requests.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/user/

Pattern: /user/
Handler: api.user
Action: {POST={create}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/user/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
contactID numeric true The aXcelerate ContactID the user is associated with
username string true The Username
password string false The Password - If this is omitted; aXcelerate will generate one.
domainID numeric false The DomainID. Set the Domain for the User
roleID numeric false The Role to assign the User to. If this is omitted; aXcelerate will try to set them to Learner if the Default Role has been configured (In Additional Options)
Response Default Response Format: json

Samples

The user information will be returned in a flat object.

{
    "ROLETYPEID": 1,
    "USERID": 1559,
    "DOMAINID": null,
    "CONTACTID": 116482,
    "ROLEID": 2456,
    "ROLENAME": "Developer",
    "ACTIVE": 1,
    "PASSWORDCHANGEATNEXTLOGIN": 0,
    "USERNAME": "nathan1"
}
print   print

resource /user/:userID

Description

Interacts with a specific user. You can read (GET) or update (PUT) user details. The parameters below refer only to PUT requests.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/user/:userID

Pattern: /user/:userID
Handler: api.user
Action: {PUT={update}, GET={read}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/user/:userID
Placeholder Type Required Default Description
userID numeric true The resource user ID to interact with
HTTP Request Methods

Supported: GET,PUT
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
userID numeric true The aXcelerate UserID.
roleID numeric false The User Role associated with the User
domainID numeric false The Domain associated with the User
active numeric false The User's Active status
username string false The Username
password string false The Password - Force set User's password
passwordchangeatnextlogin numeric false The flag to force the User to change their password at next login
Response Default Response Format: json

Samples

The user information will be returned in a flat object.

{
    "ROLETYPEID": 1,
    "USERID": 1559,
    "DOMAINID": null,
    "CONTACTID": 116482,
    "ROLEID": 2456,
    "ROLENAME": "Developer",
    "ACTIVE": 1,
    "PASSWORDCHANGEATNEXTLOGIN": 0,
    "USERNAME": "nathan1"
}
print   print

resource /user/login

Description

Login an aXcelerate User. The parameters below refer only to POST requests. The API Token is optional for this endpoint, but will be required for all subsequent calls to any other endpoint.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/user/login

Pattern: /user/login
Handler: api.user
Action: {POST={login}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/user/login
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string false API Key value. This is one of the few endpoints where this is optional. If passed, logins will be limited to this account.
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
username string true The Username
password string true The Password
Response Default Response Format: json

Samples

The user information will be returned in a flat object.

{
    "MESSAGE": "Login Successful",
    "USERID": 1559,
    "EXPIRES": "2014-10-24 15:40:56",
    "AXTOKEN": "4d9969c2-995b-4b7c-b122-66172ea3c3d8",
    "STATUS": "success",
    "ROLES": "user,Developer,super,admin"
}
print   print

resource /user/logout

Description

Logout an aXcelerate User. The parameters below refer only to POST requests.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/user/logout

Pattern: /user/logout
Handler: api.user
Action: {POST={logout}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/user/logout
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
axtoken string true User Token value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

No Parameters
Response Default Response Format: json

Samples

The user information will be returned in a flat object.

{
    "MESSAGE": "User 'nathan1' was logged out successfully.",
    "STATUS": "success"
}
print   print

resource /user/forgotPassword

Description

Reset an aXcelerate User's password. The parameters below refer only to POST requests. Only the apitoken is required for this endpoint.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/user/forgotPassword

Pattern: /user/forgotPassword
Handler: api.user
Action: {POST={forgotPassword}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/user/forgotPassword
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value. Forgot password searches will be limited to this account
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
username string true The Username
email string true The email address associated with the account
Response Default Response Format: json

Samples

The user information will be returned in a flat object.

{
	"STATUS": "success"
}
print   print

resource /user/forgotUsername

Description

Retrieve an aXcelerate Username. The parameters below refer only to POST requests.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/user/forgotUsername

Pattern: /user/forgotUsername
Handler: api.user
Action: {POST={forgotUsername}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/user/forgotUsername
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
givenName string true The User's First Name
surname string true The User's Last Name
DOB string true The User's Date of Birth
email string true The email address associated with the account
system string false for the Learner Portal The system terminology - i.e 'for the Candidate Portal'
url string false Specify a login URL in the email
Response Default Response Format: json
No Response Definitions Defined
print   print

resource /user/changePassword

Description

Change an aXcelerate User's password. The parameters below refer only to POST requests.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/user/changePassword

Pattern: /user/changePassword
Handler: api.user
Action: {POST={changePassword}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/user/changePassword
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
username string true The User name
oldPassword string true The User's old password
newPassword string true The User's new password
verifyPassword string true The User's new password again
Response Default Response Format: json

Samples

The user information will be returned in a flat object.

{
    "STATUS": "success",
    "MSG": "User's password has been changed successfully"
}
print   print

resource /users/

Description

Lists aXcelerate Users - Display Length is defaulted to 10. Note: this endpoint does not have paging. The parameters below refer only to POST requests.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/users/

Pattern: /users/
Handler: api.user
Action: {POST={search}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/users/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
contactID numeric false The aXcelerate ContactID
username string false The Username
givenName string false The Associated Contact's Given Name.
surname string false The Associated Contact's Surname.
email string false The Associated Contact's email address
Response Default Response Format: json

Samples

The user information will be returned in a flat object.

[
    {
        "ROLETYPEID": 1,
        "USERID": 200,
        "DOMAINID": null,
        "CONTACTID": 20639,
        "ROLEID": 2456,
        "ROLENAME": "Developer",
        "ACTIVE": 1,
        "PASSWORDCHANGEATNEXTLOGIN": 0,
        "USERNAME": "tracey"
    },
    {
        "ROLETYPEID": 1,
        "USERID": 8703,
        "DOMAINID": null,
        "CONTACTID": 1368359,
        "ROLEID": 2386,
        "ROLENAME": "Client Services",
        "ACTIVE": 1,
        "PASSWORDCHANGEATNEXTLOGIN": 0,
        "USERNAME": "Rob.Bisson"
    },
    {
        "ROLETYPEID": 1,
        "USERID": 8164,
        "DOMAINID": null,
        "CONTACTID": 1271108,
        "ROLEID": 2386,
        "ROLENAME": "Client Services",
        "ACTIVE": 1,
        "PASSWORDCHANGEATNEXTLOGIN": 0,
        "USERNAME": "Rowan.Carley"
    },
    {
        "ROLETYPEID": 1,
        "USERID": 7047,
        "DOMAINID": null,
        "CONTACTID": 1078532,
        "ROLEID": 2456,
        "ROLENAME": "Developer",
        "ACTIVE": 1,
        "PASSWORDCHANGEATNEXTLOGIN": 0,
        "USERNAME": "Tom.Chalmers"
    },
    {
        "ROLETYPEID": 1,
        "USERID": 7098,
        "DOMAINID": null,
        "CONTACTID": 1100635,
        "ROLEID": 2456,
        "ROLENAME": "Developer",
        "ACTIVE": 1,
        "PASSWORDCHANGEATNEXTLOGIN": 0,
        "USERNAME": "Ryan.dw"
    },
    {
        "ROLETYPEID": 1,
        "USERID": 6169,
        "DOMAINID": null,
        "CONTACTID": 965574,
        "ROLEID": 2288,
        "ROLENAME": "Test admin",
        "ACTIVE": 1,
        "PASSWORDCHANGEATNEXTLOGIN": 1,
        "USERNAME": "Custom"
    },
    {
        "ROLETYPEID": 1,
        "USERID": 6028,
        "DOMAINID": null,
        "CONTACTID": 884923,
        "ROLEID": 2386,
        "ROLENAME": "Client Services",
        "ACTIVE": 1,
        "PASSWORDCHANGEATNEXTLOGIN": 0,
        "USERNAME": "Meeta.Doolabh"
    },
    {
        "ROLETYPEID": 1,
        "USERID": 5217,
        "DOMAINID": null,
        "CONTACTID": 789951,
        "ROLEID": 2456,
        "ROLENAME": "Developer",
        "ACTIVE": 1,
        "PASSWORDCHANGEATNEXTLOGIN": 0,
        "USERNAME": "mark.g"
    },
    {
        "ROLETYPEID": 1,
        "USERID": 1559,
        "DOMAINID": null,
        "CONTACTID": 116482,
        "ROLEID": 2456,
        "ROLENAME": "Developer",
        "ACTIVE": 1,
        "PASSWORDCHANGEATNEXTLOGIN": 0,
        "USERNAME": "nathan1"
    },
    {
        "ROLETYPEID": 1,
        "USERID": 9946,
        "DOMAINID": null,
        "CONTACTID": 120194,
        "ROLEID": 2456,
        "ROLENAME": "Developer",
        "ACTIVE": 1,
        "PASSWORDCHANGEATNEXTLOGIN": 1,
        "USERNAME": "nathan.gordonski"
    }
]
print   print

resource /user/portalConfig/:userID

Description

Retrieve an aXcelerate User's Portal Configuration.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/user/portalConfig/:userID

Pattern: /user/portalConfig/:userID
Handler: api.user
Action: {GET={getPortalConfig}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/user/portalConfig/:userID
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service or AXToken Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
userID string true The User ID
Response Default Response Format: json

Samples

The portal configuration will be returned (If a configuration exists for the User Type) in a JSON object.

{
    "enquiry_response_text": "This is a Test",
    "config_name": "Sales Agent",
    "enrolment_response_text": "This is a Test",
    "step_order": [
        "contactSearch",
        "userLogin",
        "enquiry",
        "courses",
        "portfolio"
    ],
    "stylesheet_override": "test",
    "enroller_steps": {
        "portfolio": {
            "PORTFOLIOCHECKLISTID": null,
            "DISPLAY": "Documentation",
            "ID": "portfolio",
            "TYPE": "portfolio",
            "ISCRICOS": true
        },
        "enquiry": {
            "emailTo": null,
            "noteCodeID": "88",
            "DISPLAY": "Enquiry",
            "FIELDS": {
                "ReplaceWithID": {
                    "DISPLAY": "NewCustomField",
                    "ID": "ReplaceWithID",
                    "TYPE": "text",
                    "CUSTOM": true
                },
                "GIVENNAME": {
                    "DISPLAY": "Given Name",
                    "TYPE": "text"
                }
            },
            "ID": "enquiry",
            "TYPE": "course-enquiry"
        },
        "courses": {
            "DISPLAY": "Course",
            "COURSE_TYPES": [
                {
                    "DISPLAY": "Short Course",
                    "VALUE": "w"
                },
                {
                    "DISPLAY": "Qualification",
                    "VALUE": "p"
                }
            ],
            "ID": "courses",
            "TYPE": "courses"
        },
        "userLogin": {
            "DISPLAY": "Login",
            "ID": "userLogin",
            "TYPE": "user-login"
        },
        "contactSearch": {
            "contactList": null,
            "DISPLAY": "Contact",
            "ID": "contactSearch",
            "TYPE": "contact-search"
        }
    },
    "note_response_text": "This is a Test",
    "config_id": "77775374-e8d8-1104-0fe0-a3b3e6a9bde8"
}
print   print

resource /venues/

Description

A venue search. This method will return an array of venues. You can search on any field.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/venues/

Pattern: /venues/
Handler: api.venue
Action: {GET={search}, POST={search}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/venues/
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET,POST
Default: POST

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
offset numeric false 0 Used for paging - start at record.
displayLength numeric false 10 Maximum number of records to return (up to a system maximum of 100)
contactName string false Venue Contact Name
name string false The Name of the Venue
sAddress1 string false Venue address line 1.
sAddress2 string false Venue address line 2.
sCity string false Venue City.
sState string false Venue State.
sPostcode string false Venue Post Code.
mobilePhone string false Venue Contact mobile phone
Response Default Response Format: json

Samples

The Venue information will be returned in a flat object.

{
    "CONTACTNAME": "Joe",
    "NAME": "VM Learning",
    "SADDRESS1": "PO Box 1234",
    "SADDRESS2": null,
    "SCITY": "BRISBANE",
    "SSTATE": "QLD",
    "SPOSTCODE": "4000",
    "MOBILEPHONE": null
}
print   print

resource /cron/runMoodleCompletions

Description

This endpoint allows clients with Moodle intergation to run the completions for every course in their account. You can run this for specific instances or for all instances. If run for all instances, the actual process is done as a background process. If the verbose flag is used, this action returns a report of the completion running for individual courses. If running for all instances, the verbose report only returns the instances handed to the background process.

Service Entry Point(s)

PRODUCTION

https://admin.axcelerate.com.au/api

STAGING

https://stg.axcelerate.com.au/api
Resource URL & Event Translations
/cron/runMoodleCompletions

Pattern: /cron/runMoodleCompletions
Handler: api.cron
Action: {GET={runMoodleCompletions}}

URL Pattern Placeholders

The following patterns are part of the RESTful resource and must be passed in the exact position shown in the URL resource. Usually placeholders start with a (:) colon.

/cron/runMoodleCompletions
Route Pattern has no Placeholders
HTTP Request Methods

Supported: GET
Default: GET

HTTP Headers
Header Type Required Default Description
apitoken string true API Key value
wstoken string true Web Service Key value
HTTP Parameters

HTTP Parameters are passed to the resource via the URL or via FORM posts depending on the HTTP verb used.

Header Type Required Default Description
verbose boolean false true If set, returns a more verbose report.
type string false The type of course to run completions for. The only valid values are: 'el' (for E-Learning) and 'p' (for Programs)
instanceID numeric false The course ID.
Response Default Response Format: json

Samples

The return when the verbose flag is on and running for all courses.

{
    "COUNT": 3,
    "SUCCESS": true,
    "REPORT": [
        {
            "COURSENAME": "aXcelerate Quals Units Courses",
            "LEARNINGACTIVITYID": 343
        },
        {
            "COURSENAME": "Contact Management",
            "LEARNINGACTIVITYID": 553
        },
        {
            "COURSENAME": "Food Hygiene Level 1 ",
            "LEARNINGACTIVITYID": 999
        }
    ]
}

The return when the verbose flag is on and running for a single E-Learning courses. The parameter passed for this return would've been type=el, instanceID=555

{
    "COUNT": 2,
    "SUCCESS": true,
    "REPORT": [
        {
            "ERRORMSG": "",
            "COMPLETIONDATE": "July, 01 2015 09:35:03 +0000",
            "COMPLETE": true,
            "COURSENAME": "Hospitality for Cruise Ships",
            "LEARNINGACTIVITYID": 555,
            "LEARNERID": 32567,
            "UPDATED": true,
            "NAME": "Tom Steffensenburger"
        },
        {
            "ERRORMSG": "",
            "COMPLETIONDATE": "July, 01 2015 09:35:03 +0000",
            "COMPLETE": true,
            "COURSENAME": "Hospitality for Cruise Ships",
            "LEARNINGACTIVITYID": 555,
            "LEARNERID": 32575,
            "UPDATED": true,
            "NAME": "Michelle Ryan"
        }
    ]
}

HTTP Response Codes

All RESTful service APIs should return appropriate HTTP Status Codes for every request.

Code Description
200 Success!
201 Created. A new resource has been created successfully. The response body is either empty or contains a representation revealing the URI of the newly created resource.
202 Accepted. The request was valid and accepted but not yet processed. The response body should containe a URI to poll for status updates or a token assigned to this request. This allows for asynchronous REST requests.
204 No content. The request was successfull but the server has no response for it.
301 Moved permanently
302 Moved temporarily. The requested resource resides temporarily under a different URI. Since the redirection might be altered on occasion, the client SHOULD continue to use the Request-URI for future requests
400 Bad request. Look at the accompanying error messages to see why the request was invalid.
401 Unauthorized. Client not authorized to make the request.
403 Forbidden. The request is understood, but it has been refused. Look at the accompanying error messages to see why the request was invalid.
404 Not Found
405 Method Not Allowed. The requested method is not allowed for that resource
406 Not Acceptable. Cannot generate representation with given formats, headers or parameters.
410 Gone, the resource is no longer available.
500 Internal service error.
503 Service unavailable. Maybe too many requests.

FAQ

The following are frequently asked questions on the aXcelerate RESTFul Service API

resource What is a course and what are course types?

Answer

In aXcelerate terminology, a course is any learning activity. It could be a face-to-face short course, or a fully accredited 2 year Program. The difference is determined by the course type. Currently, there are 3 types:
w : workshop / short course, Note: Workshop Types have instances which essentially are scheduled 'training events';
p : program / class, Note: An instance of a program is a 'class';
el : E-learning.

resource Why doesn't my course appear?

Answer

There are a few setting you need to ensure are on for courses to appear in your course listings. These differ according to types and whether you are trying to get courses or course instances.

Workshops (type=w)

  • To return the course, the workshop type must be Active
  • The workshop type must be set to Display in Bookings Calendar = yes
  • The workshop type must be set to Online Outline accessible? = yes
  • To return the course instances given an ID, the workshop instance must be active
  • If returning current instances, the workshop instance must have an End Date in the future
  • If you are only returning public instances, the workshop instance coordination type must be Public and its type must have Display in Bookings Calendar = yes

Programs (type=p)

  • To return the course, the Program must have Display Web Outline = yes
  • The Program must be Active
  • In order for the full outline to be displayed, the Program Full Outline must be set to: Currently Active = yes. This is set in the Edit Full Outline page for a Program.
  • If returning current class instances given an ID, the class must be active and the class End Date must be in the future.

E-Learning (type=el)

  • The return an E-learning course it must be Public
  • If only returning current courses, today's date lies between the Access Start and Access End Dates
  • For E-Learning, you can usually get any instance given ID, since the ID and instance ID are the same (E-Learning has no concept of type and instance). However, if you are only getting current or public instances, the values are checked as above.

resource What is the difference between a course and a course instance?

Answer

Every course that can be enrolled or booked into has two different IDs. First is the ID, which you can think of as the template ID that defines the course. The other is the instanceID, which describes an instance of that course. For example, you may have one workshop called Advanced First Aid Training set up that has ID=343. You might offer this workshop once a week. In this case, each instance of this workshop of each week will have a different instanceID, but they will all have the one ID (343 in this example). You, of course, must use the instanceID to enrol a student into this workshop, because without it, you wouldn't know which week they were planning to attend.

resource How are course IDs and course instanceIDs mapped?

Answer

The course API uses generic identifiers (type, ID, instaceID) for the different types of courses. Often developers want to know what these generic IDs map to in aXcelerate, especially for testing purposes. The following table will show you, by course type, where the ID and instanceID can be found in aXcelerate.

Workshops (type=w)

ID is the ProgramCodeID or PCID. This can be found in the URL when you visit the workshop type edit page. Go to Workshops > Update Workshop Type and choose a type.
instanceID is the PDataID. This can be found either in the URL when viewing a workshop or directly on the view page under Workshop ID
Note: The term Workshops is customisable terminology and may be called something different in your account.

Programs (type=p)

ID is the DiplomaID or DID. This can be found in the URL when visit the Program edit page. Go to Accredited Training > Programs and click on any to edit.
instanceID is the ClassID. This can be found in the URL when viewing a class. Go to Accredited Training > Classes and click on any class.
Note: The terms Program and Class are customisable terminology and may be called something different in your account.

E-Learning (type=el)

Since E-Learning does not have the concept of template and instance, both the ID and instanceID are the same value. This is the learningActivityID and can be found in the URL when viewing or editing an E-Learning activity. Navigate to the desired activity from the E-Learning menu item.
Note: E-Learning is an optional add-on feature and may not be available in your account.

resource What are the conditions in order to enrol into a course?

Answer

The course API uses set business rules to determine if enrolment is open for any particular course instance. These rules differ depending on the type of course:

Workshops (type=w)

  • The Coordination Type must be a Public workshop (In House courses are not supported)
  • It cannot be Archived
  • The Start Date cannot have passed. Enrolment will remain open as long as the current date is on or before the start date.
  • If Close Days are set, enrolment will remain open as long as the current date is on or before the number of close days before the start date.

Programs (type=p)

  • The class cannot be Archived
  • The class cannot have finished. Enrolment will remain open as long as the current date is on or before the class end date.
  • If Close Days are set, enrolment will remain open as long as the current date is on or before the number of close days before the start date.
  • If the class is set up so that Scheduled activity start and end dates apply to all Students then the class Start Date cannot have passed.

E-Learning (type=el)

  • The course must be Public
  • The course must be Active
  • If set, the course Access Start Date must have passed. Note this is very different to how the others work! The start date means the start of enrolment being open for this E-Learning activity.
  • If set, the course Access End Date must not have passed.

resource When using the RelaxURL Console why I am getting a Request Status of 204 No Content?

Answer

This status indicates just what it says, there is no content. Check your API Paramentes. It is possible you have left some parameters out, for example not including an ID in GET /course/instances

resource What happens when course/enquire is called?

Answer

There are a few things that happen for an enquiry.

  1. The first thing that happens is that a note is added against the contact record. The type of the note can be explicitly defined by passing the noteCode parameter. The contents of the enquiry will be the contents of the note.
  2. An unassigned marketing opportunity and follow-up will also be created in the system, so that someone can follow it up. If the enquiry is against a course, the amount of the course will be the opportunity amount.
  3. If the emailTo parameter is passed, an email is sent by the system to each email, notifying them about the enquiry.

resource What is the workflow for enrolling a student?

Answer

Enrolling a student involves several API calls. These are:

  1. First, if needed, create the contact using a POST call on the contact API. This gives you a contactID for the student.
  2. You will also need the course instanceID and type that they will be booking on. (GET course/instances)
  3. Use the contactID, the instanceID, and the type in order to make a POST call to the payment API. This will return an invoiceID if the payment is successful.
  4. Finally, call the course/enrol API, passing the invoiceID, contactID, instanceID and type. It is this final call that will book the student and link the paid invoice to their booking.

resource I'm getting strange behaviour in this Relax Console when I try and post list data?

Answer

There are a few quirks to be aware of when testing with this relax tool. One is posting list data as a parameter, or any data that has a comma (,)
Because of they way this console works, you cannot have a comma anywhere in your parameters when testing. If you want, for example, to try and use the course/enrolMultiple resource and enrol more than one contact, you must add a contactIDs parameter for each contactID. Please note that this bug is only in this relax console. The APIs work fine sending a single parameter for contactIDs separated by commas.

resource How can I verify returning users?

Answer

This can be done using the contact search method. With the contact search, you can search on almost any values. You could run a search on emailAddress and Password and then use the returned contactID if results are found and returned. The passwords are different from the standard aXcelerate user passwords and can be stored against any contact. They can be set in aXcelerate or by using the API. Note that with these passwords, no minimum strength checking is performed by the service. It is up to the API implementors to enforce their own password policies.

resource What do the numbers refer to in the contact Citizenship Status field?

Answer

These numbers are internal codes for aXcelerate. Since many different departments, such as the Department of Education and AVETMISS, code citizenship status differently, we simply use our own. The codes are:

{
	1 = "Australian Citizen",
	2 = "New Zealand Citizen",
	3 = "Australian Permanent Resident",
	4 = "Student Visa",
	5 = "Temporary Resident Visa",
	6 = "Visitor's Visa"
	7 = "Business Visa",
	8 = "Holiday Visa",
	9 = "Other Visa",
	10 = "Permanent Humanitarian Visa",
	11 = "Overseas - No Visa or Citizenship"
}

Are you sure?

Are you sure you want to perform this action?


loader