GET
Read Case
Return case available.
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 parameters
string
The case ID.
Request headers
string
Subscription key which provides access to this API.
Response 200
Return the case enabled to operate.
Loading...
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"number": {
"type": "string"
},
"folder": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"files": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"number": {
"type": "string"
},
"folder": {},
"tags": {
"type": "array",
"items": {}
},
"other_supervisors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"user_name": {},
"email": {},
"phone_number": {},
"language_id": {},
"language_name": {},
"country_id": {
"type": "string"
},
"country_name": {
"type": "string"
}
},
"required": [
"id",
"first_name",
"last_name",
"user_name",
"email",
"phone_number",
"language_id",
"language_name",
"country_id",
"country_name"
]
}
},
"client": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"company_registration_number": {},
"contact_name": {
"type": "string"
},
"contact_email": {
"type": "string"
},
"contact_number": {},
"contact_address": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"line1": {},
"line2": {},
"line3": {},
"building": {},
"floor_level": {},
"postal_code": {},
"city": {},
"state_province": {},
"region": {},
"country_id": {
"type": "string"
},
"country_name": {
"type": "string"
}
}
},
"billing_address": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"line1": {},
"line2": {},
"line3": {},
"building": {},
"floor_level": {},
"postal_code": {},
"city": {},
"state_province": {},
"region": {},
"country_id": {
"type": "string"
},
"country_name": {
"type": "string"
}
}
},
"client_type": {
"type": "string"
}
}
},
"user": {
"type": "object",
"properties": {
"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"
}
}
},
"file_status": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"initial_state": {
"type": "boolean"
}
}
},
"file_template": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"file_template_components": {
"type": "array",
"items": {
"type": "object",
"properties": {
"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": [
"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"
},
"is_template_filing": {
"type": "boolean"
},
"base_id": {
"type": "string"
},
"ip_records": {
"type": "array",
"items": {}
}
}
},
"components": {},
"created_by": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"updated_by": {
"type": "string"
},
"firm_portfolio": {},
"active": {
"type": "boolean"
}
},
"required": [
"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": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"user_name": {},
"email": {},
"phone_number": {},
"language_id": {},
"language_name": {},
"country_id": {
"type": "string"
},
"country_name": {
"type": "string"
}
},
"required": [
"id",
"first_name",
"last_name",
"user_name",
"email",
"phone_number",
"language_id",
"language_name",
"country_id",
"country_name"
]
}
},
"client": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"company_registration_number": {},
"contact_name": {
"type": "string"
},
"contact_email": {
"type": "string"
},
"contact_number": {},
"contact_address": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"line1": {},
"line2": {},
"line3": {},
"building": {},
"floor_level": {},
"postal_code": {},
"city": {},
"state_province": {},
"region": {},
"country_id": {
"type": "string"
},
"country_name": {}
}
},
"billing_address": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"line1": {},
"line2": {},
"line3": {},
"building": {},
"floor_level": {},
"postal_code": {},
"city": {},
"state_province": {},
"region": {},
"country_id": {
"type": "string"
},
"country_name": {
"type": "string"
}
}
},
"client_type": {}
}
},
"user": {
"type": "object",
"properties": {
"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"
}
}
},
"file_status": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"initial_state": {
"type": "boolean"
}
}
},
"file_template": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"file_template_components": {
"type": "array",
"items": {
"type": "object",
"properties": {
"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": [
"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"
},
"is_template_filing": {
"type": "boolean"
},
"base_id": {
"type": "string"
},
"ip_records": {
"type": "array",
"items": {}
}
}
},
"components": {
"type": "array",
"items": {}
},
"created_by": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"updated_by": {
"type": "string"
},
"active": {
"type": "boolean"
}
}
}