Some API functions that return lists of SUBSCRIPTIONS (e.g. subscription_list()) accept a filter expression to limit the amount of results returned.

Note that independently of the filter, only the SUBSCRIPTIONS where the session user is a member will be returned. The filter can be used to provide a more accurate selection.

The filter is expressed in JSON format, and the possible filter fields are:

• program: List of PROGRAM identifiers separated by commas. If informed, only the SUBSCRIPTIONS from that PROGRAMs will be returned
• program_active: (0|1) indicates whether the PROGRAM must be active or not. If no value is provided, the default value is 1
• protocol: List of PROTOCOL identifiers separated by commas. If informed, only the SUBSCRIPTIONS from that PROTOCOLs will be returned
• subscription: List of SUBSCRIPTION identifiers separated by commas. If informed, only the SUBSCRIPTIONS indicated will be returned
• subscription_status: (0|1|ALL) List of SUBSCRITPION status separated by commas (0 = Inactive, 1 = Active). indicates whether the SUBSCRIPTION must be active or not. If no value is provided, the default value is 1 (Only active SUBSCRIPTIONS)
• subscription_locked: (0|1) indicates whether the SUBSCRIPTION must be locked or not. If empty, all SUBSCRIPTIONs are returned
• member_role: A list of ROLE identifiers separated by commas (see ROLE OBJECT). If informed, only the subscriptions where the session user has the specified ROLE/s will be returned
• member_team: A list of TEAM identifiers separated by commas. If informed, only the subscriptions where the session user is member in the indicated TEAM/s will be returned
• admission_status: If informed, only SUBSCRIPTION that contain ADMISSIONS with the specified status (a list of STATUS identifiers separated by commas), otherwise, all SUBSCRIPTIONS. See ADMISSION.STATUS CODE
• task_status: If informed, only SUBSCRIPTIONS that contain TASKS with the specified status (a list of STATUS identifiers separated by commas), otherwise, all SUBSCRIPTIONS. See TASK STATUS OBJECT

Example

{
"program" : "34",
"program_active" : "1",
"protocol" : "903",
"subscription" : "253 , 254",
"subscription_status" : "1",
"subscription_locked" : "0",
"subscription_role" : "39 , 41",
"subscription_team" : "563",
"admission_status" : "1,5",
"task_status" : "12, 13",
}

NOTE: Each function can support all or only part of the field filters. When calling to API functions it is not necessary to include empty filters.