We're developing a ground breaking software & know-how platform for small and medium sized law firms to recruit new clients, delight them with improved and more efficient service, and retain them.
So solving the most important commercial questions law firms ask themselves, namely how can we
- get more clients, or deliver more services to those we have?
- improve service levels whilst lowering service costs?
- improve operating margins and grow the firm?
The first set of applications are based on our tools and know-how from founding and running top rated http://www.trademarkdirect.co.uk #1 UK attorney firm for trade marks serving 1500 clients a year.
These include our US patented trade mark similarity algorithms and machine learning modules for monitoring trade mark infringement. But our vision extends way beyond trade mark services to offer a valuable operating system' for all small and medium law firms, initially in the UK and US but expanding to all major economies and beyond in time.
This API will allows you handle all operations at Firms level.
List of searches
Order by date descending
How many to take
How many to skip
Getting results from a search
Search Id
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
The search has been completed. The response body contains the list of search results.
[
{
"id": "93f37c80-09be-48d3-a3dd-ddc63a01e0c8",
"searchId": "cf484840-c7e7-4886-a018-fa1e540dd323",
"score": "50",
"classes": "25,40",
"status": "Completed",
"textMarkId": "1",
"textMarkString": "",
"resultOrder": "1",
"removed": "false",
"selected": "false",
"registry": "1",
"isRegistered": "false",
"isRegisteredNoClassMatch": "false",
"isAmber": "false"
},
{
"id": "6389bffb-db41-4a3a-b66c-a01e96b68492",
"searchId": "cf484840-c7e7-4886-a018-fa1e540dd323",
"score": "45",
"classMatch": "23",
"applicationNumber": "",
"classes": "25,40",
"status": "Completed",
"textMarkId": "1",
"textMarkString": "",
"resultOrder": "1",
"removed": "false",
"selected": "false",
"registry": "1",
"isRegistered": "false",
"isRegisteredNoClassMatch": "false",
"isAmber": "false"
}
]
The search is in progress. Query again after a few seconds to see if the search has been completed.
No search has been started with the given id.
The search failed or has been canceled.
Getting status of a search
Search Id
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
The search can be found in the queue or among the finished searches. The response contains the search status.
"Completed"
No search has been started with the given id.
Getting details for a search
Search Id
The search has been completed. The response body contains the list of search results.
[
{
id: "93f37c80-09be-48d3-a3dd-ddc63a01e0c8",
searchId: "cf484840-c7e7-4886-a018-fa1e540dd323"
score: 50,
classMatch: 30,
applicationNumber: ""
classes: "25,40"
status: "Completed",
textMarkId: 1,
textMarkString: ""
resultOrder: 1,
removed: false,
selected: false,
registry: 1,
isRegistered: false,
isRegisteredNoClassMatch: false,
isAmber: false
},
{
id: "6389bffb-db41-4a3a-b66c-a01e96b68492",
searchId: "cf484840-c7e7-4886-a018-fa1e540dd323"
score: 45,
classMatch: 23,
applicationNumber: ""
classes: "25,40"
status: "Completed",
textMarkId: 1,
textMarkString: ""
resultOrder: 1,
removed: false,
selected: false,
registry: 1,
isRegistered: false,
isRegisteredNoClassMatch: false,
isAmber: false
}
]
The search is in progress. Query again after a few seconds to see if the search has been completed.
No search has been started with the given id.
The search failed or has been canceled.
{
"message": "Search failed"
}
Trademarks - 01.Get by ID
Returned when trademark not exist
Trademarks - 03.Search by text
Return a list with watching representations.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns a list with watchings representations.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The watching <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_id</span></span></span>: The user <span class="hljs-literal">ID</span> to recieve email notifications when watching has news. To get a list of your users please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a1d19d2f9702b2c0c17ba">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_name</span></span></span>: Human-readable user name to receive notifications.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>integer</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">sensitivity</span></span></span>: The sensitivity to match a trademark. 0 means very strict, 20 is more flexible. For example, if your trademark is "LawPanel" and you set this value to 0, you'll only receive notifications about new trademarks like "Law Panel", or "LawPanel". If you set it to 20 you'll receive notifications about new trademarks like "A law", or "The panel".
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">firm_portfolio_id</span></span></span>: The trademark <span class="hljs-literal">ID</span> to watch. To get a list of your trademarks please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e751ed6bd85d4669025ae5e">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_number</span></span></span>: The trademark application number for the watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">trademark</span></span></span>: The trademark text for the watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">classes</span></span></span>: Comma separated <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf965f8c9eb0e90ebbb5d">search class numbers</a> for the watched trademark.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_id</span></span></span>: The registry <span class="hljs-literal">ID</span> where watching will be performed. To get a list of registries available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57e9e4b3901adc1844aedf7e">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_name</span></span></span>: Human-readable registry name to perform the watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">frequency_id</span></span></span>: The frequency <span class="hljs-literal">ID</span> to send notifications about watching matches. To get a list of frequencies available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a47db756d854b11a904d2">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">frequency_name</span></span></span>: Human-readable frequency name to notify about matches.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i><span>array</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">events</span></span></span>: An array of objects containing details about matches for your watching.
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: Event ID.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>integer</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">unix_time_stamp</span></span></span>: Event date creation on <a href="https://en.wikipedia.org/wiki/Unix_time" target="_blank">UNIX format</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_date</span></span></span>: Application date for the trademark that matches with your watching. In <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_number</span></span></span>: Application number for the trademark that matches with your watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">classes</span></span></span>: Comma separated values of search class numbers for the trademark that matches with your watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">databases</span></span></span>: <a href="https://en.wikipedia.org/wiki/WIPO_ST.3" target="_blank">WIPO ST.3 code</a> for the registry of the trademark that matches with your watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">owner_applicant</span></span></span>: Applicant for the trademark that matches with your watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">owner_applicant</span></span></span>: Applicant for the trademark that matches with your watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status</span></span></span>: Status text for the trademark that matches with your watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">good_and_services</span></span></span>: Good and services text for the trademark that matches with your watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">handled</span></span></span>: If <span class="hljs-literal">true</span> the event was marked as "Handled" by the user. Just a flag to organize events.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">created</span></span></span>: Watching creation date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">last_search_date</span></span></span>: Last search date for matches in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">last_notification_date_time</span></span></span>: Last date when a notification was sent to inform about matches.Date is showed in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
</ul>
[
{
"id": "b665ca9e-92b7-444b-b9da-ab4500de7b98",
"user_id": "03ce7827-aac0-477d-a01b-aad8012abc99",
"user_name": "chapeti+alsina003@gmail.com",
"sensitivity": 20,
"firm_portfolio_id": "c94a7d6d-83e1-4186-b3fe-a6720147e2a2",
"application_number": "0303456",
"trademark": "1LED",
"classes": [
"11"
],
"registry_id": "bdbc9579-0462-4449-b7e8-a835017ea7c4",
"registry_name": "GB",
"frequency_id": "c94a7d6d-83e1-4186-b3fe-a6720147e2d2",
"frequency_name": "Weekly",
"events": [],
"created": "2020-01-17T13:30:02.1027702Z",
"last_search_date_time": "2020-03-25T01:03:47.8640131Z",
"last_notification_date_time": null
},
{
"id": "7ba96a95-6ae3-4cdd-a860-ab4a00d3ae7f",
"user_id": "03ce7827-aac0-477d-a01b-aad8012abc99",
"user_name": "chapeti+alsina003@gmail.com",
"sensitivity": 20,
"firm_portfolio_id": "c94a7d6d-83e1-4186-b3fe-a6720147e2d0",
"application_number": "0303456",
"trademark": "5ARTH",
"classes": [
"20"
],
"registry_id": "bdbc9579-0462-4449-b7e8-a835017ea7c4",
"registry_name": "GB",
"frequency_id": "c94a7d6d-83e1-4186-b3fe-a6720147e2d2",
"frequency_name": "Weekly",
"events": [
{
"id": "7ba96a95-6ae3-4cdd-a860-ab4a00d3ae7f|3139581561719999999",
"unix_time_stamp": 1579741428,
"application_date": "2020-01-02T00:00:00Z",
"application_number": "UK00003455018",
"trademark": "5ARTH",
"classes": "20",
"databases": "GB",
"owner_applicant": "Lai Feifeng",
"status": "Pending",
"good_and_services": "20: desks [furniture], office furniture, furniture, chairs, display stands, [...]",
"handled": false
}
],
"created": "2020-01-22T12:50:42.5533169Z",
"last_search_date_time": "2020-03-25T01:03:47.8640131Z",
"last_notification_date_time": "2020-01-23T01:05:06.9702455Z"
},
{
"id": "77e51ee3-bd5e-4dd7-99ca-ab44012577f8",
"user_id": "77e2dd06-154c-4157-ad69-a6720147e652",
"user_name": "admin@lawpanel.io",
"sensitivity": 3,
"firm_portfolio_id": "c94a7d6d-83e1-4186-b3fe-a6720147e2d3",
"application_number": "201003372",
"trademark": "WINNING MATTERS",
"classes": [
"45",
"36",
"41",
"35"
],
"registry_id": "ae1159e1-77cc-492f-935f-a835017eab71",
"registry_name": "NO",
"frequency_id": "008d4dea-642c-483a-8c57-a6720147e2d2",
"frequency_name": "Bi-Weekly",
"events": [],
"created": "2020-01-16T17:48:29.2109982Z",
"last_search_date_time": "2020-01-25T01:03:47.8640131Z",
"last_notification_date_time": null
},
{
"id": "dcc1815c-af91-40c5-9cbc-ab4500df4e63",
"user_id": "03ce7827-aac0-477d-a01b-aad8012abc99",
"user_name": "chapeti+alsina003@gmail.com",
"sensitivity": 20,
"firm_portfolio_id": null,
"application_number": "090978978",
"trademark": "Yun Bey",
"classes": [
"9"
],
"registry_id": "bdbc9579-0462-4449-b7e8-a835017ea7c4",
"registry_name": "GB",
"frequency_id": "c94a7d6d-83e1-4186-b3fe-a6720147e2d2",
"frequency_name": "Weekly",
"events": [
{
"id": "dcc1815c-af91-40c5-9cbc-ab4500df4e63|3139581561729999999",
"watching_id": "dcc1815c-af91-40c5-9cbc-ab4500df4e63",
"unix_time_stamp": 1579741427,
"application_date": "2020-01-07T00:00:00Z",
"application_number": "UK00003455889",
"trademark": "YunBey",
"classes": "9",
"databases": "GB",
"owner_applicant": "HUANG WEN WEN",
"status": "Pending",
"good_and_services": "9: circular slide rules, slide-rules, counters, egg timers [sandglasses], reflective articles for wear, [...]",
"handled": false
}
],
"created": "2020-01-17T13:33:01.9800266Z",
"last_search_date_time": "2020-01-25T01:03:47.8640131Z",
"last_notification_date_time": "2020-01-23T01:05:07.7045947Z"
}
]
Creates a new Watching record for a trademark.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">firm_portfolio_id</span></span></span>: The trademark <span class="hljs-literal">ID</span> to watch. To get a list of your trademarks please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e751ed6bd85d4669025ae5e">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_id</span></span></span>: The user <span class="hljs-literal">ID</span> to recieve email notifications when watching has news. To get a list of your users please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a1d19d2f9702b2c0c17ba">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">frequency_id</span></span></span>: The frequency <span class="hljs-literal">ID</span> to send email notifications when watching has news. To get a list of frequencies available check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a47db756d854b11a904d2">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>integer</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">sensitivity</span></span></span>: The sensitivity to match a trademark. 0 means very strict, 20 is more flexible. For example, if your trademark is "LawPanel" and you set this value to 0, you'll only receive notifications about new trademarks like "Law Panel", or "LawPanel". If you set it to 20 you'll receive notifications about new trademarks like "A law", or "The panel".
</li>
</ul>
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
{
"firm_portfolio_id": "541fe28f-21f5-40c4-8c15-aad8012ad11c",
"user_id": "03ce7827-aac0-477d-a01b-aad8012abc99",
"frequency_id": "c94a7d6d-83e1-4186-b3fe-a6720147e2d2",
"sensitivity": 10
}
Returns a representation for the new Watching record created.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The watching <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_id</span></span></span>: The user <span class="hljs-literal">ID</span> to recieve email notifications when watching has news. To get a list of your users please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a1d19d2f9702b2c0c17ba">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_name</span></span></span>: Human-readable user name to receive notifications.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>integer</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">sensitivity</span></span></span>: The sensitivity to match a trademark. 0 means very strict, 20 is more flexible. For example, if your trademark is "LawPanel" and you set this value to 0, you'll only receive notifications about new trademarks like "Law Panel", or "LawPanel". If you set it to 20 you'll receive notifications about new trademarks like "A law", or "The panel".
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_number</span></span></span>: The trademark application number for the watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_number</span></span></span>: The trademark text for the watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">last_search_date</span></span></span>: Last search date for matches in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">classes</span></span></span>: Comma separated <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf965f8c9eb0e90ebbb5d">search class numbers</a> for the watched trademark.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_id</span></span></span>: The registry <span class="hljs-literal">ID</span> where watching will be performed. To get a list of registries available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57e9e4b3901adc1844aedf7e">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_name</span></span></span>: Human-readable registry name to perform the watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">frequency_id</span></span></span>: The frequency <span class="hljs-literal">ID</span> to send notifications about watching matches. To get a list of frequencies available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a47db756d854b11a904d2">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">frequency_name</span></span></span>: Human-readable frequency name to notify about matches.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">firm_portfolio_id</span></span></span>: The trademark <span class="hljs-literal">ID</span> to watch. To get a list of your trademarks please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e751ed6bd85d4669025ae5e">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">last_notification_date_time</span></span></span>: Last date when a notification was sent to inform about matches.Date is showed in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
</ul>
{
"id": "666aaabf-2c4e-46db-b41c-ab8800dd824f",
"user_id": "03ce7827-aac0-477d-a01b-aad8012abc99",
"user_name": "chapeti+alsina003@gmail.com",
"sensitivity": 10,
"application_number": "000055236",
"trademark": "BARCLAYS",
"last_search_date": null,
"classes": "36,42,9,35,16",
"registry_id": "cfe07713-af2b-4054-b5cf-a6720147e45f",
"registry_name": "eu",
"frequency_id": "c94a7d6d-83e1-4186-b3fe-a6720147e2d2",
"frequency_name": "Weekly",
"firm_portfolio_id": "08193b28-503d-4f47-82c0-aad8012ca5d7",
"last_notification_date_time": null
}
Updates a Watching record.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The Watching <span class="hljs-literal">ID</span> to update.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">firm_portfolio_id</span></span></span>: The trademark <span class="hljs-literal">ID</span> to watch. To get a list of your trademarks please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e751ed6bd85d4669025ae5e">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_id</span></span></span>: The user <span class="hljs-literal">ID</span> to recieve email notifications when watching has news. To get a list of your users please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a1d19d2f9702b2c0c17ba">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">frequency_id</span></span></span>: The frequency <span class="hljs-literal">ID</span> to send email notifications when watching has news. To get a list of frequencies available check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a47db756d854b11a904d2">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>integer</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">sensitivity</span></span></span>: The sensitivity to match a trademark. 0 means very strict, 20 is more flexible. For example, if your trademark is "LawPanel" and you set this value to 0, you'll only receive notifications about new trademarks like "Law Panel", or "LawPanel". If you set it to 20 you'll receive notifications about new trademarks like "A law", or "The panel".
</li>
</ul>
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
{
"id": "7ba96a95-6ae3-4cdd-a860-ab4a00d3ae7f",
"firm_portfolio_id": "605366ae-6ba7-4f0c-acc4-ab4a00d38883",
"user_id": "03ce7827-aac0-477d-a01b-aad8012abc99",
"frequency_id": "c94a7d6d-83e1-4186-b3fe-a6720147e2d2",
"sensitivity": 20
}
{
"id": "b665ca9e-92b7-444b-b9da-ab4500de7b98",
"message": "Watching 'b665ca9e-92b7-444b-b9da-ab4500de7b98' successfully updated",
"successful": true
}
Deletes a Watching record.
Returns data about operation result.
Return identified user details.
Returns an object with details about your current User and Firm identified.
{
"user": {
"id": "03ce7827-aac0-477d-a01b-aad8012abc99",
"first_name": "chapeti+alsina003",
"last_name": "chapeti+alsina003",
"user_name": "chapeti+alsina003@gmail.com",
"email": "chapeti+alsina003@gmail.com",
"phone_number": "-",
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"language_name": "English",
"country_id": "27cb8e50-0e8b-40cd-a656-a6720147e0a1",
"country_name": "Argentina",
"user_role": "FirmUser",
"last_login_date": "2020-09-03T12:40:54.2103716Z",
"is_locked_out": false,
"user_settings": {
"urls_without_help_message": null,
"first_page_to_show": null,
"send_public_note_to_client": true
},
"claims": []
},
"firm": {
"id": "7350685c-cc5a-4c85-8a22-aad8012abbaa",
"name": "alsina003",
"firm_settings": {
"id": "34e6a485-5ab4-4982-8cb4-aad8012abb64",
"header_logo_url": "https://lawpanelstoragelive.blob.core.windows.net/public-assets/logo.png",
"secondary_logo_url": "https://lawpanelstoragelive.blob.core.windows.net/public-assets/logo.png",
"header_color_left": "#FFFFFF",
"header_color_right": "#02404C",
"hide_firm_name_on_header": false
},
"tenant_name": "alsina003",
"email": null,
"phone_number": null,
"payment_provider": null,
"payment_provider_publishable_api_key": null
},
"client": {
"id": "08053072-6b7a-4938-90d8-aad8012ad39e",
"name": "International Association for the Intellectual Property",
"company_registration_number": "0303456",
"contact_name": "John Doe",
"contact_email": "john@doe.com",
"contact_number": "+543875333953",
"contact_address": {
"id": "22f2a4a9-5aeb-4abe-b553-aad8012ad39e",
"line1": "Los Crespones",
"line2": "749",
"line3": "Tres Cerritos",
"building": "Planta Baja",
"floor_level": "-",
"postal_code": "4400",
"city": "Salta Capital",
"state_province": "Salta",
"region": "Noroeste Argentino",
"country_id": "27cb8e50-0e8b-40cd-a656-a6720147e0a1",
"country_name": "Argentina"
},
"billing_address": {
"id": "727eccdf-a1dd-4207-8cd3-aad8012ad39e",
"line1": "Alsina",
"line2": "151",
"line3": "Centro",
"building": "Torre A",
"floor_level": "2",
"postal_code": "4400",
"city": "Salta Capital",
"state_province": "Salta",
"region": "Noroeste Argentino",
"country_id": "27cb8e50-0e8b-40cd-a656-a6720147e0a1",
"country_name": "Argentina"
},
"client_type": {
"id": "604a3d85-5c5b-4364-b69c-a99201175b30",
"code": 1,
"name": "Common"
}
}
}
<p>Identify you at <b><u>user</u></b> level and returns the authentication cookie <strong>.Lawpanel.AuthCookie</strong> that you must include in subsequent requests.</p>
<p>This cookie could be used in both: API and Web Site to identify the current user.</p>
<p>This cookie plus the subscription-key identifies you at both levels: Firm and User.</p>
JSON object with the user access data: email/username and password.
{
"email": "test@example.com",
"password": "hunter2"
}
<p>You will receive a 204 response if the authentication was successfully. On header "Set-Cookie" you'll get the <strong>.LawPanel.AuthCookie</strong>. Response will be very similar to this one:</p>
<p style="font-style: italic; color: #a0a0a0;">
Cache-Control: no-cache<br>
Pragma: no-cache<br>
Expires: -1<br>
<strong>
Set-Cookie:<br> .LawPanel.AuthCookie=S2pbhI1h-2KeCrllD5PNyo6fP-_pUlvtdU7dYCtKYVX8HiHn7ZcOxuWrdxyzsRFg4gxVycxw3Nh--TxRE6WeyLx_6DkMTBnn21RZMPQjM8hhPli-eBftOPhyKMW_uA9qkLv94sYoN8rAkbrl2x6jN5GN0C5LuXpt1A48PW7h2ZHlKQs-vhrg7t4pj3g0XHVpmuUVytLnZD5bH4iAPuts_LRfLk1ryyf5tcYluRPz-Fy02tBiygQmZ5rqTVNfu1qHwpgX5EOxMoDCA85AsGF3U8BTwMzC2mAXbFYjfVigXHdu5AmhgDGgBunv_MsfvxnFPD-mthNloYCmYq2qqwpf2fRYkoyL2J5jyAtjiCocMkl4NuXKWtUF3JE2GWMNv_gk-sW8svtn7y2xdZPO; domain=lawpanel.com; path=/; secure; HttpOnly<br>
</strong>
Access-Control-Max-Age: 86400<br>
Access-Control-Allow-Headers: DNT<br>
Access-Control-Allow-Headers: Origin<br>
Access-Control-Allow-Headers: Referer<br>
Access-Control-Allow-Headers: User-Agent<br>
API-Version: 1<br>
Access-Control-Expose-Headers: API-Version, Skipped, Total, Taken, Order, FileName<br>
X-XSS-Protection: 1; mode=block<br>
X-Frame-Options: Deny<br>
Referrer-Policy: strict-origin<br>
Date: Wed, 11 Mar 2020 13:31:19 GMT<br>
</p>
<p>Please remember to include the <strong>.LawPanel.AuthCookie</strong> with your subsequent requests. This cookie identifies you at a user level. The subscription key identifies you at a Firm level.</p>
You'll get a 400 ( Bad Request ) if authentication fails. Check your username/password values.
<p>Creates a new trademark for your portfolio. This method is used to add trademarks non existing on IPO databases. </p>
<p>Remember that a Case with type "Trademark filing" is also created with the trademark.</p>
Request payload to create the trademark.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_id</span></span></span>: Registry <span class="hljs-literal">GUID</span> for the trademark. To get a list of all registries available <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57e9e4b3901adc1844aedf7e">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">mark_text</span></span></span>: Text of the trademark, for example "LawPanel".
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_number</span></span></span>: Applicattion number for the trademark. It may contains any character, not only numbers.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_date</span></span></span>: Application/filing date in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registration_number</span></span></span>: Registration number for the trademark. It may contains any character, not only numbers.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registration_date</span></span></span>: Registration date in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status_date</span></span></span>: Current status date in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">mark_feature</span></span></span>: Trademark feature text.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status</span></span></span>: Current trademark status.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registration_type_id</span></span></span>: Registration type <span class="hljs-literal">GUID</span>. To get a list of all registration types available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7398b44688a6e1e26aa7ca">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">trademark_type_id</span></span></span>: Trademark type <span class="hljs-literal">GUID</span>. To get a list of all trademark types available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e73b75f0faeb654084de5ec">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">expiry_date</span></span></span>: Expiry date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">publication_date</span></span></span>: Publication date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">declaration_date</span></span></span>: Declaration date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">office_action_date</span></span></span>: Office action date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">grant_date</span></span></span>: Grant date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">client_agent_id</span></span></span>: Legal entity (aka "Company", "Client") <span class="hljs-literal">GUID</span> to assign as Agent for this trademark. Client must be of type <span class="hljs-literal">Agent</span>. Click <a href="">here</a> to get a list of all client types available. To get a list of all legal entities available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b92737f8c9eb05e07851e1">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">publication_notes</span></span></span>: Notes about trademark publication.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i>
<span>array</span>
</span>
<span class="typeOfParameter">Optional</span><strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">good_and_services</span></span></span></strong>: An array of objects to create Good And Services for the trademark.
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">language_id</span></span></span>: Registry <span class="hljs-literal">GUID</span> for the trademark. To get a list of all languages available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf30bf8c9eb0e90ebbb59">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">text</span></span></span>: Text for the Good And Service.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">search_class_id</span></span></span>: Search class <span class="hljs-literal">GUID</span> for the Good and Service. To get a list of all search class available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf965f8c9eb0e90ebbb5d">here</a>.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">image_url</span></span></span>: An URL for the trademark image .
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">notes</span></span></span>: Notes about trademark.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">do_not_create_file</span></span></span>: If <span class="hljs-literal">true</span> the system will not create a Case for this trademark.
</li>
</ul>
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
{
"registry_id": "783C0667-2884-4D0A-B93B-A6720147E45F",
"mark_text": "LawPanel",
"application_number": "87064395",
"application_date": "2020-03-17T03:00:00Z",
"registration_number": "5230966",
"registration_date": "2020-03-17T03:00:00Z",
"status_date": "2020-03-17T03:00:00Z",
"mark_feature": "mark",
"status": "Valid",
"registration_type_id": "21B28699-8E12-4575-BB65-A99201173ED2",
"trademark_type_id": "6D374194-9DF4-4A26-89DD-A992011744FD",
"expiry_date": "2020-03-17T03:00:00Z",
"publication_date": "2020-03-17T03:00:00Z",
"declaration_date": "2020-03-17T03:00:00Z",
"office_action_date": "2020-03-17T03:00:00Z",
"grant_date": "2020-03-17T03:00:00Z",
"client_agent_id": "A1C3E613-C9A5-49C5-91D9-AAAF009C09F1",
"publication_notes": "Notes about publication",
"good_and_services": [
{
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"text": "Facilitating, administering, arranging and managing funding in relation to litigation [...]",
"search_class_id": "5096b33b-2f52-456d-b306-a6720147e7fc"
},
{
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"text": "Design and development of computer hardware and software; software as a service [SaaS]; [...]",
"search_class_id": "777fe621-5eba-4985-966a-a6720147e7fc"
}
],
"image_url": "https://web.lawpanel.com/images/firm/logo-lawpanel-white.png",
"notes": "<p>Some extra notes</p>",
"do_not_create_file": false
}
Returns the trademark created representation:
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: Curent trademark <span class="hljs-literal">GUID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_id</span></span></span>: Registry <span class="hljs-literal">GUID</span> for the trademark. To get a list of all registries available <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57e9e4b3901adc1844aedf7e">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_name</span></span></span>: Human-readable name for current trademark registry.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_official_name</span></span></span>: Human-readable official name for current trademark registry.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_description</span></span></span>: Human-readable description for current trademark registry. Generally the country name associated with the IPO Registry.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">mark_text</span></span></span>: Text of the trademark, for example "LawPanel".
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_number</span></span></span>: Applicattion number for the trademark. It may contains any character, not only numbers.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_date</span></span></span>: Application/filing date in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registration_number</span></span></span>: Registration number for the trademark. It may contains any character, not only numbers.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registration_date</span></span></span>: Registration date in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status_date</span></span></span>: Current status date in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">mark_feature</span></span></span>: Trademark feature text.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status</span></span></span>: Current trademark status.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registration_type_id</span></span></span>: Registration type <span class="hljs-literal">GUID</span>. To get a list of all registration types available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7398b44688a6e1e26aa7ca">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status</span></span></span>: Registration type human-readable name for current trademark.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">trademark_type_id</span></span></span>: Trademark type <span class="hljs-literal">GUID</span>. To get a list of all trademark types available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e73b75f0faeb654084de5ec">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">trademark_type_name</span></span></span>: Trademark type human-readable name.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">expiry_date</span></span></span>: Expiry date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">publication_date</span></span></span>: Publication date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">declaration_date</span></span></span>: Declaration date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">office_action_date</span></span></span>: Office action date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">grant_date</span></span></span>: Grant date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">client_agent_id</span></span></span>: Legal entity (aka "Company", "Client") <span class="hljs-literal">GUID</span> to assign as Agent for this trademark. Client must be of type <span class="hljs-literal">Agent</span>. Click <a href="">here</a> to get a list of all client types available. To get a list of all legal entities available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b92737f8c9eb05e07851e1">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">client_agent_name</span></span></span>: Human-readable trademark agent name.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">publication_notes</span></span></span>: Notes about trademark publication.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i>
<span>array</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">good_and_services</span></span></span>: An array of objects with Good And Services for the trademark.
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">language_id</span></span></span>: Registry <span class="hljs-literal">GUID</span> for the trademark. To get a list of all languages available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf30bf8c9eb0e90ebbb59">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">text</span></span></span>: Text for the Good And Service.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">search_class_id</span></span></span>: Search class <span class="hljs-literal">GUID</span> for the Good and Service. To get a list of all search class available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf965f8c9eb0e90ebbb5d">here</a>.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">image_url</span></span></span>: An URL for the trademark image .
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">notes</span></span></span>: Notes about trademark.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">do_not_create_file</span></span></span>: If <span class="hljs-literal">true</span> the system will not create a Case for this trademark.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_id</span></span></span>: User <span class="hljs-literal">GUID</span> for the creator of the trademark. To get a list of all users available click <a href="#">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_user_name</span></span></span>: Username human-readable for the creator of the trademark.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">trademark_url_on_ipo</span></span></span>: For some registries, it may contains the URL to check trademark on IPO.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">exclude_from_auto_updates</span></span></span>: If <span class="hljs-literal">true</span> means that trademark can't be updated from IPO.
</li>
</ul>
{
"id": "677eeb82-99f7-4c68-a797-ab8400f6f701",
"registry_id": "783c0667-2884-4d0a-b93b-a6720147e45f",
"registry_name": "USPTO",
"registry_official_name": "USPTO",
"registry_description": "United States",
"mark_text": "LawPanel",
"application_number": "87064395",
"application_date": "2020-03-17T03:00:00Z",
"registration_number": "5230966",
"registration_date": "2020-03-17T03:00:00Z",
"status_date": "2020-03-17T03:00:00Z",
"mark_feature": "mark",
"status": "Valid",
"registration_type_id": "21b28699-8e12-4575-bb65-a99201173ed2",
"registration_type_name": "Associated Mark",
"trademark_type_id": "6d374194-9df4-4a26-89dd-a992011744fd",
"trademark_type_name": "Word/Device",
"expiry_date": "2020-03-17T03:00:00Z",
"publication_date": "2020-03-17T03:00:00Z",
"declaration_date": "2020-03-17T03:00:00Z",
"office_action_date": "2020-03-17T03:00:00Z",
"grant_date": "2020-03-17T03:00:00Z",
"client_agent_id": "a1c3e613-c9a5-49c5-91d9-aaaf009c09f1",
"client_agent_name": "Stronghold Invest AB",
"publication_notes": "Notes about publication",
"good_and_services": [
{
"id": "be4a9eb5-e20c-4f89-9809-ab8400f6f701",
"language": {
"id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"name": "English",
"short_name": "en",
"is_available_for_ui": true
},
"search_class": {
"id": "5096b33b-2f52-456d-b306-a6720147e7fc",
"number": 2,
"name": "Paint products",
"description": "Paints, varnishes, lacquers; preservatives against rust and against deterioration of wood; colorants; mordants; raw natural resins; metals in foil and powder form for painters, decorators, printers and artists.",
"search_classes": "2"
},
"text": "Facilitating, administering, arranging and managing funding in relation to litigation [...]"
},
{
"id": "ae0a84f0-ebd5-4071-bd9e-ab8400f6f701",
"language": {
"id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"name": "English",
"short_name": "en",
"is_available_for_ui": true
},
"search_class": {
"id": "777fe621-5eba-4985-966a-a6720147e7fc",
"number": 3,
"name": "Cosmetics and Cleaning Products",
"description": "Bleaching preparations and other substances for laundry use; cleaning, polishing, scouring and abrasive preparations; soaps; perfumery, essential oils, cosmetics, hair lotions; dentifrices; deodorants for personal use; air perfuming preparations.",
"search_classes": "3,5,21,35"
},
"text": "Design and development of computer hardware and software; software as a service [SaaS]; [...]"
}
],
"image_url": "https://web.lawpanel.com/images/firm/logo-lawpanel-white.png",
"notes": "<p>Some extra notes</p>",
"do_not_create_file": false,
"user_id": "77e2dd06-154c-4157-ad69-a6720147e652",
"user_user_name": "johndoe@ipfirm.com",
"user": {
"id": "77e2d3212-154c-1127-ad69-6720147e3652",
"first_name": "John",
"last_name": "Doe",
"user_name": "johndoe@ipfirm.com",
"email": "johndoe@ipfirm.com",
"phone_number": "+54 9387543988",
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"language_name": "en",
"country_id": "27cb8e50-0e8b-40cd-a656-a6720147e0a1",
"country_name": "AR",
"user_role": "Firm User",
"last_login_date": "2020-03-16T20:26:58.4429693Z",
"is_locked_out": false,
"claims": []
},
"trademark_url_on_ipo": null,
"exclude_from_auto_updates": false
}
Get a list with all registries (IPO) available in the system.
If you set this parameter to true, you'll only receive registries with data <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e62ae02f96ca1198ee0c637">to perform trademark searches</a>.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Returns a list with all registries availables for your query.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the registry.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">wipo_code</span></span></span></strong>: WIPO code for the registry. More details <a href="https://www.wipo.int/export/sites/www/standards/en/pdf/03-03-01.pdf" target="_blank">here</a>.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">description</span></span></span></strong>: A human readable description for the registry. Generally its name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-adjust"></i>
<span>bool</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">have_data</span></span></span></strong>: When true, it means current registry has data to <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e62ae02f96ca1198ee0c637">perform trademark searches</a>.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">url_base_for_trademarks</span></span></span></strong>: If present, it indicates a URL to get more details about trademarks. For example: <span class="hljs-string">https://euipo.europa.eu/eSearch/#details/trademarks/{ID}</span> for EUIPO.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">iso_three_letters_country_code</span></span></span></strong>: If registry belongs to a single country, it contains the <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">three letters ISO country code</a>.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">total_trademarks</span></span></span></strong>: Contains total trademarks available.</a>.</li>
</ul>
[{
"id": "b93d01dc-3fb7-4c63-b565-a7a700aacdff",
"wipo_code": "AD",
"description": "ANDORRA",
"have_data": true,
"url_base_for_trademarks": "",
"iso_three_letters_country_code": "AND",
"total_trademarks": 37080
},
{
"id": "8952587d-9f09-4bda-9160-a7a700aaca19",
"wipo_code": "AE",
"description": "UNITED ARAB EMIRATES",
"have_data": true,
"url_base_for_trademarks": "",
"iso_three_letters_country_code": "ARE",
"total_trademarks": 252109
},
{
"id": "1a03674f-2b85-4289-becd-a7a700aaccd5",
"wipo_code": "AF",
"description": "AFGHANISTAN",
"have_data": true,
"url_base_for_trademarks": "",
"iso_three_letters_country_code": "AFG",
"total_trademarks": 12869
}
]
Return an array of trademarks passing an array of trademarks ID (integers) into the body of request.
An array of integers with the trademarks ID.
[424804,424805]
Return an array with trademarks representations.
[
{
"id": "1294|UK",
"application_number": "1294",
"registration_date": "1876-01-26T00:00:00Z",
"application_date": "1876-01-26T00:00:00Z",
"expiry_date": "2022-01-26T00:00:00Z",
"mark_feature": "Figurative",
"kind_mark": "Individual",
"mark_text": "JAS, Hennessy & Co., Cognac.",
"classes": "33",
"status": "Registered",
"registry": "UK",
"good_and_services": [
{
"class_number": 33,
"description": "Brandy.",
"language_code": "en"
}
],
"applicants": [
{
"id": 114985,
"name": "Societe Jas Hennessy & Co",
"address": null
}
],
"representatives": [
{
"id": 114060,
"name": "Baker & McKenzie LLP",
"address": null
}
],
"created_at": "0001-01-01T00:00:00Z",
"enable": false
},
{
"id": "1298|UK",
"application_number": "1298",
"registration_date": "1876-01-25T00:00:00Z",
"application_date": "1876-01-25T00:00:00Z",
"expiry_date": "2002-01-25T00:00:00Z",
"mark_feature": "Figurative",
"kind_mark": "Individual",
"mark_text": "SIR WALTER RALEIGH",
"classes": "34",
"status": "Dead",
"registry": "UK",
"good_and_services": [
{
"class_number": 34,
"description": "Cigars.",
"language_code": "en"
}
],
"applicants": [
{
"id": 115885,
"name": "E. Alton & Co Limited",
"address": null
}
],
"representatives": [
{
"id": 113686,
"name": "D. Young & Co. LLP",
"address": null
}
],
"created_at": "0001-01-01T00:00:00Z",
"enable": false
}
]
Trademarks - 05.Search
Return a lists with all Companies available.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Returns a list of legal entities available on the system.
[
{
"id": "52a17882-38bd-4dfd-8326-aad8012ad09d",
"client": {
"name": "Barclays Plc",
"company_registration_number": "0303456",
"contact_name": "Bilbo Baggins",
"contact_email": "bilbo@barclays.com",
"contact_number": "+543875333953",
"contact_address": {
"id": "6a0e84cc-c9c8-4519-b88a-aad8012ad09d",
"line1": "Alsina 151",
"line2": "Torre 1",
"line3": "Departamento 2A",
"building": "Torres de Alsina",
"floor_level": "2nd",
"postal_code": "4400",
"city": "Salta",
"state_province": "Salta",
"region": "Noroeste Argentino",
"country_id": "27CB8E50-0E8B-40CD-A656-A6720147E0A1"
},
"billing_address": {
"id": "6a0e84cc-c9c8-4519-b88a-aad8012ad09d",
"line1": "Alsina 151",
"line2": "Torre 1",
"line3": "Departamento 2A",
"building": "Torres de Alsina",
"floor_level": "2nd",
"postal_code": "4400",
"city": "Salta",
"state_province": "Salta",
"region": "Noroeste Argentino",
"country_id": "27CB8E50-0E8B-40CD-A656-A6720147E0A1"
},
"client_type": {
"id": "25eaad5c-2bea-44e5-89e2-a99201175b40",
"code": 2,
"name": "Agent"
}
},
"total_users": 3,
"total_cases": 1
}
]
This code is returned if you don't have any Company.
Delete a legal entity, company or client.
The Company ID to be deleted.
Return details about the delete operation.
{
"id": "e43b3206-842c-4deb-99c8-a88d00f55c48",
"message": "Firm client successfully deleted",
"successful": true
}
Return all cases available.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Return all cases enabled to operate.
[
{
"id": "999ee0a3-209c-4bfa-96a3-ac31009acde1",
"name": "22242",
"client": {
"id": "c559a609-0948-4085-a7dd-ac31009acd26",
"name": "Robinson Richard",
"company_registration_number": null,
"contact_name": "",
"contact_email": "email@server.com",
"contact_number": null,
"contact_address": {
"id": "40d1e085-20e1-4afd-83b4-ac31009acd26",
"line1": null,
"line2": null,
"line3": null,
"building": null,
"floor_level": null,
"postal_code": null,
"city": null,
"state_province": null,
"region": null,
"country_id": "c6b020e9-e5b1-425d-823e-a67300008be3",
"country_name": "Brazil"
},
"billing_address": {
"id": "3118a563-1e88-4c4a-90df-ac31009acd26",
"line1": null,
"line2": null,
"line3": null,
"building": null,
"floor_level": null,
"postal_code": null,
"city": null,
"state_province": null,
"region": null,
"country_id": "c6b020e9-e5b1-425d-823e-a67300008be3",
"country_name": "Brazil"
},
"client_type": "604a3d85-5c5b-4364-b69c-a99201175b30"
},
"file_status_id": "dbb513aa-58e3-4a70-a805-a74c00714768",
"file_status_name": "Opened",
"owner": {
"id": "8243ac64-65e9-42b5-a292-a8070178a462",
"first_name": "TMD",
"last_name": "Migration",
"user_name": "lawpanel@tmd.com",
"email": "lawpanel@tmd.com",
"phone_number": "654321",
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"language_name": "en",
"country_id": "5306aa9a-3c36-40d8-b32e-a67300008be3",
"country_name": "GB"
},
"other_supervisors": [{
"id": "d344g609-0948-4085-a7dd-ac34567ghh56",
"first_name": "Mark",
"last_name": "KW",
"user_name": null,
"email": null,
"phone_number": null,
"language_id": null,
"language_name": null,
"country_id": "5306aa9a-3c36-40d8-b32e-a67300008be3",
"country_name": "GB"
}
],
"updated_at": "2020-09-09T09:23:37.5112425Z",
"payment_status": "",
"updated_by": "lawpanel@tmd.com",
"tags": [],
"number": "22242",
"file_template": {
"id": "3dc49d41-4cdc-47bb-b965-a807017653d4",
"name": "Trademark TMD",
"file_template_components": [
{
"id": "2f629748-c13f-4fc3-a760-a80701765553",
"name": "Search result",
"description": "Represent a search result executed by a firm",
"definition": null,
"definition_type": null,
"entity_type": "FirmSearch",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 1,
"value_type": null
},
{
"id": "fcad12f2-4efc-4158-8a41-a80701765749",
"name": "Good and services",
"description": "Please describe the goods or services the name is to be used with",
"definition": null,
"definition_type": null,
"entity_type": "StringMultiText",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 2,
"value_type": null
},
{
"id": "68bb0819-e272-4392-8fcc-a8070176592e",
"name": "Website",
"description": "If there is a website for your business or goods/services please enter the URL",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 3,
"value_type": null
},
{
"id": "b74feae6-201a-4b7e-a477-a80701765b13",
"name": "Are you already using the name",
"description": "if so please let us know, this can help us get the name registered",
"definition": "{\"Items\":[{\"Display\":\"Not using\",\"Value\":\"Not using\",\"Enable\":false},{\"Display\":\"Less than 1 year\",\"Value\":\"Less than 1 year\",\"Enable\":false},{\"Display\":\"1 - 3 years\",\"Value\":\"1 - 3 years\",\"Enable\":false},{\"Display\":\"4 - 5 years\",\"Value\":\"4 - 5 years\",\"Enable\":false},{\"Display\":\"More than 5 years\",\"Value\":\"More than 5 years\",\"Enable\":false}],\"Enable\":false}",
"definition_type": "SelectItemFromListDefinitionDto",
"entity_type": "SelectItemFromList",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 4,
"value_type": null
},
{
"id": "b5f55936-ae28-4dab-9425-a80701765d2b",
"name": "Series",
"description": "Trademark is individual or part of a series?",
"definition": "{\"OptionWithTexts\":[{\"Id\":\"IndividualTrademark\",\"OptionName\":\"This is an individual trade mark and not part of a series of trade marks\",\"OptionDescription\":\"\",\"WithDescription\":false,\"SelectedByDefault\":true,\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false},{\"Id\":\"PartOfSeriesTrademark\",\"OptionName\":\"This trade mark is part of a series of related trade marks\",\"OptionDescription\":\"A series of marks is a number of marks which only have very small differences that do not substantially affect the marks (for example, a word shown in CAPITALS and in 'small' letters).\",\"WithDescription\":true,\"SelectedByDefault\":false,\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}],\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}",
"definition_type": "OptionsWithTextDefinitionDto",
"entity_type": "OptionsWithText",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 5,
"value_type": null
},
{
"id": "9c745a64-d9aa-47f8-83e9-a80701765f17",
"name": "Previously registered",
"description": "Trademark was previously registered?",
"definition": "{\"OptionWithTexts\":[{\"Id\":\"NotPreviouslyRegistered\",\"OptionName\":\"I have not previously registered this trade mark in another country\",\"OptionDescription\":\"\",\"WithDescription\":false,\"SelectedByDefault\":true,\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false},{\"Id\":\"PreviouslyRegistered\",\"OptionName\":\"I have previously registered this trade mark in another country\",\"OptionDescription\":\"If you have previously registered this trade mark in another country you may be able to claim priority over competing trade marks in this country. Please give details of previous registrations (incl. priority date, country, number)\",\"WithDescription\":true,\"SelectedByDefault\":false,\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}],\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}",
"definition_type": "OptionsWithTextDefinitionDto",
"entity_type": "OptionsWithText",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 6,
"value_type": null
},
{
"id": "b55d051b-940a-4610-a8e3-a807017660fc",
"name": "SMS Notifications",
"description": "Being able to send you texts can help us progress your application more quickly and efficiently. Please enter your mobile phone number.",
"definition": "{\"Id\":\"SmsNotifications\",\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}",
"definition_type": "CheckboxWithTextDefinitionDto",
"entity_type": "CheckboxWithText",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 7,
"value_type": "OptionsWithTextValueDto"
},
{
"id": "ff7777f7-23f1-430e-94f0-aa4d00e71536",
"name": "Order folder",
"description": "Order folder",
"definition": "{\"Items\":[{\"Display\":\"Abandoned\",\"Value\":\"Abandoned\",\"Enable\":false},{\"Display\":\"Action required\",\"Value\":\"Action required\",\"Enable\":false},{\"Display\":\"Action required (paid)\",\"Value\":\"Action required (paid)\",\"Enable\":false},{\"Display\":\"Client action (paid)\",\"Value\":\"Client action (paid)\",\"Enable\":false},{\"Display\":\"Deleted\",\"Value\":\"Deleted\",\"Enable\":false},{\"Display\":\"For review\",\"Value\":\"For review\",\"Enable\":false},{\"Display\":\"For review (paid)\",\"Value\":\"For review (paid)\",\"Enable\":false},{\"Display\":\"New orders\",\"Value\":\"New orders\",\"Enable\":false},{\"Display\":\"No action\",\"Value\":\"No action\",\"Enable\":false},{\"Display\":\"Ongoing\",\"Value\":\"Ongoing\",\"Enable\":false},{\"Display\":\"Right Start\",\"Value\":\"Right Start\",\"Enable\":false},{\"Display\":\"Standard filing\",\"Value\":\"Standard filing\",\"Enable\":false},{\"Display\":\"To be filed\",\"Value\":\"To be filed\",\"Enable\":false},{\"Display\":\"Client action\",\"Value\":\"Client action\",\"Enable\":false}],\"Enable\":true}",
"definition_type": "SelectItemFromListDefinitionDto",
"entity_type": "SelectItemFromList",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 8,
"value_type": null
},
{
"id": "ba1be818-5b43-411a-b9db-aa4d00e7153b",
"name": "Order status",
"description": "Order status",
"definition": "{\"Items\":[{\"Display\":\"Awaiting client comments\",\"Value\":\"Awaiting client comments\",\"Enable\":false},{\"Display\":\"Filed\",\"Value\":\"Filed\",\"Enable\":false},{\"Display\":\"On hold awaiting client\",\"Value\":\"On hold awaiting client\",\"Enable\":false},{\"Display\":\"Order cancelled\",\"Value\":\"Order cancelled\",\"Enable\":false},{\"Display\":\"Order finished\",\"Value\":\"Order finished\",\"Enable\":false},{\"Display\":\"Prepare for filing\",\"Value\":\"Prepare for filing\",\"Enable\":false},{\"Display\":\"Preparing draft application\",\"Value\":\"Preparing draft application\",\"Enable\":false},{\"Display\":\"Preparing spec\",\"Value\":\"Preparing spec\",\"Enable\":false},{\"Display\":\"Report order placed\",\"Value\":\"Report order placed\",\"Enable\":false},{\"Display\":\"Searches and legal checks\",\"Value\":\"Searches and legal checks\",\"Enable\":false},{\"Display\":\"We're thinking\",\"Value\":\"We're thinking\",\"Enable\":false}],\"Enable\":true}",
"definition_type": "SelectItemFromListDefinitionDto",
"entity_type": "SelectItemFromList",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 9,
"value_type": null
}
],
"is_base": false,
"is_template_for_trademark_filing": true,
"is_template_filing": false,
"base_id": "00000000-0000-0000-0000-000000000000",
"ip_records": []
},
"active": true
}
]
Return all templates available for create Cases.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Return all templates enabled to operate with cases. A template contains different components to save data.
[
{
"enable": true,
"id": "c554e22c-6f6e-42d3-8954-a780013c92a0",
"name": "Generic / basic",
"file_template_components": [
{
"enable": true,
"id": "907530ca-ae98-42b6-9293-a780013c92fd",
"name": "Free",
"description": "Represent any kind of information to save",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": null,
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 1,
"value_type": null
}
],
"is_base": false,
"is_template_for_trademark_filing": false,
"base_id": "00000000-0000-0000-0000-000000000000",
"cases": 2
},
{
"enable": true,
"id": "df47efd3-f51e-42e0-a3f4-a74c00715017",
"name": "Opposition",
"file_template_components": [
{
"enable": true,
"id": "62968eff-b8d3-4188-84a9-a76400615aef",
"name": "Classes",
"description": "Classes",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": null,
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 2,
"value_type": null
},
{
"enable": true,
"id": "13a9f37e-d536-4859-bb76-a7640061607b",
"name": "Lawyer",
"description": "Lawyer in the opposition",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": null,
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 3,
"value_type": null
},
{
"enable": true,
"id": "4890dce9-570b-4f58-bc06-a76400615ea3",
"name": "Opponent",
"description": "Opposition opponent",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": null,
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 2,
"value_type": null
},
{
"enable": true,
"id": "086c016b-deaf-4cb3-9c2e-a76400615ccb",
"name": "Registry",
"description": "Registry",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": null,
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 2,
"value_type": null
},
{
"enable": true,
"id": "fac0cb33-f3fd-4720-8bfd-a76400615911",
"name": "Trademark",
"description": "Represent a trademark",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": null,
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 1,
"value_type": null
}
],
"is_base": false,
"is_template_for_trademark_filing": false,
"base_id": "00000000-0000-0000-0000-000000000000",
"cases": 6
},
{
"enable": true,
"id": "f9e2bd7e-5c91-4008-a6bf-a74c00714ce8",
"name": "Trademark",
"file_template_components": [
{
"enable": true,
"id": "29f11b48-64ce-4a3f-a5d5-a76400614edf",
"name": "Description",
"description": "A field to allow user enter a description about the trademark",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": null,
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 3,
"value_type": null
},
{
"enable": true,
"id": "0a9b3a97-36d7-44ba-8f16-a764006154df",
"name": "Previously registered",
"description": "Previously registered",
"definition": null,
"definition_type": null,
"entity_type": "Boolean",
"permissions": null,
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 6,
"value_type": null
},
{
"enable": true,
"id": "c2604b44-5905-4762-9299-a76400614b21",
"name": "Search result",
"description": "Represent a search result executed by a firm",
"definition": null,
"definition_type": null,
"entity_type": "FirmSearch",
"permissions": null,
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 1,
"value_type": null
},
{
"enable": true,
"id": "f8fa52b3-3f5a-48e0-b9cc-a76400615304",
"name": "Series",
"description": "Series",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": null,
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 5,
"value_type": null
},
{
"enable": true,
"id": "b172c72a-3ab9-4463-a094-a764006150bb",
"name": "Time in use",
"description": "Time in use",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": null,
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 4,
"value_type": null
},
{
"enable": true,
"id": "bfcf31e5-fa73-4680-8f86-a76400614d02",
"name": "Url",
"description": "Url",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": null,
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 2,
"value_type": null
}
],
"is_base": false,
"is_template_for_trademark_filing": false,
"base_id": "00000000-0000-0000-0000-000000000000",
"cases": 8
}
]
Create a new invoice item.
Payload must contain information about the new Invoice Item.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">invoice_entity_type</span></span></span>: A string with the type of entity where the new Invoice Item will be associated. For example, to add the new Invoice Item inside a Case you must use the string "File".
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">invoice_entity_id</span></span></span>: The ID of the entity where the new Invoice Item wil be associated. If you want to bind the Invoice Item with a Case, you have to use the Case ID here.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">currency_id</span></span></span>: The Currency ID for the invoice item. To get a list of currencies available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b93b43f8c9eb05e07851eb?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">taxes</span></span></span>: Has this item taxes?, if so, this property should contains the Taxes ID. To get a list of taxes available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf52df8c9eb0e90ebbb5b?&groupBy=tag">link</a>.
</li>
</ul>
{
"invoice_entity_id": "53620e77-5e3b-431b-9cb0-ac2800eaac75",
"invoice_entity_type": "File",
"code": "001",
"name": "Item 001",
"details": "This is a fee item for a Case",
"currency_id": "14e294cf-7425-422f-83f2-a6b20003f5e3",
"quantity": 1,
"currency_units": 100,
"taxes": [
"1db77783-9e48-4ddc-a665-a6b4002671c1"
]
}
This code is returned when the Invoice Item was created successfully.
{
"id": "2db77f75-b957-4b5e-9bd3-ac3100d1aeae",
"code": "001",
"name": "Item 001",
"product_type": {
"id": "615e202e-62f6-43ce-bc9f-a6b200040c9b",
"name": "Service"
},
"currency": {
"id": "14e294cf-7425-422f-83f2-a6b20003f5e3",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
"currency_units": 100,
"quantity": 1,
"taxes": [
{
"id": "1db77783-9e48-4ddc-a665-a6b4002671c1",
"name": "UK VAT",
"description": "Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by the national government. It was introduced in 1973 and is the third largest source of government revenue after income tax and National Insurance. It is administered and collected by HM Revenue and Customs, primarily through the Value Added Tax Act 1994.",
"units": 0,
"percent": 20
}
],
"details": "This is a fee item for a Case",
"paid_out": false,
"invoice_entity_type": "File",
"invoice_entity_id": "53620e77-5e3b-431b-9cb0-ac2800eaac75"
}
Invoice Item - 03.Update[S]
Invoice Item - 04.Delete[S]
Return a list of currency available on the system.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Return all currencies enabled to operate with payments and invoices.
[
{
"id": "54cb5c6a-a8e0-4dec-afcc-a6e90008d6ae",
"name": "American dollar",
"name_short": "USD",
"symbol": "$"
},
{
"id": "cd80f109-c15c-42c1-9ae3-a6e90008d70c",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
{
"id": "20c47730-a985-4346-b6f7-a6e90008d76a",
"name": "Euro",
"name_short": "EUR",
"symbol": "€"
}
]
Return all types of invoices available.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Returns a list of Invoice Type available.
[
{
"id": "de08d07a-b45b-4c53-8622-a7ec017b5dc1",
"name": "Default",
"code": 0,
"description": "This is the default invoice type for all invoices",
"leading_zeros": "0000000000",
"prefix": null
}
]
Creates a new invoice.
Payload must contain information about the Invoice to be created.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">invoice_items_id</span></span></span>: An array of Invoice Items ID to compose the Invoice. To get a list of Invoice Items available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5f594925c3a4d6795ab942b8?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">client_id</span></span></span>: The Company ID for the Invoice. (Who is the Invoice for?). To get details of Companies available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b92737f8c9eb05e07851e1?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">invoice_type_id</span></span></span>: The Invoice Type ID for the Invoice. To get details about Invoice Types available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b93bbf901adc17208edbcf?&groupBy=tag">link</a>.
</li>
</ul>
{
"invoice_items_ids": [
"ce30d5d7-1ce9-498e-a386-ac31015949f1"
],
"client_id": "1c71c9bd-0603-4e95-8596-abb400efe5f3",
"date_time": 1599609600,
"date_time_due": 1599609600,
"invoice_type_id": "de08d07a-b45b-4c53-8622-a7ec017b5dc1",
"invoice_number": 1,
"observations": "Invoice notes"
}
This code is returned when the client was created successfully.
Returns a list with all invoices available for your Firm.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Returns a list with all Invoices created for your Firm.
[
{
"id": "ab88a885-f937-4ce8-9f5d-ac3100f0cb9e",
"date_time": "2020-09-09T00:00:00Z",
"date_time_due": "2020-09-09T00:00:00Z",
"invoice_type": {
"id": "bec8d8b7-a1e5-4e4c-911a-a7cc00fff1c2",
"name": "Default",
"code": 0,
"description": "This is the default invoice type for all invoices",
"leading_zeros": "0000000000",
"prefix": "A-"
},
"invoice_number": 1,
"client": {
"id": "7187420e-9e7a-43f6-b832-ac3000d470e9",
"name": "Name of the Company",
"company_registration_number": "Registration Number",
"contact_name": "Contact name",
"contact_email": "contact@email.com",
"contact_number": "+5493875333953",
"contact_address": {
"id": "7b25e717-b1f1-4bf6-8cde-ac3000d470e7",
"line1": "Dr. Adolfo Alsina 151",
"line2": "-",
"line3": "-",
"building": "Torres de Alsina",
"floor_level": "2nd",
"postal_code": "4400",
"city": "Salta Capital",
"state_province": "Salta",
"region": "Noroeste Argentino",
"country_id": "4576b6bc-936c-4879-a03c-a68900ad3722",
"country_name": "Argentina"
},
"billing_address": {
"id": "55217328-90e3-4a5c-a3cf-ac3000d470e7",
"line1": "Dr. Adolfo Alsina 151",
"line2": "-",
"line3": "-",
"building": "Torres de Alsina",
"floor_level": "2nd",
"postal_code": "4400",
"city": "Salta Capital",
"state_province": "Salta",
"region": "Noroeste Argentino",
"country_id": "4576b6bc-936c-4879-a03c-a68900ad3722",
"country_name": "Argentina"
},
"client_type": {
"id": "0a246949-d71d-49ae-a17b-a975001bdf45",
"code": 1,
"name": "Client"
}
},
"total_invoice_items": 120.000000,
"total_payments": 120.00,
"user": {
"id": "f947fbce-9f3f-4ece-b002-a68d014e018c",
"first_name": "John",
"last_name": "Doe",
"user_name": "john@doe.com",
"email": "john@doe.com",
"phone_number": "+54 9387543988",
"language_id": "d690da37-20a7-436a-b6a4-a68900ad35b7",
"language_name": "en",
"country_id": "4576b6bc-936c-4879-a03c-a68900ad3722",
"country_name": "AR",
"user_role": "Admin",
"last_login_date": "2020-08-31T11:55:18.7668609Z",
"is_locked_out": false,
"user_settings": null,
"claims": []
},
"currency": {
"id": "14e294cf-7425-422f-83f2-a6b20003f5e3",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
"observations": "Observations for the Invoice"
}
]
This code is returned if there are not any Invoice for your Firm.
Invoice - 03.Update[S]
Invoice - 04.Delete[S]
Retrieve all payments methods supported by LawPanel.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Returns a list with all payment methods available to be used to create a Payment.
[
{
"id": "9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4",
"code": 1,
"name": "Credit Card",
"description": "A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services.",
"payment_method_component_definitions": [
{
"id": "7a3b5edd-b20e-499a-aeaa-a7e8000a2ccd",
"name": "card_name",
"display_name": "Name",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 1024,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 1
},
{
"id": "c1138c80-0ee2-4f67-b2da-a7cc00ffc389",
"name": "address_line_one",
"display_name": "Address line one",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 2
},
{
"id": "c1837a7a-3cc0-42ac-ad0d-a7cc00ffc504",
"name": "address_line_two",
"display_name": "Address line two",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 3
},
{
"id": "3339089b-4535-4ec1-a9b9-a7e8000a3451",
"name": "address_city",
"display_name": "City",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 4
},
{
"id": "136678f3-6827-4ea9-9a02-a7e8000a3748",
"name": "address_state",
"display_name": "State",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 5
},
{
"id": "8f298718-3d17-450f-8871-a7e8000a3abc",
"name": "address_zip",
"display_name": "Zip",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 6
},
{
"id": "3bd795ba-adff-45af-8b2f-a7e8000a3cc3",
"name": "address_country",
"display_name": "Country",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 7
},
{
"id": "2b3ea2a5-61c8-456b-8b88-a7e8000a3ec6",
"name": "observations",
"display_name": "Observations",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 1024,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 8
}
],
"reusable": true
},
{
"id": "0b655e83-d46f-432c-80d2-a7cc00ffd4d9",
"code": 2,
"name": "Bank transfer",
"description": "Wire transfer, bank transfer or credit transfer is a method of electronic funds transfer from one person or entity to another.",
"payment_method_component_definitions": [
{
"id": "b4a59072-0997-464f-a91a-a7e8000a41b8",
"name": "transfer_date",
"display_name": "Transfer date",
"class_name": "DateTime",
"pattern": "",
"mask": null,
"required": true,
"select_from": null,
"disabled": false,
"max": null,
"max_length": null,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 0
},
{
"id": "daac72de-87c7-41db-91a4-a7e8000a4426",
"name": "from_bank_name",
"display_name": "From bank",
"class_name": "String",
"pattern": "",
"mask": null,
"required": true,
"select_from": null,
"disabled": false,
"max": null,
"max_length": null,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 1
},
{
"id": "a76af918-047e-4db6-80ad-a7e8000a46a9",
"name": "from_account_number",
"display_name": "From account",
"class_name": "String",
"pattern": "",
"mask": null,
"required": true,
"select_from": null,
"disabled": false,
"max": null,
"max_length": null,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 2
},
{
"id": "0d6c92ad-3984-4536-b008-a7e8000a4929",
"name": "account_owner",
"display_name": "Account owner",
"class_name": "String",
"pattern": "",
"mask": null,
"required": true,
"select_from": null,
"disabled": false,
"max": null,
"max_length": null,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 3
},
{
"id": "28d552f1-b005-4442-86bd-a7e8000a4b32",
"name": "to_bank_name",
"display_name": "To bank",
"class_name": "String",
"pattern": "",
"mask": null,
"required": true,
"select_from": null,
"disabled": false,
"max": null,
"max_length": null,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 4
},
{
"id": "b2cc3edb-4fdb-4d74-9e8e-a7e8000a4d3f",
"name": "to_account_number",
"display_name": "To account",
"class_name": "String",
"pattern": "",
"mask": null,
"required": true,
"select_from": null,
"disabled": false,
"max": null,
"max_length": null,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 5
}
],
"reusable": false
},
{
"id": "cc6120a1-b639-4746-8fa7-a86401891b45",
"code": 3,
"name": "Other",
"description": "Other mechanism to receive payments. Manually, etc.",
"payment_method_component_definitions": [
{
"id": "617309ec-3d1c-46bb-b233-a86401891cc9",
"name": "date",
"display_name": "Date",
"class_name": "DateTime",
"pattern": "",
"mask": null,
"required": true,
"select_from": null,
"disabled": false,
"max": null,
"max_length": null,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 0
},
{
"id": "edda0df3-8d47-47f7-b45a-a86401891ed1",
"name": "comments",
"display_name": "Comments",
"class_name": "BigString",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": null,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 1
}
],
"reusable": false
}
]
This code is returned if there are not payment methods available to use with Payments.
Payment Transaction Type - 01.Read[S]
Return all payment providers available to work with in LawPanel.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Returns a list with all payment providers implemented on LawPanel.
[
{
"id": "b9fcbbd8-f584-4e44-bf28-a7cc00ffed97",
"name": "Stripe",
"description": "Stripe is a US technology company, operating in over 25 countries.",
"url": "https://stripe.com/",
"implementation": null,
"is_default": true
}
]
This code is returned if there are not payment providers available to work with.
Creates a new payment.
Payload must contain information about the Payment to be created.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">invoice_id</span></span></span>: The Invoice ID for the Payment. To get a list of Invoices available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b93c30901adc17208edbd0?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">payment_provider_id</span></span></span>: The Payment Provider ID for the Payment. If you leave it as null the default Payment Provider will be selected. To get a list of Payment Providers available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b95063901adc17208edbd3?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">payment_method_id</span></span></span>: The Payment Method ID for the Payment. To get a list of Payment Methods available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b93db1901adc17208edbd2?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">payment_method_components</span></span></span>: The components for the Payment Method selected. You can get the list of them, checking the Payment Method on details on this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5f5b978d408f759fda5857a5?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">capture</span></span></span>: If this property is true the Payment will be captured at the Payment Provider. Else, it will be only authorized.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">save_current_payment_method_data</span></span></span>: If this property is true the Payment Method will be associated with the Company on the Invoice and saved on the Payment Provider vault.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">impact_on_payment_provider</span></span></span>: If this property is true the Payment will be executed on the Payment Provider, else it will be recorded only on LawPanel.
</li>
</ul>
{
"invoice_id": "ab88a885-f937-4ce8-9f5d-ac3100f0cb9e",
"description": "A little description for the payment. This is a sample of a payment created with a credit card.",
"payment_provider_id": "b9fcbbd8-f584-4e44-bf28-a7cc00ffed97",
"payment_method_id": "9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4",
"payment_method_components": [
{
"name": "payment_provider_token",
"value": "tok_1HPug6BekBiB2yVLoh0mrG66"
},
{
"name": "card_name",
"value": "Johann Sebastian Bach"
},
{
"name": "address_line_one",
"value": "Frauenplan 21"
},
{
"name": "address_line_two",
"value": ""
},
{
"name": "address_city",
"value": "Eisenach"
},
{
"name": "address_state",
"value": "Thuringia"
},
{
"name": "address_zip",
"value": ""
},
{
"name": "address_country",
"value": "Germany"
},
{
"name": "observations",
"value": ""
}
],
"currency_units": "11.00",
"capture": true,
"save_current_payment_method_data": true,
"impact_on_payment_provider": true
}
This code is returned if the Payment was created successfully.
{
"id": "45e787ad-defe-4321-b2b6-ac3301338374",
"date_time": "2020-09-11T18:39:37.3409591Z",
"payment_provider": {
"id": "b9fcbbd8-f584-4e44-bf28-a7cc00ffed97",
"name": "Stripe",
"description": "Stripe is a US technology company, operating in over 25 countries, that allows both private individuals and businesses to accept payments over the Internet.",
"url": "https://stripe.com/",
"implementation": "PaymentProviderStripe",
"is_default": true
},
"payment_method": {
"id": "9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4",
"code": 1,
"name": "Credit Card",
"description": "A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services.",
"payment_method_component_definitions": [
{
"id": "c1138c80-0ee2-4f67-b2da-a7cc00ffc389",
"name": "address_line_one",
"display_name": "Address line one",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 2
},
{
"id": "c1837a7a-3cc0-42ac-ad0d-a7cc00ffc504",
"name": "address_line_two",
"display_name": "Address line two",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 3
},
{
"id": "dc7e0c54-8e1b-47a3-ad0a-a7e8000a2a37",
"name": "payment_provider_token",
"display_name": "Credit card token",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 512,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": true,
"display_order": 0
},
{
"id": "7a3b5edd-b20e-499a-aeaa-a7e8000a2ccd",
"name": "card_name",
"display_name": "Name",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 1024,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 1
},
{
"id": "3339089b-4535-4ec1-a9b9-a7e8000a3451",
"name": "address_city",
"display_name": "City",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 4
},
{
"id": "136678f3-6827-4ea9-9a02-a7e8000a3748",
"name": "address_state",
"display_name": "State",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 5
},
{
"id": "8f298718-3d17-450f-8871-a7e8000a3abc",
"name": "address_zip",
"display_name": "Zip",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 6
},
{
"id": "3bd795ba-adff-45af-8b2f-a7e8000a3cc3",
"name": "address_country",
"display_name": "Country",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 7
},
{
"id": "2b3ea2a5-61c8-456b-8b88-a7e8000a3ec6",
"name": "observations",
"display_name": "Observations",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 1024,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 8
}
],
"reusable": true
},
"payment_method_details": "Credit card VISA finished with 4242",
"payment_method_component_instances": [
{
"id": "ea2194db-9711-4032-a8af-ac33013381b8",
"payment_method_component_definition": {
"id": "dc7e0c54-8e1b-47a3-ad0a-a7e8000a2a37",
"name": "payment_provider_token",
"display_name": "Credit card token",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 512,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": true,
"display_order": 0
},
"value": "tok_1HQH9kBekBiB2yVLdjDcNThX"
},
{
"id": "8f18f864-fef9-49b5-af5d-ac33013381bb",
"payment_method_component_definition": {
"id": "7a3b5edd-b20e-499a-aeaa-a7e8000a2ccd",
"name": "card_name",
"display_name": "Name",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 1024,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 1
},
"value": "Johann Sebastian Bach"
},
{
"id": "e3e979ff-3955-45e3-b5ae-ac33013381bb",
"payment_method_component_definition": {
"id": "c1138c80-0ee2-4f67-b2da-a7cc00ffc389",
"name": "address_line_one",
"display_name": "Address line one",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 2
},
"value": "Frauenplan 21"
},
{
"id": "ce0a85c2-37ea-458c-98f6-ac33013381bb",
"payment_method_component_definition": {
"id": "c1837a7a-3cc0-42ac-ad0d-a7cc00ffc504",
"name": "address_line_two",
"display_name": "Address line two",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 3
},
"value": ""
},
{
"id": "385f14f3-bf74-4419-be5f-ac33013381bb",
"payment_method_component_definition": {
"id": "3339089b-4535-4ec1-a9b9-a7e8000a3451",
"name": "address_city",
"display_name": "City",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 4
},
"value": "Eisenach"
},
{
"id": "e7d63616-76e2-4c70-a47f-ac33013381bb",
"payment_method_component_definition": {
"id": "136678f3-6827-4ea9-9a02-a7e8000a3748",
"name": "address_state",
"display_name": "State",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 5
},
"value": "Thuringia"
},
{
"id": "a88ff455-5aa7-4209-bc0e-ac33013381bb",
"payment_method_component_definition": {
"id": "8f298718-3d17-450f-8871-a7e8000a3abc",
"name": "address_zip",
"display_name": "Zip",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 6
},
"value": ""
},
{
"id": "e634a53b-09fe-4518-8182-ac33013381bb",
"payment_method_component_definition": {
"id": "3bd795ba-adff-45af-8b2f-a7e8000a3cc3",
"name": "address_country",
"display_name": "Country",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 7
},
"value": "Germany"
},
{
"id": "8d98d848-244b-4f41-b0bb-ac33013381bb",
"payment_method_component_definition": {
"id": "2b3ea2a5-61c8-456b-8b88-a7e8000a3ec6",
"name": "observations",
"display_name": "Observations",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 1024,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 8
},
"value": ""
}
],
"payment_status": {
"id": "529935ee-8f1a-4d4b-a67e-a7e8000a1579",
"code": 5,
"name": "Captured",
"description": "The payment is captured"
},
"currency": {
"id": "14e294cf-7425-422f-83f2-a6b20003f5e3",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
"currency_units": 11,
"payment_status_payment_transaction_types": [
{
"id": "51bf2017-0cfc-4bf6-af8e-a7e8000a17f6",
"payment_status": {
"id": "529935ee-8f1a-4d4b-a67e-a7e8000a1579",
"code": 5,
"name": "Captured",
"description": "The payment is captured"
},
"payment_transaction_type": {
"id": "413b0c48-74bf-40b7-b534-a7e80009fb61",
"code": 2,
"name": "Refund",
"description": "Refund/cancel/void the payment"
},
"payment_method_type": "NotDefined",
"payment_amount": null
}
],
"payment_transactions": [
{
"id": "53cd8b42-e06f-4637-ae15-ac330133847f",
"payment_id": "45e787ad-defe-4321-b2b6-ac3301338374",
"date_time": 1599849578,
"payment_transaction_status": {
"id": "3d56d236-6881-4450-9436-a7cc00ff837a",
"code": 1,
"name": "Successful",
"description": "The transaction has been finished successfully"
},
"payment_transaction_type": {
"id": "fddc3cda-0315-41e5-b0ee-a7e80009f9cc",
"code": 1,
"name": "Capture",
"description": "Capture the payment"
},
"response": "Invoice details: Number: 1 - Date: 9/9/2020 - Total: 120.000000 - Notes: Observations for the Invoice. Payment details: Total: £ 11.00 - Notes: A little description for the payment. This is a sample of a payment created with a credit card. ",
"notes": null,
"payment_provider_transaction_id": "ch_1HQH9oBekBiB2yVLWk9WFPn5",
"amount": 11
}
],
"payment_provider_entity_id": "ch_1HQH9oBekBiB2yVLWk9WFPn5"
}
Payment - 02.Read[S]
Payment - 03.Update[S]
<p>Create a new user for a Company.</p>
<p>Company Users are users able to login into Clients Area for its parent Company.</p>
Payload must contain information about the Company User to be created.
Most of the properties are self-explanatory, but:
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">client_id</span></span></span>: The ID for Client/Company owner of the new Company User. To get a list of all Companies available in your Firm please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b92737f8c9eb05e07851e1?&groupBy=tag">link</a>.
</li>
</ul>
{
"client_id": "1c8a8cf8-a58a-46b8-a172-ab440147061f",
"user": {
"user_name": "user@domain.com",
"email": "user@domain.com",
"password": "123456",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+543875333953",
"is_email_confirmed": true,
"user_role": 2
}
}
This code is returned when the Company User is created successfully.
Updates a Company User.
Payload must contain information about the Company User to be updated.
Most of the properties are self-explanatory, but these:
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: You must use here the Company User ID, not the User ID.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user.id</span></span></span>: The User ID.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user.password</span></span></span>: If you don't include a value for this property, the user's password will remain unchanged.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">client_id</span></span></span>: The ID for the Company where the User belongs.To get details of different Companies available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b92737f8c9eb05e07851e1?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">claims</span></span></span>: An array of Claims IDs to be used with the user. To get details of different Claims available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5ea3ae0c8f5fee7079593df7?&groupBy=tag">link</a>.
</li>
</ul>
{
"id": "4d70a45d-a507-4ceb-94df-ac5a00bef87d",
"client_id": "08053072-6b7a-4938-90d8-aad8012ad39e",
"user": {
"id": "52d3a0c6-8157-4b0b-b485-ac5a00bef873",
"user_name": "chapeti+client_alsina_001@gmail.com",
"email": "chapeti+client_alsina_001@gmail.com",
"password": "********",
"first_name": "Sebastian",
"last_name": "Guerrero",
"phone_number": "387-155 333 953"
},
"claims_id": []
}
Deletes a Company User.
The Company User ID to be deleted.
Return a list of countries available on the system.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Return a list of all countries available in the system.
[{
"id": "b3104111-a38d-43fc-a43f-a9b600100166",
"name": "Kosovo",
"short_name": "XK",
"weight_order": 0
},
{
"id": "ec025ddd-a939-4669-83c1-a67300008be3",
"name": "Switzerland",
"short_name": "CH",
"weight_order": 0
}
]
Create a new case attachment.
Payload must contain information about the file attachment to be created.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">file_id</span></span></span>: The case <span class="hljs-literal">ID</span> where the file will be attached. To get details of case please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b93028f8c9eb05e07851e6?groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">file_name</span></span></span>: The name of the file attached.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">url</span></span></span>: The url where the file is located.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>number</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">file_size</span></span></span>: The file size in Kilo bytes.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">comments</span></span></span>: The comments about the file attachment.
</li>
</ul>
{
"comments": "....",
"file_id": "f71b5be6-5721-4aca-bede-abab0002dde2",
"file_name": "image3.jpg",
"url": "https://image3",
"file_size": "125"
}
This code is returned when the case attachment was created successfully.
{
"id": "2abcb204-ab11-4b90-b36c-abad0004e24a",
"file_id": "f71b5be6-5721-4aca-bede-abab0002dde2",
"date_time": "2020-04-30T00:17:46.9276126Z",
"file_name": "image3.jpg",
"file_size": 0,
"comments": "....",
"url": "https://image3",
"user_id": "3df22cd7-cc17-4883-989c-a6745789709d"
}
Return all cases attachments available.
Return all products enabled to operate with payments and invoices.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
The Case ID to get attachments added.
Return all cases attachments enabled to operate.
[
{
"id": "5c6b1654-a25b-4e95-9cbd-aa4800fdb57e",
"file": {
"id": "7135c0bb-6efb-46e8-84da-a8a900dca8d3",
"name": "Bass & Co's PALE ALE",
"number": "234234",
"folder": null,
"tags": [
{
"id": "641b05b3-858d-43e0-9dc4-a74c00713a60",
"name": "Waiting for clients",
"color_text": "#02404c",
"color_background": "#e2ebed",
"parent": null
}
],
"other_supervisors": null,
"client": null,
"user": {
"id": "8767ac64-77e9-42b5-a292-a9675453b462",
"first_name": "TMD",
"last_name": "Migration",
"user_name": "lawpanel@tmd.com",
"email": "lawpanel@tmd.com",
"phone_number": "654321",
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"language_name": "en",
"country_id": "5306aa9a-3c36-40d8-b32e-a67300008be3",
"country_name": "GB",
"user_role": "FirmUser",
"last_login_date": "2020-09-09T15:57:20.8386221Z",
"is_yoti": false,
"is_locked_out": false,
"yoti_id": null,
"user_settings": null,
"claims": [],
"user_type_id": "00000000-0000-0000-0000-000000000000",
"user_type_name": null
},
"file_status": {
"id": "dbb513aa-58e3-4a70-a805-a74c00714768",
"name": "Opened",
"initial_state": true
},
"file_template": {
"id": "df47efd3-f51e-42e0-a3f4-a74c00715017",
"name": "Opposition",
"file_template_components": [
{
"id": "fac0cb33-f3fd-4720-8bfd-a76400615911",
"name": "Trademark",
"description": "Represent a trademark",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 1,
"value_type": null
},
{
"id": "62968eff-b8d3-4188-84a9-a76400615aef",
"name": "Classes",
"description": "Classes",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 2,
"value_type": null
},
{
"id": "086c016b-deaf-4cb3-9c2e-a76400615ccb",
"name": "Registry",
"description": "Registry",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 2,
"value_type": null
},
{
"id": "4890dce9-570b-4f58-bc06-a76400615ea3",
"name": "Opponent",
"description": "Opposition opponent",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 2,
"value_type": null
},
{
"id": "13a9f37e-d536-4859-bb76-a7640061607b",
"name": "Lawyer",
"description": "Lawyer in the opposition",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 3,
"value_type": null
}
],
"is_base": false,
"is_template_for_trademark_filing": false,
"is_template_filing": false,
"base_id": "00000000-0000-0000-0000-000000000000",
"ip_records": []
},
"components": null,
"created_by": "user@lawpanel.com",
"updated_at": "2019-05-09T15:22:51.375006Z",
"updated_by": "user@lawpanel.com",
"firm_portfolio": null,
"active": false
},
"date_time": "2019-05-09T15:23:43.5618522Z",
"file_name": "project-image-8-square.png",
"file_size": 180357,
"comments": "",
"url": "https://lawpanelstoragelive.blob.core.windows.net/public-assets/15a3d7e5-e3ea-4d2f-87f9-6e497c95f20c.png",
"user": {
"id": "77e2dd06-154c-4157-ad69-a6720147e652",
"first_name": "UserA",
"last_name": "UserA",
"user_name": "user@lawpanel.com",
"email": "user@lawpanel.com",
"phone_number": "+54 9387543988",
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"language_name": "en",
"country_id": "27cb8e50-0e8b-40cd-a656-a6720147e0a1",
"country_name": "AR",
"user_role": "UserA",
"last_login_date": "2020-09-08T15:21:03.6948257Z",
"is_yoti": false,
"is_locked_out": false,
"yoti_id": null,
"user_settings": null,
"claims": [],
"user_type_id": "00000000-0000-0000-0000-000000000000",
"user_type_name": null
}
},
{
"id": "0ddd001b-b907-49c2-9abb-aa4600b1fc61",
"file": {
"id": "c40763bf-e802-4d79-8690-a988015b6a72",
"name": "19132 - Guava Tree",
"number": "19132",
"folder": null,
"tags": [],
"other_supervisors": null,
"client": null,
"user": {
"id": "8243ac64-65e9-42b5-a292-a8070178a462",
"first_name": "TMD",
"last_name": "Migration",
"user_name": "lawpanel@tmd.com",
"email": "lawpanel@tmd.com",
"phone_number": "654321",
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"language_name": "en",
"country_id": "5306aa9a-3c36-40d8-b32e-a67300008be3",
"country_name": "GB"
},
"file_status": {
"id": "dbb513aa-58e3-4a70-a805-a74c00714768",
"name": "Opened",
"initial_state": true
},
"file_template": {
"id": "3dc49d41-4cdc-47bb-b965-a807017653d4",
"name": "Trademark TMD",
"file_template_components": [
{
"id": "2f629748-c13f-4fc3-a760-a80701765553",
"name": "Search result",
"description": "Represent a search result executed by a firm",
"definition": null,
"definition_type": null,
"entity_type": "FirmSearch",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 1,
"value_type": null
},
{
"id": "fcad12f2-4efc-4158-8a41-a80701765749",
"name": "Good and services",
"description": "Please describe the goods or services the name is to be used with",
"definition": null,
"definition_type": null,
"entity_type": "StringMultiText",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 2,
"value_type": null
},
{
"id": "68bb0819-e272-4392-8fcc-a8070176592e",
"name": "Website",
"description": "If there is a website for your business or goods/services please enter the URL",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 3,
"value_type": null
},
{
"id": "b74feae6-201a-4b7e-a477-a80701765b13",
"name": "Are you already using the name",
"description": "if so please let us know, this can help us get the name registered",
"definition": "{\"Items\":[{\"Display\":\"Not using\",\"Value\":\"Not using\",\"Enable\":false},{\"Display\":\"Less than 1 year\",\"Value\":\"Less than 1 year\",\"Enable\":false},{\"Display\":\"1 - 3 years\",\"Value\":\"1 - 3 years\",\"Enable\":false},{\"Display\":\"4 - 5 years\",\"Value\":\"4 - 5 years\",\"Enable\":false},{\"Display\":\"More than 5 years\",\"Value\":\"More than 5 years\",\"Enable\":false}],\"Enable\":false}",
"definition_type": "SelectItemFromListDefinitionDto",
"entity_type": "SelectItemFromList",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 4,
"value_type": null
},
{
"id": "b5f55936-ae28-4dab-9425-a80701765d2b",
"name": "Series",
"description": "Trademark is individual or part of a series?",
"definition": "{\"OptionWithTexts\":[{\"Id\":\"IndividualTrademark\",\"OptionName\":\"This is an individual trade mark and not part of a series of trade marks\",\"OptionDescription\":\"\",\"WithDescription\":false,\"SelectedByDefault\":true,\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false},{\"Id\":\"PartOfSeriesTrademark\",\"OptionName\":\"This trade mark is part of a series of related trade marks\",\"OptionDescription\":\"A series of marks is a number of marks which only have very small differences that do not substantially affect the marks (for example, a word shown in CAPITALS and in 'small' letters).\",\"WithDescription\":true,\"SelectedByDefault\":false,\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}],\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}",
"definition_type": "OptionsWithTextDefinitionDto",
"entity_type": "OptionsWithText",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 5,
"value_type": null
},
{
"id": "9c745a64-d9aa-47f8-83e9-a80701765f17",
"name": "Previously registered",
"description": "Trademark was previously registered?",
"definition": "{\"OptionWithTexts\":[{\"Id\":\"NotPreviouslyRegistered\",\"OptionName\":\"I have not previously registered this trade mark in another country\",\"OptionDescription\":\"\",\"WithDescription\":false,\"SelectedByDefault\":true,\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false},{\"Id\":\"PreviouslyRegistered\",\"OptionName\":\"I have previously registered this trade mark in another country\",\"OptionDescription\":\"If you have previously registered this trade mark in another country you may be able to claim priority over competing trade marks in this country. Please give details of previous registrations (incl. priority date, country, number)\",\"WithDescription\":true,\"SelectedByDefault\":false,\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}],\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}",
"definition_type": "OptionsWithTextDefinitionDto",
"entity_type": "OptionsWithText",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 6,
"value_type": null
},
{
"id": "b55d051b-940a-4610-a8e3-a807017660fc",
"name": "SMS Notifications",
"description": "Being able to send you texts can help us progress your application more quickly and efficiently. Please enter your mobile phone number.",
"definition": "{\"Id\":\"SmsNotifications\",\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}",
"definition_type": "CheckboxWithTextDefinitionDto",
"entity_type": "CheckboxWithText",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 7,
"value_type": "OptionsWithTextValueDto"
},
{
"id": "ff7777f7-23f1-430e-94f0-aa4d00e71536",
"name": "Order folder",
"description": "Order folder",
"definition": "{\"Items\":[{\"Display\":\"Abandoned\",\"Value\":\"Abandoned\",\"Enable\":false},{\"Display\":\"Action required\",\"Value\":\"Action required\",\"Enable\":false},{\"Display\":\"Action required (paid)\",\"Value\":\"Action required (paid)\",\"Enable\":false},{\"Display\":\"Client action (paid)\",\"Value\":\"Client action (paid)\",\"Enable\":false},{\"Display\":\"Deleted\",\"Value\":\"Deleted\",\"Enable\":false},{\"Display\":\"For review\",\"Value\":\"For review\",\"Enable\":false},{\"Display\":\"For review (paid)\",\"Value\":\"For review (paid)\",\"Enable\":false},{\"Display\":\"New orders\",\"Value\":\"New orders\",\"Enable\":false},{\"Display\":\"No action\",\"Value\":\"No action\",\"Enable\":false},{\"Display\":\"Ongoing\",\"Value\":\"Ongoing\",\"Enable\":false},{\"Display\":\"Right Start\",\"Value\":\"Right Start\",\"Enable\":false},{\"Display\":\"Standard filing\",\"Value\":\"Standard filing\",\"Enable\":false},{\"Display\":\"To be filed\",\"Value\":\"To be filed\",\"Enable\":false},{\"Display\":\"Client action\",\"Value\":\"Client action\",\"Enable\":false}],\"Enable\":true}",
"definition_type": "SelectItemFromListDefinitionDto",
"entity_type": "SelectItemFromList",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 8,
"value_type": null
},
{
"id": "ba1be818-5b43-411a-b9db-aa4d00e7153b",
"name": "Order status",
"description": "Order status",
"definition": "{\"Items\":[{\"Display\":\"Awaiting client comments\",\"Value\":\"Awaiting client comments\",\"Enable\":false},{\"Display\":\"Filed\",\"Value\":\"Filed\",\"Enable\":false},{\"Display\":\"On hold awaiting client\",\"Value\":\"On hold awaiting client\",\"Enable\":false},{\"Display\":\"Order cancelled\",\"Value\":\"Order cancelled\",\"Enable\":false},{\"Display\":\"Order finished\",\"Value\":\"Order finished\",\"Enable\":false},{\"Display\":\"Prepare for filing\",\"Value\":\"Prepare for filing\",\"Enable\":false},{\"Display\":\"Preparing draft application\",\"Value\":\"Preparing draft application\",\"Enable\":false},{\"Display\":\"Preparing spec\",\"Value\":\"Preparing spec\",\"Enable\":false},{\"Display\":\"Report order placed\",\"Value\":\"Report order placed\",\"Enable\":false},{\"Display\":\"Searches and legal checks\",\"Value\":\"Searches and legal checks\",\"Enable\":false},{\"Display\":\"We're thinking\",\"Value\":\"We're thinking\",\"Enable\":false}],\"Enable\":true}",
"definition_type": "SelectItemFromListDefinitionDto",
"entity_type": "SelectItemFromList",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 9,
"value_type": null
}
],
"is_base": false,
"is_template_for_trademark_filing": true,
"is_template_filing": false,
"base_id": "00000000-0000-0000-0000-000000000000",
"ip_records": []
},
"components": null,
"created_by": "lawpanel@tmd.com",
"updated_at": "2019-05-07T10:17:53.3846162Z",
"updated_by": "user@lawpanel.com",
"firm_portfolio": null,
"active": false
},
"date_time": "2019-05-07T10:48:01.599753Z",
"file_name": "vernon-original.jpg",
"file_size": 123216,
"comments": "",
"url": "https://lawpanelstoragelive.blob.core.windows.net/public-assets/7c699279-efcd-4653-9c17-36c160b675f8.jpg",
"user": {
"id": "77e2dd06-154c-4157-ad69-a6720147e652",
"first_name": "UserA",
"last_name": "UserA",
"user_name": "user@lawpanel.com",
"email": "user@lawpanel.com",
"phone_number": "+54 9387543988",
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"language_name": "en",
"country_id": "27cb8e50-0e8b-40cd-a656-a6720147e0a1",
"country_name": "AR"
}
}
]
Delete a case attachment.
The case attachment ID
Return details about the delete operation.
{
"id": "24ab8b69-65d5-43b2-a99d-abac014452cf",
"message": "File attachment 'image1.jpg'successfully deleted",
"successful": true
}
Create a new fee item.
Payload must contain information about the fee item to be created.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">product_name</span></span></span>: The internal name for the fee item.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">currency_id</span></span></span>: The currency <span class="hljs-literal">ID</span> for this fee item. To get details of currencies please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b93b43f8c9eb05e07851eb">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">product_code</span></span></span>: Your internal code for this fee item. Use letters to group products e.g. UST001 UST = US TM.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">product_name_public</span></span></span>: The name of the fee item shown to clients.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>decimal</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">value</span></span></span>: The amount charged for this fee item.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>array</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">taxes</span></span></span>: The taxes <span class="hljs-literal">ID</span> for this fee item. To get details of taxes please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf52df8c9eb0e90ebbb5b">link</a>.<br>
</li>
</ul>
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
{
"product_name": "Product",
"currency_id": "54cb5c6a-a8e0-4dec-afcc-a6e90008d6ae",
"product_code": "0001",
"product_name_public": "Product",
"value": 150,
"taxes": [
{
"id": "4005e80b-fc55-44c0-ace8-903e53522e3e"
}
]
}
This code is returned when the fee item was created successfully.
{
"enable": true,
"id": "68525143-03ad-4b56-b943-aba7013804e9",
"firm_id": "5a7776dc-6d34-4f4a-8cac-a67201481ca0",
"product": {
"enable": true,
"id": "786aefe4-fd18-47fc-abf1-aba7013804e6",
"code": "xx",
"name": "test",
"name_public": "test",
"product_type": {
"enable": true,
"id": "13fc72e0-a875-4771-af97-a6e90008f046",
"name": "Service"
},
"prices": [
{
"enable": true,
"id": "1f11c0c4-b253-468a-9068-aba7013804de",
"date_time": "2020-04-24T18:56:01.5888802Z",
"currency": {
"enable": true,
"id": "54cb5c6a-a8e0-4dec-afcc-a6e90008d6ae",
"name": "American dollar",
"name_short": "USD",
"symbol": "$"
},
"currency_units": 150
}
],
"product_modifiers": [],
"taxes": [
{
"enable": true,
"id": "4005e80b-fc55-44c0-ace8-903e53522e3e",
"name": "US VAT",
"description": "",
"units": 0,
"percent": 0
}
]
}
}
Return all fee items available to use with an Invoice.
Take N records. Default value is 10. Max value is 100.
Skip N records.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Return all products enabled to operate with payments and invoices.
[
{
"enable": true,
"id": "8632a401-b6c6-4334-95a7-a7430126fc8d",
"code": "CN013",
"name": "All filing & registration fees - 5 Classes - China",
"name_public": "All filing & registration fees - 5 Classes - China",
"currency_symbol": "£",
"value": 3000.00,
"tax_percent": 20.00,
"tax_value": 600.0000
},
{
"enable": true,
"id": "fa793481-6bd8-4f78-8214-a7430126c28e",
"code": "CN012",
"name": "All filing & registration fees - 4 Classes - China",
"name_public": "All filing & registration fees - 4 Classes - China",
"currency_symbol": "£",
"value": 2400.00,
"tax_percent": 20.00,
"tax_value": 480.0000
},
{
"enable": true,
"id": "a247c243-7e09-4597-8fd5-a74301267825",
"code": "CN011",
"name": "All filing & registration fees - 3 Classes - China",
"name_public": "All filing & registration fees - 3 Classes - China",
"currency_symbol": "£",
"value": 1800.00,
"tax_percent": 0.0,
"tax_value": 0.0
},
{
"enable": true,
"id": "6b9b4cd9-4c50-4cce-ae06-a740010dc39f",
"code": "CN010",
"name": "All filing & registration fees - 2 Classes - China ",
"name_public": "All filing & registration fees - 2 Class - China ",
"currency_symbol": "£",
"value": 1200.00,
"tax_percent": 20.00,
"tax_value": 240.0000
},
{
"enable": true,
"id": "9d34422d-7aa5-41c6-ba9d-a74000f6b133",
"code": "CN009",
"name": "All filing & registration fees - 1 Class - China",
"name_public": "Registration fees (all) - 1 class - China",
"currency_symbol": "£",
"value": 600.00,
"tax_percent": 20.00,
"tax_value": 120.0000
}
]
Update an existing fee item.
Payload must contain information about the fee item to be updated.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The fee item <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">firm_id</span></span></span>: The firm <span class="hljs-literal">ID</span>. To get details of fee item please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5ea277b8b1feb907674fefab">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">product_id</span></span></span>: The product <span class="hljs-literal">ID</span> is equal to the fee item <span class="hljs-literal">ID</span>. To get details of fee item please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5ea277b8b1feb907674fefab">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">product_name</span></span></span>: The internal name for the fee item.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">currency_id</span></span></span>: The currency <span class="hljs-literal">ID</span> for this fee item. To get details of currencies please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b93b43f8c9eb05e07851eb">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">product_code</span></span></span>: Your internal code for this fee item. Use letters to group products e.g. UST001 UST = US TM.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">product_name_public</span></span></span>: The name of the fee item shown to clients.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">product_type_id</span></span></span>: The product type <span class="hljs-literal">ID</span>. To get details of fee item please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5ea277b8b1feb907674fefab">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>decimal</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">value</span></span></span>: The amount charged for this fee item.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>array</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">taxes</span></span></span>: The taxes <span class="hljs-literal">ID</span> for this fee item. To get details of taxes please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf52df8c9eb0e90ebbb5b">link</a>.<br>
</li>
</ul>
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
{
"id": "69fdfe98-b0bc-447d-b760-aba8002d58f8",
"country_id": "3fa874af-5237-477d-badb-a67300008be3",
"email": "bro@ther.com",
"user_name": "bro@ther.com",
"first_name": "Bro",
"last_name": "Ther",
"language_id": "8246c1d0-b478-4320-8b1d-a6720147de22",
"password": "}D`WZN'OxlC307<[",
"phone_number": "+543875333953",
"user_type_id": "",
"claims_id": [
"7c4fcc3e-1370-4efe-a2f5-a873002668dd"
]
}
Return details about the delete operation.
{
"id": "68525143-03ad-4b56-b943-aba7013804e9",
"message": "Firm product successfully updated",
"successful": true
}
Delete a fee item.
The fee item ID
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Return details about the delete operation.
{
"id": "45548143-03ad-4b56-b943-aba7013804e9",
"message": "Firm product successfully deleted",
"successful": true
}
Returns a list of languages available on the system.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Returns a list with all languages available on the system for your query.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: Language <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: A human readable name for the language.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">short_name</span></span></span>: Abbreviation for the language name.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">is_available_for_ui</span></span></span>: If <span class="hljs-literal">true</span> means that language can be selected as UI language on our web UI.
</li>
</ul>
[
{
"id": "09ae78dd-8be8-44c5-8f0e-a99201169289",
"name": "Montenegrin",
"short_name": "",
"is_available_for_ui": false
},
{
"id": "ed79ab91-d7a7-4729-90d0-a9920116928e",
"name": "Coptic",
"short_name": "",
"is_available_for_ui": false
},
{
"id": "71e097b7-d334-40e8-a7e7-a99201169293",
"name": "Cornish",
"short_name": "kw",
"is_available_for_ui": false
},
{
"id": "4c83c21c-1533-4932-89d6-a99201169298",
"name": "Corsican",
"short_name": "co",
"is_available_for_ui": false
},
{
"id": "3349c2d9-94fb-4775-976b-a9920116929e",
"name": "Cree",
"short_name": "cr",
"is_available_for_ui": false
},
{
"id": "3cb7b230-29b8-47ca-a69d-a992011692a3",
"name": "Crimean Tatar; Crimean Turkish",
"short_name": "",
"is_available_for_ui": false
},
{
"id": "b701f4da-05be-4319-884e-a992011692a8",
"name": "Creoles and pidgins",
"short_name": "",
"is_available_for_ui": false
},
{
"id": "63d05333-66f5-437e-8463-a992011692ad",
"name": "Kashubian",
"short_name": "",
"is_available_for_ui": false
},
{
"id": "830deff3-142b-4df7-bc5f-a992011692b2",
"name": "Cushitic languages",
"short_name": "",
"is_available_for_ui": false
},
{
"id": "0590e9a4-b268-4465-afbe-a992011692b7",
"name": "Czech",
"short_name": "cs",
"is_available_for_ui": false
}
]
Get a list of taxes available to work with.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Returns all taxes enabled to operate.
[
{
"id": "4455e80b-fc55-44c0-ace8-903e53522e3e",
"name": "US VAT",
"description": "",
"units": 0.00,
"percent": 0.00
},
{
"id": "4f5745b3-831a-4244-8df8-a9340122807e",
"name": "AU GST",
"description": "The goods and services tax (GST) in Australia is a value added tax of 10% on most goods and services.....",
"units": 0.00,
"percent": 10.00
},
{
"id": "8e223d0d-aa3f-4439-85fb-a6e90008ee65",
"name": "UK VAT",
"description": "Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by.......",
"units": 0.00,
"percent": 20.00
}
]
Return a list with all possible search origins to <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e62ae02f96ca1198ee0c637">create a trademark search</a>.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Return a list with all search origin available to use.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the search origin.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">code</span></span></span></strong>: A positive integer number to identify origin in a simple way.</a>.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span></strong>: Name for the search origin.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">description</span></span></span></strong>: A human readable description for the search origin.</li>
</ul>
[
{
"id": "bd57d0f2-0ac2-4c7d-a980-a89500075e3b",
"code": 6,
"name": "Bot",
"description": "Represent searchs from one of our IA bot engines."
},
{
"id": "5b45f41e-9f0d-4d91-b761-a673000392ef",
"code": 5,
"name": "Dashboard",
"description": "Represent searchs from our dashboard website."
},
{
"id": "9c00ba17-ac4f-4de2-9e04-a67300039292",
"code": 4,
"name": "Web site search",
"description": "Represent searchs from web sites."
},
{
"id": "f5d7d692-dab3-4744-9e0b-a67300039236",
"code": 3,
"name": "iOS app search",
"description": "Represent searches from iOS apps."
},
{
"id": "7c723daa-9d75-433d-848d-a673000391da",
"code": 2,
"name": "Android app search",
"description": "Represent searches from Android apps."
},
{
"id": "49a7eeba-be07-47d5-bad0-a6730003917a",
"code": 1,
"name": "Firm Search Widget",
"description": "Represent searches from firm's search widget."
},
{
"id": "ec413954-22a7-499e-a93a-a67300039112",
"code": 0,
"name": "Unknow source",
"description": "Represent searches from non determined sources."
}
]
Return a list with all possible search class available to <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e62ae02f96ca1198ee0c637">create a trademark search</a>.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Returns a list with all search classes available to <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e62ae02f96ca1198ee0c637">create a trademark search</a>.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the search class.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">number</span></span></span></strong>: Nice classification number.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span></strong>: Nice classification name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">description</span></span></span></strong>: Nice classification description.</li>
</ul>
[
{
"id": "2e04d7b7-d681-458f-8a55-a6720147e7fc",
"number": 1,
"name": "Chemical products",
"description": "Chemicals used in industry, science and photography, as well as in agriculture, horticulture and forestry; unprocessed artificial resins [...]"
},
{
"id": "5096b33b-2f52-456d-b306-a6720147e7fc",
"number": 2,
"name": "Paint products",
"description": "Paints, varnishes, lacquers; preservatives against rust and against deterioration of wood; colorants; mordants; raw natural resins; [...]"
},
{
"id": "777fe621-5eba-4985-966a-a6720147e7fc",
"number": 3,
"name": "Cosmetics and Cleaning Products",
"description": "Bleaching preparations and other substances for laundry use; cleaning, polishing, scouring and abrasive preparations; soaps; [...]"
},
{
"id": "46d9c9ae-863a-421d-9c06-a6720147e7fc",
"number": 4,
"name": "Industrial oils",
"description": "Industrial oils and greases; lubricants; dust absorbing, wetting and binding compositions; fuels and illuminants; candles and wicks for lighting; [...]"
},
{
"id": "3c69fc1c-f131-4372-b873-a6720147e7fc",
"number": 5,
"name": "Pharmaceutical and veterinary",
"description": "Pharmaceutical and veterinary preparations; sanitary preparations for medical purposes; dietetic substances adapted for medical use, food for babies; [...]"
},
{
"id": "9128ca8c-7734-4540-bffb-a6720147e7fc",
"number": 6,
"name": "Metal Products",
"description": "Common metals and their alloys; metal building materials; transportable buildings of metal; materials of metal for railway tracks; [...]"
},
{
"id": "b8163017-ebe6-4317-93ec-a6720147e7fc",
"number": 7,
"name": "Machinery Products",
"description": "Machines and machine tools; motors and engines (except for land vehicles); parts of engines and motors; machine coupling and transmission components [...]"
},
{
"id": "3c98e3db-b305-40d9-b417-a6720147e7fc",
"number": 8,
"name": "Hand Tool Products",
"description": "Hand tools and hand operated implements; cutlery; side arms; razors; electric razors and hair cutters."
},
{
"id": "3d379284-9313-4f3c-b3ba-a6720147e7fc",
"number": 9,
"name": "Computer, Electrical & Scientific Products",
"description": "Scientific, photographic, cinema, optical, weighing, measuring, apparatus and instruments; switching, transforming, or controlling electricity; [...]"
}
]
Add a new note into an existing Case.
Case ID where the note will be added.
By example, to add a note and send a communication through email system, you could send a model similar to this:
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">note</span></span></span>: Contents of the note. May contains HTML tags.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>bool</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">send_communication</span></span></span>: If true, a notification will be sent to the client, it will be a "Public Note", otherwise it is a "Private Note" and will not be sent.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">communication_channel_id</span></span></span>: The communication channel <span class="hljs-literal">ID</span> to notify client about the note added. If you leave this field empty or null, the note will be added and the client not will be notified. To get details of communication channel please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59cad4baf8c9eb1bcc0b17c1?groupBy=tag">link</a>.
</li>
</ul>
{
"note": "<h1>Hello!</h1><p>I am a note into the File.</p>",
"send_communication": "false",
"communication_channel_id": "ICommunicationChannelEmail"
}
Return 200 when the note added successfully.
{
"id": "876e34f9-5d43-46e2-a997-a7ae013f011f",
"message": "Note successfully added into file 'Brexit UK filing class 6 and 10'",
"successfull": true
}
A 400 error is returned if you have some invalid data into your payload, i.e.: biggest text fields, invalid IDs, etc.
{
"id": "",
"message": "Invalid communication channel ID: ICommunicationChannelMind",
"successfull": false
}
Return a list of all communications channels available to send communications.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Return an array with all communications channels available:
[
{
"id": "ICommunicationChannelEmail",
"name": "Email",
"description": "Electronic mail (email or e-mail) is a method of exchanging messages between people using electronics. Email first entered substantial use in the 1960s and by the mid-1970s had taken the form now recognized as email. Email operates across computer networks, which today is primarily the Internet. Some early email systems required the author and the recipient to both be online at the same time, in common with instant messaging. Today's email systems are based on a store-and-forward model. Email servers accept, forward, deliver, and store messages. Neither the users nor their computers are required to be online simultaneously; they need to connect only briefly, typically to a mail server or a webmail interface, for as long as it takes to send or receive messages."
},
{
"id": "ICommunicationChannelSms",
"name": "SMS",
"description": "Short Message Service (SMS) is a text messaging service component of most telephone, World Wide Web, and mobile telephony systems. It uses standardized communication protocols to enable mobile phone devices to exchange short text messages. An intermediary service can facilitate a text-to-voice conversion to be sent to landlines. SMS was the most widely used data application, with an estimated 3.5 billion active users, or about 80% of all mobile phone subscribers, at the end of 2010."
},
{
"id": "ICommunicationChannelWeb",
"name": "Web notification",
"description": "User is going to receive just a web notification in our portal"
}
]
Return a legal entity, company or client details.
Returns a legal entity representation.
{
"id": "2dafa750-eda5-4a5c-a79e-ab6600b58105",
"name": null,
"company_registration_number": null,
"contact_name": null,
"contact_email": null,
"contact_number": null,
"contact_address": {
"id": "bc150917-1b49-4d13-bbfc-ab6600b58105",
"line1": "",
"line2": null,
"line3": null,
"building": null,
"floor_level": null,
"postal_code": null,
"city": null,
"state_province": null,
"region": null,
"country_id": "00000000-0000-0000-0000-000000000000",
"country_name": null
},
"billing_address": {
"id": "a6235631-36be-4483-ab4d-ab6600b58105",
"line1": null,
"line2": null,
"line3": null,
"building": null,
"floor_level": null,
"postal_code": null,
"city": null,
"state_province": null,
"region": null,
"country_id": "00000000-0000-0000-0000-000000000000",
"country_name": null
},
"client_type": {
"id": "604a3d85-5c5b-4364-b69c-a99201175b30",
"code": 1,
"name": "Common"
}
}
<h4 id="trademark-details-description">
Description
<a class="section-title-anchor" href="#trademark-details-description">
<i class="fa fa-anchor"></i>
</a>
</h4>
<div class="sub-section-contents">
<p>Return the details on the IPO for the trademark selected.</p>
</div>
<hr/>
The WIPO ST.3 code for the registry. To get a list with all registries availables <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57e9e4b3901adc1844aedf7e" target="_registries">click here</a>.
Trademark's application number.
You Firm API Key
Returns a DTO with all trademark details.
{
"id": "31003300370035003800360030007C0045005500490050004F00",
"application_number": "1375860",
"registration_date": null,
"application_date": "2017-02-14T00:00:00Z",
"expiry_date": "2027-02-14T00:00:00Z",
"mark_feature": "Figurative",
"kind_mark": "Individual",
"mark_text": "M",
"classes": "9,9,9",
"status": "Live",
"registry": "EUIPO",
"good_and_services": [
{
"class_number": 9,
"description": "Computer network apparatus; computer programs relating to\n computer networks; apparatus for network communications;\n network management apparatus; network management computer\n software; data communications software; application\n software; communication software.",
"language_code": "Computer network apparatus; computer programs relating to\n computer networks; apparatus for network communications;\n network management apparatus; network management computer\n software; data communications software; application\n software; communication software."
},
{
"class_number": 9,
"description": "Appareils de réseaux informatiques; programmes\n informatiques en rapport avec des réseaux informatiques;\n appareils pour communications en réseau; appareils de\n gestion de réseaux; logiciels de gestion de réseaux;\n logiciels de communication de données; logiciels\n d'applications; logiciels de communication.",
"language_code": "Appareils de réseaux informatiques; programmes\n informatiques en rapport avec des réseaux informatiques;\n appareils pour communications en réseau; appareils de\n gestion de réseaux; logiciels de gestion de réseaux;\n logiciels de communication de données; logiciels\n d'applications; logiciels de communication."
},
{
"class_number": 9,
"description": "Aparatos de redes informáticas; programas informáticos\n relacionados con redes informáticas; aparatos para\n comunicaciones en red; aparatos de gestión de redes;\n software de gestión de redes; software de comunicación de\n datos; software de aplicaciones; software de comunicación.",
"language_code": "Aparatos de redes informáticas; programas informáticos\n relacionados con redes informáticas; aparatos para\n comunicaciones en red; aparatos de gestión de redes;\n software de gestión de redes; software de comunicación de\n datos; software de aplicaciones; software de comunicación."
}
],
"applicants": [
{
"id": 0,
"name": "Metamako General Pty Ltd in its capacity as, general partner of Metamako LP",
"address": null
}
],
"representatives": [
{
"id": 0,
"name": "Phoenix Intellectual Property",
"address": null
}
],
"image_url": "https://lawpanellocalstorage.blob.core.windows.net/public-assets/portfolio_trademark_3100330037003500380036003000_57004F00.jpg",
"priorities": [
{
"priority_country_code": "AU",
"priority_number": "01789874",
"priority_date": "2016-08-16"
}
]
}
Returns details about a particular legal entity, company or client type
The legal entity, company or client type ID.
Returns a representation for the legal entity, company or client type.
{
"id": "25eaad5c-2bea-44e5-89e2-a99201175b40",
"code": 2,
"name": "Agent"
}
Returns a list of legal entity, company or client types available on the system.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Returns a list with all legal entities, companies or client types for your query.
[
{
"id": "25eaad5c-2bea-44e5-89e2-a99201175b40",
"code": 2,
"name": "Agent"
},
{
"id": "604a3d85-5c5b-4364-b69c-a99201175b30",
"code": 1,
"name": "Common"
}
]
Creates a new trademark search and queues it for execution.
Request payload to create the search.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<span class="typeOfParameter">Required</span><strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">search_term</span></span></span></strong>: Terms to perform the search. For example <span class="hljs-string">"lawpanel"</span>. Max size allowed here is 250 characters.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<span class="typeOfParameter">Optional</span><strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">classes</span></span></span></strong>: A comma separated values of nice classification class numbers. For example <span class="hljs-string">"42, 9"</span>. You can include only positive integer numbers. To get a list of all search classes available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf965f8c9eb0e90ebbb5d">here</a></li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i>
<span>array</span>
</span>
<span class="typeOfParameter">Optional</span><strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_ids</span></span></span></strong>: An array of registry <span class="hljs-literal">GUID</span> to search into. If you set it to <span class="hljs-literal">null</span> the search will be performed over all registries. To get a list of all registries available <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57e9e4b3901adc1844aedf7e">here</a>.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<span class="typeOfParameter">Optional</span><strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">search_origin_id</span></span></span></strong>: The search origin <span class="hljs-literal">GUID</span> to save with this search. If you set it to <span class="hljs-literal">null</span> the default search origin will be used. To get a list of all search origin available <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf7bff8c9eb0e90ebbb5c">here</a>.</li>
</ul>
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
{
"search_term": "lawpanel",
"classes": "42,9",
"registry_ids": [
"783c0667-2884-4d0a-b93b-a6720147e45f",
"bdbc9579-0462-4449-b7e8-a835017ea7c4"
],
"search_origin_id": null
}
Search has been queued for execution.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the new trademark search created. Use this ID to get current trademark search <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e68d2775766cadea2f9e89a">status</a>.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">search_term</span></span></span></strong>: Terms for the search.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">classes</span></span></span></strong>: Search classes for the search.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i>
<span>array</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_ids</span></span></span></strong>: Registry IDs for the search.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">start_time</span></span></span></strong>: Date/time in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format for the beggining of search process.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">end_time</span></span></span></strong>: Date/time in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format for the end of search process.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>number</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status</span></span></span></strong>: Current search status. Possible values are: 0-Unknown; 1-Waiting; 2-Searching; 3-Completed; 4-Failed; 5-Cancelled.
</li>
</ul>
{
"id": "4B1A76CD-CBF1-4119-BA2C-A9E701367ED0",
"search_term": "lawpanel",
"classes": "42,9",
"registry_id": null,
"start_time": "0001-01-01T00:00:00Z",
"end_time": "0001-01-01T00:00:00Z",
"status": 0,
"results": []
}
Get trademark search details including search results.
The trademark search ID
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns details about the trademark search.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the new trademark search created.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">search_term</span></span></span></strong>: Terms for the search.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">classes</span></span></span></strong>: Search classes for the search.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_id</span></span></span></strong>: Registry ID for the search. You can get more details about the registry <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e68fb835a292eb6af23f674">here</a>.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">start_time</span></span></span></strong>: Date/time in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format for the beggining of search process.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">end_time</span></span></span></strong>: Date/time in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format for the end of search process.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>number</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status</span></span></span></strong>: Current search status. Possible values are: 0-Unknown; 1-Waiting; 2-Searching; 3-Completed; 4-Failed; 5-Cancelled.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i>
<span>array</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">results</span></span></span></strong>: Results for the search process. Each result has:
<ul class="propertiesList" style="margin-top: 15px;">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the trademark search result.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_id</span></span></span></strong>: Registry ID for the trademark search result. You can get more details about the registry <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e68fb835a292eb6af23f674">here</a>.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_number</span></span></span></strong>: Application number for the trademark search result.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_date</span></span></span></strong>: Application date in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format for the trademark search result.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">mark_string</span></span></span></strong>: Mark text for the trademark search result.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">classes</span></span></span></strong>: Comma separated nice classification numbers for the trademark search result.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status</span></span></span></strong>: Status for the trademark search result.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">owner</span></span></span></strong>: Owner name for the trademark search result.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">score</span></span></span></strong>: 0 means a very similar result to your search terms. Higher values mean different result for your search terms.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">similarity</span></span></span></strong>: A text representation for the "score" property.</li>
</ul>
</li>
</ul>
{
"enable": false,
"id": "2186f20b-6133-41c4-96b0-ab7a0149b905",
"search_term": "LawPanel",
"classes": null,
"registry_id": null,
"start_time": "2020-03-10T20:00:31.1352096Z",
"end_time": "2020-03-10T20:00:32.2542094Z",
"status": "Completed",
"results": [
{
"id": "264dbd77-e651-4844-b3bf-5f7897436420",
"registry_id": "528e97d0-0160-455b-80a6-a835017eb05d",
"application_number": "823437",
"application_date": "2004-02-19T03:00:00",
"mark_string": "Lawpanel",
"classes": "42",
"status": "Expired",
"owner": "XIAOYAN",
"score": 0,
"similarity": "Very high"
},
{
"id": "2e5d7253-73c1-4a50-84e7-7d891d633e81",
"registry_id": "bdbc9579-0462-4449-b7e8-a835017ea7c4",
"application_number": "UK00003147277",
"application_date": "2016-02-01T03:00:00",
"mark_string": "LAWPANEL",
"classes": "42,9",
"status": "Valid",
"owner": "Lawpanel Limited",
"score": 0,
"similarity": "Very high"
},
{
"id": "5a7d617d-dddf-4497-b79f-5f2ab7212ec8",
"registry_id": "783c0667-2884-4d0a-b93b-a6720147e45f",
"application_number": "79002163",
"application_date": "2004-02-19T03:00:00",
"mark_string": "LAWPANEL",
"classes": "42",
"status": "Invalid",
"owner": "XIAOYAN",
"score": 0,
"similarity": "Very high"
},
{
"id": "96ffcd42-3678-4040-bd3a-24871e8b1030",
"registry_id": "783c0667-2884-4d0a-b93b-a6720147e45f",
"application_number": "87064395",
"application_date": "2016-06-08T03:00:00",
"mark_string": "LAWPANEL",
"classes": "42,9",
"status": "Valid",
"owner": "MKW ASSOCIATES LIMITED",
"score": 0,
"similarity": "Very high"
},
{
"id": "ee964ecf-4afb-43c5-8ed0-4d51884bc0e1",
"registry_id": "3c5354be-726b-48d1-9bee-aa030177fb89",
"application_number": "3054524",
"application_date": "2001-12-28T03:00:00",
"mark_string": "LAWPANEL",
"classes": "42",
"status": "Invalid",
"owner": "肖岩",
"score": 0,
"similarity": "Very high"
}
]
}
Create a new "Trademark" link into a Case
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">file_id</span></span></span>: The case <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">firm_portfolio_id</span></span></span>: The trademark <span class="hljs-literal">ID</span> related to the case. To get details of trademark please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e750b35c8e8c601054d8b2f">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">file_portfolio_role_id</span></span></span>: The trademark role <span class="hljs-literal">ID</span> into the case. To get a list of trademark roles check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7e615b3724d91c29adfe03">link</a>.
</li>
</ul>
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
{
"file_id": "63573649-3ee9-4367-a176-ab0a0127509c",
"firm_portfolio_id": "42cb80ce-a153-43f2-9d9e-ab0a01275064",
"file_portfolio_role_id": "72ccf3d8-cc1b-4e9b-9f7b-a992011765ee"
}
Returns data about new case trademark created.
{
"id": "c9404ccc-3637-45e5-a6c3-ab8b01533274"
}
Create a new "Part" linked with a Case.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">file_id</span></span></span>: The case <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">client_id</span></span></span>: The Company <span class="hljs-literal">ID</span> related to the case. To get a list of Companies available check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b92737f8c9eb05e07851e1?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">file_client_role_id</span></span></span>: The Company role <span class="hljs-literal">ID</span> into the case. To get a list of roles available check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/29C3C1A448DF4FFF9CAB068A?groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">client_user_id</span></span></span>: The User <span class="hljs-literal">ID</span> for the contact related to the case. To get a list of users available check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a1494cd00b195a1f0f8e4?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">reference</span></span></span>: The reference is a text with a maximum of 256 characters.
</li>
</ul>
{
"file_id": "ad72f2c7-3866-486f-8e98-aa0300c8b9ea",
"client_id": "e7e32f0a-9d93-406a-b231-a98f00eabf67",
"file_client_role_id": "1a0bbe33-d3ce-451b-bc6b-a8ff015d9a7d",
"client_user_id": "d48e832b-dc27-4818-9057-a92200be1e31",
"reference": ""
}
Returns data about new case legal entity created
{
"id": "a5ac9bce-338b-4232-b3c3-ab8a00e9f04d"
}
Get a list of trademark searches.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns a simplified (without results) list of trademark searches performed.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the new trademark search created.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">search_term</span></span></span></strong>: Terms for the search.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">classes</span></span></span></strong>: Search classes for the search.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_id</span></span></span></strong>: Registry ID for the search. You can get more details about the registry <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e68fb835a292eb6af23f674">here</a>.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">start_time</span></span></span></strong>: Date/time in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format for the beggining of search process.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">end_time</span></span></span></strong>: Date/time in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format for the end of search process.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>number</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status</span></span></span></strong>: Current search status. Possible values are: 0-Unknown; 1-Waiting; 2-Searching; 3-Completed; 4-Failed; 5-Cancelled.
</li>
</ul>
[
{
"enable": true,
"id": "c7fec498-ac09-4f08-8b82-ab7a014823be",
"search_term": "LawPanel",
"classes": null,
"registry_id": null,
"start_time": "2020-03-10T19:54:43.5163870",
"end_time": "2020-03-10T19:56:15.0079506",
"status": "Completed"
},
{
"enable": true,
"id": "b67632a1-b5c0-41e3-ad02-ab7a01478aed",
"search_term": "LawPanel",
"classes": null,
"registry_id": null,
"start_time": "2020-03-10T19:52:35.4637377",
"end_time": "2020-03-10T19:52:36.5508547",
"status": "Completed"
}
]
Get trademark search status. You can use this method to avoid receiving the whole trademark search data.
The trademark search ID
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns an entity with an integer and a text with current search status.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>number</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status</span></span></span></strong>: Current search status. Possible values are: 0-Unknown; 1-Waiting; 2-Searching; 3-Completed; 4-Failed; 5-Cancelled.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status_text</span></span></span></strong>: Human readable status in English.</li>
</ul>
{
"status": 3,
"status_text": "Completed"
}
Get a registry by its ID value.
Registry ID
Returns a registry representation.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the registry.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">wipo_code</span></span></span></strong>: WIPO code for the registry. More details <a href="https://www.wipo.int/export/sites/www/standards/en/pdf/03-03-01.pdf" target="_blank">here</a>.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">description</span></span></span></strong>: A human readable description for the registry. Generally its name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-adjust"></i>
<span>bool</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">have_data</span></span></span></strong>: When true, it means current registry has data to <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e62ae02f96ca1198ee0c637">perform trademark searches</a>.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">url_base_for_trademarks</span></span></span></strong>: If present, it indicates a URL to get more details about trademarks. For example: <span class="hljs-string">https://euipo.europa.eu/eSearch/#details/trademarks/{ID}</span> for EUIPO.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">iso_three_letters_country_code</span></span></span></strong>: If registry belongs to a single country, it contains the <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3" target="_blank">three letters ISO country code</a>.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">total_trademarks</span></span></span></strong>: Contains total trademarks available.</a>.</li>
</ul>
{
"id": "b93d01dc-3fb7-4c63-b565-a7a700aacdff",
"wipo_code": "AD",
"description": "ANDORRA",
"have_data": true,
"url_base_for_trademarks": "",
"iso_three_letters_country_code": "AND",
"total_trademarks": 37080
}
Registration Type - 02.Read many[S]
Take N records. Default value is 10. Max value is 100.
Skip N records.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns a list with all registration types available.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the registration type.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span></strong>: Registration type human-readable name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">code</span></span></span></strong>: A number to represent the registration type.</a>.</li>
</ul>
[
{
"id": "96dc1202-d0c4-43a5-ab22-a99201173fb0",
"name": "Supplemental",
"code": 20
},
{
"id": "35002c9c-9d10-4ce4-bad0-a99201173fa5",
"name": "State",
"code": 19
},
{
"id": "ac1269aa-f659-4420-9404-a99201173f99",
"name": "Slogan",
"code": 18
},
{
"id": "9de08b0a-6266-45ea-81b0-a99201173f8d",
"name": "Part B",
"code": 17
},
{
"id": "59ecaed9-0d1a-4c07-981f-a99201173f81",
"name": "Part A",
"code": 16
},
{
"id": "cbf73e22-4324-4b3f-a2f6-a99201173f76",
"name": "OAPI Trademark",
"code": 15
},
{
"id": "5084e76c-5a49-4a4f-8bec-a99201173f6c",
"name": "OAPI National Reference",
"code": 14
},
{
"id": "510fe5f6-2c68-410f-9931-a99201173f61",
"name": "Local",
"code": 13
},
{
"id": "a3e9c0a9-1638-4af6-b15b-a99201173f56",
"name": "IR Subsequent Designation",
"code": 12
},
{
"id": "cdfada91-8db7-4654-91aa-a99201173f4a",
"name": "IR National Extension",
"code": 11
}
]
Get a registration type by its ID value.
Registration type ID
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns a registration type representation.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the registration type.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span></strong>: Registration type human-readable name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">code</span></span></span></strong>: A number to represent the registration type.</a>.</li>
</ul>
{
"id": "96dc1202-d0c4-43a5-ab22-a99201173fb0",
"name": "Supplemental",
"code": 20
}
Get a trademark type by its ID value.
Trademark type ID
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns a trademark type representation.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the trademark type.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span></strong>: Trademark type human-readable name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">code</span></span></span></strong>: A number to represent the trademark type.</li>
</ul>
{
"id": "6d374194-9df4-4a26-89dd-a992011744fd",
"name": "Word/Device",
"code": 11
}
Returns a list with all trademark types available on the system.
Take N records. Default value is 10. Max value is 100.
Skip N records.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns a list with all trademark types available.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the trademark type.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span></strong>: Trademark type human-readable name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">code</span></span></span></strong>: A number to represent the trademark type.</a>.</li>
</ul>
[
{
"id": "6d374194-9df4-4a26-89dd-a992011744fd",
"name": "Word/Device",
"code": 11
},
{
"id": "86c2145f-3051-419e-a072-a992011744f2",
"name": "Word in Standard Characters",
"code": 10
},
{
"id": "545b78f1-8d94-4fa4-b86a-a992011744e8",
"name": "Typed Drawing",
"code": 9
},
{
"id": "785826fe-4cb6-46dd-ad47-a992011744dd",
"name": "Three Dimensional",
"code": 8
},
{
"id": "83165497-eb28-4ae7-9407-a992011744d2",
"name": "Stylized Word",
"code": 7
},
{
"id": "edb846f5-467e-4ff4-876e-a992011744c7",
"name": "Sound",
"code": 6
},
{
"id": "196eba02-1533-459f-8580-a992011744bc",
"name": "Smell",
"code": 5
},
{
"id": "171546bf-599c-42fc-909b-a992011744b2",
"name": "Signature",
"code": 4
},
{
"id": "8837027a-b4b3-4fa4-84f6-a992011744a7",
"name": "Service Mark",
"code": 3
},
{
"id": "82efe10a-b712-4c9d-8ad9-a9b6000ff8e3",
"name": "Series",
"code": 12
}
]
Get a search origin by its ID value.
Search origin ID
Returns a search origin representation.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the search origin.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">code</span></span></span></strong>: A number to represent the search origin.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span></strong>: Search origin human-readable name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">description</span></span></span></strong>: A human-readable description for the search origin.</li>
</ul>
{
"id": "bd57d0f2-0ac2-4c7d-a980-a89500075e3b",
"code": 6,
"name": "Bot",
"description": "Represent searchs from one of our IA bot engines."
}
Deletes a trademark search.
The trademark search ID
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns details about the operation result.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the operation.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">message</span></span></span></strong>: Human-readable message with the operation result.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-adjust"></i>
<span>bool</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">successful</span></span></span>: True if operation was performed successfully, false if not..</li>
</ul>
{
"id": "1cafd4e4-303f-48d4-becc-ab0a012d637a",
"message": "Trademark search for 'bollywood' successfully deleted",
"successful": true
}
Get trademark details.
The trademark ID
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns details about the trademark.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: Curent trademark <span class="hljs-literal">GUID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_id</span></span></span>: Registry <span class="hljs-literal">GUID</span> for the trademark. To get a list of all registries available <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57e9e4b3901adc1844aedf7e">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_name</span></span></span>: Human-readable name for current trademark registry.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_official_name</span></span></span>: Human-readable official name for current trademark registry.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_description</span></span></span>: Human-readable description for current trademark registry. Generally the country name associated with the IPO Registry.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">mark_text</span></span></span>: Text of the trademark, for example "LawPanel".
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_number</span></span></span>: Applicattion number for the trademark. It may contains any character, not only numbers.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_date</span></span></span>: Application/filing date in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registration_number</span></span></span>: Registration number for the trademark. It may contains any character, not only numbers.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registration_date</span></span></span>: Registration date in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status_date</span></span></span>: Current status date in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">mark_feature</span></span></span>: Trademark feature text.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status</span></span></span>: Current trademark status.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registration_type_id</span></span></span>: Registration type <span class="hljs-literal">GUID</span>. To get a list of all registration types available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7398b44688a6e1e26aa7ca">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status</span></span></span>: Registration type human-readable name for current trademark.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">trademark_type_id</span></span></span>: Trademark type <span class="hljs-literal">GUID</span>. To get a list of all trademark types available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e73b75f0faeb654084de5ec">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">trademark_type_name</span></span></span>: Trademark type human-readable name.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">expiry_date</span></span></span>: Expiry date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">publication_date</span></span></span>: Publication date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">declaration_date</span></span></span>: Declaration date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">office_action_date</span></span></span>: Office action date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">grant_date</span></span></span>: Grant date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">client_agent_id</span></span></span>: Legal entity (aka "Company", "Client") <span class="hljs-literal">GUID</span> to assign as Agent for this trademark. Client must be of type <span class="hljs-literal">Agent</span>. Click <a href="">here</a> to get a list of all client types available. To get a list of all legal entities available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b92737f8c9eb05e07851e1">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">client_agent_name</span></span></span>: Human-readable trademark agent name.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">publication_notes</span></span></span>: Notes about trademark publication.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i>
<span>array</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">good_and_services</span></span></span>: An array of objects with Good And Services for the trademark.
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">language_id</span></span></span>: Registry <span class="hljs-literal">GUID</span> for the trademark. To get a list of all languages available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf30bf8c9eb0e90ebbb59">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">text</span></span></span>: Text for the Good And Service.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">search_class_id</span></span></span>: Search class <span class="hljs-literal">GUID</span> for the Good and Service. To get a list of all search class available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf965f8c9eb0e90ebbb5d">here</a>.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">image_url</span></span></span>: An URL for the trademark image .
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">notes</span></span></span>: Notes about trademark.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">do_not_create_file</span></span></span>: If <span class="hljs-literal">true</span> the system will not create a Case for this trademark.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_id</span></span></span>: User <span class="hljs-literal">GUID</span> for the creator of the trademark. To get a list of all users available click <a href="#">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_user_name</span></span></span>: Username human-readable for the creator of the trademark.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">trademark_url_on_ipo</span></span></span>: For some registries, it may contains the URL to check trademark on IPO.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">exclude_from_auto_updates</span></span></span>: If <span class="hljs-literal">true</span> means that trademark can't be updated from IPO.
</li>
</ul>
{
"id": "677eeb82-99f7-4c68-a797-ab8400f6f701",
"registry_id": "783c0667-2884-4d0a-b93b-a6720147e45f",
"registry_name": "USPTO",
"registry_official_name": "USPTO",
"registry_description": "United States",
"mark_text": "LawPanel",
"application_number": "87064395",
"application_date": "2020-03-17T03:00:00Z",
"registration_number": "5230966",
"registration_date": "2020-03-17T03:00:00Z",
"status_date": "2020-03-17T03:00:00Z",
"mark_feature": "mark",
"status": "Valid",
"registration_type_id": "21b28699-8e12-4575-bb65-a99201173ed2",
"registration_type_name": "Associated Mark",
"trademark_type_id": "6d374194-9df4-4a26-89dd-a992011744fd",
"trademark_type_name": "Word/Device",
"expiry_date": "2020-03-17T03:00:00Z",
"publication_date": "2020-03-17T03:00:00Z",
"declaration_date": "2020-03-17T03:00:00Z",
"office_action_date": "2020-03-17T03:00:00Z",
"grant_date": "2020-03-17T03:00:00Z",
"client_agent_id": "a1c3e613-c9a5-49c5-91d9-aaaf009c09f1",
"client_agent_name": "Stronghold Invest AB",
"publication_notes": "Notes about publication",
"good_and_services": [
{
"id": "be4a9eb5-e20c-4f89-9809-ab8400f6f701",
"language": {
"id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"name": "English",
"short_name": "en",
"is_available_for_ui": true
},
"search_class": {
"id": "5096b33b-2f52-456d-b306-a6720147e7fc",
"number": 2,
"name": "Paint products",
"description": "Paints, varnishes, lacquers; preservatives against rust and against deterioration of wood; colorants; mordants; raw natural resins; metals in foil and powder form for painters, decorators, printers and artists.",
"search_classes": "2"
},
"text": "Facilitating, administering, arranging and managing funding in relation to litigation [...]"
},
{
"id": "ae0a84f0-ebd5-4071-bd9e-ab8400f6f701",
"language": {
"id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"name": "English",
"short_name": "en",
"is_available_for_ui": true
},
"search_class": {
"id": "777fe621-5eba-4985-966a-a6720147e7fc",
"number": 3,
"name": "Cosmetics and Cleaning Products",
"description": "Bleaching preparations and other substances for laundry use; cleaning, polishing, scouring and abrasive preparations; soaps; perfumery, essential oils, cosmetics, hair lotions; dentifrices; deodorants for personal use; air perfuming preparations.",
"search_classes": "3,5,21,35"
},
"text": "Design and development of computer hardware and software; software as a service [SaaS]; [...]"
}
],
"image_url": "https://web.lawpanel.com/images/firm/logo-lawpanel-white.png",
"notes": "<p>Some extra notes</p>",
"do_not_create_file": false,
"user_id": "77e2dd06-154c-4157-ad69-a6720147e652",
"user_user_name": "johndoe@ipfirm.com",
"trademark_url_on_ipo": null,
"exclude_from_auto_updates": false
}
Get a list with trademarks for your query.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns a list with trademarks for your query.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: Curent trademark <span class="hljs-literal">GUID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_id</span></span></span>: Registry <span class="hljs-literal">GUID</span> for the trademark. To get a list of all registries available <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57e9e4b3901adc1844aedf7e">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_name</span></span></span>: Human-readable name for current trademark registry.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_official_name</span></span></span>: Human-readable official name for current trademark registry.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_description</span></span></span>: Human-readable description for current trademark registry. Generally the country name associated with the IPO Registry.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">mark_text</span></span></span>: Text of the trademark, for example "LawPanel".
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_number</span></span></span>: Applicattion number for the trademark. It may contains any character, not only numbers.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_date</span></span></span>: Application/filing date in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registration_number</span></span></span>: Registration number for the trademark. It may contains any character, not only numbers.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registration_date</span></span></span>: Registration date in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status_date</span></span></span>: Current status date in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">mark_feature</span></span></span>: Trademark feature text.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status</span></span></span>: Current trademark status.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registration_type_id</span></span></span>: Registration type <span class="hljs-literal">GUID</span>. To get a list of all registration types available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7398b44688a6e1e26aa7ca">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status</span></span></span>: Registration type human-readable name for current trademark.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">trademark_type_id</span></span></span>: Trademark type <span class="hljs-literal">GUID</span>. To get a list of all trademark types available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e73b75f0faeb654084de5ec">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">trademark_type_name</span></span></span>: Trademark type human-readable name.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">expiry_date</span></span></span>: Expiry date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">publication_date</span></span></span>: Publication date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">declaration_date</span></span></span>: Declaration date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">office_action_date</span></span></span>: Office action date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">grant_date</span></span></span>: Grant date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">client_agent_id</span></span></span>: Legal entity (aka "Company", "Client") <span class="hljs-literal">GUID</span> to assign as Agent for this trademark. Client must be of type <span class="hljs-literal">Agent</span>. Click <a href="">here</a> to get a list of all client types available. To get a list of all legal entities available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b92737f8c9eb05e07851e1">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">client_agent_name</span></span></span>: Human-readable trademark agent name.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">publication_notes</span></span></span>: Notes about trademark publication.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i>
<span>array</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">good_and_services</span></span></span>: An array of objects with Good And Services for the trademark.
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">language_id</span></span></span>: Registry <span class="hljs-literal">GUID</span> for the trademark. To get a list of all languages available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf30bf8c9eb0e90ebbb59">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">text</span></span></span>: Text for the Good And Service.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">search_class_id</span></span></span>: Search class <span class="hljs-literal">GUID</span> for the Good and Service. To get a list of all search class available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf965f8c9eb0e90ebbb5d">here</a>.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">image_url</span></span></span>: An URL for the trademark image .
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">notes</span></span></span>: Notes about trademark.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">do_not_create_file</span></span></span>: If <span class="hljs-literal">true</span> the system will not create a Case for this trademark.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_id</span></span></span>: User <span class="hljs-literal">GUID</span> for the creator of the trademark. To get a list of all users available click <a href="#">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_user_name</span></span></span>: Username human-readable for the creator of the trademark.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">trademark_url_on_ipo</span></span></span>: For some registries, it may contains the URL to check trademark on IPO.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">exclude_from_auto_updates</span></span></span>: If <span class="hljs-literal">true</span> means that trademark can't be updated from IPO.
</li>
</ul>
[
{
"id": "677eeb82-99f7-4c68-a797-ab8400f6f701",
"registry_id": "783c0667-2884-4d0a-b93b-a6720147e45f",
"registry_name": "USPTO",
"registry_official_name": "USPTO",
"registry_description": "United States",
"mark_text": "LawPanel",
"application_number": "87064395",
"application_date": "2020-03-17T03:00:00Z",
"registration_number": "5230966",
"registration_date": "2020-03-17T03:00:00Z",
"status_date": "2020-03-17T03:00:00Z",
"mark_feature": "mark",
"status": "Valid",
"registration_type_id": "21b28699-8e12-4575-bb65-a99201173ed2",
"registration_type_name": "Associated Mark",
"trademark_type_id": "6d374194-9df4-4a26-89dd-a992011744fd",
"trademark_type_name": "Word/Device",
"expiry_date": "2020-03-17T03:00:00Z",
"publication_date": "2020-03-17T03:00:00Z",
"declaration_date": "2020-03-17T03:00:00Z",
"office_action_date": "2020-03-17T03:00:00Z",
"grant_date": "2020-03-17T03:00:00Z",
"client_agent_id": "a1c3e613-c9a5-49c5-91d9-aaaf009c09f1",
"client_agent_name": "Stronghold Invest AB",
"publication_notes": "Notes about publication",
"good_and_services": [
{
"id": "be4a9eb5-e20c-4f89-9809-ab8400f6f701",
"language": {
"id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"name": "English",
"short_name": "en",
"is_available_for_ui": true
},
"search_class": {
"id": "5096b33b-2f52-456d-b306-a6720147e7fc",
"number": 2,
"name": "Paint products",
"description": "Paints, varnishes, lacquers; preservatives against rust and against deterioration of wood; colorants; mordants; raw natural resins; metals in foil and powder form for painters, decorators, printers and artists.",
"search_classes": "2"
},
"text": "Facilitating, administering, arranging and managing funding in relation to litigation [...]"
},
{
"id": "ae0a84f0-ebd5-4071-bd9e-ab8400f6f701",
"language": {
"id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"name": "English",
"short_name": "en",
"is_available_for_ui": true
},
"search_class": {
"id": "777fe621-5eba-4985-966a-a6720147e7fc",
"number": 3,
"name": "Cosmetics and Cleaning Products",
"description": "Bleaching preparations and other substances for laundry use; cleaning, polishing, scouring and abrasive preparations; soaps; perfumery, essential oils, cosmetics, hair lotions; dentifrices; deodorants for personal use; air perfuming preparations.",
"search_classes": "3,5,21,35"
},
"text": "Design and development of computer hardware and software; software as a service [SaaS]; [...]"
}
],
"image_url": "https://web.lawpanel.com/images/firm/logo-lawpanel-white.png",
"notes": "<p>Some extra notes</p>",
"do_not_create_file": false,
"user_id": "77e2dd06-154c-4157-ad69-a6720147e652",
"user_user_name": "johndoe@ipfirm.com",
"trademark_url_on_ipo": null,
"exclude_from_auto_updates": false
}
]
Updates an existing trademark.
Request payload to update the trademark.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: Trademark <span class="hljs-literal">GUID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_id</span></span></span>: Registry <span class="hljs-literal">GUID</span> for the trademark. To get a list of all registries available <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57e9e4b3901adc1844aedf7e">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">mark_text</span></span></span>: Text of the trademark, for example "LawPanel".
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_number</span></span></span>: Applicattion number for the trademark. It may contains any character, not only numbers.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_date</span></span></span>: Application/filing date in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registration_number</span></span></span>: Registration number for the trademark. It may contains any character, not only numbers.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registration_date</span></span></span>: Registration date in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status_date</span></span></span>: Current status date in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">mark_feature</span></span></span>: Trademark feature text.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status</span></span></span>: Current trademark status.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registration_type_id</span></span></span>: Registration type <span class="hljs-literal">GUID</span>. To get a list of all registration types available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7398b44688a6e1e26aa7ca">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">trademark_type_id</span></span></span>: Trademark type <span class="hljs-literal">GUID</span>. To get a list of all trademark types available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e73b75f0faeb654084de5ec">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">expiry_date</span></span></span>: Expiry date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">publication_date</span></span></span>: Publication date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">declaration_date</span></span></span>: Declaration date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">office_action_date</span></span></span>: Office action date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">grant_date</span></span></span>: Grant date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">client_agent_id</span></span></span>: Legal entity (aka "Company", "Client") <span class="hljs-literal">GUID</span> to assign as Agent for this trademark. Client must be of type <span class="hljs-literal">Agent</span>. Click <a href="">here</a> to get a list of all client types available. To get a list of all legal entities available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b92737f8c9eb05e07851e1">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">publication_notes</span></span></span>: Notes about trademark publication.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i>
<span>array</span>
</span>
<span class="typeOfParameter">Optional</span><strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">good_and_services</span></span></span></strong>: An array of objects to update Good And Services for the trademark.
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: Good and Service <span class="hljs-literal">GUID</span> to update. If you set this value to <span class="hljs-literal">null</span> a new one will be created.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">language_id</span></span></span>: Registry <span class="hljs-literal">GUID</span> for the trademark. To get a list of all languages available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf30bf8c9eb0e90ebbb59">here</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">text</span></span></span>: Text for the Good And Service.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">search_class_id</span></span></span>: Search class <span class="hljs-literal">GUID</span> for the Good and Service. To get a list of all search class available click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf965f8c9eb0e90ebbb5d">here</a>.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">image_url</span></span></span>: An URL for the trademark image .
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">notes</span></span></span>: Notes about trademark.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">do_not_create_file</span></span></span>: If <span class="hljs-literal">true</span> the system will not create a Case for this trademark.
</li>
</ul>
{
"id": "677eeb82-99f7-4c68-a797-ab8400f6f701",
"registry_id": "783c0667-2884-4d0a-b93b-a6720147e45f",
"mark_text": "LawPanel",
"application_number": "0303456",
"application_date": "2020-03-17T00:00:00Z",
"registration_number": 5230966,
"registration_date": "2020-03-17T00:00:00Z",
"status_date": "2020-03-17T00:00:00Z",
"mark_feature": "mark",
"status": "Valid",
"registration_type_id": "21b28699-8e12-4575-bb65-a99201173ed2",
"trademark_type_id": "6d374194-9df4-4a26-89dd-a992011744fd",
"expiry_date": "2020-03-17T00:00:00Z",
"publication_date": "2020-03-17T00:00:00Z",
"declaration_date": "2020-03-17T00:00:00Z",
"office_action_date": "2020-03-17T00:00:00Z",
"final_office_action_date": "",
"grant_date": "2020-03-17T00:00:00Z",
"client_agent_id": "a1c3e613-c9a5-49c5-91d9-aaaf009c09f1",
"publication_notes": "Notes about publication",
"good_and_services": [
{
"id": "be4a9eb5-e20c-4f89-9809-ab8400f6f701",
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"search_class_id": "5096b33b-2f52-456d-b306-a6720147e7fc",
"text": "Facilitating, administering, arranging and managing funding in relation to litigation [...]"
},
{
"id": "ae0a84f0-ebd5-4071-bd9e-ab8400f6f701",
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"search_class_id": "777fe621-5eba-4985-966a-a6720147e7fc",
"text": "Design and development of computer hardware and software; software as a service [SaaS]; [...]"
}
],
"image_url": "https://web.lawpanel.com/images/firm/logo-lawpanel-white.png",
"notes": "<p>Some extra notes</p>"
}
{
"id": "f3e5257b-ebea-43b6-aa60-ab0a012807db",
"message": "Firm portfolio for trademark 'PASTA BASTA' successfully updated",
"successful": true
}
Deletes a trademark.
The trademark ID
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns details about the operation result.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the operation.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">message</span></span></span></strong>: Human-readable message with the operation result.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-adjust"></i>
<span>bool</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">successful</span></span></span>: True if operation was performed successfully, false if not..</li>
</ul>
{
"id": "1cafd4e4-303f-48d4-becc-ab0a012d637a",
"message": "Trademark successfully deleted",
"successful": true
}
Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec">link</a>.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns a list with all properties available to create a filter for this endpoint.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_name</span></span></span>: Internal name of the property. You must it this value to define properties in your filter.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_type</span></span></span>: Type of the property. Here you can find basic types like <span class="hljs-literal">String</span>, <span class="hljs-literal">DateTime</span>, <span class="hljs-literal">Boolean</span>, <span class="hljs-literal">Int32</span>, etc. Or internal types of LawPanel entities like <span class="hljs-literal">Registry</span>, <span class="hljs-literal">SearchClass</span>, <span class="hljs-literal">Client</span>, etc.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_display_name</span></span></span>: Human-readable name for the property.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_description</span></span></span>: Human-readable description for the property.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i>
<span>array</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">comparators_available</span></span></span>: An array of strings with comparators available for this property.
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Some common values:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">==</span></span></span> Equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">!=</span></span></span> Not equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">></span></span></span> Greater than.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">>=</span></span></span> Greater or equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string"><</span></span></span> Minor than.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string"><=</span></span></span> Minor or equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">IN</span></span></span> In range.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">CU</span></span></span> Into current.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">CONTAINS</span></span></span> Contains value.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">STARTSWITH</span></span></span> Value starts with.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">ENDSWITH</span></span></span> Value ends with.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">multiple</span></span></span>: When <span class="hljs-literal">true</span> means that properti can handle multiple values on its definition.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">endpoint</span></span></span>: For properties of non-basic types like <span class="hljs-literal">String</span>, <span class="hljs-literal">DateTime</span>, <span class="hljs-literal">Boolean</span>, etc., this property indicates the endpoint where you can get a list with entities to use at the filter definition. For example, if the type of the property is <span class="hljs-literal">Registry</span> then this property will contains the endpoint <span class="hljs-literal">Registry</span> which is the URL to get Registries and their IDs in order to compose the filter.
</li>
</ul>
[
{
"property_name": "client_agent",
"property_type": "Client",
"property_display_name": "Agent",
"property_description": "",
"comparators_available": [
"==",
"!="
],
"multiple": false,
"end_point": "client"
},
{
"property_name": "application_date",
"property_type": "DateTime",
"property_display_name": "Application date",
"property_description": "",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "application_number",
"property_type": "String",
"property_display_name": "Application number",
"property_description": "",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "declaration_date",
"property_type": "DateTime",
"property_display_name": "Declaration date",
"property_description": "",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "final_office_action_date",
"property_type": "DateTime",
"property_display_name": "Final office action date",
"property_description": "",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "classes",
"property_type": "SearchClass",
"property_display_name": "Good and services",
"property_description": "",
"comparators_available": [
"==",
"!="
],
"multiple": true,
"end_point": "searchclasses"
},
{
"property_name": "grant_date",
"property_type": "DateTime",
"property_display_name": "Grant date",
"property_description": "",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "has_reminders",
"property_type": "Boolean",
"property_display_name": "Has reminders",
"property_description": "",
"comparators_available": [
"==",
"!="
],
"multiple": false,
"end_point": ""
},
{
"property_name": "mark_feature",
"property_type": "String",
"property_display_name": "Mark feature",
"property_description": "",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "mark_text",
"property_type": "String",
"property_display_name": "Mark text",
"property_description": "",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "notes",
"property_type": "String",
"property_display_name": "Notes",
"property_description": "",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "office_action_date",
"property_type": "DateTime",
"property_display_name": "Office action date",
"property_description": "",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "publication_date",
"property_type": "DateTime",
"property_display_name": "Publication date",
"property_description": "",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "publication_notes",
"property_type": "String",
"property_display_name": "Publication notes",
"property_description": "",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "registration_date",
"property_type": "DateTime",
"property_display_name": "Registration date",
"property_description": "",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "registration_number",
"property_type": "String",
"property_display_name": "Registration number",
"property_description": "",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "registry",
"property_type": "Registry",
"property_display_name": "Registry / IPO",
"property_description": "",
"comparators_available": [
"==",
"!="
],
"multiple": false,
"end_point": "registries"
},
{
"property_name": "status",
"property_type": "String",
"property_display_name": "Registry status",
"property_description": "",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "expiry_date",
"property_type": "DateTime",
"property_display_name": "Renewal date",
"property_description": "",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "status_date",
"property_type": "DateTime",
"property_display_name": "Status date",
"property_description": "",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "updated_at",
"property_type": "DateTime",
"property_display_name": "Updated at",
"property_description": "Date of last update for this entity",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
}
]
Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec">link</a>.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns a list with all properties available to create a filter for this endpoint.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_name</span></span></span>: Internal name of the property. You must it this value to define properties in your filter.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_type</span></span></span>: Type of the property. Here you can find basic types like <span class="hljs-literal">String</span>, <span class="hljs-literal">DateTime</span>, <span class="hljs-literal">Boolean</span>, <span class="hljs-literal">Int32</span>, etc. Or internal types of LawPanel entities like <span class="hljs-literal">Registry</span>, <span class="hljs-literal">SearchClass</span>, <span class="hljs-literal">Client</span>, etc.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_display_name</span></span></span>: Human-readable name for the property.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_description</span></span></span>: Human-readable description for the property.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i>
<span>array</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">comparators_available</span></span></span>: An array of strings with comparators available for this property.
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Some common values:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">==</span></span></span> Equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">!=</span></span></span> Not equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">></span></span></span> Greater than.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">>=</span></span></span> Greater or equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string"><</span></span></span> Minor than.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string"><=</span></span></span> Minor or equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">IN</span></span></span> In range.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">CU</span></span></span> Into current.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">CONTAINS</span></span></span> Contains value.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">STARTSWITH</span></span></span> Value starts with.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">ENDSWITH</span></span></span> Value ends with.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">multiple</span></span></span>: When <span class="hljs-literal">true</span> means that properti can handle multiple values on its definition.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">endpoint</span></span></span>: For properties of non-basic types like <span class="hljs-literal">String</span>, <span class="hljs-literal">DateTime</span>, <span class="hljs-literal">Boolean</span>, etc., this property indicates the endpoint where you can get a list with entities to use at the filter definition. For example, if the type of the property is <span class="hljs-literal">Registry</span> then this property will contains the endpoint <span class="hljs-literal">Registry</span> which is the URL to get Registries and their IDs in order to compose the filter.
</li>
</ul>
[
{
"property_name": "registry",
"property_type": "Registry",
"property_display_name": "Registry",
"property_description": "",
"comparators_available": [
"==",
"!="
],
"multiple": false,
"end_point": "registries"
},
{
"property_name": "start_time",
"property_type": "DateTime",
"property_display_name": "Search date",
"property_description": "",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "search_term",
"property_type": "String",
"property_display_name": "Search terms",
"property_description": "",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "updated_at",
"property_type": "DateTime",
"property_display_name": "Updated at",
"property_description": "Date of last update for this entity",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
}
]
<p>Creates a new filter for a specific endpoint.</p>
<p>You can use filters to apply them on endpoints in order to get sub-sets of entities.</p>
<p>For example, if you want to <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e751ed6bd85d4669025ae5e?groupBy=tag">get trademarks</a> containing the word <strong>law</strong> and the registry <strong>US</strong> you have to create a filter for the endpoint <span class="hljs-literal">firmportfolio</span> and then apply it.</p>
<p>Payload to create a filter for the example above would be very similar to:</p>
<div id="sample01"></div>
<script>
var sample01 = {"name": "'law' in US", "end_point":"firmportfolio","applied":false,"filter_definition":{"groups":[{"expressions":[{"property_name":"registry.id","comparator":"==","value":"783c0667-2884-4d0a-b93b-a6720147e45f","operator_next":"OR"}],"operator_next":"AND"},{"expressions":[{"property_name":"mark_text","comparator":"CONTAINS","value":"law","operator_next":"AND"}],"operator_next":"AND"}]}};
Process(sample01,"sample01" );
hljs.highlightBlock(document.getElementById("sample01"));
</script>
<p>So, basically, you have to define <span class="hljs-literal">groups of expressions</span> for each condition on each property: one group for each property, and one, or more, expressions for each condition.</p>
<p>Another example: if you want to include a new registry, for example <strong>GB</strong>, you should add a new expression into the first group:</p>
<div id="sample02"></div>
<script>
var sample02 = [{"expressions":[{"property_name":"registry.id","comparator":"==","value":"783c0667-2884-4d0a-b93b-a6720147e45f","operator_next":"OR"},{"property_name":"registry.id","comparator":"==","value":"BDBC9579-0462-4449-B7E8-A835017EA7C4","operator_next":"OR"}],"operator_next":"AND"},{"expressions":[{"property_name":"mark_text","comparator":"CONTAINS","value":"law","operator_next":"AND"}],"operator_next":"AND"}];
Process(sample02,"sample02" );
hljs.highlightBlock(document.getElementById("sample02"));
</script>
<p>Note that <span class="hljs-literal">operator_next</span> contains the nexus with next expression. On this sample an <span class="hljs-literal">OR</span> ( because we want trademarks from both: <strong>US</strong> or <strong>GB</strong> ).</p>
<p>The example above is similar to create <a class="popup-link" href="https://apimgmtstxagrkfslnrtesue.blob.core.windows.net/content/MediaLibrary/images/filter_on_UI.png">this filter</a> on the web UI.</p>
<script>
$('.popup-link').magnificPopup({
type: 'image'
});
</script>
<p>Properties available to create filters depend on each endpoint. Check method <span class="hljs-literal">Filters</span> on each endpoint to get a list of all properties available.
Request payload to create the filter.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">end_point</span></span></span>: The endpoint for the filter. For example, if you want to create a filter to select a sub-set of <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57e9e4b3901adc1844aedf7e">registries</a>, you should use the endpoint <strong>registries</strong>. Check each endpoint documentation.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: A human readable name for the filter.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">applied</span></span></span>: If <span class="hljs-literal">true</span> the filter will be applied by default on next <span class="hljs-literal">READ many</span> operation <strong>for the current user</strong>. It's important to remember that filters exist at <strong>user level</strong>.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-circle"></i>
<span>object</span>
</span>
<span class="typeOfParameter">Required</span><strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">filter_definition</span></span></span></strong>: An object containing a single property named <span class="hljs-literal">groups</span>. Where <span class="hljs-literal">groups</span> is an array of objects with these properties:
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">expressions</span></span></span>: An array of objects with these properties:
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_name</span></span></span>: Name of the property for the expression. You have to get them checking each endpoint <span class="hljs-literal">Filter</span> method. For example, to get all properties available to create filters for trademarks, check its <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e789f0e5e099ce66d77768c">Filters</a> method.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">comparator</span></span></span>: A string containing the comparator to be applied with over the value. Each endpoint with method <span class="hljs-literal">Filter</span> provide a list of all comparators available for each property. For example, you can check trademarks <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e789f0e5e099ce66d77768c">Filters</a> and its comparators available.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">value</span></span></span>: A string containing the value to be compared with saved property.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">operator_next</span></span></span>: Logic nexus with next expression. Available values are <span class="hljs-literal">AND</span>, <span class="hljs-literal">OR</span>.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">operator_next</span></span></span>: Logic nexus with next group. Available values are <span class="hljs-literal">AND</span>, <span class="hljs-literal">OR</span>.
</li>
</ul>
</section>
</li>
</ul>
{
"name": null,
"end_point": "firmportfolio",
"it_is_last_used_without_save": true,
"applied": false,
"filter_definition": {
"groups": [
{
"expressions": [
{
"property_name": "mark_text",
"comparator": "CONTAINS",
"value": "lawpanel",
"operator_next": "AND"
}
],
"operator_next": "AND"
}
]
}
}
Returns a representation of filter created. Use returned <span class="hljs-literal">id</span> as <span class="hljs-literal">filter_id</span> parameter on <span class="hljs-literal">READ many</span> endpoint.
{
"id": "66c4ef28-2429-46f3-b815-ab870165e520",
"end_point": "firmportfolio",
"name": "'law' in US",
"applied": false,
"filter_definition": {
"groups": [
{
"expressions": [
{
"property_name": "registry.id",
"comparator": "==",
"value": "783c0667-2884-4d0a-b93b-a6720147e45f",
"operator_next": "OR"
}
],
"operator_next": "AND"
},
{
"expressions": [
{
"property_name": "mark_text",
"comparator": "CONTAINS",
"value": "law",
"operator_next": "AND"
}
],
"operator_next": "AND"
}
]
}
}
Get filter details.
The filter ID
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: Filter <span class="hljs-literal">ID</span>. Use this value to apply the filter with the parameter <span class="hljs-literal">filter_id</span> on <span class="hljs-literal">READ many</span> method of endpoint.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">end_point</span></span></span>: The endpoint for the filter. For example, if you want to create a filter to select a sub-set of <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57e9e4b3901adc1844aedf7e">registries</a>, you should use the endpoint <strong>registries</strong>. Check each endpoint documentation.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: A human readable name for the filter.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">applied</span></span></span>: If <span class="hljs-literal">true</span> the filter will be applied by default on next <span class="hljs-literal">READ many</span> operation <strong>for the current user</strong>. It's important to remember that filters exist at <strong>user level</strong>.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-circle"></i>
<span>object</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">filter_definition</span></span></span>: An object containing a single property named <span class="hljs-literal">groups</span>. Where <span class="hljs-literal">groups</span> is an array of objects with these properties:
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">expressions</span></span></span>: An array of objects with these properties:
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_name</span></span></span>: Name of the property for the expression. You have to get them checking each endpoint <span class="hljs-literal">Filter</span> method. For example, to get all properties available to create filters for trademarks, check its <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e789f0e5e099ce66d77768c">Filters</a> method.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">comparator</span></span></span>: A string containing the comparator to be applied with over the value. Each endpoint with method <span class="hljs-literal">Filter</span> provide a list of all comparators available for each property. For example, you can check trademarks <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e789f0e5e099ce66d77768c">Filters</a> and its comparators available.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">value</span></span></span>: A string containing the value to be compared with saved property.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">operator_next</span></span></span>: Logic nexus with next expression. Available values are <span class="hljs-literal">AND</span>, <span class="hljs-literal">OR</span>.
</li>
</ul>
</section>
</li>
</ul>
</section>
</li>
</ul>
{
"id": "66c4ef28-2429-46f3-b815-ab870165e520",
"end_point": "firmportfolio",
"name": "'law' in US",
"applied": false,
"filter_definition": {
"groups": [
{
"expressions": [
{
"property_name": "registry.id",
"comparator": "==",
"value": "783c0667-2884-4d0a-b93b-a6720147e45f",
"operator_next": "OR"
}
],
"operator_next": "AND"
},
{
"expressions": [
{
"property_name": "mark_text",
"comparator": "CONTAINS",
"value": "law",
"operator_next": "AND"
}
],
"operator_next": "AND"
}
]
}
}
Get a list with filters for your query.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns a list of Filter representations.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: Filter <span class="hljs-literal">ID</span>. Use this value to apply the filter with the parameter <span class="hljs-literal">filter_id</span> on <span class="hljs-literal">READ many</span> method of endpoint.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">end_point</span></span></span>: The endpoint for the filter. For example, if you want to create a filter to select a sub-set of <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57e9e4b3901adc1844aedf7e">registries</a>, you should use the endpoint <strong>registries</strong>. Check each endpoint documentation.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: A human readable name for the filter.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">applied</span></span></span>: If <span class="hljs-literal">true</span> the filter will be applied by default on next <span class="hljs-literal">READ many</span> operation <strong>for the current user</strong>. It's important to remember that filters exist at <strong>user level</strong>.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-circle"></i>
<span>object</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">filter_definition</span></span></span>: An object containing a single property named <span class="hljs-literal">groups</span>. Where <span class="hljs-literal">groups</span> is an array of objects with these properties:
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">expressions</span></span></span>: An array of objects with these properties:
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_name</span></span></span>: Name of the property for the expression. You have to get them checking each endpoint <span class="hljs-literal">Filter</span> method. For example, to get all properties available to create filters for trademarks, check its <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e789f0e5e099ce66d77768c">Filters</a> method.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">comparator</span></span></span>: A string containing the comparator to be applied with over the value. Each endpoint with method <span class="hljs-literal">Filter</span> provide a list of all comparators available for each property. For example, you can check trademarks <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e789f0e5e099ce66d77768c">Filters</a> and its comparators available.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">value</span></span></span>: A string containing the value to be compared with saved property.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">operator_next</span></span></span>: Logic nexus with next expression. Available values are <span class="hljs-literal">AND</span>, <span class="hljs-literal">OR</span>.
</li>
</ul>
</section>
</li>
</ul>
</section>
</li>
</ul>
[
{
"id": "66c4ef28-2429-46f3-b815-ab870165e520",
"end_point": "firmportfolio",
"name": "'law' in US",
"applied": false,
"filter_definition": {
"groups": [
{
"expressions": [
{
"property_name": "registry.id",
"comparator": "==",
"value": "783c0667-2884-4d0a-b93b-a6720147e45f",
"operator_next": "OR"
}
],
"operator_next": "AND"
},
{
"expressions": [
{
"property_name": "mark_text",
"comparator": "CONTAINS",
"value": "law",
"operator_next": "AND"
}
],
"operator_next": "AND"
}
]
}
}
]
Updates an existing filter.
Request payload to update the filter.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: Filter <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">end_point</span></span></span>: The endpoint for the filter. For example, if you want to create a filter to select a sub-set of <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57e9e4b3901adc1844aedf7e">registries</a>, you should use the endpoint <strong>registries</strong>. Check each endpoint documentation.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: A human readable name for the filter.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">applied</span></span></span>: If <span class="hljs-literal">true</span> the filter will be applied by default on next <span class="hljs-literal">READ many</span> operation <strong>for the current user</strong>. It's important to remember that filters exist at <strong>user level</strong>.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-circle"></i>
<span>object</span>
</span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">filter_definition</span></span></span>: An object containing a single property named <span class="hljs-literal">groups</span>. Where <span class="hljs-literal">groups</span> is an array of objects with these properties:
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">expressions</span></span></span>: An array of objects with these properties:
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_name</span></span></span>: Name of the property for the expression. You have to get them checking each endpoint <span class="hljs-literal">Filter</span> method. For example, to get all properties available to create filters for trademarks, check its <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e789f0e5e099ce66d77768c">Filters</a> method.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">comparator</span></span></span>: A string containing the comparator to be applied with over the value. Each endpoint with method <span class="hljs-literal">Filter</span> provide a list of all comparators available for each property. For example, you can check trademarks <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e789f0e5e099ce66d77768c">Filters</a> and its comparators available.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">value</span></span></span>: A string containing the value to be compared with saved property.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">operator_next</span></span></span>: Logic nexus with next expression. Available values are <span class="hljs-literal">AND</span>, <span class="hljs-literal">OR</span>.
</li>
</ul>
</section>
</li>
</ul>
</section>
</li>
</ul>
{
"id": "66c4ef28-2429-46f3-b815-ab870165e520",
"name": "'law' in US",
"end_point": "firmportfolio",
"applied": true,
"filter_definition": {
"groups": [
{
"expressions": [
{
"property_name": "registry.id",
"comparator": "==",
"value": "783c0667-2884-4d0a-b93b-a6720147e45f",
"operator_next": "OR"
}
],
"operator_next": "AND"
},
{
"expressions": [
{
"property_name": "mark_text",
"comparator": "CONTAINS",
"value": "lawpanel",
"operator_next": "AND"
}
],
"operator_next": "AND"
}
]
}
}
{
"id": "4dc0aa72-fca6-482b-a144-ab05010550ea",
"message": "Filter 'Europe trademarks' successfully updated",
"successful": true
}
Deletes a filter.
The filter ID
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns details about the operation result.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the operation.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">message</span></span></span></strong>: Human-readable message with the operation result.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-adjust"></i>
<span>bool</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">successful</span></span></span>: True if operation was performed successfully, false if not..</li>
</ul>
{
"id": "1cafd4e4-303f-48d4-becc-ab0a012d637a",
"message": "Filter successfully deleted",
"successful": true
}
Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec">link</a>.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns a list with all properties available to create a filter for this endpoint.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_name</span></span></span>: Internal name of the property. You must it this value to define properties in your filter.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_type</span></span></span>: Type of the property. Here you can find basic types like <span class="hljs-literal">String</span>, <span class="hljs-literal">DateTime</span>, <span class="hljs-literal">Boolean</span>, <span class="hljs-literal">Int32</span>, etc. Or internal types of LawPanel entities like <span class="hljs-literal">Registry</span>, <span class="hljs-literal">SearchClass</span>, <span class="hljs-literal">Client</span>, etc.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_display_name</span></span></span>: Human-readable name for the property.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_description</span></span></span>: Human-readable description for the property.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i>
<span>array</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">comparators_available</span></span></span>: An array of strings with comparators available for this property.
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Some common values:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">==</span></span></span> Equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">!=</span></span></span> Not equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">></span></span></span> Greater than.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">>=</span></span></span> Greater or equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string"><</span></span></span> Minor than.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string"><=</span></span></span> Minor or equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">IN</span></span></span> In range.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">CU</span></span></span> Into current.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">CONTAINS</span></span></span> Contains value.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">STARTSWITH</span></span></span> Value starts with.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">ENDSWITH</span></span></span> Value ends with.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">multiple</span></span></span>: When <span class="hljs-literal">true</span> means that properti can handle multiple values on its definition.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">endpoint</span></span></span>: For properties of non-basic types like <span class="hljs-literal">String</span>, <span class="hljs-literal">DateTime</span>, <span class="hljs-literal">Boolean</span>, etc., this property indicates the endpoint where you can get a list with entities to use at the filter definition. For example, if the type of the property is <span class="hljs-literal">Registry</span> then this property will contains the endpoint <span class="hljs-literal">Registry</span> which is the URL to get Registries and their IDs in order to compose the filter.
</li>
</ul>
[
{
"property_name": "applied",
"property_type": "Boolean",
"property_display_name": "Applied",
"property_description": "Is this filter currently applied on the endpoint?",
"comparators_available": [
"==",
"!="
],
"multiple": false,
"end_point": ""
},
{
"property_name": "end_point",
"property_type": "String",
"property_display_name": "Endpoint",
"property_description": "Where this filter could be applied?",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "name",
"property_type": "String",
"property_display_name": "Name",
"property_description": "Human readable filter name",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "updated_at",
"property_type": "DateTime",
"property_display_name": "Updated at",
"property_description": "Date of last update for this entity",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
}
]
Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">link</a>.
Returns a list with all properties available to create a filter for this endpoint.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_name</span></span></span>: Internal name of the property. You must it this value to define properties in your filter.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_type</span></span></span>: Type of the property. Here you can find basic types like <span class="hljs-literal">String</span>, <span class="hljs-literal">DateTime</span>, <span class="hljs-literal">Boolean</span>, <span class="hljs-literal">Int32</span>, etc. Or internal types of LawPanel entities like <span class="hljs-literal">Registry</span>, <span class="hljs-literal">SearchClass</span>, <span class="hljs-literal">Client</span>, etc.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_display_name</span></span></span>: Human-readable name for the property.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_description</span></span></span>: Human-readable description for the property.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i>
<span>array</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">comparators_available</span></span></span>: An array of strings with comparators available for this property.
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Some common values:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">==</span></span></span> Equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">!=</span></span></span> Not equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">></span></span></span> Greater than.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">>=</span></span></span> Greater or equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string"><</span></span></span> Minor than.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string"><=</span></span></span> Minor or equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">IN</span></span></span> In range.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">CU</span></span></span> Into current.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">CONTAINS</span></span></span> Contains value.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">STARTSWITH</span></span></span> Value starts with.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">ENDSWITH</span></span></span> Value ends with.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">multiple</span></span></span>: When <span class="hljs-literal">true</span> means that properti can handle multiple values on its definition.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">endpoint</span></span></span>: For properties of non-basic types like <span class="hljs-literal">String</span>, <span class="hljs-literal">DateTime</span>, <span class="hljs-literal">Boolean</span>, etc., this property indicates the endpoint where you can get a list with entities to use at the filter definition. For example, if the type of the property is <span class="hljs-literal">Registry</span> then this property will contains the endpoint <span class="hljs-literal">Registry</span> which is the URL to get Registries and their IDs in order to compose the filter.
</li>
</ul>
[
{
"property_name": "is_available_for_ui",
"property_type": "Boolean",
"property_display_name": "Is available for the web UI?",
"property_description": "Is this language available on our web user interface?",
"comparators_available": [
"==",
"!="
],
"multiple": false,
"end_point": ""
},
{
"property_name": "name",
"property_type": "String",
"property_display_name": "Name",
"property_description": "Language name",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "short_name",
"property_type": "String",
"property_display_name": "Short Name",
"property_description": "Abbreviation for the language",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "updated_at",
"property_type": "DateTime",
"property_display_name": "Updated at",
"property_description": "Date of last update for this entity",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
}
]
Get language details.
The language ID.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: Language <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: A human readable name for the language.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">short_name</span></span></span>: Abbreviation for the language name.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">is_available_for_ui</span></span></span>: If <span class="hljs-literal">true</span> means that language can be selected as UI language on our web UI.
</li>
</ul>
{
"id": "09ae78dd-8be8-44c5-8f0e-a99201169289",
"name": "Montenegrin",
"short_name": "",
"is_available_for_ui": false
}
Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec">link</a>.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns a list with all properties available to create a filter for this endpoint.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_name</span></span></span>: Internal name of the property. You must it this value to define properties in your filter.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_type</span></span></span>: Type of the property. Here you can find basic types like <span class="hljs-literal">String</span>, <span class="hljs-literal">DateTime</span>, <span class="hljs-literal">Boolean</span>, <span class="hljs-literal">Int32</span>, etc. Or internal types of LawPanel entities like <span class="hljs-literal">Registry</span>, <span class="hljs-literal">SearchClass</span>, <span class="hljs-literal">Client</span>, etc.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_display_name</span></span></span>: Human-readable name for the property.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_description</span></span></span>: Human-readable description for the property.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i>
<span>array</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">comparators_available</span></span></span>: An array of strings with comparators available for this property.
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Some common values:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">==</span></span></span> Equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">!=</span></span></span> Not equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">></span></span></span> Greater than.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">>=</span></span></span> Greater or equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string"><</span></span></span> Minor than.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string"><=</span></span></span> Minor or equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">IN</span></span></span> In range.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">CU</span></span></span> Into current.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">CONTAINS</span></span></span> Contains value.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">STARTSWITH</span></span></span> Value starts with.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">ENDSWITH</span></span></span> Value ends with.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">multiple</span></span></span>: When <span class="hljs-literal">true</span> means that properti can handle multiple values on its definition.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">endpoint</span></span></span>: For properties of non-basic types like <span class="hljs-literal">String</span>, <span class="hljs-literal">DateTime</span>, <span class="hljs-literal">Boolean</span>, etc., this property indicates the endpoint where you can get a list with entities to use at the filter definition. For example, if the type of the property is <span class="hljs-literal">Registry</span> then this property will contains the endpoint <span class="hljs-literal">Registry</span> which is the URL to get Registries and their IDs in order to compose the filter.
</li>
</ul>
[
{
"property_name": "contact_email",
"property_type": "String",
"property_display_name": "Contact email",
"property_description": "",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "contact_name",
"property_type": "String",
"property_display_name": "Contact name",
"property_description": "",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "contact_number",
"property_type": "String",
"property_display_name": "Contact number",
"property_description": "",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "name",
"property_type": "String",
"property_display_name": "Name",
"property_description": "Company name",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "client_type",
"property_type": "ClientType",
"property_display_name": "Type",
"property_description": "Company type",
"comparators_available": [
"==",
"!="
],
"multiple": false,
"end_point": "clienttype"
},
{
"property_name": "updated_at",
"property_type": "DateTime",
"property_display_name": "Updated at",
"property_description": "Date of last update for this entity",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
}
]
Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec">link</a>.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns a list with all properties available to create a filter for this endpoint.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_name</span></span></span>: Internal name of the property. You must it this value to define properties in your filter.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_type</span></span></span>: Type of the property. Here you can find basic types like <span class="hljs-literal">String</span>, <span class="hljs-literal">DateTime</span>, <span class="hljs-literal">Boolean</span>, <span class="hljs-literal">Int32</span>, etc. Or internal types of LawPanel entities like <span class="hljs-literal">Registry</span>, <span class="hljs-literal">SearchClass</span>, <span class="hljs-literal">Client</span>, etc.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_display_name</span></span></span>: Human-readable name for the property.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_description</span></span></span>: Human-readable description for the property.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i>
<span>array</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">comparators_available</span></span></span>: An array of strings with comparators available for this property.
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Some common values:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">==</span></span></span> Equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">!=</span></span></span> Not equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">></span></span></span> Greater than.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">>=</span></span></span> Greater or equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string"><</span></span></span> Minor than.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string"><=</span></span></span> Minor or equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">IN</span></span></span> In range.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">CU</span></span></span> Into current.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">CONTAINS</span></span></span> Contains value.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">STARTSWITH</span></span></span> Value starts with.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">ENDSWITH</span></span></span> Value ends with.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">multiple</span></span></span>: When <span class="hljs-literal">true</span> means that properti can handle multiple values on its definition.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">endpoint</span></span></span>: For properties of non-basic types like <span class="hljs-literal">String</span>, <span class="hljs-literal">DateTime</span>, <span class="hljs-literal">Boolean</span>, etc., this property indicates the endpoint where you can get a list with entities to use at the filter definition. For example, if the type of the property is <span class="hljs-literal">Registry</span> then this property will contains the endpoint <span class="hljs-literal">Registry</span> which is the URL to get Registries and their IDs in order to compose the filter.
</li>
</ul>
[
{
"property_name": "description",
"property_type": "String",
"property_display_name": "Description",
"property_description": "",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "name",
"property_type": "String",
"property_display_name": "Name",
"property_description": "",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "updated_at",
"property_type": "DateTime",
"property_display_name": "Updated at",
"property_description": "Date of last update for this entity",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "wipo_code",
"property_type": "String",
"property_display_name": "WIPO code",
"property_description": "",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
}
]
Return a class available to <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e62ae02f96ca1198ee0c637">create a trademark search</a>.
The Search Class ID
Returns a search class representation.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the search class.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">number</span></span></span></strong>: Nice classification number.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span></strong>: Nice classification name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">description</span></span></span></strong>: Nice classification description.</li>
</ul>
{
"id": "2e04d7b7-d681-458f-8a55-a6720147e7fc",
"number": 1,
"name": "Chemical products",
"description": "Chemicals used in industry, science and photography, [...]"
}
Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec">link</a>.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns a list with all properties available to create a filter for this endpoint.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_name</span></span></span>: Internal name of the property. You must it this value to define properties in your filter.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_type</span></span></span>: Type of the property. Here you can find basic types like <span class="hljs-literal">String</span>, <span class="hljs-literal">DateTime</span>, <span class="hljs-literal">Boolean</span>, <span class="hljs-literal">Int32</span>, etc. Or internal types of LawPanel entities like <span class="hljs-literal">Registry</span>, <span class="hljs-literal">SearchClass</span>, <span class="hljs-literal">Client</span>, etc.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_display_name</span></span></span>: Human-readable name for the property.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_description</span></span></span>: Human-readable description for the property.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i>
<span>array</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">comparators_available</span></span></span>: An array of strings with comparators available for this property.
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Some common values:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">==</span></span></span> Equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">!=</span></span></span> Not equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">></span></span></span> Greater than.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">>=</span></span></span> Greater or equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string"><</span></span></span> Minor than.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string"><=</span></span></span> Minor or equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">IN</span></span></span> In range.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">CU</span></span></span> Into current.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">CONTAINS</span></span></span> Contains value.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">STARTSWITH</span></span></span> Value starts with.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">ENDSWITH</span></span></span> Value ends with.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">multiple</span></span></span>: When <span class="hljs-literal">true</span> means that properti can handle multiple values on its definition.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">endpoint</span></span></span>: For properties of non-basic types like <span class="hljs-literal">String</span>, <span class="hljs-literal">DateTime</span>, <span class="hljs-literal">Boolean</span>, etc., this property indicates the endpoint where you can get a list with entities to use at the filter definition. For example, if the type of the property is <span class="hljs-literal">Registry</span> then this property will contains the endpoint <span class="hljs-literal">Registry</span> which is the URL to get Registries and their IDs in order to compose the filter.
</li>
</ul>
[
{
"property_name": "description",
"property_type": "String",
"property_display_name": "Description",
"property_description": "",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "name",
"property_type": "String",
"property_display_name": "Name",
"property_description": "",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "number",
"property_type": "Int32",
"property_display_name": "Number",
"property_description": "",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<="
],
"multiple": false,
"end_point": ""
},
{
"property_name": "search_classes",
"property_type": "String",
"property_display_name": "Other search class numbers related",
"property_description": "",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "updated_at",
"property_type": "DateTime",
"property_display_name": "Updated at",
"property_description": "Date of last update for this entity",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
}
]
Get a list of your users.
Take N records. Default value is 10. Max value is 100.
Skip N records.
To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Returns a simplified list of users for your query.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the user.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">first_name</span></span></span></strong>: Person first name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">last_name</span></span></span></strong>: Person last name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_name</span></span></span></strong>: Person user name. Use this value to login into your account.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">phone_number</span></span></span></strong>: Person phone number.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">language_id</span></span></span>: Language ID for the user. You can get more details about the language <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e793f62cffd3c88b7866c3f">here</a>.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">language_name</span></span></span></strong>: Language human-readable name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">country_id</span></span></span>: Country ID for the user. You can get more details about the country <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a1d9fff6bc84307df35ec">here</a>.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">country_name</span></span></span></strong>: Country human-readable name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_role</span></span></span>: A number to identify role of user. Possible values are: <br/><br/>
<ul>
<li>0: Firm user.</li>
<li>2: Legal entity user.</li>
<li>4: Agent user.</li>
<li>8: Admin user (internal).</li>
<li>16: System user (internal).</li>
</ul>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">last_login_date</span></span></span>: User last login date in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">is_locked_out</span></span></span>: If <span class="hljs-literal">true</span> the user can't login due to security reasons. Other user can revert this situation with an update.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_type_id</span></span></span>: User type ID for the user. You can get more details about the user type <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a265e9634c38fcbf7d361">here</a>.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_type_name</span></span></span></strong>: User type human-readable name.</li>
</ul>
[
{
"id": "03ce7827-aac0-477d-a01b-aad8012abc99",
"first_name": "Ricardo Sebastian",
"last_name": "Guerrero",
"user_name": "sebastian@lawpanel.com",
"email": "sebastian@lawpanel.com",
"phone_number": "+543875333953",
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"language_name": "English",
"country_id": "27cb8e50-0e8b-40cd-a656-a6720147e0a1",
"country_name": "Argentina",
"user_role": 0,
"last_login_date": "2020-01-22T12:26:00.9180468",
"is_locked_out": false,
"user_type_id": "98668B91-296D-4F41-BEE8-A99201177CF0",
"user_type_name": "Attorney"
}
]
Get details about a specific User.
The user ID
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns details about the user.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the user.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">first_name</span></span></span></strong>: Person first name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">last_name</span></span></span></strong>: Person last name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_name</span></span></span></strong>: Person user name. Use this value to login into your account.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">phone_number</span></span></span></strong>: Person phone number.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">language_id</span></span></span>: Language ID for the user. You can get more details about the language <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e793f62cffd3c88b7866c3f?groupBy=tag">here</a>.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">language_name</span></span></span></strong>: Language human-readable name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">country_id</span></span></span>: Country ID for the user. You can get more details about the country <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a1d9fff6bc84307df35ec?groupBy=tag">here</a>.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">country_name</span></span></span></strong>: Country human-readable name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_role</span></span></span>: A string with current role of user. Possible values are: <br/><br/>
<ul>
<li>FirmUser.</li>
<li>ClientUser.</li>
<li>AgentUser.</li>
<li>AdminUser.</li>
<li>SystemUser.</li>
</ul>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">last_login_date</span></span></span>: User last login date in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">is_locked_out</span></span></span>: If <span class="hljs-literal">true</span> the user can't login due to security reasons. Other user can revert this situation with an update.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_type_id</span></span></span>: User type ID for the user. You can get more details about the user type <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a265e9634c38fcbf7d361?groupBy=tag">here</a>.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_type_name</span></span></span></strong>: User type human-readable name.</li>
</ul>
{
"id": "03ce7827-aac0-477d-a01b-aad8012abc99",
"first_name": "Ricardo Sebastian",
"last_name": "Guerrero",
"user_name": "chapeti+alsina003@gmail.com",
"email": "chapeti+alsina003@gmail.com",
"phone_number": "+543875333953",
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"language_name": "English",
"country_id": "27cb8e50-0e8b-40cd-a656-a6720147e0a1",
"country_name": "Argentina",
"user_role": "FirmUser",
"last_login_date": "2020-01-22T12:26:00.9180468Z",
"is_locked_out": false,
"user_type_id": "98668b91-296d-4f41-bee8-a99201177cf0",
"user_type_name": "Attorney"
}
Returns details about a particular country
The country ID.
Returns details about the country.
{
"id": "ec025ddd-a939-4669-83c1-a67300008be3",
"name": "Switzerland",
"short_name": "CH",
"weight_order": 0
}
Get a user type by its ID value.
User type ID
Returns a user type representation.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the user type.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span></strong>: User type human-readable name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">code</span></span></span></strong>: A number to represent the user type.</li>
</ul>
{
"id": "98668b91-296d-4f41-bee8-a99201177cf0",
"name": "Attorney",
"code": 1
}
Returns a list with all frequencies available on the system.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Returns a list with all trademark types available.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the frequency.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span></strong>: Frequency human-readable name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">unit_name</span></span></span></strong>: Frequency unit human-readable name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">years</span></span></span></strong>: How many years has this frequency?.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">months</span></span></span></strong>: How many months has this frequency?.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">days</span></span></span></strong>: How many days has this frequency?.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">hours</span></span></span></strong>: How many hours has this frequency?.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">minutes</span></span></span></strong>: How many minutes has this frequency?.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">seconds</span></span></span></strong>: How many seconds has this frequency?.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">total_in_seconds</span></span></span></strong>: How many seconds has in total this frequency?.
</li>
</ul>
[
{
"id": "085309f3-91b4-4f2e-a156-a99201164a3d",
"name": "Yearly",
"unit_name": "Year",
"years": 1,
"months": 0,
"days": 0,
"hours": 0,
"minutes": 0,
"seconds": 0,
"total_in_seconds": 31557600
},
{
"id": "c94a7d6d-83e1-4186-b3fe-a6720147e2d2",
"name": "Weekly",
"unit_name": "Week",
"years": 0,
"months": 0,
"days": 7,
"hours": 0,
"minutes": 0,
"seconds": 0,
"total_in_seconds": 604800
},
{
"id": "35a83aa2-e5fb-4bd7-9f02-a6720147e2d2",
"name": "Monthly",
"unit_name": "Month",
"years": 0,
"months": 1,
"days": 0,
"hours": 0,
"minutes": 0,
"seconds": 0,
"total_in_seconds": 2592000
},
{
"id": "008d4dea-642c-483a-8c57-a6720147e2d2",
"name": "Bi-Weekly",
"unit_name": "2 weeks",
"years": 0,
"months": 0,
"days": 14,
"hours": 0,
"minutes": 0,
"seconds": 0,
"total_in_seconds": 1209600
},
{
"id": "af3c4667-0857-42b9-83ed-a6720147e2d2",
"name": "Daily",
"unit_name": "Day",
"years": 0,
"months": 0,
"days": 1,
"hours": 0,
"minutes": 0,
"seconds": 0,
"total_in_seconds": 86400
}
]
Returns details of a frequency.
The frequency ID.
Returns a frequency representation.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the frequency.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span></strong>: Frequency human-readable name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">unit_name</span></span></span></strong>: Frequency unit human-readable name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">years</span></span></span></strong>: How many years has this frequency?.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">months</span></span></span></strong>: How many months has this frequency?.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">days</span></span></span></strong>: How many days has this frequency?.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">hours</span></span></span></strong>: How many hours has this frequency?.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">minutes</span></span></span></strong>: How many minutes has this frequency?.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">seconds</span></span></span></strong>: How many seconds has this frequency?.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">total_in_seconds</span></span></span></strong>: How many seconds has in total this frequency?.
</li>
</ul>
{
"id": "085309f3-91b4-4f2e-a156-a99201164a3d",
"name": "Yearly",
"unit_name": "Year",
"years": 1,
"months": 0,
"days": 0,
"hours": 0,
"minutes": 0,
"seconds": 0,
"total_in_seconds": 31557600
}
Get a watching details.
The watching ID
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns a Watching representation
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The watching <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_id</span></span></span>: The user <span class="hljs-literal">ID</span> to recieve email notifications when watching has news. To get a list of your users please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a1d19d2f9702b2c0c17ba">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_name</span></span></span>: Human-readable user name to receive notifications.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>integer</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">sensitivity</span></span></span>: The sensitivity to match a trademark. 0 means very strict, 20 is more flexible. For example, if your trademark is "LawPanel" and you set this value to 0, you'll only receive notifications about new trademarks like "Law Panel", or "LawPanel". If you set it to 20 you'll receive notifications about new trademarks like "A law", or "The panel".
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">firm_portfolio_id</span></span></span>: The trademark <span class="hljs-literal">ID</span> to watch. To get a list of your trademarks please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e751ed6bd85d4669025ae5e">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_number</span></span></span>: The trademark application number for the watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">trademark</span></span></span>: The trademark text for the watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">classes</span></span></span>: Comma separated <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf965f8c9eb0e90ebbb5d">search class numbers</a> for the watched trademark.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_id</span></span></span>: The registry <span class="hljs-literal">ID</span> where watching will be performed. To get a list of registries available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57e9e4b3901adc1844aedf7e">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">registry_name</span></span></span>: Human-readable registry name to perform the watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">frequency_id</span></span></span>: The frequency <span class="hljs-literal">ID</span> to send notifications about watching matches. To get a list of frequencies available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a47db756d854b11a904d2">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">frequency_name</span></span></span>: Human-readable frequency name to notify about matches.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i><span>array</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">events</span></span></span>: An array of objects containing details about matches for your watching.
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: Event ID.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>integer</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">unix_time_stamp</span></span></span>: Event date creation on <a href="https://en.wikipedia.org/wiki/Unix_time" target="_blank">UNIX format</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_date</span></span></span>: Application date for the trademark that matches with your watching. In <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">application_number</span></span></span>: Application number for the trademark that matches with your watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">classes</span></span></span>: Comma separated values of search class numbers for the trademark that matches with your watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">databases</span></span></span>: <a href="https://en.wikipedia.org/wiki/WIPO_ST.3" target="_blank">WIPO ST.3 code</a> for the registry of the trademark that matches with your watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">owner_applicant</span></span></span>: Applicant for the trademark that matches with your watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">owner_applicant</span></span></span>: Applicant for the trademark that matches with your watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">status</span></span></span>: Status text for the trademark that matches with your watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">good_and_services</span></span></span>: Good and services text for the trademark that matches with your watching.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">handled</span></span></span>: If <span class="hljs-literal">true</span> the event was marked as "Handled" by the user. Just a flag to organize events.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">created</span></span></span>: Watching creation date for the trademark in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">last_search_date</span></span></span>: Last search date for matches in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">last_notification_date_time</span></span></span>: Last date when a notification was sent to inform about matches.Date is showed in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601 (UTC)</a> format.
</li>
</ul>
{
"id": "7ba96a95-6ae3-4cdd-a860-ab4a00d3ae7f",
"user_id": "03ce7827-aac0-477d-a01b-aad8012abc99",
"user_name": "chapeti+alsina003@gmail.com",
"sensitivity": 20,
"firm_portfolio_id": "605366ae-6ba7-4f0c-acc4-ab4a00d38883",
"application_number": "0303456",
"trademark": "5ARTH",
"classes": "20",
"registry_id": "bdbc9579-0462-4449-b7e8-a835017ea7c4",
"registry_name": "GB",
"frequency_id": "c94a7d6d-83e1-4186-b3fe-a6720147e2d2",
"frequency_name": "Weekly",
"events": [
{
"id": "7ba96a95-6ae3-4cdd-a860-ab4a00d3ae7f|3139581561719999999",
"unix_time_stamp": 1579741428,
"application_date": "2020-01-02T00:00:00+00:00",
"application_number": "UK00003455018",
"trademark": "5ARTH",
"classes": "20",
"databases": "GB",
"owner_applicant": "Lai Feifeng",
"status": "Pending",
"good_and_services": "20: desks [furniture], office furniture, furniture, chairs, display stands, [...]",
"handled": false
}
],
"created": "2020-01-22T12:50:42.5533169Z",
"last_search_date": "2020-01-23T01:05:06.9702455Z",
"last_notification_date_time": "2020-01-23T01:05:06.9702455Z"
}
Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec">link</a>.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns a list with all properties available to create a filter for this endpoint.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_name</span></span></span>: Internal name of the property. You must it this value to define properties in your filter.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_type</span></span></span>: Type of the property. Here you can find basic types like <span class="hljs-literal">String</span>, <span class="hljs-literal">DateTime</span>, <span class="hljs-literal">Boolean</span>, <span class="hljs-literal">Int32</span>, etc. Or internal types of LawPanel entities like <span class="hljs-literal">Registry</span>, <span class="hljs-literal">SearchClass</span>, <span class="hljs-literal">Client</span>, etc.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_display_name</span></span></span>: Human-readable name for the property.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_description</span></span></span>: Human-readable description for the property.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i>
<span>array</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">comparators_available</span></span></span>: An array of strings with comparators available for this property.
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Some common values:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">==</span></span></span> Equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">!=</span></span></span> Not equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">></span></span></span> Greater than.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">>=</span></span></span> Greater or equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string"><</span></span></span> Minor than.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string"><=</span></span></span> Minor or equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">IN</span></span></span> In range.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">CU</span></span></span> Into current.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">CONTAINS</span></span></span> Contains value.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">STARTSWITH</span></span></span> Value starts with.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">ENDSWITH</span></span></span> Value ends with.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">multiple</span></span></span>: When <span class="hljs-literal">true</span> means that properti can handle multiple values on its definition.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">endpoint</span></span></span>: For properties of non-basic types like <span class="hljs-literal">String</span>, <span class="hljs-literal">DateTime</span>, <span class="hljs-literal">Boolean</span>, etc., this property indicates the endpoint where you can get a list with entities to use at the filter definition. For example, if the type of the property is <span class="hljs-literal">Registry</span> then this property will contains the endpoint <span class="hljs-literal">Registry</span> which is the URL to get Registries and their IDs in order to compose the filter.
</li>
</ul>
[
{
"property_name": "frequency",
"property_type": "Frequency",
"property_display_name": "Alert frequency",
"property_description": "",
"comparators_available": [
"==",
"!="
],
"multiple": false,
"end_point": "frequencies"
},
{
"property_name": "last_notification_date_time",
"property_type": "DateTime",
"property_display_name": "Last notification date time",
"property_description": "",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "last_search_date_time",
"property_type": "DateTime",
"property_display_name": "Last search date time",
"property_description": "",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "interesting_watching_history_records",
"property_type": "Int32",
"property_display_name": "Number of not handled events",
"property_description": "",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<="
],
"multiple": false,
"end_point": ""
},
{
"property_name": "sensitivity",
"property_type": "Int32",
"property_display_name": "Range",
"property_description": "",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<="
],
"multiple": false,
"end_point": ""
},
{
"property_name": "user",
"property_type": "User",
"property_display_name": "Responsible",
"property_description": "",
"comparators_available": [
"==",
"!="
],
"multiple": false,
"end_point": "users"
},
{
"property_name": "firm_portfolio",
"property_type": "FirmPortfolio",
"property_display_name": "Trademark",
"property_description": "",
"comparators_available": [
"==",
"!="
],
"multiple": false,
"end_point": "firmportfolio"
},
{
"property_name": "updated_at",
"property_type": "DateTime",
"property_display_name": "Updated at",
"property_description": "Date of last update for this entity",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
}
]
Returns a list with all user types available on the system.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Returns a list with all user types available.
<ul class="propertiesList">
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span></strong>: The ID for the user type.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-font"></i>
<span>string</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span></strong>: User type human-readable name.</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-sort-numeric-up"></i>
<span>integer</span>
</span>
<strong><span class="PropertyName"><span class="coffeescript"><span class="hljs-string">code</span></span></span></strong>: A number to represent the user type.</a>.</li>
</ul>
[
{
"id": "ad2c01df-7323-42bf-9744-a99201177d0f",
"name": "Partner",
"code": 3
},
{
"id": "764c59e3-6528-474a-887c-a99201177d02",
"name": "Paralegal",
"code": 2
},
{
"id": "98668b91-296d-4f41-bee8-a99201177cf0",
"name": "Attorney",
"code": 1
}
]
Return the list of roles possible for Part on Cases: trademark owner, designer, representative, etc.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Returns data about case legal entities roles
[
{
"enable": true,
"id": "2ef1ef65-98f6-4aa1-ab64-a992011765e4",
"code": 6,
"name": "Agent"
},
{
"enable": true,
"id": "68f8f46d-0313-4816-985c-a992011765bd",
"code": 1,
"name": "Client"
},
{
"enable": true,
"id": "7677d33e-e916-4a15-b58a-a992011765d8",
"code": 4,
"name": "Other"
},
{
"enable": true,
"id": "0c01905c-dc73-40f1-9885-a992011765de",
"code": 5,
"name": "Other representative"
},
{
"enable": true,
"id": "ee252fa3-3243-4337-a357-a992011765d1",
"code": 3,
"name": "Representative"
}
]
Return the list of roles possibles for the IP Records on Cases.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Returns data about case trademark roles
[
{
"enable": true,
"id": "ea70d6e8-229d-470d-90fa-a9fb01864182",
"code": 4,
"name": "Designation",
"is_own": false
},
{
"enable": true,
"id": "3295f071-aad8-4e8f-a28f-a992011765ff",
"code": 3,
"name": "Disposition",
"is_own": false
},
{
"enable": true,
"id": "5a7fdfcd-3a50-4f87-9869-a992011765f8",
"code": 2,
"name": "Other party",
"is_own": false
},
{
"enable": true,
"id": "72ccf3d8-cc1b-4e9b-9f7b-a992011765ee",
"code": 1,
"name": "Own",
"is_own": true
}
]
Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">link</a>.
Returns a list with all properties available to create a filter for this endpoint.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_name</span></span></span>: Internal name of the property. You must it this value to define properties in your filter.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_type</span></span></span>: Type of the property. Here you can find basic types like <span class="hljs-literal">String</span>, <span class="hljs-literal">DateTime</span>, <span class="hljs-literal">Boolean</span>, <span class="hljs-literal">Int32</span>, etc. Or internal types of LawPanel entities like <span class="hljs-literal">Registry</span>, <span class="hljs-literal">SearchClass</span>, <span class="hljs-literal">Client</span>, etc.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_display_name</span></span></span>: Human-readable name for the property.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">property_description</span></span></span>: Human-readable description for the property.
</li>
<li>
<span class="typeOfProperty">
<i class="icon fa fa-list"></i>
<span>array</span>
</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">comparators_available</span></span></span>: An array of strings with comparators available for this property.
<br/>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Some common values:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">==</span></span></span> Equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">!=</span></span></span> Not equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">></span></span></span> Greater than.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">>=</span></span></span> Greater or equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string"><</span></span></span> Minor than.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string"><=</span></span></span> Minor or equal to.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">IN</span></span></span> In range.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">CU</span></span></span> Into current.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">CONTAINS</span></span></span> Contains value.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">STARTSWITH</span></span></span> Value starts with.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">ENDSWITH</span></span></span> Value ends with.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">multiple</span></span></span>: When <span class="hljs-literal">true</span> means that properti can handle multiple values on its definition.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">endpoint</span></span></span>: For properties of non-basic types like <span class="hljs-literal">String</span>, <span class="hljs-literal">DateTime</span>, <span class="hljs-literal">Boolean</span>, etc., this property indicates the endpoint where you can get a list with entities to use at the filter definition. For example, if the type of the property is <span class="hljs-literal">Registry</span> then this property will contains the endpoint <span class="hljs-literal">Registry</span> which is the URL to get Registries and their IDs in order to compose the filter.
</li>
</ul>
[
{
"property_name": "name",
"property_type": "String",
"property_display_name": "Name",
"property_description": "Human-readable country name",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "short_name",
"property_type": "String",
"property_display_name": "Short Name",
"property_description": "Abbreviation for the country",
"comparators_available": [
"CONTAINS",
"==",
"!=",
"STARTSWITH",
"ENDSWITH"
],
"multiple": false,
"end_point": ""
},
{
"property_name": "updated_at",
"property_type": "DateTime",
"property_display_name": "Updated at",
"property_description": "Date of last update for this entity",
"comparators_available": [
"==",
"!=",
">",
">=",
"<",
"<=",
"IN",
"CU"
],
"multiple": false,
"end_point": ""
}
]
Create a new task for the Case.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
This code is returned when the task was created successfully.
{}
Update a task for the Case.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Delete a task.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Get task details.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Create a new reminder for the Task.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Returns data about new task reminder created
{}
Get task reminder details.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Update a task reminder.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Delete a task reminder.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Return a tax entity details.
The tax ID.
Returns a tax entity representation.
{
"id": "1235e80b-fc55-44c0-ace8-903e53522e3e",
"name": "AR VAT",
"description": "",
"units": 0,
"percent": 0
}
Return a currency entity details.
Returns a currency entity representation.
{
"id": "cd12f109-c15c-42c1-9ae3-a6e91118d70c",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
}
Return product available.
The product ID.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Return the product enabled to operate with payments and invoices.
{
"enable": true,
"id": "3bfb0737-c7ed-4c97-b418-ab1800d95f1e",
"firm_id": "8a5536dc-6d34-4f4a-8cac-a67201481ca0",
"product": {
"enable": true,
"id": "3bfb0737-c7ed-4c97-b418-ab1800d95f1e",
"code": "asd",
"name": "OurFee",
"name_public": "Our fee NOIP",
"product_type": {
"enable": true,
"id": "13fc72e0-a875-4771-af97-a6e90008f046",
"name": "Service"
},
"prices": [
{
"enable": true,
"id": "8e51e221-abb0-4457-ba77-ab1800d95f1e",
"date_time": "2019-12-03T13:11:25.5360819Z",
"currency": {
"enable": true,
"id": "cd80f109-c15c-42c1-9ae3-a6e90008d70c",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
"currency_units": 300
}
],
"product_modifiers": [],
"taxes": []
}
}
Creates a new "Firm User".
Payload must contain information about the user to be created.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">country_id</span></span></span>: The country <span class="hljs-literal">ID</span>. To get details of fee item please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59bacfe6901adc16e035bf43">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">email</span></span></span>: The email of the user. This email is used to authentication.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_name</span></span></span>: The user name use email.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">first_name</span></span></span>: The first name of the user.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">last_name</span></span></span>: The last name of the user.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">language_id</span></span></span>: The language used by the user. To get details of currencies please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf30bf8c9eb0e90ebbb59">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">password</span></span></span>: We recommend you use a strong password for your security.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>numeric</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">phone_number</span></span></span>: The phone number of the user.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>bool</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">reset_password</span></span></span>: If the reset passord is true, the user will be forced to change their password the first time upon login. By default is false.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>bool</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">two_factor_authenticator</span></span></span>: If the two factor authenticatos is true, the user will be forced to use this method of authentication by email or SMS. By default is false.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_type_id</span></span></span>: The user type <span class="hljs-literal">ID</span>. To get details of user types please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7ba3a9a1fc742a9d55aecb">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>array</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">claims</span></span></span>: The claims <span class="hljs-literal">ID</span> for this fee item. There are differents user restrictions in Ip records / Trademarks view (portfolio). If the list is empty it will default to administrator role. To get details of claims please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5ea3ae0c8f5fee7079593df7">link</a>.<br>
</li>
</ul>
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
{
"country_id": "3fa600af-5237-477d-badb-a67300008be3",
"email": "albert@genius.com",
"user_name": "albert@genius.com",
"first_name": "Albert",
"last_name": "Einstein",
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"password": "GUj/j8<#0Gxa,ut>",
"phone_number": "+543875123953",
"reset_password": "False",
"two_factor_authenticator": "False",
"user_type_id": "",
"claims": []
}
This code is returned when the user was created successfully.
{
"enable": true,
"id": "sa548916-e2fa-4ce8-ba49-aba70183c408",
"first_name": "Albert",
"last_name": "Einstein",
"user_name": "albert@genius.com",
"email": "albert@genius.com",
"phone_number": "0",
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"language_name": "English",
"country_id": "3fa600af-5237-477d-badb-a67300008be3",
"country_name": "Germany",
"user_role": "FirmUser",
"last_login_date": null,
"is_yoti": false,
"is_locked_out": false,
"yoti_id": null,
"user_settings": null,
"claims": [],
"user_type_id": null,
"user_type_name": null
}
Return claims available to assigned to users.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Return the claims available to be assigned with users.
[
{
"id": "e8ed8dbb-1234-4672-ab59-a87300266bd8",
"claim_target": {
"id": "e30ea880-9ce1-4ca9-a719-a87300266764",
"code": 1,
"name": "Portfolio",
"description": "Permissions related with actions over the Portfolio"
},
"code": 102,
"name": "External Limited User",
"description": "User can only see and edit portfolio items assigned to them."
},
{
"id": "e41ff142-6547-41c4-9452-a87300266a61",
"claim_target": {
"id": "e30ea880-9ce1-4ca9-a719-a87300266764",
"code": 1,
"name": "Portfolio",
"description": "Permissions related with actions over the Portfolio"
},
"code": 101,
"name": "Internal Limited User",
"description": "User can see all portfolios items, but only edit items assigned to them."
},
{
"id": "7c4fcc3e-7897-4efe-a2f5-a873002668dd",
"claim_target": {
"id": "e30ea880-9ce1-4ca9-a719-a87300266764",
"code": 1,
"name": "Portfolio",
"description": "Permissions related with actions over the Portfolio"
},
"code": 100,
"name": "Read only",
"description": "User can see all portfolio items, but cannot edit them."
}
]
Deletes an user.
The user ID
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Return details about the delete operation.
{
"id": "131a8211-c74f-43d0-b8c8-abaa013621de",
"message": "User 'blanquito@ups.com' deleted",
"successful": true
}
Updates an existing user.
Payload must contain information about the User to be updated.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The user <span class="hljs-literal">ID</span>. To get details of an particular User please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a1d19d2f9702b2c0c17ba?groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">first_name</span></span></span>: The first name of the user.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">last_name</span></span></span>: The last name of the user.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_name</span></span></span>: The username. You can't change this value.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">email</span></span></span>: The email address for the user.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">password</span></span></span>: We recommend you use a strong password for your security.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>numeric</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">phone_number</span></span></span>: The phone number of the user.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">language_id</span></span></span>: The language used by the user. To get a list of languages available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf30bf8c9eb0e90ebbb59?groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">country_id</span></span></span>: The country <span class="hljs-literal">ID</span>. To get a list of all countries available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59bacfe6901adc16e035bf43?groupBy=tag">link</a>.
</li>
</ul>
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
{
"id": "52d3a0c6-8157-4b0b-b485-ac5a00bef873",
"first_name": "Sebastian",
"last_name": "Guerrero",
"user_name": "client_email@domain.com",
"email": "client_email@domain.com",
"password": "1234567",
"phone_number": "387-155 333 953",
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"country_id": "27cb8e50-0e8b-40cd-a656-a6720147e0a1"
}
Return details about the delete operation.
{
"id": "69fdf398-b0bc-447d-b760-aba8002d58f8",
"message": "User 'bro@ther.com' successfully updated",
"successful": true
}
Return case available.
The case ID.
Return the case enabled to operate.
{
"id": "999ee0a3-209c-4bfa-96a3-ac31009acde1",
"name": "22242",
"number": "22242",
"folder": {
"id": "d46cfddd-9103-4059-9380-ac31009acddd",
"name": "56611b85-84bd-431d-835d-6e803979e3ee_e72d1fa5-baec-480a-90e3-4c360e806f45",
"files": [
{
"id": "999ee0a3-209c-4bfa-96a3-ac31009acde1",
"name": "22242",
"number": "22242",
"folder": null,
"tags": [],
"other_supervisors": [
{
"id": "d344g609-0948-4085-a7dd-ac34567ghh56",
"first_name": "Mark",
"last_name": "KW",
"user_name": null,
"email": null,
"phone_number": null,
"language_id": null,
"language_name": null,
"country_id": "5306aa9a-3c36-40d8-b32e-a67300008be3",
"country_name": "GB"
}
],
"client": {
"id": "c559a609-0948-4085-a7dd-ac31009acd26",
"name": "Robinson Richard",
"company_registration_number": null,
"contact_name": "",
"contact_email": "email@server.com",
"contact_number": null,
"contact_address": {
"id": "40d1e085-20e1-4afd-83b4-ac31009acd26",
"line1": null,
"line2": null,
"line3": null,
"building": null,
"floor_level": null,
"postal_code": null,
"city": null,
"state_province": null,
"region": null,
"country_id": "c6b020e9-e5b1-425d-823e-a67300008be3",
"country_name": "Brazil"
},
"billing_address": {
"id": "3118a563-1e88-4c4a-90df-ac31009acd26",
"line1": null,
"line2": null,
"line3": null,
"building": null,
"floor_level": null,
"postal_code": null,
"city": null,
"state_province": null,
"region": null,
"country_id": "c6b020e9-e5b1-425d-823e-a67300008be3",
"country_name": "Brazil"
},
"client_type": "604a3d85-5c5b-4364-b69c-a99201175b30"
},
"user": {
"id": "8243ac64-65e9-42b5-a292-a8070178a462",
"first_name": "TMD",
"last_name": "Migration",
"user_name": "lawpanel@tmd.com",
"email": "lawpanel@tmd.com",
"phone_number": "654321",
"language_id": "09ae78dd-8be8-44c5-8f0e-a99201169289",
"language_name": "Montenegrin",
"country_id": "c6b020e9-e5b1-425d-823e-a67300008be3",
"country_name": "Brazil"
},
"file_status": {
"id": "dbb513aa-58e3-4a70-a805-a74c00714768",
"name": "Opened",
"initial_state": true
},
"file_template": {
"id": "3dc49d41-4cdc-47bb-b965-a807017653d4",
"name": "Trademark TMD",
"file_template_components": [
{
"id": "2f629748-c13f-4fc3-a760-a80701765553",
"name": "Search result",
"description": "Represent a search result executed by a firm",
"definition": null,
"definition_type": null,
"entity_type": "FirmSearch",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 1,
"value_type": null
},
{
"id": "fcad12f2-4efc-4158-8a41-a80701765749",
"name": "Good and services",
"description": "Please describe the goods or services the name is to be used with",
"definition": null,
"definition_type": null,
"entity_type": "StringMultiText",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 2,
"value_type": null
},
{
"id": "68bb0819-e272-4392-8fcc-a8070176592e",
"name": "Website",
"description": "If there is a website for your business or goods/services please enter the URL",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 3,
"value_type": null
},
{
"id": "b74feae6-201a-4b7e-a477-a80701765b13",
"name": "Are you already using the name",
"description": "if so please let us know, this can help us get the name registered",
"definition": "{\"Items\":[{\"Display\":\"Not using\",\"Value\":\"Not using\",\"Enable\":false},{\"Display\":\"Less than 1 year\",\"Value\":\"Less than 1 year\",\"Enable\":false},{\"Display\":\"1 - 3 years\",\"Value\":\"1 - 3 years\",\"Enable\":false},{\"Display\":\"4 - 5 years\",\"Value\":\"4 - 5 years\",\"Enable\":false},{\"Display\":\"More than 5 years\",\"Value\":\"More than 5 years\",\"Enable\":false}],\"Enable\":false}",
"definition_type": "SelectItemFromListDefinitionDto",
"entity_type": "SelectItemFromList",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 4,
"value_type": null
},
{
"id": "b5f55936-ae28-4dab-9425-a80701765d2b",
"name": "Series",
"description": "Trademark is individual or part of a series?",
"definition": "{\"OptionWithTexts\":[{\"Id\":\"IndividualTrademark\",\"OptionName\":\"This is an individual trade mark and not part of a series of trade marks\",\"OptionDescription\":\"\",\"WithDescription\":false,\"SelectedByDefault\":true,\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false},{\"Id\":\"PartOfSeriesTrademark\",\"OptionName\":\"This trade mark is part of a series of related trade marks\",\"OptionDescription\":\"A series of marks is a number of marks which only have very small differences that do not substantially affect the marks (for example, a word shown in CAPITALS and in 'small' letters).\",\"WithDescription\":true,\"SelectedByDefault\":false,\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}],\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}",
"definition_type": "OptionsWithTextDefinitionDto",
"entity_type": "OptionsWithText",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 5,
"value_type": null
},
{
"id": "9c745a64-d9aa-47f8-83e9-a80701765f17",
"name": "Previously registered",
"description": "Trademark was previously registered?",
"definition": "{\"OptionWithTexts\":[{\"Id\":\"NotPreviouslyRegistered\",\"OptionName\":\"I have not previously registered this trade mark in another country\",\"OptionDescription\":\"\",\"WithDescription\":false,\"SelectedByDefault\":true,\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false},{\"Id\":\"PreviouslyRegistered\",\"OptionName\":\"I have previously registered this trade mark in another country\",\"OptionDescription\":\"If you have previously registered this trade mark in another country you may be able to claim priority over competing trade marks in this country. Please give details of previous registrations (incl. priority date, country, number)\",\"WithDescription\":true,\"SelectedByDefault\":false,\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}],\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}",
"definition_type": "OptionsWithTextDefinitionDto",
"entity_type": "OptionsWithText",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 6,
"value_type": null
},
{
"id": "b55d051b-940a-4610-a8e3-a807017660fc",
"name": "SMS Notifications",
"description": "Being able to send you texts can help us progress your application more quickly and efficiently. Please enter your mobile phone number.",
"definition": "{\"Id\":\"SmsNotifications\",\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}",
"definition_type": "CheckboxWithTextDefinitionDto",
"entity_type": "CheckboxWithText",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 7,
"value_type": "OptionsWithTextValueDto"
},
{
"id": "ff7777f7-23f1-430e-94f0-aa4d00e71536",
"name": "Order folder",
"description": "Order folder",
"definition": "{\"Items\":[{\"Display\":\"Abandoned\",\"Value\":\"Abandoned\",\"Enable\":false},{\"Display\":\"Action required\",\"Value\":\"Action required\",\"Enable\":false},{\"Display\":\"Action required (paid)\",\"Value\":\"Action required (paid)\",\"Enable\":false},{\"Display\":\"Client action (paid)\",\"Value\":\"Client action (paid)\",\"Enable\":false},{\"Display\":\"Deleted\",\"Value\":\"Deleted\",\"Enable\":false},{\"Display\":\"For review\",\"Value\":\"For review\",\"Enable\":false},{\"Display\":\"For review (paid)\",\"Value\":\"For review (paid)\",\"Enable\":false},{\"Display\":\"New orders\",\"Value\":\"New orders\",\"Enable\":false},{\"Display\":\"No action\",\"Value\":\"No action\",\"Enable\":false},{\"Display\":\"Ongoing\",\"Value\":\"Ongoing\",\"Enable\":false},{\"Display\":\"Right Start\",\"Value\":\"Right Start\",\"Enable\":false},{\"Display\":\"Standard filing\",\"Value\":\"Standard filing\",\"Enable\":false},{\"Display\":\"To be filed\",\"Value\":\"To be filed\",\"Enable\":false},{\"Display\":\"Client action\",\"Value\":\"Client action\",\"Enable\":false}],\"Enable\":true}",
"definition_type": "SelectItemFromListDefinitionDto",
"entity_type": "SelectItemFromList",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 8,
"value_type": null
},
{
"id": "ba1be818-5b43-411a-b9db-aa4d00e7153b",
"name": "Order status",
"description": "Order status",
"definition": "{\"Items\":[{\"Display\":\"Awaiting client comments\",\"Value\":\"Awaiting client comments\",\"Enable\":false},{\"Display\":\"Filed\",\"Value\":\"Filed\",\"Enable\":false},{\"Display\":\"On hold awaiting client\",\"Value\":\"On hold awaiting client\",\"Enable\":false},{\"Display\":\"Order cancelled\",\"Value\":\"Order cancelled\",\"Enable\":false},{\"Display\":\"Order finished\",\"Value\":\"Order finished\",\"Enable\":false},{\"Display\":\"Prepare for filing\",\"Value\":\"Prepare for filing\",\"Enable\":false},{\"Display\":\"Preparing draft application\",\"Value\":\"Preparing draft application\",\"Enable\":false},{\"Display\":\"Preparing spec\",\"Value\":\"Preparing spec\",\"Enable\":false},{\"Display\":\"Report order placed\",\"Value\":\"Report order placed\",\"Enable\":false},{\"Display\":\"Searches and legal checks\",\"Value\":\"Searches and legal checks\",\"Enable\":false},{\"Display\":\"We're thinking\",\"Value\":\"We're thinking\",\"Enable\":false}],\"Enable\":true}",
"definition_type": "SelectItemFromListDefinitionDto",
"entity_type": "SelectItemFromList",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 9,
"value_type": null
}
],
"is_base": false,
"is_template_for_trademark_filing": true,
"is_template_filing": false,
"base_id": "00000000-0000-0000-0000-000000000000",
"ip_records": []
},
"components": null,
"created_by": "lawpanel@tmd.com",
"updated_at": "2020-09-09T09:23:37.5112425Z",
"updated_by": "lawpanel@tmd.com",
"firm_portfolio": null,
"active": true
}
]
},
"tags": [],
"other_supervisors": [
{
"id": "d344g609-0948-4085-a7dd-ac34567ghh56",
"first_name": "Mark",
"last_name": "KW",
"user_name": null,
"email": null,
"phone_number": null,
"language_id": null,
"language_name": null,
"country_id": "5306aa9a-3c36-40d8-b32e-a67300008be3",
"country_name": "GB"
}
],
"client": {
"id": "c559a609-0948-4085-a7dd-ac31009acd26",
"name": "Robinson Richard",
"company_registration_number": null,
"contact_name": "",
"contact_email": "email@server.com",
"contact_number": null,
"contact_address": {
"id": "40d1e085-20e1-4afd-83b4-ac31009acd26",
"line1": null,
"line2": null,
"line3": null,
"building": null,
"floor_level": null,
"postal_code": null,
"city": null,
"state_province": null,
"region": null,
"country_id": "00000000-0000-0000-0000-000000000000",
"country_name": null
},
"billing_address": {
"id": "3118a563-1e88-4c4a-90df-ac31009acd26",
"line1": null,
"line2": null,
"line3": null,
"building": null,
"floor_level": null,
"postal_code": null,
"city": null,
"state_province": null,
"region": null,
"country_id": "c6b020e9-e5b1-425d-823e-a67300008be3",
"country_name": "Brazil"
},
"client_type": null
},
"user": {
"id": "8243ac64-65e9-42b5-a292-a8070178a462",
"first_name": "TMD",
"last_name": "Migration",
"user_name": "lawpanel@tmd.com",
"email": "lawpanel@tmd.com",
"phone_number": "654321",
"language_id": "09ae78dd-8be8-44c5-8f0e-a99201169289",
"language_name": "Montenegrin",
"country_id": "c6b020e9-e5b1-425d-823e-a67300008be3",
"country_name": "Brazil"
},
"file_status": {
"id": "dbb513aa-58e3-4a70-a805-a74c00714768",
"name": "Opened",
"initial_state": true
},
"file_template": {
"id": "3dc49d41-4cdc-47bb-b965-a807017653d4",
"name": "Trademark TMD",
"file_template_components": [
{
"id": "2f629748-c13f-4fc3-a760-a80701765553",
"name": "Search result",
"description": "Represent a search result executed by a firm",
"definition": null,
"definition_type": null,
"entity_type": "FirmSearch",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 1,
"value_type": null
},
{
"id": "fcad12f2-4efc-4158-8a41-a80701765749",
"name": "Good and services",
"description": "Please describe the goods or services the name is to be used with",
"definition": null,
"definition_type": null,
"entity_type": "StringMultiText",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 2,
"value_type": null
},
{
"id": "68bb0819-e272-4392-8fcc-a8070176592e",
"name": "Website",
"description": "If there is a website for your business or goods/services please enter the URL",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 3,
"value_type": null
},
{
"id": "b74feae6-201a-4b7e-a477-a80701765b13",
"name": "Are you already using the name",
"description": "if so please let us know, this can help us get the name registered",
"definition": "{\"Items\":[{\"Display\":\"Not using\",\"Value\":\"Not using\",\"Enable\":false},{\"Display\":\"Less than 1 year\",\"Value\":\"Less than 1 year\",\"Enable\":false},{\"Display\":\"1 - 3 years\",\"Value\":\"1 - 3 years\",\"Enable\":false},{\"Display\":\"4 - 5 years\",\"Value\":\"4 - 5 years\",\"Enable\":false},{\"Display\":\"More than 5 years\",\"Value\":\"More than 5 years\",\"Enable\":false}],\"Enable\":false}",
"definition_type": "SelectItemFromListDefinitionDto",
"entity_type": "SelectItemFromList",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 4,
"value_type": null
},
{
"id": "b5f55936-ae28-4dab-9425-a80701765d2b",
"name": "Series",
"description": "Trademark is individual or part of a series?",
"definition": "{\"OptionWithTexts\":[{\"Id\":\"IndividualTrademark\",\"OptionName\":\"This is an individual trade mark and not part of a series of trade marks\",\"OptionDescription\":\"\",\"WithDescription\":false,\"SelectedByDefault\":true,\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false},{\"Id\":\"PartOfSeriesTrademark\",\"OptionName\":\"This trade mark is part of a series of related trade marks\",\"OptionDescription\":\"A series of marks is a number of marks which only have very small differences that do not substantially affect the marks (for example, a word shown in CAPITALS and in 'small' letters).\",\"WithDescription\":true,\"SelectedByDefault\":false,\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}],\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}",
"definition_type": "OptionsWithTextDefinitionDto",
"entity_type": "OptionsWithText",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 5,
"value_type": null
},
{
"id": "9c745a64-d9aa-47f8-83e9-a80701765f17",
"name": "Previously registered",
"description": "Trademark was previously registered?",
"definition": "{\"OptionWithTexts\":[{\"Id\":\"NotPreviouslyRegistered\",\"OptionName\":\"I have not previously registered this trade mark in another country\",\"OptionDescription\":\"\",\"WithDescription\":false,\"SelectedByDefault\":true,\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false},{\"Id\":\"PreviouslyRegistered\",\"OptionName\":\"I have previously registered this trade mark in another country\",\"OptionDescription\":\"If you have previously registered this trade mark in another country you may be able to claim priority over competing trade marks in this country. Please give details of previous registrations (incl. priority date, country, number)\",\"WithDescription\":true,\"SelectedByDefault\":false,\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}],\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}",
"definition_type": "OptionsWithTextDefinitionDto",
"entity_type": "OptionsWithText",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 6,
"value_type": null
},
{
"id": "b55d051b-940a-4610-a8e3-a807017660fc",
"name": "SMS Notifications",
"description": "Being able to send you texts can help us progress your application more quickly and efficiently. Please enter your mobile phone number.",
"definition": "{\"Id\":\"SmsNotifications\",\"CreatedAt\":\"0001-01-01T00:00:00\",\"Enable\":false}",
"definition_type": "CheckboxWithTextDefinitionDto",
"entity_type": "CheckboxWithText",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 7,
"value_type": "OptionsWithTextValueDto"
},
{
"id": "ff7777f7-23f1-430e-94f0-aa4d00e71536",
"name": "Order folder",
"description": "Order folder",
"definition": "{\"Items\":[{\"Display\":\"Abandoned\",\"Value\":\"Abandoned\",\"Enable\":false},{\"Display\":\"Action required\",\"Value\":\"Action required\",\"Enable\":false},{\"Display\":\"Action required (paid)\",\"Value\":\"Action required (paid)\",\"Enable\":false},{\"Display\":\"Client action (paid)\",\"Value\":\"Client action (paid)\",\"Enable\":false},{\"Display\":\"Deleted\",\"Value\":\"Deleted\",\"Enable\":false},{\"Display\":\"For review\",\"Value\":\"For review\",\"Enable\":false},{\"Display\":\"For review (paid)\",\"Value\":\"For review (paid)\",\"Enable\":false},{\"Display\":\"New orders\",\"Value\":\"New orders\",\"Enable\":false},{\"Display\":\"No action\",\"Value\":\"No action\",\"Enable\":false},{\"Display\":\"Ongoing\",\"Value\":\"Ongoing\",\"Enable\":false},{\"Display\":\"Right Start\",\"Value\":\"Right Start\",\"Enable\":false},{\"Display\":\"Standard filing\",\"Value\":\"Standard filing\",\"Enable\":false},{\"Display\":\"To be filed\",\"Value\":\"To be filed\",\"Enable\":false},{\"Display\":\"Client action\",\"Value\":\"Client action\",\"Enable\":false}],\"Enable\":true}",
"definition_type": "SelectItemFromListDefinitionDto",
"entity_type": "SelectItemFromList",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 8,
"value_type": null
},
{
"id": "ba1be818-5b43-411a-b9db-aa4d00e7153b",
"name": "Order status",
"description": "Order status",
"definition": "{\"Items\":[{\"Display\":\"Awaiting client comments\",\"Value\":\"Awaiting client comments\",\"Enable\":false},{\"Display\":\"Filed\",\"Value\":\"Filed\",\"Enable\":false},{\"Display\":\"On hold awaiting client\",\"Value\":\"On hold awaiting client\",\"Enable\":false},{\"Display\":\"Order cancelled\",\"Value\":\"Order cancelled\",\"Enable\":false},{\"Display\":\"Order finished\",\"Value\":\"Order finished\",\"Enable\":false},{\"Display\":\"Prepare for filing\",\"Value\":\"Prepare for filing\",\"Enable\":false},{\"Display\":\"Preparing draft application\",\"Value\":\"Preparing draft application\",\"Enable\":false},{\"Display\":\"Preparing spec\",\"Value\":\"Preparing spec\",\"Enable\":false},{\"Display\":\"Report order placed\",\"Value\":\"Report order placed\",\"Enable\":false},{\"Display\":\"Searches and legal checks\",\"Value\":\"Searches and legal checks\",\"Enable\":false},{\"Display\":\"We're thinking\",\"Value\":\"We're thinking\",\"Enable\":false}],\"Enable\":true}",
"definition_type": "SelectItemFromListDefinitionDto",
"entity_type": "SelectItemFromList",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 9,
"value_type": null
}
],
"is_base": false,
"is_template_for_trademark_filing": true,
"is_template_filing": false,
"base_id": "00000000-0000-0000-0000-000000000000",
"ip_records": []
},
"components": [],
"created_by": "lawpanel@tmd.com",
"updated_at": "2020-09-09T09:23:37.5112425Z",
"updated_by": "lawpanel@tmd.com",
"active": true
}
Return Case attachment available.
The case attachment ID.
Return the case attachment to operate.
{
"enable": true,
"id": "8940e34a-74ef-41c7-a9f5-ac31013c064c",
"file": {
"id": "daaa210f-4925-4037-8e7a-ab7400033d9f",
"name": "20636 - Test",
"number": "20636"
},
"date_time": "2020-09-09T19:10:36.622201Z",
"file_name": "image1.jpg",
"file_size": 1253,
"comments": "...",
"url": "https://lawpanelstoragelive.blob.core.windows.net/public-assets/8a758e34-6df3-47df-8dda-d3717cbc7aa4.jpg"
}
Return all fee items bundle available.
Take N records. Default value is 10. Max value is 100.
Skip N records.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Return all fee items bundle enabled to operate.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The fee item bundle <span class="hljs-literal">ID</span>. To get details of fee item bundle please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5ed7fb29785bd93e76caeefc">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: The public name of fee item bundle.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>number</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">categories</span></span></span>: The total of Parameters for this bundle. If we have this parameters: Registries and Nº Classes, then we will have 2 categories.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>number</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">products</span></span></span>: The total of fee items.
</li>
</ul>
[
{
"id": "1d11e45d-ab34-43cb-a730-abcf0146ff8f",
"name": "UK",
"categories": 2,
"products": 9
},
{
"id": "6bbbe76e-03ff-4369-b118-ab1800d8bef0",
"name": "Omar",
"categories": 3,
"products": 8
},
{
"id": "4f98c41c-2cb1-4cba-aaf7-a74c0070c5fb",
"name": "UK & EU TM 1-8 classes",
"categories": 2,
"products": 32
},
{
"id": "33805e78-46f5-41b6-bcff-a73f00d10da1",
"name": "International",
"categories": 0,
"products": 0
},
{
"id": "8cad6bb0-07c8-4e1d-9f30-a73c00a21eab",
"name": "USA",
"categories": 2,
"products": 5
},
{
"id": "93406ac0-1f87-49f2-90f9-a6f80025d975",
"name": "UK and EU TM 1-8 classes",
"categories": 2,
"products": 38
}
]
Return fee item bundle details.
The fee item bundle ID.
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
Return the fee item bundle enabled to operate.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The fee item bundle <span class="hljs-literal">ID</span>. To get details of fee item bundle please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5ed7fb29785bd93e76caeefc">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">firm_id</span></span></span>: The firm <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">product_filter</span></span></span>: An array object with fee item bundle properties.
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The fee item bundle <span class="hljs-literal">ID</span>. To get details of fee item bundle please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5ed7fb29785bd93e76caeefc">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: The public name of fee item bundle.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">internal_name</span></span></span>: The internal name of fee item bundle.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">product_filter_details</span></span></span>: An array object with fee item bundle details.
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The fee item bundle detail <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">products</span></span></span>: An array object with products of fee item bundle detail. To get list of products please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf0a4901adc16e035bf45">link</a>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The product <span class="hljs-literal">ID</span>. To get details of product please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5ea277b8b1feb907674fefab">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">code</span></span></span>: The code of product.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name_public</span></span></span>: The public name of product.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-object-group"></i><span>object</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">product_type</span></span></span>: An object with product type properties.
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The product type <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: The name of product type.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">prices</span></span></span>: An object with prices properties.
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The price <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">date_time</span></span></span>: The date it was created.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-object-group"></i><span>object</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">currency</span></span></span>: An object with currency properties.
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The currency <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: The name of currency.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name_short</span></span></span>: The short version name of currency.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">symbol</span></span></span>: The character that represents the currency symbol.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>number</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">currency_units</span></span></span>: The amount.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">taxes</span></span></span>: An object with tax properties.
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The tax <span class="hljs-literal">ID</span>. To get details of tax please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf52df8c9eb0e90ebbb5b">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: The name of tax.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">description</span></span></span>: The description of tax.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>number</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">units</span></span></span>: The units of tax.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>number</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">percent</span></span></span>: The percent of tax.
</li>
</ul>
</section>
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">product_modifier_definitions</span></span></span>: An array object with parameters of fee item bundle detail. To get details please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5ed94aabdd1e487fe4c9a0cc">link</a>
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The parameter <span class="hljs-literal">ID</span>. To get details please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5ed94aabdd1e487fe4c9a0cc">link</a>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: The public name of parameter.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>numeric</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">order</span></span></span>: The parameter's position.
</li>
</ul>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
</li>
</ul>
{
"id": "4f98c41c-2cb1-4cba-aaf7-a74c0070c5fb",
"firm_id": "8a5536dc-6d34-4f4a-8cac-a67201481ca0",
"product_filter": {
"id": "4f98c41c-2cb1-4cba-aaf7-a74c0070c5fb",
"name": "UK & EU TM 1-8 classes",
"internal_name": null,
"product_filter_details": [
{
"id": "93aff913-5b56-4b97-9199-a74c0070c919",
"products": [
{
"id": "7b9c70e3-e570-48c9-9d1d-a6e90008fbd9",
"code": "001",
"name": "Registry fee - UK - 1 class",
"name_public": "Registry fee - UK - 1 class",
"product_type": {
"id": "13fc72e0-a875-4771-af97-a6e90008f046",
"name": "Service"
},
"prices": [
{
"id": "65a91dc7-fb1c-4e73-a9d0-a6e90008fc37",
"date_time": "2016-12-27T00:32:42.8524174Z",
"currency": {
"id": "cd80f109-c15c-42c1-9ae3-a6e90008d70c",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
"currency_units": 170
}
],
"taxes": []
},
{
"id": "70ae1e30-b306-4812-b428-a6e90009251c",
"code": "009",
"name": "Our advice fee - UK - 1 class",
"name_public": "Our advice fee - UK - 1 class",
"product_type": {
"id": "13fc72e0-a875-4771-af97-a6e90008f046",
"name": "Service"
},
"prices": [
{
"id": "967a42d9-1670-491f-83e4-a6e900092579",
"date_time": "2016-12-27T00:33:18.0591632Z",
"currency": {
"id": "cd80f109-c15c-42c1-9ae3-a6e90008d70c",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
"currency_units": 249
}
],
"taxes": [
{
"id": "8e113d0d-aa3f-4439-85fb-a6e90008ee65",
"name": "UK VAT",
"description": "Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by the national government. It was introduced in 1973 and is the third largest source of government revenue after income tax and National Insurance. It is administered and collected by HM Revenue and Customs, primarily through the Value Added Tax Act 1994.",
"units": 0,
"percent": 20
}
]
}
],
"product_modifier_definitions": [
{
"id": "8ca47b1d-3358-42fb-b99d-a6e90008f4bc",
"name": "1",
"order": 1,
"product_modifier_group": {
"id": "d379fbb8-a984-45a1-b031-a6e90008f4bb",
"name": "N° Classes",
"order": 2
}
},
{
"id": "0dc8cfbc-4d04-4e9b-9040-a74c0070af83",
"name": "UKIPO",
"order": 1,
"product_modifier_group": {
"id": "13167519-ed58-4054-9f6b-a6e90008f2e2",
"name": "Registers",
"order": 1
}
}
]
},
{
"id": "215609c3-4c46-49e5-9764-a74c0070cb9c",
"products": [
{
"id": "37eddd1c-9ce8-41c8-9b0a-a6e900090132",
"code": "002",
"name": "Registry fee - UK - 2 class",
"name_public": "Registry fee - UK - 2 class",
"product_type": {
"id": "13fc72e0-a875-4771-af97-a6e90008f046",
"name": "Service"
},
"prices": [
{
"id": "d533c401-cdf5-4178-ac46-a6e90009018f",
"date_time": "2016-12-27T00:32:47.4099709Z",
"currency": {
"id": "cd80f109-c15c-42c1-9ae3-a6e90008d70c",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
"currency_units": 220
}
],
"taxes": []
},
{
"id": "fd4a4699-43d2-4f7f-a1bc-a6e900092aa2",
"code": "010",
"name": "Our advice fee - UK - 2 class",
"name_public": "Our advice fee - UK - 2 class",
"product_type": {
"id": "13fc72e0-a875-4771-af97-a6e90008f046",
"name": "Service"
},
"prices": [
{
"id": "4a3b771a-1c00-48cd-a2f8-a6e900092aff",
"date_time": "2016-12-27T00:33:22.7716174Z",
"currency": {
"id": "cd80f109-c15c-42c1-9ae3-a6e90008d70c",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
"currency_units": 299
}
],
"taxes": [
{
"id": "8e113d0d-aa3f-4439-85fb-a6e90008ee65",
"name": "UK VAT",
"description": "Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by the national government. It was introduced in 1973 and is the third largest source of government revenue after income tax and National Insurance. It is administered and collected by HM Revenue and Customs, primarily through the Value Added Tax Act 1994.",
"units": 0,
"percent": 20
}
]
}
],
"product_modifier_definitions": [
{
"id": "0dc8cfbc-4d04-4e9b-9040-a74c0070af83",
"name": "UKIPO",
"order": 1,
"product_modifier_group": {
"id": "13167519-ed58-4054-9f6b-a6e90008f2e2",
"name": "Registers",
"order": 1
}
},
{
"id": "5ca4c337-6c5e-4b8a-8c2b-a6e90008f4bc",
"name": "2",
"order": 2,
"product_modifier_group": {
"id": "d379fbb8-a984-45a1-b031-a6e90008f4bb",
"name": "N° Classes",
"order": 2
}
}
]
}
]
}
}
Return all parameters and definitions of fee item bundle available.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">public_name</span></span></span>: The public name of fee item bundle. To get details of fee item bundle please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5ed7fa017f2151f933487f2d">link</a>.
</li>
</ul>
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
{
"public_name": "UK"
}
Return list of parameters availables.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The parameter fee item bundle detail <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: The public name of parameter.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>numeric</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">order</span></span></span>: The parameter's position.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">product_modifier_definitions</span></span></span>: An array object with parameters definition of fee item bundle.
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The parameter definition <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: The public name of parameter definition.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>numeric</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">order</span></span></span>: The parameter's definition position.
</li>
</ul>
</section>
</li>
</ul>
[
{
"id": "a796e98e-3621-4a85-9f47-abcf0146ff1e",
"name": "Registers",
"order": 1,
"product_modifier_definitions": [
{
"id": "1bd8eb8e-e061-4761-86af-abcf0146ff25",
"name": "UKIPO",
"order": 1
},
{
"id": "45dbfbbe-d890-4609-9da1-abcf0146ff3a",
"name": "EUIPO",
"order": 2
},
{
"id": "dc055e90-9303-4c1e-b3c7-abcf0146ff3a",
"name": "USPTO",
"order": 3
}
]
},
{
"id": "8c250091-ad3e-4236-a473-abcf0146ff5b",
"name": "N° Classes",
"order": 2,
"product_modifier_definitions": [
{
"id": "eb859b25-af17-48f4-88f3-abcf0146ff5c",
"name": "1",
"order": 1
},
{
"id": "aa96f22c-62aa-4cbf-8d47-abcf0146ff5d",
"name": "2",
"order": 2
},
{
"enable": true,
"id": "f0ca94d2-6c49-4649-a6bc-abcf0146ff5e",
"name": "3",
"order": 3
},
{
"id": "3d37d804-0213-47ee-86a3-abcf0146ff6a",
"name": "4",
"order": 4
},
{
"id": "243198cb-b157-4d47-aeff-abcf0146ff6b",
"name": "5",
"order": 5
},
{
"id": "2d664ef4-4b55-4676-9827-abcf0146ff6c",
"name": "6",
"order": 6
},
{
"id": "1a52476d-a5b2-4b1e-a2e3-abcf0146ff6d",
"name": "7",
"order": 7
},
{
"id": "6069df47-7e5d-4fc8-9c9f-abcf0146ff6e",
"name": "8",
"order": 8
}
]
}
]
Return all fee items bundle availables.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">public_name</span></span></span>: The public name of fee item bundle. To get details of fee item bundle please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5ed7fa017f2151f933487f2d">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">param_and_values</span></span></span>: An array object with properties.
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: The public name of a parameter. To get details please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5ed94aabdd1e487fe4c9a0cc">link</a>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">value</span></span></span>: The name of an item in the product_modifier_definitions list. To get details please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5ed94aabdd1e487fe4c9a0cc">link</a>
</li>
</ul>
</section>
</li>
</ul>
User authentication cookie. Read more about how to you get it from <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/57d1b3ea78125813d06c1c50">here</a>.
{
"public_name": "Usa",
"param_and_values": [
{
"name": "Registers",
"value": "uspto"
},
{
"name": "N° Classes",
"value": "1"
}
]
}
Return list of parameters availables.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The product <span class="hljs-literal">ID</span>. To get details of product please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5ea277b8b1feb907674fefab">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">code</span></span></span>: The code of product.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: The internal name of product.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name_public</span></span></span>: The public name of product.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-object-group"></i><span>object</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">product_type</span></span></span>: An object with product type properties.
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The product type <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: The name of product type.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">prices</span></span></span>: An object with prices properties.
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The price <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">date_time</span></span></span>: The date it was created.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-object-group"></i><span>object</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">currency</span></span></span>: An object with currency properties.
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The currency <span class="hljs-literal">ID</span>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: The name of currency.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name_short</span></span></span>: The short version name of currency.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">symbol</span></span></span>: The character that represents the currency symbol.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>number</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">currency_units</span></span></span>: The amount.
</li>
</ul>
</section>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">taxes</span></span></span>: An object with tax properties.
<section>
<div style="margin-top: 10px; margin-left: 22px; margin-bottom: 5px;">Object properties are:</div>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The tax <span class="hljs-literal">ID</span>. To get details of tax please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf52df8c9eb0e90ebbb5b">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: The name of tax.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">description</span></span></span>: The description of tax.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>number</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">units</span></span></span>: The units of tax.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>number</span></span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">percent</span></span></span>: The percent of tax.
</li>
</ul>
</section>
</li>
</ul>
[
{
"id": "b33d5201-b08f-46e5-95b7-a73800fcbd6b",
"code": "USA001",
"name": "Advice fee - USA - 1 class",
"name_public": "Advice fee - USA - 1 class",
"product_type": {
"id": "13fc72e0-a875-4771-af97-a6e90008f046",
"name": "Service"
},
"prices": [
{
"id": "2b0569fe-855b-4872-9fe7-a73800fcbd67",
"date_time": "2017-03-16T15:20:11.8584245Z",
"currency": {
"enable": true,
"id": "cd80f109-c15c-42c1-9ae3-a6e90008d70c",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
"currency_units": 400.00
}
],
"taxes": [
{
"id": "8e113d0d-aa3f-4439-85fb-a6e90008ee65",
"name": "UK VAT",
"description": "Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by the national government. It was introduced in 1973 and is the third largest source of government revenue after income tax and National Insurance. It is administered and collected by HM Revenue and Customs, primarily through the Value Added Tax Act 1994.",
"units": 0.00,
"percent": 20.00
}
]
},
{
"id": "e720f11b-09de-4d87-879b-a73800fd4ce3",
"code": "USA002",
"name": "Advice fee - USA - 4 or more classes ",
"name_public": "Advice fee - USA - 4 or more classes ",
"product_type": {
"id": "13fc72e0-a875-4771-af97-a6e90008f046",
"name": "Service"
},
"prices": [
{
"id": "b44031ad-35da-48c8-b291-a73800fd4ce3",
"date_time": "2017-03-16T15:22:14.3010599Z",
"currency": {
"id": "cd80f109-c15c-42c1-9ae3-a6e90008d70c",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
"currency_units": 500.00
}
],
"taxes": [
{
"id": "8e113d0d-aa3f-4439-85fb-a6e90008ee65",
"name": "UK VAT",
"description": "Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by the national government. It was introduced in 1973 and is the third largest source of government revenue after income tax and National Insurance. It is administered and collected by HM Revenue and Customs, primarily through the Value Added Tax Act 1994.",
"units": 0.00,
"percent": 20.00
}
]
},
{
"id": "ec61f1d7-6aed-4ab9-8b56-a73800fdc127",
"code": "USA003",
"name": "Registry fee - USA - 1 Class",
"name_public": "Registry fee - USA - 1 Class",
"product_type": {
"id": "13fc72e0-a875-4771-af97-a6e90008f046",
"name": "Service"
},
"prices": [
{
"id": "d076d07c-ff4a-4e54-83c8-a73800fdc127",
"date_time": "2017-03-16T15:23:53.5118319Z",
"currency": {
"id": "cd80f109-c15c-42c1-9ae3-a6e90008d70c",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
"currency_units": 275.00
}
],
"taxes": []
},
{
"id": "570cbe41-6591-42db-a498-a73800fe09ef",
"code": "USA004",
"name": "Registry fee - USA - 2 Classes",
"name_public": "Registry fee - USA - 2 Classes",
"product_type": {
"id": "13fc72e0-a875-4771-af97-a6e90008f046",
"name": "Service"
},
"prices": [
{
"id": "bbed028a-15bb-4b00-9a8b-a73800fe09ef",
"date_time": "2017-03-16T15:24:55.6209427Z",
"currency": {
"id": "cd80f109-c15c-42c1-9ae3-a6e90008d70c",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
"currency_units": 450.00
},
{
"id": "e268e171-3940-47fe-af7a-a73800fea303",
"date_time": "2017-03-16T15:27:06.2455733Z",
"currency": {
"id": "cd80f109-c15c-42c1-9ae3-a6e90008d70c",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
"currency_units": 550.00
}
],
"taxes": [
{
"id": "8e113d0d-aa3f-4439-85fb-a6e90008ee65",
"name": "UK VAT",
"description": "Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by the national government. It was introduced in 1973 and is the third largest source of government revenue after income tax and National Insurance. It is administered and collected by HM Revenue and Customs, primarily through the Value Added Tax Act 1994.",
"units": 0.00,
"percent": 20.00
}
]
},
{
"id": "6b4f3193-c55c-4106-90f0-a73800fe85f1",
"code": "USA005",
"name": "Registry fee - USA - 3 Classes",
"name_public": "Registry fee - USA - 3 Classes",
"product_type": {
"id": "13fc72e0-a875-4771-af97-a6e90008f046",
"name": "Service"
},
"prices": [
{
"id": "eae2599f-6383-4fad-a939-a73800fe85f1",
"date_time": "2017-03-16T15:26:41.4389508Z",
"currency": {
"id": "cd80f109-c15c-42c1-9ae3-a6e90008d70c",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
"currency_units": 825.00
}
],
"taxes": [
{
"id": "8e113d0d-aa3f-4439-85fb-a6e90008ee65",
"name": "UK VAT",
"description": "Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by the national government. It was introduced in 1973 and is the third largest source of government revenue after income tax and National Insurance. It is administered and collected by HM Revenue and Customs, primarily through the Value Added Tax Act 1994.",
"units": 0.00,
"percent": 20.00
}
]
}
]
Creates a new case.
Payload must contain information about the legal entity, company or client to be created.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: The name of the case. A little description about it.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">number</span></span></span>: A string/number to be used as a reference for the case. You can use here your internal identifier for this case.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>bool</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">active</span></span></span>: Is current case active or not?.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">file_template_id</span></span></span>: The template to use in the case. To get details of templates please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b9369ff8c9eb05e07851e9?groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_id</span></span></span>: The User ID for the supervisor responsable of this case. To get details of users please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a1494cd00b195a1f0f8e4?groupBy=tag">link</a>. If you don't include this value the user identified will be used by default.
</li>
</ul>
{
"active": true,
"file_template_id": "c554e22c-6f6e-42d3-8954-a780013c92a0",
"name": "Case",
"number": "No case reference",
"user_id": "7ed98cd7-cc17-4883-989c-a6730003709d"
}
This code is returned when the case was created successfully.
{
"enable": true,
"id": "f71b5be6-5721-4aca-bede-abab0002dde2",
"name": "Case",
"number": "No case reference",
"folder": {
"enable": true,
"id": "31aa7ee6-1394-4bdb-9c06-abab0002ddb8",
"name": "87d088a8-f7b3-4ce2-8bdc-fae909a2a691_f540accb-d2e5-4016-8582-d71538343486",
"files": [
{
"enable": true,
"id": "f71b5be6-5721-4aca-bede-abab0002dde2",
"name": "Case",
"number": "No case reference",
"folder": null,
"tags": [],
"other_supervisors": null,
"client": null,
"user": {
"enable": true,
"id": "7ed98cd7-cc17-1487-510c-a6730003709d",
"first_name": "Tom",
"last_name": "Cruz",
"user_name": "tomcruz@act.com",
"email": "tomcruz@act.com",
"phone_number": "+54 9387452147",
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"language_name": "en",
"country_id": "5306aa9a-3c36-40d8-b32e-a67300008be3",
"country_name": "GB",
"user_role": "FirmUser",
"last_login_date": "2020-02-09T23:04:14.4459343Z",
"is_yoti": false,
"is_locked_out": false,
"yoti_id": null,
"user_settings": null,
"claims": [],
"user_type_id": "00000000-0000-0000-0000-000000000000",
"user_type_name": null
},
"file_status": {
"enable": true,
"id": "dbb513aa-58e3-4a70-a805-a74c00714768",
"name": "Opened",
"initial_state": true
},
"file_template": {
"enable": true,
"id": "c554e22c-6f6e-42d3-8954-a780013c92a0",
"name": "Generic / basic",
"file_template_components": [
{
"enable": true,
"id": "907530ca-ae98-42b6-9293-a780013c92fd",
"name": "Free",
"description": "Represent any kind of information to save",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 1,
"value_type": null
}
],
"is_base": false,
"is_template_for_trademark_filing": false,
"base_id": "00000000-0000-0000-0000-000000000000"
},
"components": null,
"created_by": "tomcruz@act.com",
"updated_at": "2020-04-28T00:10:26.2597074Z",
"updated_by": "tomcruz@act.com",
"firm_portfolio": null,
"active": true
}
]
},
"tags": [],
"other_supervisors": null,
"client": null,
"user": {
"enable": true,
"id": "7ed98cd7-cc17-1487-510c-a6730003709d",
"first_name": "Tom",
"last_name": "Cruz",
"user_name": "tomcruz@act.com",
"email": "tomcruz@act.com",
"phone_number": "+54 9387452147",
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"language_name": "en",
"country_id": "5306aa9a-3c36-40d8-b32e-a67300008be3",
"country_name": "GB",
"user_role": "FirmUser",
"last_login_date": "2020-02-09T23:04:14.4459343Z",
"is_yoti": false,
"is_locked_out": false,
"yoti_id": null,
"user_settings": null,
"claims": [],
"user_type_id": "00000000-0000-0000-0000-000000000000",
"user_type_name": null
},
"file_status": {
"enable": true,
"id": "dbb513aa-58e3-4a70-a805-a74c00714768",
"name": "Opened",
"initial_state": true
},
"file_template": {
"enable": true,
"id": "c554e22c-6f6e-42d3-8954-a780013c92a0",
"name": "Generic / basic",
"file_template_components": [
{
"enable": true,
"id": "907530ca-ae98-42b6-9293-a780013c92fd",
"name": "Free",
"description": "Represent any kind of information to save",
"definition": null,
"definition_type": null,
"entity_type": "String",
"permissions": [],
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 1,
"value_type": null
}
],
"is_base": false,
"is_template_for_trademark_filing": false,
"base_id": "00000000-0000-0000-0000-000000000000"
},
"components": null,
"created_by": "tomcruz@act.com",
"updated_at": "2020-04-28T00:10:26.2597074Z",
"updated_by": "tomcruz@act.com",
"firm_portfolio": null,
"active": true
}
A 400 error is returned if you have some invalid data into your payload, i.e.: biggest text fields, invalid IDs, etc.
{
"id": "",
"message": "Invalid file status ID",
"successfull": false
}
Creates a new Company.
Payload must contain information about the Company to be created.
Most of the properties are self-explanatory, but these:
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">client_type_id</span></span></span>: The ID for the type of Company.To get details of different types available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e5fc497bff59224dddd21bc?&groupBy=tag">link</a>. If you don't include this value the default type will be "Client".
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">country_id</span></span></span>: The ID for the address country. To get details of different countries available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59bacfe6901adc16e035bf43?&groupBy=tag">link</a>.
</li>
</ul>
{
"client": {
"name": "Name of the Company",
"company_registration_number": "Registration Number",
"contact_name": "Contact name",
"contact_email": "contact@email.com",
"contact_number": "+5493875333953",
"contact_address": {
"line1": "Dr. Adolfo Alsina 151",
"line2": "-",
"line3": "-",
"building": "Torres de Alsina",
"floor_level": "2nd",
"postal_code": "4400",
"city": "Salta Capital",
"state_province": "Salta",
"region": "Noroeste Argentino",
"country_id": "4576b6bc-936c-4879-a03c-a68900ad3722"
},
"billing_address": {
"line1": "Dr. Adolfo Alsina 151",
"line2": "-",
"line3": "-",
"building": "Torres de Alsina",
"floor_level": "2nd",
"postal_code": "4400",
"city": "Salta Capital",
"state_province": "Salta",
"region": "Noroeste Argentino",
"country_id": "4576b6bc-936c-4879-a03c-a68900ad3722"
}
},
"client_type_id": "0a246949-d71d-49ae-a17b-a975001bdf45"
}
If everything happened succesfully returns the model with new Company created.
{
"id": "7187420e-9e7a-43f6-b832-ac3000d470e9",
"name": "Name of the Company",
"company_registration_number": "Registration Number",
"contact_name": "Contact name",
"contact_email": "contact@email.com",
"contact_number": "+5493875333953",
"contact_address": {
"id": "7b25e717-b1f1-4bf6-8cde-ac3000d470e7",
"line1": "Dr. Adolfo Alsina 151",
"line2": "-",
"line3": "-",
"building": "Torres de Alsina",
"floor_level": "2nd",
"postal_code": "4400",
"city": "Salta Capital",
"state_province": "Salta",
"region": "Noroeste Argentino",
"country_id": "4576b6bc-936c-4879-a03c-a68900ad3722",
"country_name": "Argentina"
},
"billing_address": {
"id": "55217328-90e3-4a5c-a3cf-ac3000d470e7",
"line1": "Dr. Adolfo Alsina 151",
"line2": "-",
"line3": "-",
"building": "Torres de Alsina",
"floor_level": "2nd",
"postal_code": "4400",
"city": "Salta Capital",
"state_province": "Salta",
"region": "Noroeste Argentino",
"country_id": "4576b6bc-936c-4879-a03c-a68900ad3722",
"country_name": "Argentina"
},
"client_type": {
"id": "0a246949-d71d-49ae-a17b-a975001bdf45",
"code": 1,
"name": "Client"
}
}
Updates a Case.
Payload with data to update the Case.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: Case ID to be modified.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: Name of the Case.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">file_status_id</span></span></span>: The Case status ID. To get a list of statuses available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/read-many-case-status?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">file_client_id</span></span></span>: The Company ID to be used as Agent for the Case. To get a list of Companies available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b92737f8c9eb05e07851e1?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">tags</span></span></span>: The tags ID for the Case. To get a list of tags available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/read-many-tag?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">other_supervisors</span></span></span>: The User IDs for other supervisors of this Case. To get a list of users available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a1494cd00b195a1f0f8e4?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">user_id</span></span></span>: The User ID to be the Case Owner/Responsible. To get a list of Users available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e7a1494cd00b195a1f0f8e4?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">number</span></span></span>: A string to be used as a representation/code for the case.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">components</span></span></span>: An array with values for all components of the Case Template:
<ul style="margin-top: 10px;">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">file_template_component_id</span></span></span>: The ID of the case template component. To get more details about the case template please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/read-case-template?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">entity_id</span></span></span>: If this component is binded with an entity of LawPanel (an User, Company, Registry, Search, etc.) you should use its ID here. Else you can ignore this field.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">value</span></span></span>: If this component is <strong>not</strong> binded with an entity of LawPanel (it's an String, DateTime, Integer, etc.) you should include here its value. If component is an structure of any type, you should save the value as a JSON serialized entity.
</li>
</ul>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">active</span></span></span>: A boolean to identify/filter active or not active Cases.
</li>
</ul>
{
"id": "53d2d270-4129-4a86-9123-ab4500df3da4",
"name": "Yun Bey",
"file_status_id": "dbb513aa-58e3-4a70-a805-a74c00714768",
"file_client_id": null,
"tags": [
"da599d0b-1010-45ca-8ced-ac3600c3c1c7",
" 5c9ced5e-c6c5-4dee-8fed-ac3600c3ca09"
],
"other_supervisors": [
"03ce7827-aac0-477d-a01b-aad8012abc99"
],
"user_id": "03ce7827-aac0-477d-a01b-aad8012abc99",
"number": "0303456",
"components": [
{
"file_template_component_id": "03f91a9b-fa22-4e3f-b95d-aad8012abc45",
"entity_id": "00000000-0000-0000-0000-000000000000",
"value": "Common Law Mark"
},
{
"file_template_component_id": "27cd665d-084b-45d2-a8dc-aad8012abc45",
"entity_id": "00000000-0000-0000-0000-000000000000",
"value": "Opposed"
},
{
"file_template_component_id": "67d2da70-62ef-4a31-a665-aad8012abc45",
"entity_id": "00000000-0000-0000-0000-000000000000",
"value": "2020-09-14T00:00:00Z"
},
{
"file_template_component_id": "78a1df77-bf30-4439-8dc7-aad8012abc4e",
"entity_id": "00000000-0000-0000-0000-000000000000",
"value": "This is the content for the property \"Information\""
}
],
"active": "true"
}
Return details about the update operation.
{
"id": "c8650a60-cc9e-476c-bed9-ac3100f3db50",
"message": "File '23109 - Case' successfully updated",
"successful": true
}
Returns details about an Invoice.
Invoice ID to get details
Returns details about an Invoice.
{
"id": "ab88a885-f937-4ce8-9f5d-ac3100f0cb9e",
"date_time": "2020-09-09T00:00:00Z",
"date_time_due": "2020-09-09T00:00:00Z",
"invoice_type": {
"id": "bec8d8b7-a1e5-4e4c-911a-a7cc00fff1c2",
"name": "Default",
"code": 0,
"description": "This is the default invoice type for all invoices",
"leading_zeros": "0000000000",
"prefix": "A-"
},
"invoice_number": 1,
"client": {
"id": "7187420e-9e7a-43f6-b832-ac3000d470e9",
"name": "Name of the Company",
"company_registration_number": "Registration Number",
"contact_name": "Contact name",
"contact_email": "contact@email.com",
"contact_number": "+5493875333953",
"contact_address": {
"id": "7b25e717-b1f1-4bf6-8cde-ac3000d470e7",
"line1": "Dr. Adolfo Alsina 151",
"line2": "-",
"line3": "-",
"building": "Torres de Alsina",
"floor_level": "2nd",
"postal_code": "4400",
"city": "Salta Capital",
"state_province": "Salta",
"region": "Noroeste Argentino",
"country_id": "4576b6bc-936c-4879-a03c-a68900ad3722",
"country_name": "Argentina"
},
"billing_address": {
"id": "55217328-90e3-4a5c-a3cf-ac3000d470e7",
"line1": "Dr. Adolfo Alsina 151",
"line2": "-",
"line3": "-",
"building": "Torres de Alsina",
"floor_level": "2nd",
"postal_code": "4400",
"city": "Salta Capital",
"state_province": "Salta",
"region": "Noroeste Argentino",
"country_id": "4576b6bc-936c-4879-a03c-a68900ad3722",
"country_name": "Argentina"
},
"client_type": {
"id": "0a246949-d71d-49ae-a17b-a975001bdf45",
"code": 1,
"name": "Client"
}
},
"invoice_items": [
{
"id": "2db77f75-b957-4b5e-9bd3-ac3100d1aeae",
"code": "001",
"name": "Item 001",
"product_type": {
"enable": true,
"id": "615e202e-62f6-43ce-bc9f-a6b200040c9b",
"name": "Service"
},
"currency": {
"id": "14e294cf-7425-422f-83f2-a6b20003f5e3",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
"currency_units": 100,
"quantity": 1,
"taxes": [
{
"id": "1db77783-9e48-4ddc-a665-a6b4002671c1",
"name": "UK VAT",
"description": "Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by the national government. It was introduced in 1973 and is the third largest source of government revenue after income tax and National Insurance. It is administered and collected by HM Revenue and Customs, primarily through the Value Added Tax Act 1994.",
"units": 0,
"percent": 20
}
],
"details": "This is a fee item for a Case",
"paid_out": false,
"invoice_entity_type": "File",
"invoice_entity_id": "53620e77-5e3b-431b-9cb0-ac2800eaac75"
}
],
"payments": [],
"user": {
"id": "f947fbce-9f3f-4ece-b002-a68d014e018c",
"first_name": "Admin",
"last_name": "Admin",
"user_name": "admin@lawpanel.com",
"email": "admin@lawpanel.com",
"phone_number": "+54 9387543988",
"language_id": "d690da37-20a7-436a-b6a4-a68900ad35b7",
"language_name": "en",
"country_id": "4576b6bc-936c-4879-a03c-a68900ad3722",
"country_name": "AR",
"user_role": "Admin",
"last_login_date": "2020-08-31T11:55:18.7668609Z",
"is_yoti": false,
"is_locked_out": false,
"yoti_id": null,
"user_settings": null,
"claims": [],
"user_type_id": "00000000-0000-0000-0000-000000000000",
"user_type_name": null
},
"observations": "Observations for the Invoice"
}
Create a new case link.
Payload must contain information about the file link to be created.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">file_id</span></span></span>: The case <span class="hljs-literal">ID</span> where the file will be attached. To get details of case please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b93028f8c9eb05e07851e6?groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Requerid</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">url</span></span></span>: The url or link.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">comments</span></span></span>: The comments about the file link.
</li>
</ul>
{
"comments": "...",
"file_id": "c8650a60-cc9e-476c-bed9-ac3100f3db50",
"url": "https://www.lawpanel.com"
}
This code is returned when the case link was created successfully.
{
"id": "bbef5448-de95-4b5d-bcb5-ac31015276aa",
"file": {
"id": "c8650a60-cc9e-476c-bed9-ac3100f3db50",
"name": "23109 - Test",
"number": "23109"
},
"date_time": "2020-09-09T20:32:18.5817988Z",
"comments": "...",
"url": "https://www.lawpanel.com"
}
Delete a case link.
The Case Link ID to be deleted.
Return details about the delete operation.
{
"id": "24ab8b69-65d5-43b2-a99d-abac014452cf",
"message": "File link 'https://www.lawpanel.com'successfully deleted",
"successful": true
}
Return file link available.
The file case ID.
Return the case link to operate.
{
"id": "bbef5448-de95-4b5d-bcb5-ac31015276aa",
"file": {
"id": "c8650a60-cc9e-476c-bed9-ac3100f3db50",
"name": "23109 - Test",
"number": "23109"
},
"date_time": "2020-09-09T20:32:18.5817988Z",
"comments": "...",
"url": "https://www.lawpanel.com"
}
Return all cases links available.
Return all products enabled to operate with payments and invoices.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Return all cases links enabled to operate.
[
{
"id": "15c8ff31-9a22-4fd0-af5a-a98200a81648",
"file": {
"id": "0811cdd6-959c-4ad6-a4d6-a96e00c5dd0d",
"name": "newtrademark - filing",
"number": "11111111"
},
"date_time": "2018-10-23T10:11:59.1854985Z",
"comments": "Search",
"url": "http://www.google.com"
},
{
"id": "6c79eab9-c3c4-4257-9578-a8cb015657c8",
"file": {
"enable": true,
"id": "96c4a2fb-c836-4d1b-b651-a8cb0155e75a",
"name": "File 001",
"number": "1"
},
"date_time": "2018-04-23T20:46:25.9424283Z",
"comments": "asdad",
"url": "https://www.nada.com"
}
]
Return all invoice items available.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
The name of the entity binded with the Invoice Items. For example, to get Invoice Items from Cases you have to use "File".
The ID of the entity with the Invoice Items binded. If you binded with a Case, it should be the Case ID.
Return all Invoice Items available.
[
{
"id": "ce30d5d7-1ce9-498e-a386-ac31015949f1",
"code": "001",
"name": "Fee item name",
"product_type": {
"id": "13fc72e0-a875-4771-af97-a6e90008f046",
"name": "Service"
},
"currency": {
"id": "cd80f109-c15c-42c1-9ae3-a6e90008d70c",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
"currency_units": 120.00,
"quantity": 1.00,
"taxes": 24.000000,
"details": "Details about the fee item.",
"total": 144.000000,
"invoice": {
"id": "67b65eae-8c99-4544-8549-ac3101599c49",
"date_time": "2020-09-09T00:00:00Z",
"date_time_due": "2020-09-09T00:00:00Z",
"invoice_type": {
"id": "de08d07a-b45b-4c53-8622-a7ec017b5dc1",
"name": "Default",
"code": 0,
"description": "This is the default invoice type for all invoices",
"leading_zeros": "0000000000",
"prefix": "A-"
},
"invoice_number": 1,
"client": {
"id": "1c71c9bd-0603-4e95-8596-abb400efe5f3",
"name": "David Gonzalez",
"company_registration_number": null,
"contact_name": null,
"contact_email": null,
"contact_number": null,
"contact_address": {
"id": "bd5b2ed9-8bd8-4756-811f-abb400efe5ee",
"line1": "12821 Newport Avenue",
"line2": null,
"line3": null,
"building": null,
"floor_level": null,
"postal_code": "",
"city": "Tustin",
"state_province": null,
"region": null,
"country_id": "00000000-0000-0000-0000-000000000000",
"country_name": null
},
"billing_address": {
"id": "855a4c6e-2990-485b-923c-abb400efe5ee",
"line1": null,
"line2": null,
"line3": null,
"building": null,
"floor_level": null,
"postal_code": null,
"city": null,
"state_province": null,
"region": null,
"country_id": "00000000-0000-0000-0000-000000000000",
"country_name": null
},
"client_type": {
"id": "604a3d85-5c5b-4364-b69c-a99201175b30",
"code": 1,
"name": "Common"
}
},
"invoice_items": [
{
"id": "ce30d5d7-1ce9-498e-a386-ac31015949f1",
"code": "001",
"name": "Fee item name",
"product_type": {
"id": "13fc72e0-a875-4771-af97-a6e90008f046",
"name": "Service"
},
"currency": {
"id": "cd80f109-c15c-42c1-9ae3-a6e90008d70c",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
"currency_units": 120.00,
"quantity": 1.00,
"taxes": [
{
"id": "8e113d0d-aa3f-4439-85fb-a6e90008ee65",
"name": "UK VAT",
"description": "Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by the national government. It was introduced in 1973 and is the third largest source of government revenue after income tax and National Insurance. It is administered and collected by HM Revenue and Customs, primarily through the Value Added Tax Act 1994.",
"units": 0.00,
"percent": 20.00
}
],
"details": "Details about the fee item.",
"paid_out": false,
"invoice_entity_type": "File",
"invoice_entity_id": "ddaa47cc-e75d-4865-895d-abb400f00285"
}
],
"payments": [],
"user": {
"id": "77e2dd06-154c-4157-ad69-a6720147e652",
"first_name": "Admin",
"last_name": "Admin",
"user_name": "admin@lawpanel.io",
"email": "admin@lawpanel.io",
"phone_number": "+54 9387543988",
"language_id": "8246c1d0-b008-4320-8b1d-a6720147de22",
"language_name": "en",
"country_id": "27cb8e50-0e8b-40cd-a656-a6720147e0a1",
"country_name": "AR",
"user_role": "Admin",
"last_login_date": "2020-09-09T19:52:01.2115975Z",
"is_locked_out": false,
"user_settings": null,
"claims": [],
"user_type_id": "00000000-0000-0000-0000-000000000000",
"user_type_name": null
},
"observations": "Invoice notes"
},
"invoice_entity_type": "File",
"invoice_entity_id": "ddaa47cc-e75d-4865-895d-abb400f00285",
"invoice_entity_text": null
}
]
This code is returned if the entity doesn't have any Invoice Item.
Returns details about a Payment Method.
Payment Method ID to get details.
Returns details about a Payment Method.
{
"enable": true,
"id": "9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4",
"code": 1,
"name": "Credit Card",
"description": "A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services.",
"payment_method_component_definitions": [
{
"enable": true,
"id": "7a3b5edd-b20e-499a-aeaa-a7e8000a2ccd",
"payment_method": {
"enable": true,
"id": "9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4",
"code": 1,
"name": "Credit Card",
"description": "A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services, based on the cardholder's promise to the card issuer to pay them for the amounts so paid plus other agreed charges. The card issuer (usually a bank) creates a revolving account and grants a line of credit to the cardholder, from which the cardholder can borrow money for payment to a merchant or as a cash advance.",
"payment_method_component_definitions": null,
"reusable": false
},
"name": "card_name",
"display_name": "Name",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 1024,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 1
},
{
"enable": true,
"id": "c1138c80-0ee2-4f67-b2da-a7cc00ffc389",
"payment_method": {
"enable": true,
"id": "9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4",
"code": 1,
"name": "Credit Card",
"description": "A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services, based on the cardholder's promise to the card issuer to pay them for the amounts so paid plus other agreed charges. The card issuer (usually a bank) creates a revolving account and grants a line of credit to the cardholder, from which the cardholder can borrow money for payment to a merchant or as a cash advance.",
"payment_method_component_definitions": null,
"reusable": false
},
"name": "address_line_one",
"display_name": "Address line one",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 2
},
{
"enable": true,
"id": "c1837a7a-3cc0-42ac-ad0d-a7cc00ffc504",
"payment_method": {
"enable": true,
"id": "9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4",
"code": 1,
"name": "Credit Card",
"description": "A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services, based on the cardholder's promise to the card issuer to pay them for the amounts so paid plus other agreed charges. The card issuer (usually a bank) creates a revolving account and grants a line of credit to the cardholder, from which the cardholder can borrow money for payment to a merchant or as a cash advance.",
"payment_method_component_definitions": null,
"reusable": false
},
"name": "address_line_two",
"display_name": "Address line two",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 3
},
{
"enable": true,
"id": "3339089b-4535-4ec1-a9b9-a7e8000a3451",
"payment_method": {
"enable": true,
"id": "9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4",
"code": 1,
"name": "Credit Card",
"description": "A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services, based on the cardholder's promise to the card issuer to pay them for the amounts so paid plus other agreed charges. The card issuer (usually a bank) creates a revolving account and grants a line of credit to the cardholder, from which the cardholder can borrow money for payment to a merchant or as a cash advance.",
"payment_method_component_definitions": null,
"reusable": false
},
"name": "address_city",
"display_name": "City",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 4
},
{
"enable": true,
"id": "136678f3-6827-4ea9-9a02-a7e8000a3748",
"payment_method": {
"enable": true,
"id": "9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4",
"code": 1,
"name": "Credit Card",
"description": "A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services, based on the cardholder's promise to the card issuer to pay them for the amounts so paid plus other agreed charges. The card issuer (usually a bank) creates a revolving account and grants a line of credit to the cardholder, from which the cardholder can borrow money for payment to a merchant or as a cash advance.",
"payment_method_component_definitions": null,
"reusable": false
},
"name": "address_state",
"display_name": "State",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 5
},
{
"enable": true,
"id": "8f298718-3d17-450f-8871-a7e8000a3abc",
"payment_method": {
"enable": true,
"id": "9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4",
"code": 1,
"name": "Credit Card",
"description": "A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services, based on the cardholder's promise to the card issuer to pay them for the amounts so paid plus other agreed charges. The card issuer (usually a bank) creates a revolving account and grants a line of credit to the cardholder, from which the cardholder can borrow money for payment to a merchant or as a cash advance.",
"payment_method_component_definitions": null,
"reusable": false
},
"name": "address_zip",
"display_name": "Zip",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 6
},
{
"enable": true,
"id": "3bd795ba-adff-45af-8b2f-a7e8000a3cc3",
"payment_method": {
"enable": true,
"id": "9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4",
"code": 1,
"name": "Credit Card",
"description": "A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services, based on the cardholder's promise to the card issuer to pay them for the amounts so paid plus other agreed charges. The card issuer (usually a bank) creates a revolving account and grants a line of credit to the cardholder, from which the cardholder can borrow money for payment to a merchant or as a cash advance.",
"payment_method_component_definitions": null,
"reusable": false
},
"name": "address_country",
"display_name": "Country",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 254,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 7
},
{
"enable": true,
"id": "2b3ea2a5-61c8-456b-8b88-a7e8000a3ec6",
"payment_method": {
"enable": true,
"id": "9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4",
"code": 1,
"name": "Credit Card",
"description": "A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services, based on the cardholder's promise to the card issuer to pay them for the amounts so paid plus other agreed charges. The card issuer (usually a bank) creates a revolving account and grants a line of credit to the cardholder, from which the cardholder can borrow money for payment to a merchant or as a cash advance.",
"payment_method_component_definitions": null,
"reusable": false
},
"name": "observations",
"display_name": "Observations",
"class_name": "String",
"pattern": "",
"mask": null,
"required": false,
"select_from": null,
"disabled": false,
"max": null,
"max_length": 1024,
"min": null,
"read_only": false,
"step": null,
"place_holder": null,
"private": false,
"internal": false,
"display_order": 8
}
],
"reusable": false
}
Returns a list with al statuses available to use for Cases.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Returns a list with all Case Statuses available ot use with Cases.
[
{
"id": "c4c2dfd7-d507-4a9d-9352-a73c013b33b6",
"name": "Opened",
"initial_state": true
},
{
"id": "2e5b7a11-e263-46c1-a7a0-a72901028c07",
"name": "Closed",
"initial_state": false
},
{
"id": "a4966fbc-f052-4be9-90dc-a72901028aa7",
"name": "Pending",
"initial_state": false
},
{
"id": "e9019ddf-65cd-41c9-87f7-a72901028940",
"name": "Filed",
"initial_state": false
}
]
Returns a list with all Tags available.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Returns a list with all tags available.
[
{
"id": "f4757b8b-eacd-4a7f-934c-ac2200c0f3f1",
"name": "Tag A",
"color_text": "#02404c",
"color_background": "#e2ebed",
"parent": null,
"files_count": 0
},
{
"id": "809a1cb8-3cf3-4833-a659-ac2200c1012f",
"name": "Tag B",
"color_text": "#02404c",
"color_background": "#e2ebed",
"parent": null,
"files_count": 0
},
{
"id": "fc8b7bbc-6b7a-40eb-bdb9-ac2200c10a84",
"name": "Tag C",
"color_text": "#02404c",
"color_background": "#e2ebed",
"parent": null,
"files_count": 0
}
]
Creates a new Tag.
The payload with Tag data.
{
"name": "Tag D",
"color_text": "#02404c",
"color_background": "#e2ebed",
"parent_id": ""
}
This code is returned if the Tag was successfully created.
{
"id": "a3e1942e-ab2a-4914-b3c3-ac3600fef62e",
"name": "Tag D",
"color_text": "#02404c",
"color_background": "#e2ebed",
"parent": null
}
Returns details about a Case Template.
Case Template ID
Returns this code if the ID is valid and the Case Template exists.
{
"id": "873c49ce-d6cf-4667-94ad-aad8011d6db7",
"name": "Trademark filing",
"file_template_components": [
{
"id": "2a951ce5-995d-4697-811d-aad8011d6db7",
"name": "Case Sub status",
"description": "Case Sub status",
"definition": "{\"Items\":[{\"Display\":\"Allowed\",\"Value\":\"Allowed\",\"Enable\":false},{\"Display\":\"Awaiting Examination\",\"Value\":\"Awaiting Examination\",\"Enable\":false},{\"Display\":\"Formalised\",\"Value\":\"Formalised\",\"Enable\":false},{\"Display\":\"IR designation under Article 9\",\"Value\":\"IR designation under Article 9\",\"Enable\":false},{\"Display\":\"Opposed\",\"Value\":\"Opposed\",\"Enable\":false},{\"Display\":\"Partial Refusal of Protection\",\"Value\":\"Partial Refusal of Protection\",\"Enable\":false},{\"Display\":\"Renewal Instructions Sought\",\"Value\":\"Renewal Instructions Sought\",\"Enable\":false},{\"Display\":\"Renewed\",\"Value\":\"Renewed\",\"Enable\":false},{\"Display\":\"Total Refusal of Protection\",\"Value\":\"Total Refusal of Protection\",\"Enable\":false}],\"Enable\":false}",
"definition_type": "SelectItemFromListDefinitionDto",
"entity_type": "SelectItemFromList",
"permissions": null,
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 1,
"value_type": null
},
{
"id": "be41d32c-b1c0-417d-a5ba-aad8011d6db7",
"name": "Case status",
"description": "Case status",
"definition": "{\"Items\":[{\"Display\":\"Registered\",\"Value\":\"Registered\",\"Enable\":false},{\"Display\":\"Abandoned\",\"Value\":\"Abandoned\",\"Enable\":false},{\"Display\":\"Case Transferred\",\"Value\":\"Case Transferred\",\"Enable\":false},{\"Display\":\"Cautionary Notice\",\"Value\":\"Cautionary Notice\",\"Enable\":false},{\"Display\":\"Common Law Mark\",\"Value\":\"Common Law Mark\",\"Enable\":false},{\"Display\":\"Lapsed\",\"Value\":\"Lapsed\",\"Enable\":false},{\"Display\":\"Not yet filed\",\"Value\":\"Not yet filed\",\"Enable\":false},{\"Display\":\"Pending\",\"Value\":\"Pending\",\"Enable\":false},{\"Display\":\"Pending(Not Responsible)\",\"Value\":\"Pending(Not Responsible)\",\"Enable\":false},{\"Display\":\"Refused\",\"Value\":\"Refused\",\"Enable\":false},{\"Display\":\"Registered\",\"Value\":\"Registered\",\"Enable\":false},{\"Display\":\"Registered(Not Responsible)\",\"Value\":\"Registered(Not Responsible)\",\"Enable\":false},{\"Display\":\"Test\",\"Value\":\"Test\",\"Enable\":false},{\"Display\":\"Withdrawn\",\"Value\":\"Withdrawn\",\"Enable\":false}],\"Enable\":false}",
"definition_type": "SelectItemFromListDefinitionDto",
"entity_type": "SelectItemFromList",
"permissions": null,
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 0,
"value_type": null
},
{
"id": "45778ab7-da47-4127-a861-aad8011d6db7",
"name": "Information",
"description": "",
"definition": null,
"definition_type": null,
"entity_type": "StringMultiText",
"permissions": null,
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 3,
"value_type": null
},
{
"id": "132a0b08-da56-4a4c-ac67-aad8011d6db7",
"name": "Date opened",
"description": "",
"definition": null,
"definition_type": null,
"entity_type": "DateTime",
"permissions": null,
"required": false,
"regex_to_validate": null,
"multiple_values": false,
"display_order": 2,
"value_type": null
}
],
"is_base": false,
"is_template_for_trademark_filing": true,
"is_template_filing": false,
"base_id": "d212c728-1ed6-474e-b350-a989010374d6",
"ip_records": [
{
"id": "6b125f60-5ff0-4a56-82c6-ac0600e4a811",
"code": 1,
"name": "Trademark",
"human_readable_name": "Trademarks",
"value": "FirmPortfolio"
}
]
}
Creates a new Order. An Order is a composed entity by a Case, a Company, a Company User, Invoice Items, an Invoice, a Payment. In order to simplify the creation of Orders we have this special endpoint.
Payload with data about the new order to be created.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">order_name</span></span></span>: The name for the order. A little description about it.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">order_number</span></span></span>: A string/number to be used as a reference for the Order. You can use here your internal identifier for this order.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">company_name</span></span></span>: The name of the Company/Client who owns the order. The system is going to create a new Company with this name. To get a list of all Companies available, please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b92737f8c9eb05e07851e1?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">company_user_email</span></span></span>: An email address to create a new account for the Company created. This new user will access to the order details using. To get a list of all Company Users available, please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/read-many-company-user?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">company_user_password</span></span></span>: The password for the Company User to be created.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">file_template_id</span></span></span>: The Case Template ID to be used with the Case creation for the order. To get a list of all Case Template available, please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b9369ff8c9eb05e07851e9?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">company_user_password</span></span></span>: The password for the Company User to be created.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">file_template_components</span></span></span>: A list of object with the components values for the Case Template.
<br/>
<p style="margin-top: 10px;">
Each object should have these properties: <br/>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">name</span></span></span>: The name of the Case Template component.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">value</span></span></span>: The value for the Case Template component.
</li>
</ul>
</p>
To get a list of all Case Template available (and its components), please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b9369ff8c9eb05e07851e9?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">payment_currency_id</span></span></span>: The Currency ID for the payment. To get a list of all Currency available, please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59b93b43f8c9eb05e07851eb?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-list"></i><span>array</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">payment_items</span></span></span>: A list of object with the payment components for the Order.
<br/>
<p style="margin-top: 10px;">
Each object should have these properties: <br/>
<ul>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">description</span></span></span>: A little description for the payment concept.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-sort-numeric-up"></i><span>number</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">amount</span></span></span>: The amount for the concept described on "description" property. If the concept has a tax, you should include it here.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">tax_id</span></span></span>: The Tax ID to be included with the payment item. If the item does not have a Tax, use "null". To get a list of all Tax available, please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59baf52df8c9eb0e90ebbb5b?&groupBy=tag">link</a>.
</li>
</ul>
</p>
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span></span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">do_not_create_payment</span></span></span>: If you set this property to "true" the Payment for the Order will not be performed.
</li>
</ul>
{
"order_name": "Order for trademark search \"lawpanel\".",
"order_number": "1",
"company_name": "Michael Jackson",
"company_user_email": "michael@jackson.com",
"company_user_password": "mj2020_",
"file_template_id": "96C4A417-7A0A-4241-AE84-AC3D011C40C8",
"file_template_components": [
{
"name": "Search result",
"value": "432db66d-467c-4835-bac6-ac3d00fa3af6"
},
{
"name": "Good and services",
"value": "Good and services contents"
},
{
"name": "Website",
"value": "https://www.site.com"
},
{
"name": "Are you already using the name",
"value": "1 - 3 years"
},
{
"name": "Series",
"value": "{\"option_id_selected\":\"PartOfSeriesTrademark\",\"description\":\"This is the content for Series, second option selected with a description.\"}"
},
{
"name": "Previously registered",
"value": "{\"option_id_selected\":\"PreviouslyRegistered\",\"description\":\"This is the contents for 'Previously registered', second option.\"}"
},
{
"name": "SMS Notifications",
"value": "{\"selected\":true,\"description\":\"+5493875333953\"}"
},
{
"name": "Order folder",
"value": "Abandoned"
},
{
"name": "Order status",
"value": "On hold awaiting client"
},
{
"name": "Country",
"value": "Argentina"
}
],
"payment_currency_id": "95CE88B2-3229-4DD7-A35A-A6B20003F63B",
"payment_items": [
{
"description": "Registration fees 1 trademark on UK",
"amount": 100,
"tax_id": "1DB77783-9E48-4DDC-A665-A6B4002671C1"
},
{
"description": "Our fees",
"amount": 30,
"tax_id": null
}
],
"do_not_create_payment": true
}
Returns an object with details about the operation result.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The Case ID created for the order. To get details about this Case please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5ea77ddddfd01866a2aab1fb?&groupBy=tag">link</a>.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">success</span></span></span>: "true" if the Order was created successfully, "false" if not.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">message</span></span></span>: A little message with some information about the operation result.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">url_to_redirect</span></span></span>: A five minutes valid URL to redirect the Company User created. This URL will allow the User access to the Company Area to show the Order created details.
</li>
</ul>
{
"id": "6c2c01a1-10e2-47ae-b3b1-ac3e0144c3dc",
"success": true,
"message": "Order '1/Order for trademark search \"lawpanel\".' successfully created",
"url_to_redirect": "https://web.lawpanel.local/account/loginfromorder?magic=bFZyNVdGT28rT0N0SGxwd3l2NoRGJhby"
}
Returns a list with all Company Users available on your Firm.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
A list of objects with information about the Company Users available.
[
{
"id": "7d6b5e8c-47e1-4ef1-b7ef-ac2b0134e7dc",
"client": {
"id": "1c8a8cf8-a58a-46b8-a172-ab440147061f",
"name": "Company AAA",
"company_registration_number": "",
"contact_name": "",
"contact_email": "",
"contact_number": "",
"contact_address": {
"id": "a1faf098-2f03-4daf-993c-ab440147061f",
"line1": "",
"line2": "",
"line3": "",
"building": "",
"floor_level": "",
"postal_code": "",
"city": "",
"state_province": "",
"region": "",
"country_id": "00000000-0000-0000-0000-000000000000",
"country_name": null
},
"billing_address": {
"id": "7207503e-557f-410b-9ebd-ab440147061f",
"line1": "",
"line2": "",
"line3": "",
"building": "",
"floor_level": "",
"postal_code": "",
"city": "",
"state_province": "",
"region": "",
"country_id": "00000000-0000-0000-0000-000000000000",
"country_name": null
},
"client_type": {
"id": "0a246949-d71d-49ae-a17b-a975001bdf45",
"code": 1,
"name": "Client"
}
},
"user": {
"id": "2e05b964-f441-4c8f-ab39-ac2b0134e7c5",
"first_name": "John",
"last_name": "Doe",
"user_name": "user@domain.com",
"email": "user@domain.com",
"phone_number": "+543875333953",
"language_id": "d690da37-20a7-436a-b6a4-a68900ad35b7",
"language_name": "en",
"country_id": "57a84942-d7fd-4a92-8014-a68900ad3722",
"country_name": "SY",
"user_role": "ClientUser",
"last_login_date": null,
"is_locked_out": false,
"user_settings": null,
"claims": [],
"user_type_id": "00000000-0000-0000-0000-000000000000",
"user_type_name": null
},
"claims_id": []
},
{
"id": "c0c37d0d-afdf-4f6e-bec5-ac2b0133c86f",
"client": {
"id": "1c8a8cf8-a58a-46b8-a172-ab440147061f",
"name": "Company AAA",
"company_registration_number": "",
"contact_name": "",
"contact_email": "",
"contact_number": "",
"contact_address": {
"id": "a1faf098-2f03-4daf-993c-ab440147061f",
"line1": "",
"line2": "",
"line3": "",
"building": "",
"floor_level": "",
"postal_code": "",
"city": "",
"state_province": "",
"region": "",
"country_id": "00000000-0000-0000-0000-000000000000",
"country_name": null
},
"billing_address": {
"id": "7207503e-557f-410b-9ebd-ab440147061f",
"line1": "",
"line2": "",
"line3": "",
"building": "",
"floor_level": "",
"postal_code": "",
"city": "",
"state_province": "",
"region": "",
"country_id": "00000000-0000-0000-0000-000000000000",
"country_name": null
},
"client_type": {
"id": "0a246949-d71d-49ae-a17b-a975001bdf45",
"code": 1,
"name": "Client"
}
},
"user": {
"id": "62b29f6e-cbc5-4ab2-afc4-ac2b0133c48d",
"first_name": "John",
"last_name": "Bach",
"user_name": "test423@lawpanel.com",
"email": "test323@lawpanel.com",
"phone_number": "783638737",
"language_id": "d690da37-20a7-436a-b6a4-a68900ad35b7",
"language_name": "en",
"country_id": "57a84942-d7fd-4a92-8014-a68900ad3722",
"country_name": "SY",
"user_role": "ClientUser",
"last_login_date": null,
"is_locked_out": false,
"user_settings": null,
"claims": [
{
"id": "20d14622-df5c-4997-828d-aa3f00d79b41",
"claim_target": {
"id": "acc902b5-cafe-4cad-a429-aa3f00d79a04",
"code": 2,
"name": "Client area",
"description": "Permissions related with actions over the client users"
},
"code": 10000,
"name": "Read only",
"description": "User can only see all data but not perform any action"
}
],
"user_type_id": "00000000-0000-0000-0000-000000000000",
"user_type_name": null
},
"claims_id": []
}
]
Checks if email address is available to create an order for the Company.
The email to verify if is available to be used with an Order creation.
The Company name where availability is checked
Returns information about the availability or not to create an order for the company and email sent as parameters.
{
"available": true,
"message": "Email address 'clientuser@bclient.com' is available to create a new order for company 'B client'."
}
Checks if email address is available to create a new Company User.
The email to verify if is available to create a new Company User.
Returns information about the availability or not to create a Company User using the email.
{
"available": true,
"message": "Email address 'clientuser@bclient.com' is available to create a new Company User"
}
Return all case events attachments available.
The Case ID to get all events.
Optional. The type of event you want to receive. Possible values are: FileEventFeeItemAddedToFile, FileEventFeeItemDeleted, FileEventInvoiceCreatedForFile, FileEventInvoiceDeleted, FileEventInvoiceItemUpdated, FileEventInvoiceUpdatedForFile, FileEventType, FileEventTypeCommunicationOfClientUserToFirm, FileEventTypeCommunicationOfFirmUserToClient, FileEventTypeEmailAddedToFile, FileEventTypeFileAttachmentCreated, FileEventTypeFileAttachmentDeleted, FileEventTypeFileAttachmentUpdated, FileEventTypeFileClientCreated, FileEventTypeFileClientRemoved, FileEventTypeFileCreated, FileEventTypeFileDesignCreated, FileEventTypeFileDesignRemoved, FileEventTypeFileLinkCreated, FileEventTypeFileLinkDeleted, FileEventTypeFileLinkUpdated, FileEventTypeFilePortfolioCreated, FileEventTypeFilePortfolioDeleted, FileEventTypeFilePortfolioRemoved, FileEventTypeFilePortfolioUpdated, FileEventTypeFileRenamed, FileEventTypeFileUpdated, FileEventTypeFileUpdatedFromBatchTask, FileEventTypeNoteAddedToFile, FileEventTypeReminderSent, FileEventTypeReminderUpdated, FileEventTypeReportSentByEmail, FileEventTypeTaskReminderDeleted, FileEventTypeTrademarkUpdatedFromIpo.
Return all Case events for the Case selected.
[
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139337893079999999|FileEvent",
"date_time": "2020-10-31T01:38:12Z",
"event_type": "File updated",
"by": "Ashya Ison",
"by_id": "b075ae99-365d-4eb1-823f-a8f900bb37d2",
"comments": ""
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338795689999999|FileEvent",
"date_time": "2020-10-30T00:33:51Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338795709999999|FileEvent",
"date_time": "2020-10-30T00:33:49Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338795729999999|FileEvent",
"date_time": "2020-10-30T00:33:47Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338795749999999|FileEvent",
"date_time": "2020-10-30T00:33:45Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338795769999999|FileEvent",
"date_time": "2020-10-30T00:33:43Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338795789999999|FileEvent",
"date_time": "2020-10-30T00:33:41Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338795809999999|FileEvent",
"date_time": "2020-10-30T00:33:39Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338795819999999|FileEvent",
"date_time": "2020-10-30T00:33:38Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338795839999999|FileEvent",
"date_time": "2020-10-30T00:33:36Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338795859999999|FileEvent",
"date_time": "2020-10-30T00:33:34Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338795879999999|FileEvent",
"date_time": "2020-10-30T00:33:32Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338795899999999|FileEvent",
"date_time": "2020-10-30T00:33:30Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338795919999999|FileEvent",
"date_time": "2020-10-30T00:33:28Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338795929999999|FileEvent",
"date_time": "2020-10-30T00:33:27Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338795949999999|FileEvent",
"date_time": "2020-10-30T00:33:25Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338795969999999|FileEvent",
"date_time": "2020-10-30T00:33:23Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338795989999999|FileEvent",
"date_time": "2020-10-30T00:33:21Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338796009999999|FileEvent",
"date_time": "2020-10-30T00:33:19Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338796029999999|FileEvent",
"date_time": "2020-10-30T00:33:17Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338796039999999|FileEvent",
"date_time": "2020-10-30T00:33:16Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338796059999999|FileEvent",
"date_time": "2020-10-30T00:33:14Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338796079999999|FileEvent",
"date_time": "2020-10-30T00:33:12Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338796099999999|FileEvent",
"date_time": "2020-10-30T00:33:10Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338796119999999|FileEvent",
"date_time": "2020-10-30T00:33:08Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338796139999999|FileEvent",
"date_time": "2020-10-30T00:33:06Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338796149999999|FileEvent",
"date_time": "2020-10-30T00:33:05Z",
"event_type": "Note added",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": "Private note"
},
{
"file_id": "693d950b-a69e-4373-8f0c-ac6400087a26",
"folder_id": "60815174-02fd-49ca-8ff3-ac6400087846",
"user_id": "33193f6f-8076-49e5-8c39-a8090119f09f",
"firm_id": "575726f9-ce96-4d4e-8088-a8090118c86e",
"client_id": "",
"id": "693d950b-a69e-4373-8f0c-ac6400087a26|3139338797469999999|FileEvent",
"date_time": "2020-10-30T00:30:53Z",
"event_type": "File creation",
"by": "LawPanel System",
"by_id": "942c0e1b-2202-4a7e-b9c3-a6720147e58c",
"comments": ""
}
]
Returns the event data serialized.
The event ID to get its data.
Returns a serialized string with the event data. Returned value depends on the type of event.
"{\"FileId\":\"2d2a8faf-2e13-4c36-b9f3-ac47013119e8\",\"NoteId\":\"1c96834f-a7f2-408f-a2c1-37fdd57a4fef_637401066514736366\",\"Note\":\"<p>I'm the contents of the note added.</p>\",\"NoteType\":null}"
Sends an email to the user's address with a link to recover its password.
The user name to recover the password.
Always returns OK without any comment, even username is valid or not. ( by security reasons )
Updates a Company data.
Payload must contain information about the Company to be updated.
Most of the properties are self-explanatory, but these:
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">id</span></span></span>: The ID of the Company to be updated.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">client_type_id</span></span></span>: The ID for the type of Company.To get details of different types available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e5fc497bff59224dddd21bc?&groupBy=tag">link</a>. If you don't include this value the default type will be "Client".
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-font"></i><span>string</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">country_id</span></span></span>: The ID for the address country. To get details of different countries available please check this <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/59bacfe6901adc16e035bf43?&groupBy=tag">link</a>.
</li>
</ul>
{
"client": {
"id": "08053072-6b7a-4938-90d8-aad8012ad39e",
"name": "International Association for the Intellectual Property",
"company_registration_number": "0303456",
"contact_name": "John Doe",
"contact_email": "john@doe.com",
"contact_number": "+543875333953",
"contact_address": {
"line1": "Los Crespones",
"line2": "749",
"line3": "Tres Cerritos",
"building": "Planta Baja",
"floor_level": "-",
"postal_code": "4400",
"city": "Salta Capital",
"state_province": "Salta",
"region": "Noroeste Argentino",
"country_id": "27cb8e50-0e8b-40cd-a656-a6720147e0a1"
},
"billing_address": {
"line1": "Alsina",
"line2": "151",
"line3": "Centro",
"building": "Torre A",
"floor_level": "2",
"postal_code": "4400",
"city": "Salta Capital",
"state_province": "Salta",
"region": "Noroeste Argentino",
"country_id": "27cb8e50-0e8b-40cd-a656-a6720147e0a1"
}
},
"client_type_id": "604a3d85-5c5b-4364-b69c-a99201175b30"
}
Returns information about the Company Updated.
{
"id": "60ec6803-5544-4ac9-b108-aad8012ad3a3",
"message": "Firm client successfully updated",
"successful": true
}
Returns a list with all invoices available for your Firm.
Take N records. Default value is 10. Max value is 100.
Skip N records.
Filter ID to apply on this endpoint. To get further details about filters click <a href="https://developer.lawpanel.com/docs/services/57d1b3e7781258070026484d/operations/5e78b798bbd38a43886ac8ec?groupBy=tag">here</a>.
Filter definition to apply on this endpoint. To get more details about this parameter check <a href="https://developer.lawpanel.com/#pagination">Pagination and Filtering</a>.
Company ID to filter outstanding invoices.
User ID to filter oustanding invoices.
Returns a list with all Oustanding Invoices for your Firm.
[
{
"id": "ab88a885-f937-4ce8-9f5d-ac3100f0cb9e",
"date_time": "2020-09-09T00:00:00Z",
"date_time_due": "2020-09-09T00:00:00Z",
"invoice_type": {
"id": "bec8d8b7-a1e5-4e4c-911a-a7cc00fff1c2",
"name": "Default",
"code": 0,
"description": "This is the default invoice type for all invoices",
"leading_zeros": "0000000000",
"prefix": "A-"
},
"invoice_number": 1,
"client": {
"id": "7187420e-9e7a-43f6-b832-ac3000d470e9",
"name": "Name of the Company",
"company_registration_number": "Registration Number",
"contact_name": "Contact name",
"contact_email": "contact@email.com",
"contact_number": "+5493875333953",
"contact_address": {
"id": "7b25e717-b1f1-4bf6-8cde-ac3000d470e7",
"line1": "Dr. Adolfo Alsina 151",
"line2": "-",
"line3": "-",
"building": "Torres de Alsina",
"floor_level": "2nd",
"postal_code": "4400",
"city": "Salta Capital",
"state_province": "Salta",
"region": "Noroeste Argentino",
"country_id": "4576b6bc-936c-4879-a03c-a68900ad3722",
"country_name": "Argentina"
},
"billing_address": {
"id": "55217328-90e3-4a5c-a3cf-ac3000d470e7",
"line1": "Dr. Adolfo Alsina 151",
"line2": "-",
"line3": "-",
"building": "Torres de Alsina",
"floor_level": "2nd",
"postal_code": "4400",
"city": "Salta Capital",
"state_province": "Salta",
"region": "Noroeste Argentino",
"country_id": "4576b6bc-936c-4879-a03c-a68900ad3722",
"country_name": "Argentina"
},
"client_type": {
"id": "0a246949-d71d-49ae-a17b-a975001bdf45",
"code": 1,
"name": "Client"
}
},
"total_invoice_items": 120.000000,
"total_payments": 31.00,
"user": {
"id": "f947fbce-8f3f-4ece-ba22-a67d014e108c",
"first_name": "John",
"last_name": "Doe",
"user_name": "john@doe.com",
"email": "john@doe.com",
"phone_number": "+54 9387543988",
"language_id": "d690da37-20a7-436a-b6a4-a68900ad35b7",
"language_name": "en",
"country_id": "4576b6bc-936c-4879-a03c-a68900ad3722",
"country_name": "AR",
"user_role": "FirmUser",
"last_login_date": "2020-10-01T17:37:57.6217197Z",
"is_locked_out": false,
"user_settings": null,
"claims": [],
"user_type_id": "00000000-0000-0000-0000-000000000000",
"user_type_name": null
},
"currency": {
"id": "14e294cf-7425-422f-83f2-a6b20003f5e3",
"name": "Pound sterling",
"name_short": "GBP",
"symbol": "£"
},
"observations": "Observations for the Invoice"
}
]
Uploads a file to LawPanel's servers.
Payload must contain information about the file to be uploaded. Payload must be a multipart-form with a param named "file" containing the file to be uploaded.
<ul class="propertiesList">
<li>
<span class="typeOfProperty"><i class="icon fa fa-file"></i><span>string</span> </span>
<span class="typeOfParameter">Required</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">file</span></span></span>: The file to be uploaded.
</li>
<li>
<span class="typeOfProperty"><i class="icon fa fa-adjust"></i><span>bool</span> </span>
<span class="typeOfParameter">Optional</span>
<span class="PropertyName"><span class="coffeescript"><span class="hljs-string">force_download</span></span></span>: If you set this property to "true" files uploaded will not be opened on the browser, they'll be forced to be downloaded.
</li>
</ul>
-----------------------------9051914041544843365972754266
Content-Disposition: form-data; name="file"; filename="a.txt"
Content-Type: text/plain
This is the content of a.txt.
-----------------------------9051914041544843365972754266--
Returns a JSON structure with details about the file uploaded.
{
"id": "d6f80720-430c-47cb-a3e6-07a905a0f33f",
"url": "https://lawpanellocal.blob.core.windows.net/private-assets/d6f80720-430c-47cb-a3e6-07a905a0f33f_637426929817710507.png",
"size": 402438,
"name": "02.Octubre 1 de 2.png",
"ext": ".png",
"mime_type": "image/png"
}
Checks if email address is available to create an order for TMD.
The email to verify if is available to be used with an Order creation.
Returns information about the availability or not to create an order for the company and email sent as parameters.
{
"available": true,
"message": "Email address 'clientuser@bclient.com' is available to create a new order for company 'B client'."
}
Checks if email address is available to create an order for TMD.
Returns information about the availability or not to create an order for the company and email sent as parameters.
{
"available": true,
"message": "Email address 'clientuser@bclient.com' is available to create a new order for company 'B client'."
}
Return a abandoned basket entity details.
Possible use the id or code to get the entity
Returns a abandoned basket entity representation.
Creates a new Abandoned basket entity.
If everything happened succesfully returns the model with new Abandoned basket created.
Updates a Abandoned basket data.
Returns information about the Abandoned basket Updated.
Delete a Abandoned basket
The Abandoned basket ID to be deleted.
Return details about the delete operation.
Return a access search result entity details.
Possible use the id or code to get the entity
Returns a access search result entity representation.
Creates a new Access search result entity.
If everything happened succesfully returns the model with new Access search result created.
Updates a Access search result data.
Returns information about the Access search result Updated.
Delete a Access search result
The Access search result ID to be deleted.
Return details about the delete operation.