iSheets API
iSheets API version 2 - iSheet module - API - iSheet item - create

iSheets API version 2 - iSheet module - API - iSheet item - create

OVERVIEW


 

Use this method to add a new iSheet item. Multiple iSheets can be supported.

 

POST /api/3/isheet/{isheetid}/items

 

isheetid

number

The ID of the isheet

Request body

Send an iSheet item - common object - add/edit iSheet item - common object - add/edit 

Response

Case 1 : If there is an error in column data, the method will return a 403 http response for an unsuccessful request 

<items>

    <item>

        <index>1</index>

        <columns>

            <column>

                <columnid>1216</columnid>

                <status>ERROR</status>

                <statuscode>403</statuscode>

                <message>#Name is required</message>

            </column>

            <column>

                <columnid>1357</columnid>

                <status>ERROR</status>

                <statuscode>403</statuscode>

                <message>#Invalid number for pincode</message>

            </column>

        </columns>

    </item>

</items>



Case 2 : If the method is processed correctly, it will return a 200 http response for a successful request

If the operation is successful, the API returns a progressive key resource object. Using the progressive key, an API user can see the status of an iSheet item. In the case of a failure, an error object is returned with the appropriate error code.

To get the status of an iSheet item based on a progressive key

POST /api/3/progressivekeystatus/{progressive_key}

 

Name Type Description
progressive_key String

This key is returned when a long-running operation is called and can be used to find the final status of the operation

 

 

 

 

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<progressivekeyresponse>

    <items>

        <item>

            <itemid>1232</itemid>

            <status>SUCCESS</status>

            <statuscode>200</statuscode>

            <message>#Record added successfully</message>

        </item>

        <item>

            <itemid>1233</itemid>

            <status>SUCCESS</status>

            <statuscode>200</statuscode>

            <message>#Record added successfully</message>

        </item>

    </items>

</progressivekeyresponse>

 

Note: Multiple isheet records are allowed while inserting.

Comments


6 Comments

Last Updated: Jun 09,2023