GET
Contents
Description
Retrieves whatever information (in the form of an entity) is identified by the Request-URI.
Remarks
Generally speaking, a GET represents a request to retrieve information from the server. for example, calling GET on the Request-URI http://ServerNameHere.com/CaseMapAD/CMServerAD.svc/version returns the version information of the service.
If the Request-URI refers to a data-producing process, the server will return the produced data in the response, rather than the source text of the process; the exception would be if the text happens to be the output of the process.
The GET method should not contain entity-body in the request; any request entity-body will be discarded and not processed.
Return Codes
The following table describes the return codes common to GET actions that return information about a single resource, such as GET get-cases.
Status Code |
Meaning |
Example |
200 |
The input is valid. |
/cases/case-6/data/
|
401 |
The user is unauthorized. |
User does not have the correct authorization on their account.
|
401 |
The authorization header contains a locked user ID. |
/cases/case-6/data/, when user is locked.
|
401, WWW-authenticate |
The user has no authorization. |
The user does not have an Active Directory account on the server.
|
403 |
The user or policy has been denied. |
Invalid user token.
|
404 |
The user input is invalid. |
/cases/case-$$/data/ /cases/case-0/data/ /cases/case-@@/data/
|
404 |
The URI is in an invalid format. |
/cases/case6-61/data/
|
404 |
The specified Resource ID does not exist. |
/cases/case-9999/data/, when case 9999 doesn't exist.
|
404 |
The call is missing necessary information. |
/cases/case-/data/
|
404/410 |
The resource has been deleted. |
/cases/case-6/data/ , when case 6 has been deleted.
|
405 |
The method type does not match up with the call. |
Giving DELETE/PUT/POST instead of GET
|
Supported Methods
The following table describes the GET methods available for each service:
Service |
GET methods |
CMServerAD |
|
Example
The following is an example of a URI used to retrieve data about a case, as described in the example section of GET get-case_data.
GET http://www.serverRersourceName.com/CMServerAD/cases/case-6/data/ |