GET

Search Origin - 02.Read many

Return a list with all possible search origins to create a trademark search.

Request URL

Request parameters

(optional)
integer

Take N records. Default value is 10. Max value is 100.

(optional)
integer

Skip N records.

Request headers

string
Subscription key which provides access to this API.

Response 200

Return a list with all search origin available to use.

  • string id: The ID for the search origin.
  • integer code: A positive integer number to identify origin in a simple way..
  • string name: Name for the search origin.
  • string description: A human readable description for the search origin.

Loading...
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "code": {
        "type": "integer"
      },
      "name": {
        "type": "string"
      },
      "description": {
        "type": "string"
      }
    },
    "required": [
      "id",
      "code",
      "name",
      "description"
    ]
  },
  "example": [
    {
      "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."
    }
  ]
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.lawpanel.com/v1/firms/searchorigins?take=10&skip=0"
-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("subscription-key", "{subscription key}");

            // Request parameters
            queryString["take"] = "10";
            queryString["skip"] = "0";
            var uri = "https://api.lawpanel.com/v1/firms/searchorigins?" + 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/searchorigins");

            builder.setParameter("take", "10");
            builder.setParameter("skip", "0");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            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
            "take": "10",
            "skip": "0",
        };
      
        $.ajax({
            url: "https://api.lawpanel.com/v1/firms/searchorigins?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                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/searchorigins";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"take=10",
                         @"skip=0",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_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/searchorigins');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'take' => '10',
    'skip' => '0',
);

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

params = urllib.urlencode({
    # Request parameters
    'take': '10',
    'skip': '0',
})

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

params = urllib.parse.urlencode({
    # Request parameters
    'take': '10',
    'skip': '0',
})

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

query = URI.encode_www_form({
    # Request parameters
    'take' => '10',
    'skip' => '0'
})

if uri.query && uri.query.length > 0
    uri.query += '&' + query
else
    uri.query = query
end

request = Net::HTTP::Get.new(uri.request_uri)
# 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.