SYNOPSIS

int MGOgetsubscriptions_ext (Subscription **lst, Subscription *sub, Validation *val, int map);

DESCRIPTION

The MGOgetsubscriptions_ext() function returns a list of subscriptions (implicit and/or explicit) for the given uwnetid. Information is passed through sub and val and returned through the linked list lst. The required and optional fields are:

• sub.uwnetid (o)
• sub.subscription_code (o)
• sub.status_code (o)
• val.validid (o)
• val.ein (o)
• val.ssn (o)
• val.studentid (o)
• val.system_key (o)
• val.account (o)
• val.advanceid (o)
• val.regid (o)
• val.source_code (o)

sub.uwnetid is the uwnetid name. sub.subscription_code is the subscription reference code. val.validid is the validation id. val.source_code is the validation source reference code. val.ein is the employee number. val.ssn is the social security number. val.studentid is the student number. val.account is the AVF account name. val.system_key is the student system key value. val.advanceid is the advance number. val.regid is the registry id. map is the validation source code expiration map. This field instructs MGOgetsubscriptions_ext() on how it should treat a validation status_code for the given validation source. The value is as follows (specify "0" to disable this feature):

• +[validation source_code] - assume current
• -[validation source_code] - assume expired
• +[category_code * 100] - assume current
• -[category_code * 100] - assume current

Note: Searching by uwnetid will return both the implicit and explicit subscriptions, while searching by validid, ein, ssn, studentid, system_key, account, advanceid or regid will return only the implicit subscription list.

The following fields are set for each matched subscription. The values between the brackets indicate these fields are set depending on whether its an implicit or an explicit subscription (see note below).

• lst.next
• lst.uwnetid
• lst.subscription_code
• lst.subscription_name
• lst.subscription_data
• lst.permit [e]
• lst.permit_by [e]
• lst.permit_source [e]
• lst.permit_exp [e]
• lst.deny [e]
• lst.deny_by [e]
• lst.deny_source [e]
• lst.deny_exp [e]
• lst.notify_code [e]
• lst.notify_date [e]
• lst.category_code [i]
• lst.category_name [i]
• lst.notify_code
• lst.notify_date
• lst.source_code [i]
• lst.source_name [i]
• lst.status_code
• lst.status_name

Notes: lst.source_code is non-zero if it's an implicit subscription, and zero if it's an explicit subscription. Implicit subscriptions are inhereted by virtue of being affiliated with a particular validation, whereas explicit subscriptions are granted individually. The lst.status_code and lst.status_name fields are set as follows: For implicit subscriptions, this is the validation reference status; for explicit subscriptions, this is the subscription reference status.

RETURN VALUE

Returns the number of subscriptions found upon success or -1 if an error occurred (in which case MGOerrno and MGOerrmsg are set appropriately).

ERRORS

• MGO_E_MAR - One or more of the required arguments were missing
• MGO_E_IAR - Invalid or ambiguous argument
• MGO_E_PMD - Permission denied. See access control
• MGO_E_MAT - No matches found given the selection criteria
• MGO_E_VNV - The given validation information is not valid
• MGO_E_SQL - An SQL error occurred. See MGOerrmsg for details

AUTHENTICATION LEVEL

rmango

SEE ALSO

MGOanalsubscription(), MGOfreesubscription(), MGOselrsubscription(), MGOselrsubstatus(), MGOselrvalstatus(), MGOzero()