legaladvice_ui/swagger.json at master · fastdatascience/legaladvice_ui · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
{
    "swagger": "2.0",
    "info": {
        "version": "1.0.0",
        "title": "Companies House Public Data API",
        "description": "An API suite providing read only access to search and retrieve public company data"
    },
    "host": "api.company-information.service.gov.uk",
    "schemes": [
        "https",
        "http"
    ],
    "consumes": [
        "application/json"
    ],
    "produces": [
        "application/json"
    ],
    "tags": [{
            "name": "registeredOfficeAddress",
            "description": "Registered office address"
        },
        {
            "name": "companyProfile",
            "description": "Company profile"
        },
        {
            "name": "search",
            "description": "Search"
        },
        {
            "name": "officers",
            "description": "Officers"
        },
        {
            "name": "registers",
            "description": "Registers"
        },
        {
            "name": "charges",
            "description": "Charges"
        },
        {
            "name": "filingHistory",
            "description": "Filing history"
        },
        {
            "name": "insolvency",
            "description": "Insolvency"
        },
        {
            "name": "exemptions",
            "description": "Exemptions"
        },
        {
            "name": "officerDisqualifications",
            "description": "Officer disqualifications"
        },
        {
            "name": "officerAppointments",
            "description": "Officer appointments"
        },
        {
            "name": "UKEstablishments",
            "description": "UK Establishments"
        },
        {
            "name": "personsWithSignificantControl",
            "description": "Persons with significant control"
        },
        {
            "name": "pscDiscrepancies",
            "description": "PSC discrepancies"
        }
    ],
    "securityDefinitions": {
        "api_key": {
            "type": "apiKey",
            "name": "api_key",
            "in": "header"
        }
    },
    "security": [{
            "api_key": []
        }
    ],
    "paths": {
        "/company/{companyNumber}/registered-office-address": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/companyAddress.json#/getCompanyAddress"
        },
        "/company/{companyNumber}": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/companyProfile.json"
        },
        "/search": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/search.json#/searchAll"
        },
        "/search/companies": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/search.json#/searchCompanies"
        },
        "/search/officers": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/search.json#/searchOfficers"
        },
        "/search/disqualified-officers": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/search.json#/searchDisqualified-officers"
        },
        "/dissolved-search/companies": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/search-companies.json#/searchDissolved"
        },
        "/alphabetic-search/companies": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/search-companies.json#/searchAlphabetic"
        },
        "/advanced-search/companies": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/search-companies.json#/searchAdvanced"
        },
        "/company/{company_number}/officers": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/companyOfficerList.json#/listCompanyOfficers"
        },
        "/company/{company_number}/appointments/{appointment_id}": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/companyOfficerList.json#/getCompanyOfficerAppointment"
        },
        "/company/{company_number}/registers": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/companyRegisters.json"
        },
        "/company/{company_number}/filing-history/{transaction_id}": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/filingHistory.json#/getFilingHistory"
        },
        "/company/{company_number}/filing-history": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/filingHistory.json#/listFilingHistory"
        },
        "/company/{company_number}/exemptions": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/exemptions.json"
        },
        "/disqualified-officers/natural/{officer_id}": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/disqualifications.json#/getNatural"
        },
        "/disqualified-officers/corporate/{officer_id}": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/disqualifications.json#/getCorporate"
        },
        "/officers/{officer_id}/appointments": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/officerAppointmentList.json"
        },
        "/company/{company_number}/charges": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/charges.json#/chargeList"
        },
        "/company/{company_number}/charges/{charge_id}": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/charges.json#/chargeDetails"
        },
        "/company/{company_number}/insolvency": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/insolvency.json#/insolvencyCase"
        },
        "/company/{company_number}/uk-establishments": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/companyUKEstablishments.json"
        },
        "/company/{company_number}/persons-with-significant-control": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/psc.json#/listCompanyPSC"
        },
        "/company/{company_number}/persons-with-significant-control/individual/{psc_id}": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/psc.json#/getIndividualPSC"
        },
        "/company/{company_number}/persons-with-significant-control/individual-beneficial-owner/{psc_id}": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/psc.json#/getIndividualBO"
        },
        "/company/{company_number}/persons-with-significant-control/corporate-entity/{psc_id}": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/psc.json#/getCorporateEntityPSC"
        },
        "/company/{company_number}/persons-with-significant-control/corporate-entity-beneficial-owner/{psc_id}": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/psc.json#/getCorporateEntityBO"
        },
        "/company/{company_number}/persons-with-significant-control/legal-person/{psc_id}": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/psc.json#/getLegalPersonPSC"
        },
        "/company/{company_number}/persons-with-significant-control/legal-person-beneficial-owner/{psc_id}": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/psc.json#/getLegalPersonBO"
        },
        "/company/{company_number}/persons-with-significant-control-statements": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/psc.json#/listCompanyPSCStatements"
        },
        "/company/{company_number}/persons-with-significant-control-statements/{statement_id}": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/psc.json#/getPSCStatement"
        },
        "/company/{company_number}/persons-with-significant-control/super-secure/{super_secure_id}": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/psc.json#/getSuperSecurePSC"
        },
        "/company/{company_number}/persons-with-significant-control/super-secure-beneficial-owner/{super_secure_id}": {
            "$ref": "https://developer-specs.company-information.service.gov.uk//api.ch.gov.uk-specifications/swagger-2.0/spec/psc.json#/getSuperSecureBO"
        }
    }
}