Add Remove User from Address List - OMADLUSR
Add/Remove User from Address List (OMADLUSR)
Required Parameter Group:
| 1 | Function Code | Input | Char(1) |
| 2 | Address List Identifier | Input | Char(10) |
| 3 | User Identifier | Input | Char(10) |
| 4 | Return Status | Output | Char(1) |
API Overview:
The Add/Remove User from Address List API (OMADLUSR) is used to add or remove users to existing QTRACS address lists. This API has no interactive display components. This API provides a reliable and easy to use mechanism for external applications to add/remove members to an address list without using the QTRACS user interface. In addition, this API will optionally add or remove unseen messages from the specified user's mailbox.
Some QTRACS address lists may be defined to be a 'coverage', meaning all members of the address list are actually dispatchers responsible for covering a fleet. Using this API, it is possible for a dispatcher to add or remove himself from a coverage.
Required Parameter Group Details:
(1) Function Code
INPUT; CHAR(1)
This parameter is a function code that instructs the API what action to perform. Valid values are:
| A | Add user to address list and give him a copy of any unseen messages that exist for the address list |
| R | Remove user from address list and remove his copy of any unseen messages that he received because of his membership in the address list |
| 1 | Add user to address list, but do not add any unseen messages to his mailbox |
| 2 | Remove user from address list, but do not remove any unseen messages from his mailbox |
(2) Address List Identifier
INPUT; CHAR(10)
This parameter must contain the address list to be modified.
(3) User Identifier
INPUT; CHAR(10)
This parameter must contain the user to be added or removed from the specified address list.
(4) Return Status
OUTPUT; CHAR(1)
Status value returned to the caller will be set as follows:
| 0 | Success, request complete |
| 1 | Failure, request not completed |
Effect
Calling this API from some external application may result in the addition or removal of a QTRACS user to/from a QTRACS address list.
The following conditions are considered errors (return status will be returned as '1'):
- Function code is not A, R, 1, or 2.
- User identifier is not a valid QTRACS user
- Address list identifier is not a valid QTRACS address list
- A request is made to delete the one (and only) member of an address list. Address lists must always have at least one member.
- Adding another user to the list causes the address list to exceed the maximum membership limit. This limit is specified in the Account Preferences section of the System Configuration.
The following conditions are not considered errors (return status will be returned as '0'):
- A request to remove a member completes normally.
- A request to remove a member cannot be completed because the user does not currently exist as a member of the address list.
- A request to add a member completes normally.
- A request to add a member cannot be completed because the user already exists as a member of the address list.
Adding or removing a member from an address list may have an effect on that member's unseen messages:
- If function code A is specified, then the system will add the member to the specified address list, and it will update the new member's mailbox with any unseen messages that currently exist for that address list.
- If function code R is specified, then the system will remove the member from the specified address list, and it will remove all unseen messages from the member's mailbox that he received as a result of his former membership in that address list.