Vulnerabilities API

[giohappy]

REST APIs to list, filter and obtain details for vulnerability and fragility functions.

Filtering

• bbox: filter vulnerabilities according to the countries they're tied to (iso codes).
• type: "vulnerabilities functions" | "fragility functions" | "damage to loss functions"
• exposures (assets field)
• hazards

Details for "vulnerability functions"

show vulnerability detail info, with the following fields:

(talic fields are dervied)

• id integer
• hazard
• asset
• taxonomy
• geographical applicability (array of country names)
• scale_applicatibility
• reference_table.author_year
• reference_table.title
• vf_relationship
• vf_math
• vf_math_model
• function - array of dict obtained from splitting and zipping the following fields:
  • par_names
  • ub_par_value
  • med_par_value
  • lb_par_value
• im_range
• im_data_source
• im_name_f
• im_table.definition (join)
• im_table.units (join)
• im_table.range (join)
• lp_name
• loss_parameter.description (join)
• loss_parameter.units (join)

Details for "fragility functions"

(talic fields are dervied)

• id
• hazard
• asset
• taxonomy
• geographical applicability (array of country names)
• scale_applicability
• reference_table.author_year
• reference_table.title
• ff_math_modelf
• ff_relationship
• ff_math
• function - array of dict obtained from splitting and zipping the following fields:
  • par_names
  • ub_par_value
  • med_par_value
  • lb_par_value
• im_name_f
• im_table.definition
• im_table.units
• im_table.range
• im_range
• im_data_source
• damage_scale_name
• damage_scale.dm_states_name
• damage_scale.reference
• dm_states_name
• dm_scale_reference
• edp_name_all
• edp.description
• edp.units

Details for "damage to loss functions"

• id
• hazard
• asset
• taxonomy
• geographical applicability (array of country names)
• scale_applicability
• reference_table.author_year
• reference_table.title
• dtl_pdf_type
• dtl_parameters
• dtl_parameters_values
• damage_scale_name
• damage_scale.dm_states_name
• damage_scale.reference

[ricardogsilva]

@giohappy please take a look at the database record obtained from executing:

SELECT *
FROM vulnerabilities.ff_table
WHERE id=11;

Note how the par_names column is empty but the im_range column shows values. The other columns that we are using for showing the function parameters (med_par_value, ub_par_value, lb_par_value) are all empty. I'm not sure if this is a bug in the data or expected behavior.

[ricardogsilva]

Another question that is not clear for me:

• Should I use the exact values for the serializer fields as shown here? For example, should the serializer have an attribute called damage_scale.reference, or is that just an indication that I need to do a JOIN in order to get that value? I'm currently naming the fields differently, e.g. damage_scale_reference

[giohappy]

@ricardogsilva yes, ff_table entries are for the most part with empty params. I don't have the domain knowledge to know how to treat and show them. We will leave those fields empty, waiting for their feedbacks...

Correct, I recorded the source table but the field should be named only with the field name.