ASP.NET VETtrak API web services
ContentsIndexHome
PreviousUpNext
VT_API.GetStudyReasonsForOccurrence Method

Get a list of Study Reasons applicable to an occurrence or booking. 

This is an public AVETMISS list of "reasons for study" that are valid for enrolments in the occurrence, based on the state of the occurrence's location and the reportability of the occurrence. 

Pass in the ID of the occurrence or booking to get study reasons for. 

Each Study Reason item is represented by a TStudyReason. The collection of Study Reason items is represented by a List of TStudyReason

A token is passed for authentication. If the authentication fails, or other errors occur, no study reasons are returned. The result of the authentication is represented by a TAuthenticate object. 

Requires a valid registration key entry for the Short Courses feature. 

This function has security level "Unrestricted", and can be accessed by any authenticated user.

C#
[WebMethod(Description = "Gets a list of study reasons applicable to an occurrence")]
public TAuthStudyReasonList GetStudyReasonsForOccurrence(string token, int occurrenceId);
Parameters 
Description 
string token 
String containing a token. 
int occurrenceId 
Integer of the ID of the occurrence or booking to get study reasons for. 

TAuthStudyReasonList : an authenticated list of Study Reason items applicable to the specified occurrence.

Copyright (c) VETtrak 2022. All rights reserved.