New Disqualified Officer functionality

API Changes Information
#1

During the week commencing 25th January 2016 we will be introducing new functionality to the API and Web Service. This functionality will introduce disqualified officers to CHS and the ability to search and view information on them. We have also improved the searching functionality for disqualifications and will be rolling this out to Officer and Company searching in the future.

Early sight of the resource representations, are shown below:-

DisqualifiedOfficerSearch resource.

 {
   "items" : [
      {
         "address" : {
            "address_line_1" : "string",
            "address_line_2" : "string",
            "country" : "string",
            "locality" : "string",
            "postal_code" : "string",
            "premises" : "string",
            "region" : "string"
         },
         "date_of_birth" : "date",
         "description" : "string",
         "description_identifiers" : [
            "string"
         ],
         "kind" : "string",
         "links" : {
            "self" : "string"
         },
         "matches" : [
            {
               "snippet" : [
                  "integer"
               ],
               "title" : [
                  "integer"
               ]
            }
         ],
         "snippet" : "string",
         "title" : "string"
      }
   ],
   "items_per_page" : "integer",
   "kind" : "string",
   "page_number" : "integer",
   "start_index" : "integer",
   "total_results" : "integer"
}

corporateDisqualification resource

{
   "company_number" : "string",
   "country_of_registration" : "string",
   "disqualifications" : [
      {
         "address" : {
            "address_line_1" : "string",
            "address_line_2" : "string",
            "country" : "string",
            "locality" : "string",
            "postal_code" : "string",
            "premises" : "string",
            "region" : "string"
         },
         "case_identifier" : "string",
         "company_names" : [
            "string"
         ],
         "court_name" : "string",
         "disqualification_type" : "string",
         "disqualified_from" : "date",
         "disqualified_until" : "date",
         "heard_on" : "date",
         "last_variation" : {
            "case_identifier" : "string",
            "court_name" : "string",
            "varied_on" : "date"
         },
         "reason" : {
            "act" : "string",
            "article" : "string",
            "description_identifier" : "string",
            "section" : "string"
         },
         "undertaken_on" : "date"
      }
   ],
   "etag" : "string",
   "kind" : "string",
   "links" : {
      "self" : "string"
   },
   "name" : "string",
   "permissions_to_act" : [
      {
         "company_names" : [
            "string"
         ],
         "court_name" : "string",
         "expires_on" : "date",
         "granted_on" : "date"
      }
   ]
}

naturalDisqualification resource

{
   "date_of_birth" : "date",
   "disqualifications" : [
      {
         "address" : {
            "address_line_1" : "string",
            "address_line_2" : "string",
            "country" : "string",
            "locality" : "string",
            "postal_code" : "string",
            "premises" : "string",
            "region" : "string"
         },
         "case_identifier" : "string",
         "company_names" : [
            "string"
         ],
         "court_name" : "string",
         "disqualification_type" : "string",
         "disqualified_from" : "date",
         "disqualified_until" : "date",
         "heard_on" : "date",
         "last_variation" : {
            "case_identifier" : "string",
            "court_name" : "string",
            "varied_on" : "date"
         },
         "reason" : {
            "act" : "string",
            "article" : "string",
            "description_identifier" : "string",
            "section" : "string"
         },
         "undertaken_on" : "date"
      }
   ],
   "etag" : "string",
   "forename" : "string",
   "honours" : "string",
   "kind" : "string",
   "links" : {
      "self" : "string"
   },
   "nationality" : "string",
   "other_forenames" : "string",
   "permissions_to_act" : [
      {
         "company_names" : [
            "string"
         ],
         "court_name" : "string",
         "expires_on" : "date",
         "granted_on" : "date"
      }
   ],
   "surname" : "string",
   "title" : "string"
}
OfficerSearch - Search Functionality
Officer Id vs Disqualified officer Id and how to link the two?
#2
#3

I assume the date of birth will be redacted?

Will this be a separate call, or will disqualified officers be returned with the existing officer search?
Will there be full documentation available before this goes live?
Have there been any advancements on introducing a staging / versioned environment for this kind of release?

#4

Hi Hywel, thanks for your post.
We can output the full date of birth for disqualified officers so it won’t be redacted.
It will be a separate call for disqualified searching.
The spec will we published when the functionality is implemented.
No advancements on a staging / versioned environment sorry.

Have a great weekend.

Regards
Paul Francis

#5

Why we need to search again for disqualification ?

Can’t we do an Officer search and then use the self id (person id) to retrieve both the appointments and disqualifications ?

XMLGateway delivers both appointments and disqualifications combined in OfficerDetail response.

What’s the design decision behind the separate api calls for appointments and disqualifications ?

Thanks,
Harshad

#6

Hi Harshad,

The requirement for CHS was that the register of disqualifications remained a separate entity.

Regards,

Paul

Officer Id vs Disqualified officer Id and how to link the two?
#7

Is there a way to get the reource url for the disqualifications from the Officer List resource?

I already have a method for getting the Officer appointments: given a company number, I get the Officer List, then use “items.links.officer.appointments” to get a resource url for a given officer’s appointments.

I’m looking for a similar way to get the Disqualifications. Or any alternative method.

#8

Hi Daniel,

Unfortunately not. Disqualified officers are a separate register to “normal” officers and may also not be linked to a company number.

Regards

Paul

Officer Id in disqualified officers api
#9

Thanks Paul.

So given a Officer List for a company, to view disqualifications for one of those officers we’d have to use the Disqualification search, using the officer name as search parameter?

#10

Hello,

In the documentation of “Officer disqualifications” I see that the search requires officer_id parameter. Can you please clarify to me if there is (or will be) a way to obtain officer_id of disqualified directors via the API?

Thank you!

#11

@tarasova,

There is disqualified officer search which returns the URL of the Officer Disqualification. Its documented under

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

Thanks,

@mfairhurst

#12

Thank you for the pointer!

– Tatiana

#13

Hope it helped :grinning:

#14

Yes, it did. One thing that was not obvious to me at first was the possibility to use wildcards as values for the query parameter.