Retrieves a collection of of spreadsheets for the specified case.
To use this action, send a GET request to the /cases/{caseID}/data resource.
In response to a get-case-data request, CaseMap Server returns a <data> element. This collection contains the location, display sequence, ID, as well as the plural and singular names of the spreadsheet.
Common spreadsheets include the Facts, Issues, and Persons spreadsheets.
Syntax
GET {ServerNameHere}/CaseMapAD/CMServerAD/cases/{caseID}/data
or
GET {ServerNameHere}/CaseMapLA/CMServerLA/cases/{caseID}/data |
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 contains the caseID.
Content
The request does not contain any elements in the body.
Headers
The response includes the headers common to all CaseMap Server responses. For more information, see About response headers.
Content
Name |
Description |
data |
Parent element for the response; contains a collection of spreadsheet descriptions. Type: complex Children: dataItem
|
dataItem |
Description of a spreadsheet. Type: complex Parent: data Children: location, id, namePlural, nameSingluar
|
location |
Relative path of the spreadsheet. Type: string Parent: data Example: /cases/case-6/data/facts
|
displaySequence |
Sequence the spreadsheet is in the display. Type: int Parent: data Example: 1
|
id |
Data ID. This value can be used in calls to GET get-case-views to limit the types of data returned. Type: int Parent: data Example: 1
|
namePlural |
Plural name of the spreadsheet Type: string Parent: data Example: Issues
|
nameSingluar |
Singular name of the spreadsheet. Type: string Parent: data Example: Issue |
Status Codes
Returns 200 on a valid response. Otherwise, returns one of the common status codes. for more information, see GET.
Request Example
The following requests the version information.
GET /CMServerAD/cases/case-6/data/ HTTP/1.1 User-Agent: Fiddler Host: localhost:3952 |
C# Example
The following example retrieves the case data from the specified CaseMap Server. The sample takes the server URL and case ID as parameters. The sample also uses the DisplayMessage helper method to display the response message. For more information on the helper methods, see CaseMap Server Helper Methods.
public static void getServerCaseData(string serverResource, string caseID) { //define the resource and the endpoint string resourceName = "/CaseMapAD/CMServerAD.svc/case/" + caseID + "/data/"; 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:14:00 GMT X-AspNet-Version: 2.0.50727 Cache-Control: private Content-Type: application/xml; charset=utf-8 Content-Length: 3721 Connection: Close |
<data xmlns="http://services.lexisnexis.com/xmlschema/litigation-services/casemap/1" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <dataItem> <location>/cases/case-6/data/facts</location> <displaySequence>1</displaySequence> <id>1</id> <namePlural>Facts</namePlural> <nameSingular>Fact</nameSingular> </dataItem> <dataItem> <location>/cases/case-6/data/issues</location> <displaySequence>2</displaySequence> <id>2</id> <namePlural>Issues</namePlural> <nameSingular>Issue</nameSingular> </dataItem> <dataItem> <location>/cases/case-6/data/all-objects</location> <displaySequence>3</displaySequence> <id>3</id> <namePlural>All Objects</namePlural> <nameSingular>All Objects</nameSingular> </dataItem> <dataItem> <location>/cases/case-6/data/persons</location> <displaySequence>4</displaySequence> <id>4</id> <namePlural>Persons</namePlural> <nameSingular>Person</nameSingular> <parentID>3</parentID> </dataItem> <dataItem> <location>/cases/case-6/data/organizations</location> <displaySequence>5</displaySequence> <id>5</id> <namePlural>Organizations</namePlural> <nameSingular>Organization</nameSingular> <parentID>3</parentID> </dataItem> <dataItem> <location>/cases/case-6/data/documents</location> <displaySequence>6</displaySequence> <id>6</id> <namePlural>Documents</namePlural> <nameSingular>Document</nameSingular> <parentID>3</parentID> </dataItem> <dataItem> <location>/cases/case-6/data/other-physical-evidence</location> <displaySequence>7</displaySequence> <id>7</id> <namePlural>Other Physical Evidence</namePlural> <nameSingular>Other Physical Evidence</nameSingular> <parentID>3</parentID> </dataItem> <dataItem> <location>/cases/case-6/data/events</location> <displaySequence>8</displaySequence> <id>8</id> <namePlural>Events</namePlural> <nameSingular>Event</nameSingular> <parentID>3</parentID> </dataItem> <dataItem> <location>/cases/case-6/data/places</location> <displaySequence>9</displaySequence> <id>9</id> <namePlural>Places</namePlural> <nameSingular>Place</nameSingular> <parentID>3</parentID> </dataItem> <dataItem> <location>/cases/case-6/data/pleadings</location> <displaySequence>10</displaySequence> <id>10</id> <namePlural>Pleadings</namePlural> <nameSingular>Pleading</nameSingular> <parentID>3</parentID> </dataItem> <dataItem> <location>/cases/case-6/data/proceedings</location> <displaySequence>11</displaySequence> <id>11</id> <namePlural>Proceedings</namePlural> <nameSingular>Proceeding</nameSingular> <parentID>3</parentID> </dataItem> <dataItem> <location>/cases/case-6/data/other-discovery</location> <displaySequence>12</displaySequence> <id>12</id> <namePlural>Other Discovery</namePlural> <nameSingular>Other Discovery</nameSingular> <parentID>3</parentID> </dataItem> <dataItem> <location>/cases/case-6/data/demonstrative-evidence</location> <displaySequence>13</displaySequence> <id>13</id> <namePlural>Demonstrative Evidence</namePlural> <nameSingular>Demonstrative Evidence</nameSingular> <parentID>3</parentID> </dataItem> <dataItem> <location>/cases/case-6/data/other-objects</location> <displaySequence>14</displaySequence> <id>14</id> <namePlural>Other Objects</namePlural> <nameSingular>Other Object</nameSingular> <parentID>3</parentID> </dataItem> <dataItem> <location>/cases/case-6/data/questions</location> <displaySequence>15</displaySequence> <id>15</id> <namePlural>Questions</namePlural> <nameSingular>Question</nameSingular> </dataItem> <dataItem> <location>/cases/case-6/data/authorities</location> <displaySequence>16</displaySequence> <id>18</id> <namePlural>Authorities</namePlural> <nameSingular>Authority</nameSingular> </dataItem> <dataItem> <location>/cases/case-6/data/extracts-from-authorities</location> <displaySequence>17</displaySequence> <id>19</id> <namePlural>Extracts from Authorities</namePlural> <nameSingular>Authority Extract</nameSingular> </dataItem> </data> |