POST

Watching - 01.Create

Creates a new Watching record for a trademark.

Request URL

Request headers

string

User authentication cookie. Read more about how to you get it from here.

string
Subscription key which provides access to this API.

Request body

  • string Required firm_portfolio_id: The trademark ID to watch. To get a list of your trademarks please check this link.
  • string Required user_id: The user ID to recieve email notifications when watching has news. To get a list of your users please check this link.
  • string Required frequency_id: The frequency ID to send email notifications when watching has news. To get a list of frequencies available check this link.
  • integer Required sensitivity: 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".

Loading...
                  {
  "type": "object",
  "properties": {
    "firm_portfolio_id": {
      "type": "string"
    },
    "user_id": {
      "type": "string"
    },
    "frequency_id": {
      "type": "string"
    },
    "sensitivity": {
      "type": "integer"
    }
  }
}
                  
              

Response 201

Returns a representation for the new Watching record created.

  • string id: The watching ID.
  • string user_id: The user ID to recieve email notifications when watching has news. To get a list of your users please check this link.
  • string user_name: Human-readable user name to receive notifications.
  • integer sensitivity: 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".
  • string application_number: The trademark application number for the watching.
  • string application_number: The trademark text for the watching.
  • string last_search_date: Last search date for matches in ISO-8601 (UTC) format.
  • string classes: Comma separated search class numbers for the watched trademark.
  • string registry_id: The registry ID where watching will be performed. To get a list of registries available please check this link.
  • string registry_name: Human-readable registry name to perform the watching.
  • string frequency_id: The frequency ID to send notifications about watching matches. To get a list of frequencies available please check this link.
  • string frequency_name: Human-readable frequency name to notify about matches.
  • string firm_portfolio_id: The trademark ID to watch. To get a list of your trademarks please check this link.
  • string last_notification_date_time: Last date when a notification was sent to inform about matches.Date is showed in ISO-8601 (UTC) format.

Loading...
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "user_id": {
      "type": "string"
    },
    "user_name": {
      "type": "string"
    },
    "sensitivity": {
      "type": "integer"
    },
    "application_number": {
      "type": "string"
    },
    "trademark": {
      "type": "string"
    },
    "last_search_date": {},
    "last_search_results": {},
    "classes": {
      "type": "string"
    },
    "registry_id": {
      "type": "string"
    },
    "registry_name": {
      "type": "string"
    },
    "frequency_id": {
      "type": "string"
    },
    "frequency_name": {
      "type": "string"
    },
    "firm_portfolio_id": {
      "type": "string"
    },
    "interesting_watching_history_records": {
      "type": "integer"
    },
    "last_notification_date_time": {}
  },
  "example": {
    "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: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": "2020-01-23T01:05:06.9702455Z",
    "last_notification_date_time": "2020-01-23T01:05:06.9702455Z"
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.lawpanel.com/v1/firms/watching"
-H ".LawPanel.AuthCookie: "
-H "Content-Type: application/json"
-H "subscription-key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add(".LawPanel.AuthCookie", "");
            client.DefaultRequestHeaders.Add("subscription-key", "{subscription key}");

            var uri = "https://api.lawpanel.com/v1/firms/watching?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.lawpanel.com/v1/firms/watching");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader(".LawPanel.AuthCookie", "");
            request.setHeader("Content-Type", "application/json");
            request.setHeader("subscription-key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.lawpanel.com/v1/firms/watching?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader(".LawPanel.AuthCookie","");
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("subscription-key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.lawpanel.com/v1/firms/watching";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@".LawPanel.AuthCookie"];
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"subscription-key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.lawpanel.com/v1/firms/watching');
$url = $request->getUrl();

$headers = array(
    // Request headers
    '.LawPanel.AuthCookie' => '',
    'Content-Type' => 'application/json',
    'subscription-key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    '.LawPanel.AuthCookie': '',
    'Content-Type': 'application/json',
    'subscription-key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.lawpanel.com')
    conn.request("POST", "/v1/firms/watching?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    '.LawPanel.AuthCookie': '',
    'Content-Type': 'application/json',
    'subscription-key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.lawpanel.com')
    conn.request("POST", "/v1/firms/watching?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.lawpanel.com/v1/firms/watching')

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['.LawPanel.AuthCookie'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['subscription-key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body


* See getting started for more information on how to use this API.