How to get access

1. Step one: Apply and receive approval for an API account

To make any request to the API, you must first apply for an API account. Contact the system's support center and ask for an API account for your company. Once approved, you will receive a username, password, company ID and API key along with a list of addresses (URLs) to activate the service.

2. Step two: Make your first request

First, connect with your username, password, and API key. You will receive a Token which will be used in every request at the current session.
Second, make your first request!

Data dictionary - GET application request

Parameters:
These are the parameters that can be specified in the request when the "CompanyId" or "MotherCompanyId" mandatory.

Responses:
1. Shortened data list - when "Detail_level" parameter = NULL.

• «
• 1 (current)
• 2
• »

2. Complete data list - when "Detail_level" parameter = "full", includes all the fields that appear in the shortened list above and in addition:

• «
• 1 (current)
• 2
• »

Attachments details ("Detail_level" parameter = "full") - details of the "AttachmentDetails" object fields:

Application statuses details ("Detail_level" parameter = "full") - details of the "StatusDetails" object fields:

Project contacts details ("Detail_level" parameter = "full") - details of the "ContactDetails" object fields:

Messages posted in the application's message board ("Detail_level" parameter = "full") - details of the "MessageDetails" object fields:

Tasks created during the treatment ("Detail_level" parameter = "full") - details of the "TasksDetails" object fields:

Data dictionary - POST application request

Rules for updating application status and sending files:

1. Updating application status to "End treatment" (סיום טיפול):
   1. "ReasonOfCompletionId" field is mandatory
   2. "AttachmentFile" is not mandatory; however, it is highly recommended that you transfer a file explaining the terms of the approval or the reasons for the rejection.
      
      
2. Updating application status to "Completions are required" (נדרשות השלמות):
   1. DocumentID" field is mandatory - at least one document ID required for completion.
   2. Do not transfer a file on "AttachmentFile" field unless an "Answer to Applicant" document is specified on "DocumentID" field.
      
      
3. "Answer to the Applicant" document (תשובה לפונה):
   1. Used to transfer files between the approver and the applicant until the application's treatment ends. In the file attached to the document, the approver can specify instructions for the applicant or attach a template to fill and return in case the application's status is "Completions are required".
   2. The document and file can be transferred when the application's status is "Sent and transferred for treatment" or "Completions are required".
   3. File type and size: PDF up to 5 MB.
      
      

If the system detects that the update request does not comply with these rules, an error message will be returned.
להורדה בעברית

Parameters:

"ApplicationId" and "CompanyId" fields are mandatory.

Fields for update:

The values ​​of some of the fields should be taken from code tables.

Code Tables

The code tables are available for download at the following link - click here.

In the development phase use the "DEV" tables and at the end of the development use the "PROD" tables. These values ​​must be entered in the fields specified in the data dictionary.

<script>
function openContent(evt, cityName) {
  var i, tabcontent, tablinks;
  tabcontent = document.getElementsByClassName("tabcontent");
  for (i = 0; i < tabcontent.length; i++) {
    tabcontent[i].style.display = "none";
  }
  tablinks = document.getElementsByClassName("tablinks");
  for (i = 0; i < tablinks.length; i++) {
    tablinks[i].className = tablinks[i].className.replace(" active", "");
  }
  document.getElementById(cityName).style.display = "block";
  evt.currentTarget.className += " active";
}

// Get the element with id="defaultOpen" and click on it
document.getElementById("defaultOpen").click();
</script>