GET get-case-users
Contents
Description
Retrieves a collection of of users assigned to a specified case
To use this action, send a GET request to the /cases/{caseID}/users resource.
In response to a get-case-users request, CaseMap Server returns a <userSummaries> element. This collection contains the first name, ID, last name, and user name of each user assigned to the case.
Requests
Syntax
GET {ServerNameHere}/CaseMapAD/CMServerAD/{caseID}/users/
or
GET {ServerNameHere}/CaseMapLA/CMServerLA/{caseID}/users/ |
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.
Responses
Headers
The response includes the headers common to all CaseMap Server responses. For more information, see About response headers.
Content
Name |
Description |
userSummaries |
Parent element for the response, and collection of user summary elements. Type: complex Children: userSummary
|
userSummary |
Summary of a single user Type: complex Parent: userSummaries Children: emailAddress, firstName, id, lastName, userName
|
emailAddress |
email address. Type: string Parent: userSummary Example: testuser@lexisnexis.com
|
firstName |
First name of the user. Type: string Parent: userSummary Example: Testaccount
|
id |
ID of the user. Type: int Parent: userSummary Example: 6
|
lastName |
Last name of the user. Type: string Parent: userSummary Example: Userperson
|
userName |
Account name of the user. Type: string Parent: userSummary Example: test_user |
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/case-6/users/ HTTP/1.1 User-Agent: Fiddler Host: localhost:3952 |
C# Example
The following example retrieves the users 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 getServerCaseUsers(string serverResource, string caseID) { //define the resource and the endpoint string resourceName = "/CaseMapAD/CMServerAD.svc/case/" + caseID + "/users/"; 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:10:26 GMT X-AspNet-Version: 2.0.50727 Cache-Control: private Content-Type: application/xml; charset=utf-8 Content-Length: 647 Connection: Close |
<userSummaries xmlns="http://services.lexisnexis.com/xmlschema/litigation-services/casemap/1" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <userSummary> <emailAddress/> <firstName>Test User 1</firstName> <id>3</id> <lastName>Prapin</lastName> <userName>pap_user_1</userName> </userSummary> <userSummary> <emailAddress/> <firstName>Test User 3</firstName> <id>6</id> <lastName>Prapin</lastName> <userName>pap_user_3</userName> </userSummary> </userSummaries> |