GET get-case-views

 

Description

Retrieves a collection of of views associated with the specified case.

To use this action, send a GET request to the /cases/{caseID}/views/ resource.

In response to a get-case-views request, CaseMap Server returns a <views> element. This collection contains the data type ID, ID, and name of all the views associated with the case. You can optionally limit the response to a particular user or data type, using the optional query parameters.

A view is a set of fields and sorting information for a particular spreadsheet.

 

Requests

 

Syntax

GET {ServerNameHere}/CaseMapAD/CMServerAD/cases/{caseID}/views/?userId={userID}&dataTypeId={dataTypeID}

 

or

 

GET {ServerNameHere}/CaseMapLA/CMServerLA/cases/{caseID}/views/?userId={userID}&dataTypeId={dataTypeID}

 

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. In addition, the query string contains the following search values:

 

Value

Description

userId

(optional) ID number of the user to retrieve the spreadsheet views for.

Example: 3

 

dataTypeId

(optional) Type of data to retrieve. This integer value is returned in the ID element by GET get-case_data.

Example: 1

 

 

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

views

Parent element of the response; contains a collection of view objects.

Type: complex

Children: view

 

view

Description of a view the user has.

Type: complex

Parent: views

Children: dataTypeId, id, name

 

  dataTypeId

Data type ID. If the dataTypeId URL parameter was used to limit the search, this element will be the same for all views.

Type: int

Parent: view

Example: 3

 

    id

The ID of the view

Type: int

Parent: view

Example: 59228293

 

    name

The name of the view.

Type: string

Parent: view

Example: Document - Favorite

 

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/case-6/views/?userId=3 HTTP/1.1

User-Agent: Fiddler

Host: localhost:3952

 

C# Example

The following example retrieves the case views from the specified CaseMap Server. The sample takes the server URL, case number and userID as a parameter. 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 getServerCaseViews(string serverResource, string caseID, string userID)

{

 

  //define the resource and the endpoint

  string resourceName = "/CaseMapAD/CMServerAD.svc/cases/" + caseID + "/views/?userId=" + userID;

  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:20:34 GMT

X-AspNet-Version: 2.0.50727

Cache-Control: private

Content-Type: application/xml; charset=utf-8

Content-Length: 2474

Connection: Close

 

<views xmlns="http://services.lexisnexis.com/xmlschema/litigation-services/casemap/1" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">

 <view>

   <dataTypeId>6</dataTypeId>

   <id>59228293</id>

   <name>Document - Favorite</name>

 </view>

 <view>

   <dataTypeId>18</dataTypeId>

   <id>164510641</id>

   <name>Favorite</name>

 </view>

 <view>

   <dataTypeId>8</dataTypeId>

   <id>206474897</id>

   <name>Event - Favorite</name>

 </view>

 <view>

   <dataTypeId>10</dataTypeId>

   <id>445172537</id>

   <name>Pleading - Favorite</name>

 </view>

 <view>

   <dataTypeId>18</dataTypeId>

   <id>484203523</id>

   <name>Most Fields</name>

 </view>

 <view>

   <dataTypeId>12</dataTypeId>

   <id>506016688</id>

   <name>Other Discovery - Favorite</name>

 </view>

 <view>

   <dataTypeId>5</dataTypeId>

   <id>541528399</id>

   <name>Organization - Favorite</name>

 </view>

 <view>

   <dataTypeId>2</dataTypeId>

   <id>571339841</id>

   <name>Jury Instructions</name>

 </view>

 <view>

   <dataTypeId>11</dataTypeId>

   <id>720547300</id>

   <name>Proceeding - Favorite</name>

 </view>

 <view>

   <dataTypeId>1</dataTypeId>

   <id>866746305</id>

   <name>Favorite</name>

 </view>

 <view>

   <dataTypeId>15</dataTypeId>

   <id>868748177</id>

   <name>Assigned To</name>

 </view>

 <view>

   <dataTypeId>19</dataTypeId>

   <id>882473373</id>

   <name>Most Fields</name>

 </view>

 <view>

   <dataTypeId>2</dataTypeId>

   <id>1105810968</id>

   <name>Demonstrative Evidence Analysis</name>

 </view>

 <view>

   <dataTypeId>2</dataTypeId>

   <id>1200365318</id>

   <name>Favorite</name>

 </view>

 <view>

   <dataTypeId>4</dataTypeId>

   <id>1363887205</id>

   <name>Person - Favorite</name>

 </view>

 <view>

   <dataTypeId>13</dataTypeId>

   <id>1386622048</id>

   <name>Demonstrative Evidence - Favorite</name>

 </view>

 <view>

   <dataTypeId>1</dataTypeId>

   <id>1474848196</id>

   <name>Date, Fact and Source</name>

 </view>

 <view>

   <dataTypeId>14</dataTypeId>

   <id>1574936314</id>

   <name>Other Object - Favorite</name>

 </view>

 <view>

   <dataTypeId>4</dataTypeId>

   <id>1617081878</id>

   <name>Person - Address/Phone</name>

 </view>

 <view>

   <dataTypeId>9</dataTypeId>

   <id>1674014038</id>

   <name>Place - Favorite</name>

 </view>

 <view>

   <dataTypeId>3</dataTypeId>

   <id>1704210468</id>

   <name>All Object Types - Favorite</name>

 </view>

 <view>

   <dataTypeId>15</dataTypeId>

   <id>1800626038</id>

   <name>Favorite</name>

 </view>

 <view>

   <dataTypeId>7</dataTypeId>

   <id>1884578000</id>

   <name>Other Physical Evidence - Favorite</name>

 </view>

 <view>

   <dataTypeId>19</dataTypeId>

   <id>1885741421</id>

   <name>Favorite</name>

 </view>

 <view>

   <dataTypeId>5</dataTypeId>

   <id>2040184350</id>

   <name>Organization - Address/Phone</name>

 </view>

 <view>

   <dataTypeId>6</dataTypeId>

   <id>2118863299</id>

   <name>Trial Exhibit List</name>

 </view>

</views>

 

 

Need additional help? Email the CaseMap Support team at: casemap.support@lexisnexis.com, or contact a support representative at 1-800-833-3346 (option 3). The CaseMap Support team is available between the hours of 9:00 a.m. to 7:00 p.m. Eastern Time, Monday - Friday.

© 2018 LexisNexis. All rights reserved.