Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Example [recordsToSubmit]:

Code Block
"@mobileNumber","string_question","integer_question","decimal_question","date_question","Time_question","Date_Time_question","select_multiple_question","select_one_question","geopoint_question","barcode_question"@END_LINE;"0909707606","sent using wss to the mobile device 0909707606 #9","11","12.5","2012-07-06","23:59:59","2012-07-21T23:59:59","option_a option_c","option_3","10.687 106.23 5420","898777907"


  • The “@mobileNumber” is a system field. If this field is blank or omitted, the submitted record status will be set to “Pending”. Otherwise, the record will be delivered to the mobile unit whose mobile number is set in this field and the status set to "Sent".
  • "@Scheduled_Time" is a system field. If the dispatch job should be started at a specific time, populate this field with a date and time value. Use ISO format (e.g. "2012-07-21T23:59:59") in the local time zone of the account.
  • "@Scheduled_Duration_Hour" is a system field. Only valid if @Scheduled_Time is populated. The number of hours the dispatch job is expected to take.

listDispatch

Return a list of Records headers based on status, only included RecordKey, and base header fields(MobileNumber, Date Completed, Date Submitted).

...

An example of a reponse in CSV format:

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="no"?>

...


<Root version="1.0">

...


    <StatusCode>200</StatusCode>

...


    <ErrorMessage>Success</ErrorMessage>

...


    <Data>

...


        <error_message/>

...


        <error_code/>

...


        <Result>

...


            <![CDATA[key, tableName, description, columnsName

...


                aglteWRvZm9ybXNyFQsSDkxvb2t1cFRhYmxlTXN0GIIGDA,"DS1","Sample Table 1","STATION,STATION_NAME,ELEVATION,LATITUDE,LONGITUDE,DATE,HLY-CLDH-NORMAL,Completeness Flag,HLY-HTDH-NORMAL,Completeness Flag"

...


                aglteWRvZm9ybXNyFQsSDkxvb2t1cFRhYmxlTXN0GJEGDA,"DS2","Sample Table 2","STATION,STATION_NAME,ELEVATION,LATITUDE,LONGITUDE,DATE,HLY-CLDH-NORMAL,Completeness Flag,HLY-HTDH-NORMAL,Completeness Flag"]]>

...


    </Data>

...


</Root>


getLookupTableData

Get the content of a Lookup Table. Note that this method is subject to the Use Limits described above.

...

An example of a reponse in CSV format

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="no"?>

...


<Root version="1.0">

...


    <StatusCode>200</StatusCode>

...


    <ErrorMessage>Success</ErrorMessage>

...


    <Data>

...


        <error_message/>

...


        <error_code/>

...


        <Result>

...


            <![CDATA["STATION","STATION_NAME","ELEVATION","LATITUDE","LONGITUDE","DATE","HLY-CLDH-NORMAL","Completeness Flag","HLY-HTDH-NORMAL","Completeness Flag" "GHCND:USW00003947","KANSAS CITY INTERNATIONAL AIRPORT MO US","306.3","39.2972","-94.7306","20100101 00:00","0","C","375","C" "GHCND:USW00003947","KANSAS CITY INTERNATIONAL AIRPORT MO US","306.3","39.2972","-94.7306","20100101 01:00","0","C","380","C" "GHCND:USW00003947","KANSAS CITY INTERNATIONAL AIRPORT MO US","306.3","39.2972","-94.7306","20100101 02:00","0","C","384","C"]]>

...


        </Result>

...


    </Data>

...


</Root>

addLookupTableData

Add a new Lookup Table. Note that this method is subject to the Use Limits described above.

...

An example DATA SOURCE parameter:

Code Block
"STATION","STATION_NAME","ELEVATION","LATITUDE","LONGITUDE","DATE","HLY-CLDH-NORMAL","Completeness Flag","HLY-HTDH-NORMAL","Completeness Flag"@END_LINE;"GHCND:USW00003947","KANSAS CITY INTERNATIONAL AIRPORT MO US","306.3","39.2972","-94.7306","20100101 00:00","0","C","375","C"@END_LINE; "GHCND:USW00003947","KANSAS CITY INTERNATIONAL AIRPORT MO US","306.3","39.2972","-94.7306","20100101 01:00","0","C","380","C"

updateLookupTableData

Update an existing Lookup Table. Note that this method is subject to the Use Limits described above.

...

  • Where:
  • [ACCOUNT NAME]: your doForms account name
  • [EMAIL]: The email address which used to login into mydoForms
  • [PASSWORD]: The password which used to login into mydoForms
  • [LU NAME]: The Lookup Table name
  • [DESCRIPTION]: The Lookup Table description
  • [LU KEY]: The Lookup Table key which returned by getLookupTableList
  • [DATA SOURCE]: The datasource in CSV format. The @END_LINE; is used as a carriage return for each row and the first row is the header. Note: the number of fields in the new datasource must be same withthe current datasource.
  • [ResponseFormat]: 1 = CSV, 2 = XML, 3 = JSON

An example DATA SOURCE:

Code Block
"STATION","STATION_NAME","ELEVATION","LATITUDE","LONGITUDE","DATE","HLY-CLDH-NORMAL","Completeness Flag","HLY-HTDH-NORMAL","Completeness Flag"@END_LINE;"GHCND:USW00003947","KANSAS CITY INTERNATIONAL AIRPORT MO US","306.3","39.2972","-94.7306","20100101 00:00","0","C","375","C"@END_LINE; "GHCND:USW00003947","KANSAS CITY INTERNATIONAL AIRPORT MO US","306.3","39.2972","-94.7306","20100101 01:00","0","C","380","C"

appendLookupTableData2

Append new rows to an existing Lookup Table. Note that this method is subject to the Use Limits described above.

...

  • [ACCOUNT NAME]: your doForms account name
  • [EMAIL]: The email address which used to login into mydoForms
  • [PASSWORD]: The password which used to login into mydoForms
  • [LU NAME]: The Lookup Table name
  • [DESCRIPTION]: The Lookup Table description
  • [LU KEY]: The Lookup Table key which returned by getLookupTableList
  • [DATA SOURCE]: The datasource in CSV format. The @END_LINE; is used as a carriage return for each row and the first row is the header. Note: the number of fields in the new datasource must be same with the current datasource.
  • [RESPONSE FORMAT]: 1 = CSV, 2 = XML, 3 = JSON
  • [COMPLETE]: 1 if this is the last append call. 0 if additional append calls will be made.

An example DATA SOURCE:

Code Block
"STATION","STATION_NAME","ELEVATION","LATITUDE","LONGITUDE","DATE","HLY-CLDH-NORMAL","Completeness Flag","HLY-HTDH-NORMAL","Completeness Flag"@END_LINE; "GHCND:USW00003947","KANSAS CITY INTERNATIONAL AIRPORT MO US","306.3","39.2972","-94.7306","20100101 00:00","0","C","375","C"@END_LINE; "GHCND:USW00003947","KANSAS CITY INTERNATIONAL AIRPORT MO US","306.3","39.2972","-94.7306","20100101 01:00","0","C","380","C"

deleteLookupTableData

Delete all rows of an existing Lookup Table.

...