iForm Data Get

Posted by Anonymous (not verified) on in General discussion

Here is an example of how to retrieve data stored on an iCIMS iForm. If the field is a synced, the data is stored on the platform profile field.

Call Type: GET

This is only an example of each form. You will have tweak the GET for all fields
Employment Application (305)
URL:
https://api.icims.com/customers/6271/forms/938515?questions=Highschool,CITY_2_3_1,state_3_1,hs_country,fieldsofstudy,typeofcert,gradudated,name_of_employer,address_1 city_2 state_2,employer_country zip_1_1,date_1_1,date_2,endingpos,startsal,endsalary,reason, may_we_contact,present_employer,supervisorname,supervisortitle,superphone

Result:
{
state_3_1: "NY"
CITY_2_3_1: "New York"
name_of_employer: "Test Emp1"
reason: "Test Reason1"
Highschool: "Test High School"
date_1_1: "2005-01-01"
endingpos: "testend1"
links: 
[
2]
0:  
{
title: "the current form being viewed."
rel: "self"
url: "https://api.icims.com/customers/6271/forms/938515"
}
-
1:  
{
title: "the profile this Form is owned by."
rel: "formAbout"
url: "https://api.icims.com/customers/6271/people/477703"
}
-
-
supervisorname: "Test SupName1"
startsal: "55555"
present_employer: "Yes"
typeofcert: "High School diploma"
supervisortitle: "Test Sup Title1"
hs_country: "US"
gradudated: "Yes"
date_2: "2015-01-01"
endsalary: "55555"
superphone: "2125551212"
}

Criminal History Disclosure (290)
URL
https://api.icims.com/customers/6271/forms/938730?questions=convictions

Result:

{
links: 
[
2]
0:  
{
title: "the current form being viewed."
rel: "self"
url: "https://api.icims.com/customers/6271/forms/938730"
}
-
1:  
{
title: "the profile this Form is owned by."
rel: "formAbout"
url: "https://api.icims.com/customers/6271/people/477703"
}
-
-
convictions: 
[
2]
0:  
{
ccounty: "N/A"
csentence: "N/A"
cconvdatemonth: "N/A - I have no criminal history to disclose"
clastname: "TestTroi"
cnameused: "TestDeanna"
entry: 0
ccrime: "N/A"
cstate: "N/A - I have no criminal history to disclose"
cfelonymisdemeanordd: "N/A - I have no criminal history to disclose"
cconvdateyear: "N/A - I have no criminal history to disclose"
ccountyfederaldd: "N/A - I have no criminal history to disclose"
}
-
1:  
{
ccounty: "NA"
csentence: "NA"
cconvdatemonth: "N/A - I have no criminal history to disclose"
clastname: "TestTroiNA"
cnameused: "TestDeannaNA"
entry: 1
ccrime: "NA"
cstate: "N/A - I have no criminal history to disclose"
cfelonymisdemeanordd: "N/A - I have no criminal history to disclose"
cconvdateyear: "N/A - I have no criminal history to disclose"
ccountyfederaldd: "N/A - I have no criminal history to disclose"
}
-
-
}