‪...‬טוען
 

About our API

The interface can be used to GET the company's applications records from the National Infrastructure Coordination system (IS-IL) in order to handle them in the company's internal systems and to update the application's treatment status and details.

This API provides access to the following information:

  1. Application details.
  2. Contacts in the application.
  3. Treatment statuses.
  4. Documents and attachments.
  5. Location of the work area on a map (Polygon).
  6. Message board feature.
  7. Task list.
Version Description
API v1
  • Receive company's applications
  • Receive subsidiaries applications
  • Retrieving applications by range of dates or application numbers
  • Retrieving applications by treatment statuses
  • Update application status
  • Update reason of finish treatment for the application
  • Post and receive documents and attachments
  • Post and receive messages in application's message feed

How to get access


# 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.

# 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" field is mandatory.

Field name Type Description How it can be used Data sample
CompanyId STRING Company identifier, מזהה חברה Pull applications of specific company

"9b65af7-7ffa-4f16-bbe9-c58069716"

MotherCompanyId STRING Mother company identifier, מזהה חברת אם Pull subsidiaries applications

"9b65af7-7ffa-4f16-bbe9-c58069716"

ApplyNumberMin INTEGER Minimum application number from which applications will be pulled, מספר פניה מינימלי אשר ממנו ימשכו פניות עד למספר המקסימלי המצוין בשדה הבא Pull Applications by range: from ApplyNumberMin to ApplyNumberMax

"2356001"

Add two zeros instead of the "/" sign in the application number

ApplyNumberMax INTEGER Maximum application number to which applications will be pulled, מספר פניה מקסימלי אשר עד אליו ימשכו פניות Pull Applications by range

"3256002"

Add two zeros instead of the "/" sign in the application number

ApplicationStatus STRING Application status, סטטוס פניה Pull only open applications

"onlyOpen"

CreatedOnFrom DATE Minimum Application creation date from which applications will be pulled, תאריך יצירת פניה מינימלי אשר ממנו ימשכו פניות עד לתאריך המקסימלי המצוין בשדה הבא Pull applications by range: from CreatedOnFrom to CreatedOnTo

"2021-08-0108:00:00"

[YYYY-MM-DDHH:MM:SS]

CreatedOnTo DATE Maximum Application creation date to which applications will be pulled, תאריך יצירת פניה מקסימלי אשר עד אליו ימשכו פניות Pull applications by range

"2021-10-0108:00:00"

[YYYY-MM-DDHH:MM:SS]

ModifiedOn DATE Application last modification date, תאריך עדכון אחרון של הפניה Pull applications that have been modified after the specified date

"2021-10-0108:00:00"

[YYYY-MM-DDHH:MM:SS]

Detail_level STRING Detail level of returned application data, רמת פירוט הנתונים שיוחזרו על-ידי הממשק Pull an abbreviated data list or a complete data list that includes files

NULL / "full"

OwnerID STRING Application approver identifier, מזהה מטפל בפניה Pull applications by approver

"acc04bb6-b2f5-4e4c-b6fa-12f640ae111a"


Responses:

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

Field name Type Description Data sample
ApplicationID STRING Application identifier, מזהה פניה

"acc04bb6-b2f5-4e4c-b6fa-12f640ae111a"

ApplicationNumber STRING Application number in the system, מספר הפניה במערכת

"2739001"

ApplicationName STRING Application name, שם הפניה

"תיאום תכנון בשכונת הרכבת"

ProjectId STRING Project id to which the application is associated, מזהה הפרויקט אליו משויכת הפניה

"a79451-e301-49fa-a8c-309fd0b109"

ProjectName STRING Project name to which the application is associated, שם הפרויקט אליו משויכת הפניה

"כפר יונה הרחבה"

WorkingPlace STRING Description of the project location, תיאור קצר של הפרויקט

"פריסת תשתית חשמל ברחוב הרקפת בית קמה"

ProjectCompanyInitiateId STRING Identifier of the company that initiates the project, מזהה חברה היוזמת את הפרויקט

"1b7024-d03-4cb1-a070-7d1629454f"

ProjectCompanyInitiateName STRING Name of the company that initiates the project, שם החברה היוזמת את הפרויקט

"מקורות מרחב מרכז"

InitiativeCompanyVatNumber STRING BN/Vat number of the initiating company, מספר ח.פ./עוסק מורשה של החברה היוזמת

"520010472"

RecepientCompanyId STRING Recipient company identifier, מזהה החברה הנמענת/המטפלת בפניה

"682bc0-fc1-4ba-bac1-6db2985499"

RecipientCompanyVatNumber STRING Recipient company BN/Vat number, מספר ח.פ./עוסק מורשה של החברה הנמענת/המטפלת בפניה

"523460209"

RecepientCompanyName STRING Recipient company name, שם החברה הנמענת/המטפלת בפניה

"נתיבי ישראל"

ApplicationCreatedOn DATE Application creation date, תאריך יצירת פניה

"15/03/2021 12:38:08"

ApplicationModifiedOn DATE Application last modification date, תאריך עדכון אחרון של הפניה

"05/09/2021 02:11:55"

ApplicationStatusId STRING Application status identifier, מזהה סטטוס פניה

"362220c4-8646-4ab7-8c73-46b1f02fddfd"

ApplicationStatusName STRING Application status, שם סטטוס פניה

"נדרשות השלמות"

StatusCreatedOn DATE Date of change application status, תאריך שינוי סטטוס הפניה

"30/12/2020 17:36:33"

ProjectLeaderId STRING Project leader identifier, מזהה מוביל (יזם) הפרויקט

"4d388f-f5bf-446d-8b6d-9a6856aedbc4"

ProjectLeaderName STRING Project leader name, שם מוביל (יזם) הפרויקט

"מוטי לוי"

ProjectManagerId STRING Project manager identifier, מזהה מנהל הפרויקט

"4d188f-f5bf-446d-8b6d-9a6856aedbc4"

ProjectManagerName STRING Project manager name, שם מנהל הפרויקט

"עמית רותם"

ApplicationCreatedByName STRING Application creator name, שם יוצר הפניה

"נתי כהן"

ApplicationCreatedByPhone STRING Application creator phone, טלפון יוצר הפניה

"0520000000"

ApplicationCreatedByMail STRING Application creator mail,דוא"ל יוצר הפניה

"example@example.com"

PreviousOwner STRING Previous Owner,שם מטפל קודם בפניה

" "


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

Field name Type Description Data sample
RequestId STRING Request identifier, מזהה הבקשה במערכת אליה משויכת הפניה

"1b1c54ba-381b-42e4-bd94-ef41a916fe31"

RequestNumber INTEGER Request number, מספר בקשה

"2739"

ProjectNumber INTEGER Project number, מספר הפרויקט במערכת אליו משויכת הפניה

"1823"

ProjectDescription STRING Project description, תיאור קצר של הפרויקט

"החלפת קו מים ראשי"

ProjectPlaceDescription STRING Description of the project location, תיאור מיקום הפרויקט

"רחוב הרצל עפולה"

RequestTypeId STRING Request type identifier, מזהה סוג בקשה

"1b1c54ba-381b-42e4-bd94-ef41a916fe31"

RequestTypeName STRING Request type name, שם סוג הבקשה

"קבלת מידע"

ApplicaitonInternalReferenceNumber STRING Application's internal reference number, מספר סימוכין פנימי של הפניה במערכות החברה המטפלת

"4430-ab"

ReasonFinishTreatment STRING Reason of finish the treatment, סיבת סיום הטיפול בפניה (במידה והפניה בסטטוס "סיום טיפול")

"ניתן מידע"

InternalApplictionIsExists BOOLEAN Field indicating whether internal treatment exists, שדה המציין אם קיים טיפול פנימי בפניה

"FALSE"

CancelledReason STRING Reason of canceling the request, סיבת ביטול הפניה

"בקשה לא פעילה"

ApplicationLink STRING Link to the application page in the system, קישור לדף הפניה במערכת

"https://is-il.creatio.com/0/Nui/ViewModule.aspx#
CardModuleV2/UsrApplications1Page/
3cb000a6-212f-4810-b6dd-b77eb40990c2"

PolygonCreatedDate DATE Working area polygon creation date, תאריך בו נוצר פוליגון אזור העבודה

"15/03/2021 12:38:08"

AOIGeoJsonXY STRING Defining the polygon points on the new map of Israel according to X and Y axes, הגדרת נקודות פוליגון העבודה לפי הצירים על מפת ישראל החדשה

"{\"type\":\"Polygon\",\"coordinates\":[[[202971.43,669771.4],
[203011.12,669493.59],
[202746.53,669539.89],
[202865.6,669830.93],
[202971.43,669771.4]]]}"

LAT/LONGGeoJson STRING Defining polygon points on the map in global format- LAT/LNG, הגדרת נקודות פוליגון על המפה לפי הפורמט העולמי (GOOGLE MAP)

"{\"type\":\"Polygon\",\"coordinates\":[[[35.02975371222534,32.12119606768106],
[35.030179048719255,32.11869138901707],
[35.02737457509167,32.11910502888664],
[35.02863124916511,32.121731350485994],
[35.02975371222534,32.12119606768106]]]}"

AttachmentDetails Object Attached files table, טבלת מסמכים מצורפים לפניה Details of the object fields later on the page,
פירוט השדות והערכים בהמשך העמוד
StatusDetails Object Application status table, טבלת סטטוסים של הפניה Details of the object fields later on the page,
פירוט השדות והערכים בהמשך העמוד
ContactDetails Object Project contacts table, טבלת אנשי קשר בפרויקט ממנו יצאה הפניה Details of the object fields later on the page,
פירוט השדות והערכים בהמשך העמוד
MessageDetails Object Message board table, טבלת לוח הודעות בפניה Details of the object fields later on the page,
פירוט השדות והערכים בהמשך העמוד
TasksDetails Object Tasks table, טבלת משימות בפניה Details of the object fields later on the page,
פירוט השדות והערכים בהמשך העמוד

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

Field name Type Description Data sample
ApplicationID STRING Application identifier, מזהה פניה

"acc04bb6-b2f5-4e4c-b6fa-12f640ae111a"

ApplicationNumber STRING Application number in the system, מספר הפניה במערכת

"2739001"

DocumentId STRING Document identifier, מזהה מסמך

"29623025-23dc-4ca7-9af1-b8c49e82a07a"

DocumentType STRING Document type name, שם סוג המסמך

"תכנית תנוחה כללית"

DocumentCreatedOn DATE Document creation date, תאריך יצירת המסמך

"19/09/2021 14:12:19"

DocCreatedById STRING Document creator identifier, מזהה יוצר המסמך

"4d1a38f-f5bf-446d-8b6d-9a66aec4"

DocCreatedBy STRING Document creator name, שם יוצר המסמך

"נתי כהן"

DocCreatedOn DATE Date of uploading the file, תאריך העלאת הקובץ

"19/09/2021 14:12:19"

DocUploadById STRING Identifier of the person who uploaded the file, מזהה מעלה הקובץ

"4d1a38f-f5bf-446d-8b6d-9a66aec4"

DocUploadBy STRING Name of the person who uploaded the file, שם מעלה הקובץ

"רובי גורן"

DocType STRING Document type, סוג קובץ

"PDF"

DocSize STRING Document size in Bytes, גודל הקובץ

"72401"

AttachmentLink STRING Link to the attached document, לינק לקובץ המצורף

"https://is-il.creatio.com/
0/rest/FileService/GetFile/3cd768ce-
d485-4a8f-8f73-ba9b0780d6/
ea33cfb-3b7b-42c0-8235-11333fb3957"

AttachedDocumentsToRequestFile STRING Attachment identifier, מזהה קובץ מצורף

"ea33cf8b-3b7b-42c0-8235-1c1333fb3957"


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

Field name Type Description Data sample
StatusCreatedOn DATE Date of change application status, תאריך שינוי סטטוס הפניה

"19/09/2021 14:29:30"

StatusId STRING Status identifier, מזהה סטטוס

"362220c4-8646-4ab7-8c73-46b1f02fddfd"

StatusName STRING Status name, שם הסטטוס

"נדרשות השלמות"


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

Field name Type Description Data sample
ContactId STRING Contact identifier, מזהה איש קשר

"72ba9f-8a5f-421f-8469-00c917a65c"

Name STRING Contact name, שם איש קשר

"אבי רון"

Role STRING Contact role, תפקיד איש קשר במערכת

"קבלן"

JobTitle STRING Job description of the contact, תיאור תפקיד של איש הקשר

"מהנדס"

CompanyID STRING Company identifier, מזהה חברה של איש הקשר

"7d4040a-e855-4695-9039-0f2e77bdc0"

CompanyName STRING Company name, שם החברה של איש הקשר

"יורי עבודות בניה ופיתוח בע\"מ"

CompanyVatNumber STRING Company BN/Vat number, מספר ח.פ./עוסק מורשה של חברת איש הקשר

"513400554"

Email STRING Contact email, דוא"ל של איש הקשר

"kablan1@gmail.com"

MobilePhone STRING Contact mobile phone, טלפון של איש הקשר

"0500000000"


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

Field name Type Description Data sample
MessageId STRING Message identifier, מזהה הודעה

"72436804-d1cd-4d82-b77f-95140333c"

MessageCreatedById STRING Message creator identifier, מזהה יוצר ההודעה

"bcb78b27-ca52-4063-b1c5-6d3342b9f"

MessageCreatedByName STRING Message creator name, שם יוצר ההודעה

"אבי רון"

MessageCreatedOn DATE Message creation date, תאריך יצירת ההודעה

"19/09/2021 14:30:37"

MessageRecipients STRING Message Recipients, מקבלי ההודעה

"יוגב כהן"

MessageDescription STRING Message content, תוכן ההודעה

"העליתי את התוכניות שביקשת, אשמח לבדיקתך בהקדם, תודה."


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

Field name Type Description Data sample
TaskId STRING Task identifier, מזהה משימה

"da11ba4e-5847-491e-9c4f-ca8fd83663"

TaskCreatedById STRING Task creator identifier, מזהה יוצר המשימה

"bcb78b27-ca52-4063-b1c5-6d3342b9f"

TaskCreatedByName STRING Task creator name, שם יוצר המשימה

"אבי רון"

TaskCreatedOn DATE Task creation date, תאריך יצירת המשימה

"19/09/2021 14:30:37"

TaskOwnerId STRING Task owner identifier, מזהה מבצע המשימה

"4d1a388f-f5bf-446d-8b6d-9a685dbc4"

TaskOwnerName STRING Task owner name, שם מבצע המשימה

"רוני דומי"

TaskTitle STRING Task description including the required document, תיאור המשימה

"לחברת נתיבי ישראל נדרשת תוכנית תנוחה כללית בפניה 2536/8"

TaskStatusId STRING Task status identifier, מזהה סטטוס המשימה

"384d4b84-58e6-df11-971b-001d60e938c6"

TaskStatusName STRING Task status name, שם סטטוס המשימה

"לא התחיל"


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.

Field name Type Description Data sample
ApplicationId STRING Application identifier, מזהה פניה

"69b5af7-7ffa-4f16-bbe9-c5806716aff "

CompanyId STRING Company identifier, מזהה חברה

"1b70f924-d013-4cb1-a070-7d5416254f"


Fields for update:

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

Field name Type Description Data sample
InternalReferenceNumber STRING Application Internal reference number, מספר סימוכין פנימי

"345433"

ApplicationStatusId STRING Application status identifier, מזהה סטטוס פניה

"362220c4-8646-4ab7-
8c73-46b1f02fddfd"

Values from code tables

ReasonOfCompletionId STRING End of treatment reason identifier, מזהה סיבת סיום הטיפול

"a441c41d-183b-4245-90b3-5e27f4fddab5"

Values from code tables

DocumentID ARRAY Document identifier, מזהה מסמך (רשימת מסמכים נדרשים להשלמה כולל "מסמך תשובה לפונה")

["8cca8ddb-7454-4bc4-
a7eb-97cdf6c2f8a5",
"9681747a-56ac-44e7-
89a6-0a3553b2ad8c"]

Values from code tables

AttachmentFileName STRING Attachment name, שם הקובץ המצורף

"היתר חפירה.pdf"

AttachmentFile Base64 The attached file, הקובץ עצמו
SocialMessage STRING The message to be published in the message board, ההודעה שתפורסם בלוח ההודעות בפניה

"השלימו את המסמכים הנדרשים בהקדם"

ContactPerson STRING Name of the updater, שם מעדכן הפניה

"גלילאו גליליי"

ContactPersonEmail STRING Email of the updater, מייל מעדכן הפניה

"o1@example.com"

ContactPersonPhone STRING Phone of the updater, טלפון מעדכן הפניה

"0500000000"


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.