You can use your form to call a Web Services via Field2Base JavaScript Library.
The class you will need to make a Restful API call is WebServices
Please refer to attached eForm for a working sample by uploading to your Company. This sample form will match the project users which this form is working under. By doing so, you can manage your users via the Admin Portal, and let the form to pick up the users that are available dynamically without modifying and uploading the data file.
Note: You will need to change the Authorization information under the web service header section based on your company setting.
To initialize a call, you will need to assign the endpoint your web services provider is located using
WebServices.startRestService(Endpoint, Method);where
Endpoint: Web services provider URI
Method: GET, POST
then, you can add the HhtmlHeader where the Authorization or other information that is required from your Web services provider.
WebServices.addHtmlHeader(Header, Value);where
Header: Header Vame (ex: Authorization)
Value: Header Value (ex: Basic Token)
You could also add a parameter to your API request as follows:
WebServices.addParameters(Key, Value);where
Key: Parameter Key (ex: ID)
Value: Parameter Value (ex: 5)
Below is a complete Sample of calling Field2Base UserAPI Web Service.
WebServices.startRestService("https://fieldconnect.field2base.com/v2/api/users", "GET");
WebServices.addHtmlHeader("Authorization", "Authentication CompanyID:Username:Password:API_Token);
WebServices.call("handleUserList");
Please check the Authorization required in calling F2B Web Services is in the following format:
Authentication: Basic
CompanyID: Your F2B company ID
Username: Your API Account
Password: Your API Account Password
API_Token: Your API Sync Key
Now, you are ready to call your very first REST Call from your form. Note that the call will be pointing to a JavaScript function as shown below:
WebServices.call("handleUserList");The handleUserList is a custom define JavaScript function that handles the return of your RESTful call. You can have any function name you want.
Befoe digging into the code, let's take a look on the response from this UserAPI Web Service.
[
{
"UserKey": "aaaaaaaa-e0b8-4bd0-8553-ac46bf854fad",
"UserName": "HowardChen",
"EnableWebAccess": true,
"Password": null,
"PasswordNeverExpires": false,
"ForcePasswordChangeOnLogin": null,
"FirstName": "Howard",
"MiddleName": null,
"LastName": "Chen",
"Phone": "9194628500x261",
"Fax": null,
"Email": "howard-chen@field2base.com",
"Projects": [
"bbbbbbbb-eb1a-44b6-8b8a-5aeb661ffb97",
"cccccccc-f475-44a9-a8df-8502c54e3de2"
],
"Groups": [],
"PrefersPDFAttachments": null,
"OptionalRecipient": null
}
]Now, let's look at the sample of the handleUserList function
function handleUserList(result)
{
var projectID = Field2Base.getProjectId();
var username = Field2Base.getUsername();
Form.getRegion("Page1@projectID").setValue(projectID);
var resultObj = eval(result);
var userList = [];
for (var i=0; i < resultObj.length; i++)
{
if(resultObj[i].UserName == username) continue; // Skip current user
for(var j=0; j< resultObj[i].Projects.length; j++)
{
if(resultObj[i].Projects[j] == projectID)
{
userList.push(resultObj[i].UserName); // If project ID matched, push into userList array
break;
}
}
}
Form.getRegion("Page1@UserName").setDatasourceList(userList);
Form.getRegion("Page1@msg").clearValue()
}
First, the Web Services will return a string(result) that contains the JSON data we see above.
To be able to parse this set of data, we use eval() to convert the result into an JavaScript Object.
We can get the current project ID by using Field2Base.getProjectId(), then match each of the return user's project record into userList[] array. Finally, assign the datasource with this array
Form.getRegion("Page1@UserName").setDatasourceList(userList);
Let's give it a try in our Mobile Form...
Now, you can enjoy the power of Web Services by using REST API in F2B's JavaScript Library to integrate almost anything.
Comments
0 comments
Please sign in to leave a comment.