Meshed Group Web API for cricos platform

Introduction

DOTEDU Web API - CRICOS by WebSutra Technology Pty Ltd is developed with Microsoft ASP.NET WEB API2.2, with OAuth2.0 Security Bearer Token. Over the wire, all data communication will be encrypted SSL HTTP protocol.

API to call

Get access-token via '/token' url with valid user credential.
[See more detail of Bearer Token with individual local account in http://www.asp.net/web-api/overview/security/individual-accounts-in-web-api].
- Please keep your token in the safe place as it represents your unique credential to access the API resource and perform the action.
- Bearer Token will be valid 24 hours after request. We intend not to persist the token permanently for the security reason. If your token is expired, you need to request a new token again as step 1, to access the restricted resource.
Then use that token for resource access as part of resource authorization.
All the root path of resouces to call start with as below, based on the user product type;
1. RTOManager-Cricos: '/api/{Version}/{Resource}/{?id}/{?filterquery}'.

CampusV1

Endpoint	Description
GET api/V1/Campuses?campusid={campusid}&courseid={courseid}&vcode={vcode}&vsuburb={vsuburb}&vstate={vstate}&vpostcode={vpostcode}&vcountry={vcountry}&refresh={refresh}	Get all campuses information list [Optional] You can filter campuses result with specific search filter by query strings E.g. GET 'api/V1/Campuses' GET 'api/V1/Campuses?vstate=NSW' GET 'api/V1/Campuses?vstate=NSW&courseid=BSB50207'
GET api/V1/Campuses/{id}	Get campus information by particular campus id
GET api/V1/Campuses/{id}/Venues?vcode={vcode}&vsuburb={vsuburb}&vstate={vstate}&vpostcode={vpostcode}&vcountry={vcountry}	Get associated venues/training locations list by specific campus. [Optional] You can filter venues/training locations result with specific search filter by query strings. E.g. GET 'api/V1/Campuses/{id}/Venues' GET 'api/V1/Campuses/{id}/Venues?vstate=NSW' GET 'api/V1/Campuses/{id}/Venues?vstate=NSW&vcountry=Australia'
GET api/V1/Campuses/{id}/Courses?active={active}&ctype={ctype}&courseid={courseid}&natcode={natcode}&campusid={campusid}&refresh={refresh}	Get associated courses/qualifications information list by specific campus. [Optional] You can filter courses result wiht specific search filter by query strings. E.g. GET 'api/V1/Campuses/{id}/Courses' GET 'api/V1/Campuses/{id}/Courses?active=true' GET 'api/V1/Campuses/{id}/Courses?active=true&ctype=VET'

CourseV1

Interface for courses information. Restricted by resource owner from valid RTOManager client.

Endpoint	Description
GET api/V1/Courses?active={active}&ctype={ctype}&courseid={courseid}&natcode={natcode}&campusid={campusid}&refresh={refresh}	Get all courses information list [Optional] You can filter courses result with specific search filter by query strings E.g. GET 'api/V1/Courses' GET 'api/V1/Courses?active=true' GET 'api/V1/Courses?active=true&ctype=VET'
GET api/V1/Courses/{id}	Get course information by particular course Id
GET api/V1/Courses/{id}/Campuses?campusid={campusid}&courseid={courseid}&vcode={vcode}&vsuburb={vsuburb}&vstate={vstate}&vpostcode={vpostcode}&vcountry={vcountry}&refresh={refresh}	Get associated campus list by particular course Id. You can do more campus search filter by query string. Detail refers to GET 'api/V1/Campuses/{id}/Venues?vstate=NSW', for example.
GET api/V1/Courses/{id}/CourseIntakes?campusid={campusid}&publish={publish}&coursetype={coursetype}&year={year}&courseid={courseid}&intakedate={intakedate}&finishdate={finishdate}&targetfor={targetfor}&refresh={refresh}	Get associated intake dates list by particular course Id. You can do more course intakes search filter by query string. Detail refers to GET 'api/V1/CourseIntakes?year=2015&publish=true&targetfor=Local', for example.

CourseIntakeV1

Endpoint	Description
GET api/V1/CourseIntakes?campusid={campusid}&publish={publish}&coursetype={coursetype}&year={year}&courseid={courseid}&intakedate={intakedate}&finishdate={finishdate}&targetfor={targetfor}&refresh={refresh}	Get all course intake date information list. [Suggestion] give course intake search filter value to narrow down data returned. Key filter parameter should be used by default is 'year', 'publish' and 'targetfor' E.g. GET 'api/V1/CourseIntakes?year=2015&publish=true&targetfor=Local' GET 'api/V1/CourseIntakes?year=2015&publish=true&targetfor=Local&intakedate=1/1/2015' GET 'api/V1/CourseIntakes?year=2015&publish=true&targetfor=Local&intakedate=1/1/2015-' GET 'api/V1/CourseIntakes?year=2015&publish=true&targetfor=Local&intakedate=1/1/2015-28/2/2015' GET 'api/V1/CourseIntakes?year=2015&publish=true&targetfor=Local&intakedate=1/1/2015-&finishdate=-30/12/2015'

Endpoint

Description

GET api/V1/CourseIntakes?campusid={campusid}&publish={publish}&coursetype={coursetype}&year={year}&courseid={courseid}&intakedate={intakedate}&finishdate={finishdate}&targetfor={targetfor}&refresh={refresh}

Get all course intake date information list.

[Suggestion] give course intake search filter value to narrow down data returned.

Key filter parameter should be used by default is 'year', 'publish' and 'targetfor'

E.g.

GET 'api/V1/CourseIntakes?year=2015&publish=true&targetfor=Local'
GET 'api/V1/CourseIntakes?year=2015&publish=true&targetfor=Local&intakedate=1/1/2015'
GET 'api/V1/CourseIntakes?year=2015&publish=true&targetfor=Local&intakedate=1/1/2015-'
GET 'api/V1/CourseIntakes?year=2015&publish=true&targetfor=Local&intakedate=1/1/2015-28/2/2015'
GET 'api/V1/CourseIntakes?year=2015&publish=true&targetfor=Local&intakedate=1/1/2015-&finishdate=-30/12/2015'

Classification

Endpoint	Description
GET api/Classification/AUStates	Get Australian state list that works with RTOManager system. Used only when country is 'Australia'.
GET api/Classification/Countries	Get country list that was setup in RTOManager system.
GET api/Classification/Disabilities	Get AVETMISS disability classification list.
GET api/Classification/EmploymentStatuses	Get AVETMISS current employment status classification list.
GET api/Classification/EnglishTests	Get default English test types list available from RTOManager system.
GET api/Classification/Genders	Get gender classification list, that works with Governmental data reporting. Use Value to record Student Gender.
GET api/Classification/HighSchoolLevels	Get AVETMISS high school levels classification list.
GET api/Classification/HowWellSpeakEngCodes	Get AVETMISS how well speaking English classification codes list.
GET api/Classification/IndustryOfEmployments	Get AVETMISS industry of employments classification list. This is mandatory for VICTORIA STATE DET to Student Compliance Info (IndustryEmployment).
GET api/Classification/KnowFroms	Get existing CRM KnowFrom list that was setup in RTOManager system.
GET api/Classification/Languages	Get AVETMISS languages classification list, that was setup in RTOManager system.
GET api/Classification/LeadSources	Get existing CRM LeadSources list that was setup in RTOManager system.
GET api/Classification/MarketingCampaigns	Get existing CRM Marketing Event/Campaign names list that was setup in RTOManager system.
GET api/Classification/NameTitles	Get AVETMISS person name titles classification list.
GET api/Classification/OccupationCodes	Get AVETMISS occupation codes classification list. It's mandatory for VICTORIA STATE DET to Student Compliance Info (OccupationCode).
GET api/Classification/QualificationAchievementRecognitions	Get AVETMISS qualification achievement recognition codes list. It's mandatory for VICTORIA STATE DET to Student Education History (AchievementRecognitionCode).
GET api/Classification/QualificationLevels	Get AVETMISS education qualification levels classification list. It will be used with Student Education History (EducationLevelCode).
GET api/Classification/StudyReasonCodes	Get AVETMISS study reasons classification list. It will be used with Student Compliance Info (StudyReason);
GET api/Classification/VisaStatuses?Origin={Origin}	Get visa status list that is specific used with RTOManager system, based on student Origin.
GET api/Classification/SchoolTypes	Get AVETMISS school types classification list. It will be used with Student Compliance Info (IsStillAtHighSchool).

StudentOfferV1

Interface for student offers/application. Restricted by resource owner from valid RTOManager client.

Endpoint	Description
GET api/V1/StudentOffers?offerid={offerid}&firstname={firstname}&lastname={lastname}&countrybirth={countrybirth}&dateapplied={dateapplied}&intakedate={intakedate}&status={status}	Get all student information list (only latest 500 students, if no URI parameter filter provided.) [Optional] You can filter student result with specific search filter by query strings E.g. GET 'api/Vet/V1/StudentOffers' GET 'api/Vet/V1/StudentOffers?dateapplied=17/11/2015' GET 'api/Vet/V1/StudentOffers?dateapplied=17/11/2015&firstname=John' GET 'api/Vet/V1/StudentOffers?offerid=9876&intakedate=17/11/2015'
GET api/V1/StudentOffers/{id}	Get student offer information by specified offer id.
POST api/V1/StudentOffers	Submit a new application by direct apply.
POST api/V1/StudentOffers/Validate	Validate a new application before submit the application.
GET api/V1/StudentOffers/USI?id={id}&firstname={firstname}&lastname={lastname}&dateofbirth={dateofbirth}&usi={usi}	Validate provided student USI before submit the application.
POST api/V1/StudentOffers/USI	Validate provided student USI before submit the application. Remarks: The integration service is configured with USI Service live environment (regardless of live or sandbox WEB API).