GET get-cases
Contents
Description
Retrieves a list of registered cases on the server.
To use this action, send a GET request to the /cases/ resource.
In response to a get-cases request, CaseMap Server returns a <caseSummaries> element. This collection contains the client matter number, the description, the ID, and the case name for each case on the server.
Requests
Syntax
GET {ServerNameHere}/CaseMapAD/CMServerAD/cases/
or
GET {ServerNameHere}/CaseMapLA/CMServerLA/cases/ |
Headers
The request includes the GET, User-Agent, and Host headers, which are standard for all CaseMap Server requests. For more information, see About request headers.
Parameters
The URL does not contain any parameters.
Content
The request does not contain any elements in the body.
Responses
Headers
The response includes the headers common to all CaseMap Server responses. For more information, see About response headers.
Content
Name |
Description |
caseSummaries |
Parent element for the resonse; contains a collection of case summaries. Type: complex Children: caseSummary
|
caseSummary |
Case summary for one case. Type: complex Parent: caseSummaries Children: clientMatterNumber, id, name
|
clientMatterNumber |
The client matter number. Type: int Parent: caseSummary Example: 1234
|
id |
ID number Type: int Parent: caseSummary Example: 5678
|
name |
Friendly name of the case. Type: string Parent: caseSummary Example: CMCase |
Status Codes
Returns 200 on a valid response. Otherwise, returns one of the common status codes. for more information, see GET.
Examples
Request Example
The following requests the version information.
GET /CMServerAD/cases/ HTTP/1.1 User-Agent: Fiddler Host: localhost:3952 |
C# Example
The following example retrieves a list of all cases on the specified server. The sample takes the server URL as a parameter. The sample also uses the DisplayMessage helper method to display the response. For more information on the helper methods, see CaseMap Server Helper Methods.
public static void getServerCaseViews(string serverResource) { //define the resource and the endpoint string resourceName = "/CaseMapAD/CMServerAD.svc/cases"; string endPoint = serverResource + resourceName;
//create the call and add in the authorization token HttpWebRequest request = WebRequest.Create(endPoint) as HttpWebRequest; request.Method = "GET";
//send it off and get the returned list. HttpWebResponse response = request.GetResponse() as HttpWebResponse;
//display the list DisplayMessage(response); Console.ReadLine();
response.Close(); } |
Response Example
The following is a response to the request in the previous example.
HTTP/1.1 200 OK Server: ASP.NET Development Server/9.0.0.0 Date: Tue, 09 Aug 2011 22:04:08 GMT X-AspNet-Version: 2.0.50727 Cache-Control: private Content-Type: application/xml; charset=utf-8 Content-Length: 386 Connection: Close |
<caseSummaries xmlns="http://services.lexisnexis.com/xmlschema/litigation-services/casemap/1" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <caseSummary> <clientMatterNumber>1234</clientMatterNumber> <description>5678</description> <id>1</id> <name>CMCase</name> </caseSummary> <caseSummary> <clientMatterNumber/> <description/> <id>6</id> <name>Hawkins</name> </caseSummary> </caseSummaries> |