Skip to content

Basic of Easit GO WebAPI

GET

Request

A GET requests body for receiving items from Easit GO looks like this.

1
2
3
{
  "itemViewIdentifier": "itemViewIdentifier"
}

1
2
3
4
5
6
7
8
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="http://www.easit.com/bps/schemas">
  <soapenv:Header/>
  <soapenv:Body>
    <sch:GetItemsRequest>
      <sch:ItemViewIdentifier>importHandlerIdentifier</sch:ItemViewIdentifier>
     </sch:GetItemsRequest>
  </soapenv:Body>
</soapenv:Envelope>

Response

A response for a GET request will follow this structure.

1
2
3
4
5
6
7
8
9
{
  "columns":{},
  "items": {},
  "requestedPage": 1,
  "page": 1,
  "pageSize": 100,
  "totalNumberOfPages": 10,
  "totalNumberOfItems": 1000,
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header/>
  <soapenv:Body>
    <GetItemsResponse requestedPage="1" page="1" pageSize="100" totalNumberOfPages="10" totalNumberOfItems="1000" xmlns="http://www.easit.com/bps/schemas">
      <Columns>
        ...
      </Columns>
      <Items>
        ...
      </Items>
     </GetItemsResponse>
  </soapenv:Body>
</soapenv:Envelope>

POST

Request

A POST requests body for sending items to EasitGO looks like this.

1
2
3
4
{
  "importHandlerIdentifier": "importHandlerIdentifier",
  "itemToImport": []
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="http://www.easit.com/bps/schemas">
  <soapenv:Header/>
  <soapenv:Body>
   <sch:ImportItemsRequest>
     <sch:ImportHandlerIdentifier>importHandlerIdentifier</sch:ImportHandlerIdentifier>
     <sch:ItemToImport>
       ...
     </sch:ItemToImport>
   </sch:ImportItemsRequest>
  </soapenv:Body>
</soapenv:Envelope>

Response

A response for a GET request will follow this structure.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "importItemResult": [
   {
     "skippedOrExceptionMessage": null,
     "returnValues": null,
     "uid": null,
     "result": "OK"
   }
  ]
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header/>
  <soapenv:Body>
   <ImportItemsResponse xmlns="http://www.easit.com/bps/schemas">
     <ImportItemResult UID="null" result="OK">
       <ReturnValues/>
     </ImportItemResult>
   </ImportItemsResponse>
  </soapenv:Body>
</soapenv:Envelope>

Views (itemViewIdentifier)

A view (itemViewIdentifier) is configured in EasitGO by giving it an identifier and selecting a item view. The item view supplies the view with items and the data from those items. You cannot get any other data than the one visually present while looking at the item view in Easit GO.

More information about can be found on docs.easitgo.com.

Importhandler (importHandlerIdentifier)

A importhandler (importHandlerIdentifier) is configured in Easit GO by giving it an name, identifier and the "steps"/functions required to process received data as desired. In a nutshell, the importhandler decides what to do with the data we send to Easit GO.

More information about what functions are available and how to configure a importhandler can be found on docs.easitgo.com.