You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Purpose: Get a list of form submissions.

Base URL: https://www.commcarehq.org/a/[domain]/api/v0.4/form/

Input parameters:

The forms can be filtered using the following parameters

NameDescriptionExampleStatus
xmlnsForm XML namespace (optional)xmlns=ttp://openrosa.org/formdesigner/dd3190c7dd7e9e7d469a9705709f2f6b4e27f1d8"Proposed
received_on_startDate (optional)user=3c5a623af057e23a32ae4000cf291339Supported
typeType of case (optional)type=pregnant_motherSupported
closedCase status (optional)
Supported: false (default), true, any 
closed=anySupported
[ property ]Any case propertyname=NEAL&properties/favorite_color=blueSupported

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.2/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