Search resource documentation incorrect / gotchas

Minor issue but for reference the search resource documentation (all four types) is incorrect: field “description_identifier” is listed as [ "integer" ]
…but (as it states further down) these return string constants which appear in the search_descriptions_raw.yaml file.

  • There are separate sets of constants for company, officer and disqualified officer searches and these are given in search_descriptions_raw.yaml but since the general search can return results of any of these types you’ll need to put these all together or check each constant set for general search results.

Another couple of things to be aware of:

  • DisqualifiedOfficerSearch resource and OfficerSearch resource correctly document this field as "description_identifiers" (final ‘s’) - probably should be the same field name for all 4 search types.
  • Looking up the given constant to get the text may give you a field to substitute and in these constants there may be a “type” given first e.g. "{date:date_of_creation}" or "Born {month-year:date_of_birth}" - possibly helpful if only it appeared in such fields elsewhere.
  • As mentioned elsewhere the above sometimes references an invalid field (e.g. a date field with value "unknown"). This affects the “description” field also:[quote=“ash, post:15, topic:888”]
    By chance, I encountered another “Closed on …” company earlier today, also an NF company: NF002699

There’s an enumeration for a status of “closed” rather than “closed-on”, which does not require a date, which suggests to me that when the date is unknown it should have been given that status instead.
[/quote]

1 Like