DESCRIPTION
Runs a search to find all the matters which have the official number which is included in the lookup URL.
URL STRUCTURE
https://[hostname]/matter/get-by-official-number/{officialNumberToSearch}METHOD
GET
HEADERS
**Authorization:** string Base64 [email]:[key]
ARGUMENTS
| Name | Type | Description |
|---|---|---|
| officialNumberToSearch | string (minimum 5 characters) | Official office bibliographic number |
PARAMETERS
| Name | Type | Description |
|---|---|---|
| matterCountry | string | 2 letter country code to filter results by matter country |
| numberCountry | string | 2 letter country code to filter results by official office country |
| numberType | enum | Filters results to the history date id |
| exactMatch | bool | When true, only exact matches for the officialNumberToSearch argument will be returned |
ENUMS
numberType
| Value For API |
| priority |
| application |
| publication |
| grant |
| loged |
RETURNS
Results limited to 250 results maximum.
Sample response
[
{
"id": "65",
"oldCode": null,
"oldId": null,
"country": "GB",
"countryName": null,
"status": {
"id": "8",
"name": ""
},
"matterCode": "000014GB",
"shortTitle": "Back scratcher",
"longTitle": null,
"formalTitle": null,
"clientRef": null,
"parentage": null,
"designatedCountries": null,
"application": null,
"publication": null,
"natRegEntry": null,
"natRegPublication": null,
"grant": null,
"priority": null,
"applicants": [],
"inventors": [],
"licensees": [],
"associates": [],
"otherSideClients": [],
"otherSideSolicitors": [],
"clientKeyContactId": null,
"category": {
"id": 9,
"definition": "patent",
"name": "Patent"
},
"subCategory": null,
"imageId": null,
"typeOfMark": null,
"businessUnit": null,
"expiryDate": null,
"client": null,
"clientId": null,
"billingAddress": null,
"billingAddressId": null,
"user": null,
"user2": null,
"user3": null,
"user4": null,
"family": null,
"office": null,
"notes": null,
"familyId": null,
"businessGroup": null,
"internationalRegistrationId": null,
"classes": null,
"goods": null,
"openDate": null,
"designatedStates": null,
"parentMatterId": null,
"typeId": null,
"correspondenceNotes": null,
"renewalClient": null,
"renewalClientId": null,
"renewalBillingAddress": null,
"renewalBillingAddressId": null,
"entityType": "matter",
"legalEntity": null,
"allHistoryDates": null,
"goodsAndClasses": null,
"associatesLoaded": null,
"budgets": null,
"customFields": []
}, //...
]