TITLE | VALUE | |
---|---|---|
NAME | SDES GET LETTERS BY TYPE | |
DESCRIPTION | This RPC will retrieve a list of letters from the LETTER file ($407.5), given the letter type (required), and text to match (optional). Can only be invoked by Acheron | |
TAG | GETLETTERSBYTYPE | |
ROUTINE | SDES2 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 1 |
INPUT PARAMETER | TYPE | |
DESCRIPTION | This is the type of letter from the LETTER TYPE file (#407.6). Currently the values are: N - No show A - Appointment Cancellation P - Preappointment Cancellation C - Clinic Cancellation | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | 1 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 2 |
INPUT PARAMETER | TEXT | |
DESCRIPTION | This is the text used to match record entries. If 'CHY' is passed, only records that begin with 'CHY' will be returned. This text match is in addition to the type provided. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 15 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 3 |
INPUT PARAMETER | BRIEF | |
DESCRIPTION | This flag indiciates that the calling application wants a 'brief' list, instead of the 'verbose' list. The verbose list contains the letter text, resulting in a larger returned data set. It may be advantageous in some cases to retrieve a brief list, and use SDES GET LETTER BY IEN to retrieve the details. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 1 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 4 |
INPUT PARAMETER | EASTRCKNGNMBR | |
DESCRIPTION | Enterprise Appointment Scheduling (EAS) Tracking Number associated to an appointment. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 40 | |
RETURN VALUE TYPE | ARRAY | |
RETURN PARAMETER DESCRIPTION | A list of letters (brief or verbose), following the below format. The Brief version - will not include 'Initial Section' and 'Final Section'. { "Letter": [ { "FinalSection": [ "If you would like to reschedule your appointment please call us at ", "(xxx)xxx-xxxx x1234 or toll free at 1-(xxx)xxx-xxxx x1234. We apologize", "for the inconvenience.", " ", " ", "Thank you for your service,", " ", "Cheyenne VAMC Dental Clinic" ], "ID": 192, "InitialSection": [ "This letter is to inform you that the following appointment has been ", "cancelled:" ], "Name": "CHY DENTAL CC", "PrintClinicLocation": "", "PrintDefaultProvider": "", "Type": "CLINIC CANCELLED " } ] } | |
AVAILABILITY | RESTRICTED | |
INACTIVE | ACTIVE | |
CLIENT MANAGER | ||
WORD WRAP ON | FALSE | |
VERSION | ||
SUPPRESS RDV USER SETUP | ||
APP PROXY ALLOWED | Yes |