Add Form

Overview
Creates a form in MobiWork

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/mobiform/add.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. If not provided we use an active global administrator ID

Return
Returns a Form Object if Form creation is successful or errors will be returned

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="request">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="mobiForm"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="mobiForm">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="filledFormId"/>
        <xs:element ref="name"/>
        <xs:element ref="apiName" minOccurs="0"/>
        <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" minOccurs="0"/>
  <xs:element name="pdfUrl" minOccurs="0">
    <xs:complexType/>
  </xs:element>
  <xs:element name="status" type="xs:NCName" minOccurs="0"/>
  <xs:element name="createdDate" type="xs:string" minOccurs="0"/>
  <xs:element name="createdByUserName" type="xs:string" minOccurs="0"/>
  <xs:element name="createdBy" type="xs:integer" minOccurs="0"/>
  <xs:element name="formFields">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="formField" minOccurs="0"/>
      </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" minOccurs="0"/>
  <xs:element name="index" type="xs:integer" minOccurs="0"/>
  <xs:element name="value" type="xs:NMTOKEN" minOccurs="0"/>
  <xs:element name="name" type="xs:string" minOccurs="0"/>
  <xs:element name="apiName" type="xs:NCName"/>
</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="mobiForm"/>
      </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="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">
    <xs:complexType/>
  </xs:element>
  <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:NMTOKEN"/>
  <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/add.html?token=COJL8X2FKSLMMRTYCH2B" -data '<request> <mobiForm> <filledFormId>0</filledFormId> <name>TestForm</name> <apiName>TestForm</apiName> <pdfUrl></pdfUrl> <status>CREATED</status> <createdDate>2019/06/20</createdDate> <createdByUserName>Mobi Admin</createdByUserName> <createdBy>1</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> </request> '
Response:	<?xml version="1.0" encoding="UTF-8" ?> <response version="5.0.156" statusCode="1"> <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> </response>