Officer Search Resource

Documentation Issues
1

I am adding CH Officer Search to my app, and have been reviewing the resource at:

https://developer.companieshouse.gov.uk/api/docs/search-overview/OfficerSearch-resource.html

this shows the ‘matches’ property to be an array:

“matches” : [ { “address_snippet” : [ “integer” ], “snippet” : [ “integer” ], “title” : [ “integer” ] } ],

But the API is just returning an object:

"matches":{"title":[1,5,7,11],"snippet":[]}

I presume it should be an object and this is just a mistake in the documentation?

2

Yes, this is an error in the documentation. It is not an array, it is a list.