POST
Create Case
Creates a new case.
Important
Calls to this method must include the cookie .LawPanel.AuthCookie in order to identify you at user level. For more details about authentication please check this link. To obtain the cookie you can use the method Login.
Request URL
Request headers
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 Required name: The name of the case. A little description about it.
- string Required number: A string/number to be used as a reference for the case. You can use here your internal identifier for this case.
- bool Required active: Is current case active or not?.
- string Required file_template_id: The template to use in the case. To get details of templates please check this link.
- string Optional user_id: The User ID for the supervisor responsable of this case. To get details of users please check this link. If you don't include this value the user identified will be used by default.
Loading...
{
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"file_template_id": {
"type": "string"
},
"name": {
"type": "string"
},
"number": {
"type": "string"
},
"user_id": {
"type": "string"
}
},
"example": {
"active": true,
"file_template_id": "c554e22c-6f6e-42d3-8954-a780013c92a0",
"name": "Case",
"number": "No case reference",
"user_id": "7ed98cd7-cc17-4883-989c-a6730003709d"
}
}
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",
"items": {}
},
"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",
"items": {}
},
"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",
"items": {}
},
"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",
"items": {}
},
"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",
"items": {}
},
"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",
"items": {}
},
"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...