GET

Watching - 06.Filters

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 link.

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.

Response 200

Returns a list with all properties available to create a filter for this endpoint.

  • string property_name: Internal name of the property. You must it this value to define properties in your filter.
  • string property_type: Type of the property. Here you can find basic types like String, DateTime, Boolean, Int32, etc. Or internal types of LawPanel entities like Registry, SearchClass, Client, etc.
  • string property_display_name: Human-readable name for the property.
  • string property_description: Human-readable description for the property.
  • array comparators_available: An array of strings with comparators available for this property.
    Some common values:
    • string == Equal to.
    • string != Not equal to.
    • string > Greater than.
    • string >= Greater or equal to.
    • string < Minor than.
    • string <= Minor or equal to.
    • string IN In range.
    • string CU Into current.
    • string CONTAINS Contains value.
    • string STARTSWITH Value starts with.
    • string ENDSWITH Value ends with.
  • bool multiple: When true means that properti can handle multiple values on its definition.
  • string endpoint: For properties of non-basic types like String, DateTime, Boolean, 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 Registry then this property will contains the endpoint Registry which is the URL to get Registries and their IDs in order to compose the filter.

Loading...
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "property_name": {
        "type": "string"
      },
      "property_type": {
        "type": "string"
      },
      "property_display_name": {
        "type": "string"
      },
      "property_description": {
        "type": "string"
      },
      "comparators_available": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "multiple": {
        "type": "boolean"
      },
      "end_point": {
        "type": "string"
      }
    },
    "required": [
      "property_name",
      "property_type",
      "property_display_name",
      "property_description",
      "comparators_available",
      "multiple",
      "end_point"
    ]
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.lawpanel.com/v1/firms/watching/filters"
-H ".LawPanel.AuthCookie: "
-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/filters?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // 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/filters");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader(".LawPanel.AuthCookie", "");
            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/filters?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader(".LawPanel.AuthCookie","");
                xhrObj.setRequestHeader("subscription-key","{subscription key}");
            },
            type: "GET",
            // 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/filters";
    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:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@".LawPanel.AuthCookie"];
    [_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/filters');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

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

// 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': '',
    'subscription-key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.lawpanel.com')
    conn.request("GET", "/v1/firms/watching/filters?%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': '',
    'subscription-key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.lawpanel.com')
    conn.request("GET", "/v1/firms/watching/filters?%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/filters')

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['.LawPanel.AuthCookie'] = ''
# 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.