getTableRecord
This method allows viewing active records from a SoftExpert Form pivot table. To use this method, it is necessary to follow the standard documented below:
Java class | |
---|---|
Request | web/wwwroot/ws/java/form/GetTableRecordRequestType.java |
Return | web/wwwroot/ws/java/form/GetTableRecordResponseType.java |
Request:
ID # | Required | Description |
---|---|---|
TableID | X | Table ID # |
Pagination | X | Pagination number. If no value is entered, it will be considered 1. If it is less than 1, an error will return. |
TableFieldID | ID # of the table field to be filtered | |
TableFieldValue | Value of the table field to be filtered. Notes according to the field type: • Number: numeric digits without thousand and decimal separators • Decimal: numeric digits without thousand separator and with period (.) as decimal separator • Date: YYYY-MM-DD • Time: HH:MM • Boolean: 0 or 1 |
Request structure:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:form">
<soapenv:Header/>
<soapenv:Body>
<urn:getTableRecord>
<!--You may enter the following 3 items in any order-->
<urn:TableID>testeapi</urn:TableID>
<urn:Pagination>1</urn:Pagination>
</urn:getTableRecord>
</soapenv:Body>
</soapenv:Envelope>
Return:
ID # | Description |
---|---|
Status | SUCCESS: SUCCESS FAILURE: FAILURE |
Code | SUCCESS: • 1 - If the method request was successful and records were found • 2 - If the method request was successful, but there are over 1000 records, indicating a new request must be made with pagination increase • 3 - If the method request was successful, but no records were found FAILURE: Negative return code |
Detail | SUCCESS: Â Success return description FAILURE: Description of the error that was found |
TotalPagination | SUCCESS: Total number of pages found |
RecordList | SUCCESS: • In the case of fields of the file type, a hash will return, which may be used later in the DOWNLOAD method to download the file. • An array with the records that were found will return. If there are no records, an empty array will return. • The method will only return 1000 records per request. If there are more than 1000 records, a new request with a pagination increase will be necessary. FAILURE: Description of the error that was found |