POST

Cases - 01.Create

Create a new case.

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

Payload must contain information about the legal entity, company or client to be created.

  • string Requerid name: The name of the case.
  • string Requerid number: The number is the case reference.
  • bool Requerid active: Respresent if the case is active or not.
  • string Requerid file_template_id: The template to use in the case. To get details of templates please check this link.
  • string Requerid user_id: The supervisor responsable of the case. To get details of supervisors please check this link.
  • string Optional client_id: The Agent related to the case. To get details of agents please check this link.
  • array Optional other_supervisors: The other supervisors ID for this case. To get details of other supervisors please check this link.

Loading...

Response 201

This code is returned when the case was created successfully.

Loading...
{
  "type": "object",
  "properties": {
    "enable": {
      "type": "boolean"
    },
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "number": {
      "type": "string"
    },
    "folder": {
      "type": "object",
      "properties": {
        "enable": {
          "type": "boolean"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "files": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "enable": {
                "type": "boolean"
              },
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "number": {
                "type": "string"
              },
              "folder": {},
              "tags": {
                "type": "array"
              },
              "other_supervisors": {},
              "client": {},
              "user": {
                "type": "object",
                "properties": {
                  "enable": {
                    "type": "boolean"
                  },
                  "id": {
                    "type": "string"
                  },
                  "first_name": {
                    "type": "string"
                  },
                  "last_name": {
                    "type": "string"
                  },
                  "user_name": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string"
                  },
                  "phone_number": {
                    "type": "string"
                  },
                  "language_id": {
                    "type": "string"
                  },
                  "language_name": {
                    "type": "string"
                  },
                  "country_id": {
                    "type": "string"
                  },
                  "country_name": {
                    "type": "string"
                  },
                  "user_role": {
                    "type": "string"
                  },
                  "last_login_date": {
                    "type": "string"
                  },
                  "is_yoti": {
                    "type": "boolean"
                  },
                  "is_locked_out": {
                    "type": "boolean"
                  },
                  "yoti_id": {},
                  "user_settings": {},
                  "claims": {
                    "type": "array"
                  },
                  "user_type_id": {
                    "type": "string"
                  },
                  "user_type_name": {}
                }
              },
              "file_status": {
                "type": "object",
                "properties": {
                  "enable": {
                    "type": "boolean"
                  },
                  "id": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "initial_state": {
                    "type": "boolean"
                  }
                }
              },
              "file_template": {
                "type": "object",
                "properties": {
                  "enable": {
                    "type": "boolean"
                  },
                  "id": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "file_template_components": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "enable": {
                          "type": "boolean"
                        },
                        "id": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "definition": {},
                        "definition_type": {},
                        "entity_type": {
                          "type": "string"
                        },
                        "permissions": {
                          "type": "array"
                        },
                        "required": {
                          "type": "boolean"
                        },
                        "regex_to_validate": {},
                        "multiple_values": {
                          "type": "boolean"
                        },
                        "display_order": {
                          "type": "integer"
                        },
                        "value_type": {}
                      },
                      "required": [
                        "enable",
                        "id",
                        "name",
                        "description",
                        "definition",
                        "definition_type",
                        "entity_type",
                        "permissions",
                        "required",
                        "regex_to_validate",
                        "multiple_values",
                        "display_order",
                        "value_type"
                      ]
                    }
                  },
                  "is_base": {
                    "type": "boolean"
                  },
                  "is_template_for_trademark_filing": {
                    "type": "boolean"
                  },
                  "base_id": {
                    "type": "string"
                  }
                }
              },
              "components": {},
              "created_by": {
                "type": "string"
              },
              "updated_at": {
                "type": "string"
              },
              "updated_by": {
                "type": "string"
              },
              "firm_portfolio": {},
              "active": {
                "type": "boolean"
              }
            },
            "required": [
              "enable",
              "id",
              "name",
              "number",
              "folder",
              "tags",
              "other_supervisors",
              "client",
              "user",
              "file_status",
              "file_template",
              "components",
              "created_by",
              "updated_at",
              "updated_by",
              "firm_portfolio",
              "active"
            ]
          }
        }
      }
    },
    "tags": {
      "type": "array"
    },
    "other_supervisors": {},
    "client": {},
    "user": {
      "type": "object",
      "properties": {
        "enable": {
          "type": "boolean"
        },
        "id": {
          "type": "string"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "user_name": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "phone_number": {
          "type": "string"
        },
        "language_id": {
          "type": "string"
        },
        "language_name": {
          "type": "string"
        },
        "country_id": {
          "type": "string"
        },
        "country_name": {
          "type": "string"
        },
        "user_role": {
          "type": "string"
        },
        "last_login_date": {
          "type": "string"
        },
        "is_yoti": {
          "type": "boolean"
        },
        "is_locked_out": {
          "type": "boolean"
        },
        "yoti_id": {},
        "user_settings": {},
        "claims": {
          "type": "array"
        },
        "user_type_id": {
          "type": "string"
        },
        "user_type_name": {}
      }
    },
    "file_status": {
      "type": "object",
      "properties": {
        "enable": {
          "type": "boolean"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "initial_state": {
          "type": "boolean"
        }
      }
    },
    "file_template": {
      "type": "object",
      "properties": {
        "enable": {
          "type": "boolean"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "file_template_components": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "enable": {
                "type": "boolean"
              },
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "definition": {},
              "definition_type": {},
              "entity_type": {
                "type": "string"
              },
              "permissions": {
                "type": "array"
              },
              "required": {
                "type": "boolean"
              },
              "regex_to_validate": {},
              "multiple_values": {
                "type": "boolean"
              },
              "display_order": {
                "type": "integer"
              },
              "value_type": {}
            },
            "required": [
              "enable",
              "id",
              "name",
              "description",
              "definition",
              "definition_type",
              "entity_type",
              "permissions",
              "required",
              "regex_to_validate",
              "multiple_values",
              "display_order",
              "value_type"
            ]
          }
        },
        "is_base": {
          "type": "boolean"
        },
        "is_template_for_trademark_filing": {
          "type": "boolean"
        },
        "base_id": {
          "type": "string"
        }
      }
    },
    "components": {},
    "created_by": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "updated_by": {
      "type": "string"
    },
    "firm_portfolio": {},
    "active": {
      "type": "boolean"
    }
  }
}

Response 400

A 400 error is returned if you have some invalid data into your payload, i.e.: biggest text fields, invalid IDs, etc.

Loading...

Code samples

@ECHO OFF

curl -v -X POST "https://api.lawpanel.com/v1/firms/file"
-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/file?" + 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/file");


            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/file?" + $.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/file";
    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/file');
$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/file?%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/file?%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/file')

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.