List Form

Overview
Retrieve Form List of the client

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/mobiForm/list.html?token=XXXXXXXX&userId={userId}

Arguments

clientId required	MobiWork assigned unique ID of the company
versionNumber required	Version number of MobiWork API SDK release. Current version is: 10.0.78
token required	Part of URL as a request parameter and is required in every call to verify access to API calls
userId optional	If provided, this User ID will be taken as a logged in user

Filter or Search Criteria

formApiName	By the name of the form
status	By the status of the form
createdFromDate	By the creation date of the from
createdToDate	By the ending date of the form
createdByUserId	By the form's creator Id.

Return
Returns a list of form Object(s) if valid arguments and search criteria are provided. If no search criteria is provided the list of a maximum 200 Form will be returned. Returns an error if not a valid request

Request Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="mobiForm">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="formApiName"/>
        <xs:element ref="status"/>
        <xs:element ref="createdFromDate"/>
        <xs:element ref="createdToDate"/>
        <xs:element ref="createdByUserId"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="formApiName" type="xs:NCName" minOccurs="0"/>
  <xs:element name="status" type="xs:NCName" minOccurs="0"/>
  <xs:element name="createdFromDate" type="xs:string" minOccurs="0"/>
  <xs:element name="createdToDate" type="xs:string" minOccurs="0"/>
  <xs:element name="createdByUserId" type="xs:integer" minOccurs="0"/>
</xs:schema>

Response Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="response">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="mobiFormList"/>
      </xs:sequence>
      <xs:attribute name="statusCode" use="required" type="xs:integer"/>
      <xs:attribute name="version" use="required" type="xs:NMTOKEN"/>
    </xs:complexType>
  </xs:element>
  <xs:element name="mobiFormList">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="totalAvailableCount"/>
        <xs:element ref="count"/>
        <xs:element maxOccurs="unbounded" ref="mobiForm"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="totalAvailableCount" type="xs:integer"/>
  <xs:element name="count" type="xs:integer"/>
  <xs:element name="mobiForm">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="filledFormId"/>
        <xs:element ref="name"/>
        <xs:element ref="apiName"/>
        <xs:element ref="pdfUrl"/>
        <xs:element ref="status"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="createdByUserName"/>
        <xs:element ref="createdBy"/>
        <xs:element ref="formFields"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="filledFormId" type="xs:integer"/>
  <xs:element name="pdfUrl" type="xs:anyURI"/>
  <xs:element name="status" type="xs:NCName"/>
  <xs:element name="createdDate" type="xs:string"/>
  <xs:element name="createdByUserName">
    <xs:complexType/>
  </xs:element>
  <xs:element name="createdBy" type="xs:integer"/>
  <xs:element name="formFields">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="formField"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="formField">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="fieldType"/>
        <xs:element ref="apiName"/>
        <xs:element ref="index"/>
        <xs:element ref="name"/>
        <xs:element ref="value"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="fieldType" type="xs:integer"/>
  <xs:element name="index" type="xs:integer"/>
  <xs:element name="value" type="xs:string"/>
  <xs:element name="name" type="xs:string"/>
  <xs:element name="apiName" type="xs:NCName"/>
</xs:schema>

Curl Example

HTTP Method:	POST
Request:	curl -k -X POST -H "https://www.mobiwork.com/api/rest/12014/10.0.78/mobiForm/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml' --data '<mobiForm> <createdByUserId>0</createdByUserId> <createdFromDate>2019/06/20</createdFromDate> <createdToDate>2019/06/20</createdToDate> <formApiName>TestForm</formApiName> <status>CREATED</status> </mobiForm>'
Response:	<?xml encoding="UTF-8" ?> <response version="10.0.78" statusCode="1"> <mobiFormList> <totalAvailableCount>55</totalAvailableCount> <count>55</count> <mobiForm> <filledFormId>5</filledFormId> <name>TestForm</name> <apiName>TestForm</apiName> <pdfUrl></pdfUrl> <status>CREATED</status> <createdDate>2019/06/20</createdDate> <createdByUserName></createdByUserName> <createdBy>0</createdBy> <formFields> <formField><fieldType>6</fieldType><apiName>selectcolor</apiName><index>0</index><name>select color</name><value>blue</value></formField> <formField><fieldType>1</fieldType><apiName>name</apiName><index>0</index><name>name</name><value>piet</value></formField> <formField><fieldType>2</fieldType><apiName>Age</apiName><index>0</index><name>Age</name><value>99</value></formField> </formFields> </mobiForm> </mobiFormList> <response>