|
HTML
/api/v1/RegDocs/html/:registrationNumber
CSV
/api/v1/RegDocs/csv/:registrationNumber
XML
/api/v1/RegDocs/xml/:registrationNumber
JSON
/api/v1/RegDocs/json/:registrationNumber
|
GET |
Returns list of all available registration document URLs (PDF format) and data for provided registration number (:registrationNumber parameter is required).
Example URL: /api/v1/RegDocs/xml/1234
Additional filters available for RegDocs endpoint:
| Parameter |
Acceptable Values |
Returns |
Example URL |
:docType |
"Document Type" (see DocumentTypes endpoint for list of acceptable values) |
Data matching specified :registrationNumber and :docType values |
/api/v1/RegDocs/xml/1234?docType=AMENDMENT |
:countryCode |
"Country Code" (see Countries endpoint for list of acceptable values) |
Data matching specified :registrationNumber and :countryCode values (foreign principal country) |
/api/v1/RegDocs/xml/1234?countryCode=AF |
Parameters can also be combined using standard GET method syntax ('?' to identify first parameter and '&' to identify multiple query parameters).
Example URL:
/api/v1/RegDocs/xml/1234?docType=AMENDMENT&countryCode=AF
would return records that match the provided :registrationNumber, :docType and :countryCode values (1234, AMENDMENT and AF, respectively.
|