Dossier Filtering

Hint

Dossier Filtering is a feature that allows you to filter the list of dossiers displayed in the Dossier List View. You can use it to filter the list of dossiers by the dossier’s attributes, by the dossier’s state or with more complex filters.

Basic filtering : Retrieving a specific dossier

The function get_dossiers allows you to retrieve all dossiers of a demarche. You can pass a filter argument to this function to filter the list of dossiers. Let’s retrieve a dossier by its number :

from demarches_simpy import Profile, Dossier, Demarche, DossierState

# Create a profile
profile = Profile('API_KEY',verbose=True)

# Create a dossier
demarche = Demarche(000000, profile, verbose=False)


specific_dossier = demarche.get_dossiers(-1, lambda dossier : dossier.number == 1234567)

print(len(specific_dossier)) # 1

Note

The ‘-1’ argument passed to the function indicate that we don’t want a limit on the number of dossiers returned. If you want to retrieve only one dossier, you can pass 1 as the limit argument.

Background fetching

The id or the number of a dossier is part of the Dossier object. We don’t need to fetch the dossier to retrieve its id or number. That’s why it will be fast. But if we want to apply a filter on a property (which will be fetched) we need to enable bakcground_fetching option, which will fetch the dossier in background. It will increase the speed of the research. If you don’t enable this option it will work but it will take longer.

## Background fetching

# Define a filter function
def filter(dossier : Dossier):
    return dossier.state == DossierState.INSTRUCTION


# Get all dossiers in Instruction State
filtered_dossier = demarche.get_dossiers(-1,dossier_filter=filter, background_fetching=True)

Advanced usage

We saw that background_fetching will fetch property in background. But if the property is conditionnal it won’t be fetched. For instance ‘fields’ of a dossier is conditionnal. If you want to filter on a conditionnal property you need to enable them at default by using default_variables dict.

## Advanced usage

def filter(dossier : Dossier):
    for field in dossier.get_fields():
        if field.stringValue == 'foo':
            return True
    return False

advanced_filtered_dossier = demarche.get_dossiers(-1,dossier_filter=filter, background_fetching=True, default_variables={"includeFields": True})

Full example

from demarches_simpy import Profile, Dossier, AnnotationModifier

# Create a profile
profile = Profile('API_KEY',verbose=True)

# Create a dossier
dossier = Dossier(000000, profile)


# Assign an instructeur_id

# First method 
profile.set_instructeur_id('instructeur_id')

# Second method 
## Only works if the dossier is not in CONSTRUCTION state
instructeurs = dossier.get_attached_instructeurs_info()
instructeur = instructeurs[0]

# print(instructeur)
# > {'id': 'instructeur_id', 'email': 'mail@mail.com'}

profile.set_instructeur_id(instructeur['id'])

# Create the annotation action

action = AnnotationModifier(profile, dossier)

# Get an annotation

annotation = dossier.get_annotations()['annotation-label']

# print(annotation)
# > {'id': 'annotation_id', 'stringValue' : 'value'}

# Modify the annotation

annotation['stringValue'] = 'new_value'

# Perform the action

result = action.perform(annotation)

if result == AnnotationModifier.NETWORK_ERROR:
    print("Network error")
elif result == AnnotationModifier.SUCCESS:
    print("Success")