Versions Compared

Key

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

...

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.

...