online-help.platform.features.premier_subscription.connectors.inbound-rest-api.endpoints.form.title
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
Response Body XSD
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>