GET get-case-issues-outline

 

Description

Retrieves a list of issues for the specified case.

To use this action, send a GET request to the /cases/{caseID}/data/issues resource. You specify the outline format option in the Accept header.

In response to a get-case-issues request, CaseMap Server returns an <issues> element. This collection contains a description of all the issues in the  the case, including ID, name, outline number, short name, and any subissues.

 

Requests

 

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. In addition, the Accept header can contain the following information:

 

Name

Description

Accept

Contains the formatting and spreadsheet (viewID) information

Type: string

 

Name

Description

nameFormat

(Optional) format for the name. Must be one of the following:

•full
•short

The default value is full.

 

view

(Optional) Type of view to retrieve. Must be one of the following:

•outline

If this is ommitted, the issue data is returned the same way as any other spreadsheet.

 

Example: Accept: view=outline;nameFormat=short

 

Parameters

The URL contains the caseID.

 

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

issues

Parent element for the response; contains a collection of issue elements.

Type: complex

Children: issue

 

  issue

Description of a single issue.

Type: complex

Parent: issues

Children: id, name, outlineNumber, shortName, subIssues

 

    id

ID of the issue.

Type: int

Parent: issue

Example: 1769765926

 

    name

Name of the issue

Type: string

Parent: issue

Example: Wrongful Termination

 

    outlineNumber

Outline number.

Type: int

Parent: issue

Example: 1

 

    shortName

The short name of the issue

Type: string

Parent: issue

Example: WrongfulTermination

 

    subIssues

Additional issues organized under the current issue

Type: complex

Parent: issue

Children: issue

 

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/data/issues/ HTTP/1.1

User-Agent: Fiddler

Host: localhost:3952

Accept: view=outline

 

C# Example

The following example retrieves the issues of a specified case 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 getServerCaseIssues(string serverResource, string caseID, string recordCount, string startingRecordNumber)

{

  //define the resource and the endpoint

  string resourceName = "/CaseMapAD/CMServerAD.svc/case/" + caseID + "/data/issues/

  string endPoint = serverResource + resourceName;

 

  //create the call

  HttpWebRequest request = WebRequest.Create(endPoint) as HttpWebRequest;

   request.Method = "GET";

 

  //add in the additional header values

   request.Accept = "view=outline;nameFormat=short";

 

  //send it off and get the response

  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 23:26:18 GMT

X-AspNet-Version: 2.0.50727

Cache-Control: private

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

Content-Length: 1895

Connection: Close

 

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

 <issue>

   <id>1769765926</id>

   <name>Wrongful Termination</name>

   <outlineNumber>1</outlineNumber>

   <shortName>WrongfulTermination</shortName>

   <subIssues/>

 </issue>

 <issue>

   <id>1554959045</id>

   <name>Age Discrimination</name>

   <outlineNumber>2</outlineNumber>

   <shortName>AgeDiscrimination</shortName>

   <subIssues>

     <issue>

       <id>1982336477</id>

       <name>Hawkins Specific</name>

       <outlineNumber>2.1</outlineNumber>

       <shortName>HawkinsSpecific</shortName>

       <subIssues/>

     </issue>

     <issue>

       <id>1491271512</id>

       <name>Pattern &amp; Practice</name>

       <outlineNumber>2.2</outlineNumber>

       <shortName>Pattern&amp;Practice</shortName>

       <subIssues/>

     </issue>

   </subIssues>

 </issue>

 <issue>

   <id>182509757</id>

   <name>Retaliation</name>

   <outlineNumber>3</outlineNumber>

   <shortName>Retaliation</shortName>

   <subIssues>

     <issue>

       <id>473045427</id>

       <name>Transfer</name>

       <outlineNumber>3.1</outlineNumber>

       <shortName>Transfer</shortName>

       <subIssues/>

     </issue>

     <issue>

       <id>1339773059</id>

       <name>Demotion</name>

       <outlineNumber>3.2</outlineNumber>

       <shortName>Demotion</shortName>

       <subIssues/>

     </issue>

   </subIssues>

 </issue>

 <issue>

   <id>1290855574</id>

   <name>Deserved Termination</name>

   <outlineNumber>4</outlineNumber>

   <shortName>DeservedTermination</shortName>

   <subIssues/>

 </issue>

 <issue>

   <id>323638003</id>

   <name>Damages</name>

   <outlineNumber>5</outlineNumber>

   <shortName>Damages</shortName>

   <subIssues>

     <issue>

       <id>1725246657</id>

       <name>Failure to Mitigate</name>

       <outlineNumber>5.1</outlineNumber>

       <shortName>FailureToMitigate</shortName>

       <subIssues/>

     </issue>

     <issue>

       <id>1666049993</id>

       <name>Lost Wages</name>

       <outlineNumber>5.2</outlineNumber>

       <shortName>LostWages</shortName>

       <subIssues/>

     </issue>

     <issue>

       <id>777908468</id>

       <name>Mental Anguish</name>

       <outlineNumber>5.3</outlineNumber>

       <shortName>MentalAnguish</shortName>

       <subIssues/>

     </issue>

   </subIssues>

 </issue>

</issues>

 

 

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.

© 2017 LexisNexis. All rights reserved.