| TITLE | VALUE | |
|---|---|---|
| NAME | MAGG REASON GET PROPERTIES | |
| DESCRIPTION | This remote procedure returns the reason properties from the MAG REASON file (#2005.88) | |
| TAG | GET | |
| ROUTINE | MAGGA01 | |
| INPUT PARAMETERS | SEQUENCE NUMBER | 1 |
| INPUT PARAMETER | RSNID | |
| DESCRIPTION | Identifier of the reason: Internal Entry Number of the record in the MAG REASON file (#2005.88) or the reason code (see the FLAGS parameter). | |
| PARAMETER TYPE | LITERAL | |
| REQUIRED | YES | |
| MAXIMUM DATA LENGTH | ||
| INPUT PARAMETERS | SEQUENCE NUMBER | 2 |
| INPUT PARAMETER | FLAGS | |
| DESCRIPTION | Flags that control execution (can be combined): C By default, value of the RSNID parameter is treated as the reason IEN. If this flag is provided, then the reason code should be passed as the value of the RSNID. F Include full details (description text). By default, only the summary data is returned. | |
| PARAMETER TYPE | LITERAL | |
| REQUIRED | ||
| MAXIMUM DATA LENGTH | ||
| RETURN VALUE TYPE | ARRAY | |
| RETURN PARAMETER DESCRIPTION | Zero value of the first '^'-piece of the Results[0] indicates that an error occurred during the execution of the procedure. In this case, the errors are returned in the Results array as shown below: Results[0] Result descriptor ^01: 0 ^02: Message Results[i] Error descriptor ^01: Error code ^02: Message ^03: Error location ^04: Message type Results[j] Line of the additional info (optional) ^01: "" ^02: Text Otherwise, the Results[0] contains '1^OK' and the reason summary and description are returned in the subsequent elements of the Results array as follows: Results[1] Reason summary ^01: IEN of the reason (file #2005.88) ^02: Text of the reason ^03: Types of the reason (combination of "C", "D", "P", and/or "S") ^04: Date of inactivation (FileMan). ^05: Unique code of the reason (only for standard reasons distributed nationally; reasons defined by the sites do not have codes). Results[1+i] Line of the description of the reason (optional) ^01: "D" ^02: Text line The description text is returned only if the value of the FLAGS parameter contains "F" and the DESCRIPTION field (1) of the MAG REASON file (#2005.88) is not empty. | |
| AVAILABILITY | RESTRICTED | |
| INACTIVE | ||
| CLIENT MANAGER | ||
| WORD WRAP ON | TRUE | |
| VERSION | ||
| SUPPRESS RDV USER SETUP | ||
| APP PROXY ALLOWED | ||