Verifies whether an award/certificate exists, based on the client's name and award parchment number, and if so, returns its details.
Specify the given name, surname and parchment number of an award to verify. The surname and parchmentNumber fields are mandatory. For a single-name client, specify the single name in the surname field, and leave the givenName blank.
If the specified details exactly match a single award in VETtrak, and that award is marked as being available for verification in VETtrak, the details of the award and its units are returned in a TQucl object.
A token is passed for authentication. If the authentication fails, or other errors occur, no award is returned. The result of the authentication is represented by a TAuthenticate object. If no or multiple matching awards are found, no award is returned, and the returned TAuthenticate will have a Status of -4 (STATUS_NO_RECORDS).
This function has security level "Protected", and can only be accessed by users that have explicitly been granted permission to the API.
[WebMethod(Description = "Verifies the existence of an award and returns its details")] public TAuthQucl VerifyAward(string token, string givenName, string surname, string parchmentNumber);
Parameters |
Description |
string token |
String token. |
string givenName |
Given/first name of client with award. Leave blank for a single name. |
string surname |
Surname or single-name of the client with award. |
string parchmentNumber |
Parchment/certificate number of award. |
Copyright (c) VETtrak 2022. All rights reserved.
|