Purpose: get a list of cases. The list of cases may be presented to the end user a simple list of cases, where each case name incudes a hyperlink to access detailed information about the case.

Base URL: https://www.commcarehq.org/a/[domain]/api/v0.5/case/

Input parameters:

In addition to all Case Data parameters, you may use the following input parameters to filter results and control paging

NameDescriptionExampleStatusSummary
owner_idUser or Group UUID (optional)owner_id=ac9d34ff59cf6388e4f5804b12276d8a(tick) SupportedAll cases owned by that entity (should not use with user)
user_idUser UUID (optional)user_id=3c5a623af057e23a32ae4000cf291339(tick) SupportedAll cases last modified by that user
typeType of case (optional)type=pregnant_mother(tick) SupportedAll cases matching the type
closedCase status (optional)
Supported: false, true (defaults to both)
closed=true(tick) SupportedAll open/closed/both cases
date_modified_startModified after this date (phone date)

date_modified_start=2012-05-20

date_modified_start=2013-09-29T10:40Z

(tick) SupportedDefaults to the first submission date.
date_modified_endModifed before this date (phone date)date_modified_end=2012-05-27(tick) SupportedDefaults to the current date.
server_date_modified_startModified after this date (server date)server_date_modified_start=2012-05-20(tick) SupportedDefaults to the first submission date.
server_date_modified_endModifed before this date (server date)server_date_modified_end=2012-05-27(tick) SupportedDefaults to the current date.
nameNamename=NEAL(tick) Supported 
limitThe maximum number of records to return.limit=100(tick) SupportedDefaults to 20. Maximum is 100.
offsetThe number of records to offset in the results.offset=100(tick) SupportedDefaults to 0.
external_id'external_id' propertyexternal_id=123abc(tick) Supported

 

Output values:

NameDescriptionExample
case_idCase UUID0X9OCW3JMV98EYOVN32SGN4II
usernameUser name of case owner, including domainjdoe@example.commcarehq.org
user_idUUID user that owns the case3c5a623af057e23a32ae4000cf291339
owner_idUUID group/user that owns the caseac9d34ff59cf6388e4f5804b12276d8a
case_nameName of caseRose
external_idExternal ID associated with the case123456
case_typeType of casepregnant_mother
date_openedDate and time case was opened2011-11-16T14:26:15Z
date_modifiedDate and time case was last modified2011-12-13T15:09:47Z
closedCase statusfalse
date_closedDate and time case was closed2011-12-20T15:09:47Z

Sample usage:

https://www.commcarehq.org/a/[domain]/api/v0.3/case/?format=xml

Sample XML output (Proposed):

<cases>
	<case>
		<case_id>0X9OCW3JMV98EYOVN32SGN4II</case_id>
		<username>jdoe@example.commcarehq.org</username>
		<user_id>3c5a623af057e23a32ae4000cf291339</user_id>
		<owner_id>3c5a623af057e23a32ae4000cf291339</owner_id>
		<case_name>Rose</case_name>
		<external_id>123456</external_id>
		<case_type>pregnancy</case_type>
		<date_opened>2011-11-16T14:26:15</date_opened>
		<date_modified>2011-12-13 15:09:47</date_modified>
		<closed>false</closed>
		<date_closed>2011-12-20 15:09:47</date_closed>
	</case>
	...
</cases>

Sample JSON Output:

JSON Format
[ { "case_id" : "45WKYXQRFFU3AT4Y022EX7HF2",
    "closed" : false,
    "date_closed" : null,
    "date_modified" : "2012-03-13T18:21:52Z",
    "domain" : "demo",
    "indices" : {  },
    "properties" : { 
    	"case_name" : "ryan",
        "case_type" : "programmer",
        "date_opened" : "2012-03-13T18:21:52Z",
        "external_id" : "45WKYXQRFFU3AT4Y022EX7HF2",
        "gender" : "m",
        "languages" : "python java javascript c php erlang love",
        "owner_id" : null,
        "role" : "artisan"
      },
    "server_date_modified" : "2012-04-05T23:56:41Z",
    "server_date_opened" : "2012-04-05T23:56:41Z",
    "user_id" : "06414101dc45bcfdc963b8cb1a1ebdfd",
    "version" : "1.0",
    "xform_ids" : [ "3HQEXR2S0GIRFY2GF40HAR7ZE" ]
  },
  ...
]
  • No labels