POST
Trademark Search - 01.Create
Creates a new trademark search and queues it for execution.
Important
Calls to this method must include the cookie .LawPanel.AuthCookie in order to identify you at user level. For more details about authentication please check this link. To obtain the cookie you can use the method Login.
Request URL
Request headers
string
Subscription key which provides access to this API.
Request body
Request payload to create the search.
- string Requiredsearch_term: Terms to perform the search. For example "lawpanel". Max size allowed here is 250 characters.
- string Optionalclasses: A comma separated values of nice classification class numbers. For example "42, 9". You can include only positive integer numbers. To get a list of all search classes available click here
- array Optionalregistry_ids: An array of registry GUID to search into. If you set it to null the search will be performed over all registries. To get a list of all registries available here.
- string Optionalsearch_origin_id: The search origin GUID to save with this search. If you set it to null the default search origin will be used. To get a list of all search origin available here.
Loading...
{
"type": "object",
"properties": {
"search_term": {
"type": "string",
"description": "Search terms to perform the search. Max lenght: 250 characters."
},
"classes": {
"type": "string",
"format": "Search class numbers separated by commas."
},
"registry_id": {
"type": "string",
"format": "Guid"
},
"search_origin_id": {
"type": "string",
"format": "Guid"
}
},
"example": {
"search_term": "lawpanel",
"classes": "42,9",
"registry_ids": [
"783c0667-2884-4d0a-b93b-a6720147e45f",
"bdbc9579-0462-4449-b7e8-a835017ea7c4"
],
"search_origin_id": null
}
}
Response 201
Search has been queued for execution.
- string id: The ID for the new trademark search created. Use this ID to get current trademark search status.
- string search_term: Terms for the search.
- string classes: Search classes for the search.
- array registry_ids: Registry IDs for the search.
- string start_time: Date/time in ISO-8601 (UTC) format for the beggining of search process.
- string end_time: Date/time in ISO-8601 (UTC) format for the end of search process.
- number status: Current search status. Possible values are: 0-Unknown; 1-Waiting; 2-Searching; 3-Completed; 4-Failed; 5-Cancelled.
Loading...
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"search_term": {
"type": "string"
},
"classes": {
"type": "string"
},
"registry_id": {},
"start_time": {
"type": "string"
},
"end_time": {
"type": "string"
},
"status": {
"type": "integer"
},
"results": {
"type": "array",
"items": {}
}
}
}