Loading...
 

Data dictionary - GET application request


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

Field name Type Description Data sample
ApplicationStatus STRING Application status, סטטוס פניה "onlyOpen"
ApplyNumberMax STRING Maximum application number to which applications will be pulled, מספר פניה מקסימלי אשר עד אליו ימשכו פניות "3256002"
ApplyNumberMin STRING Minimum application number from which applications will be pulled, מספר פניה מינימלי אשר ממנו ימשכו פניות עד למספר המקסימלי המצוין בשדה הבא "2356001"
CompanyId STRING Company identifier, מזהה חברה "9b65af7-7ffa-4f16-bbe9-c58069716"
CreatedOnFrom DATE Minimum Application creation date from which applications will be pulled, תאריך יצירת פניה מינימלי אשר ממנו ימשכו פניות עד לתאריך המקסימלי המצוין בשדה הבא

"2023-01-03T17:32:544"
[YYYY-MM-DDTHH:MM:SS]
CreatedOnTo DATE Maximum Application creation date to which applications will be pulled, תאריך יצירת פניה מקסימלי אשר עד אליו ימשכו פניות

"2023-04-03T10:30:124"
[YYYY-MM-DDTHH:MM:SS]
Detail_level STRING Detail level of returned application data, רמת פירוט הנתונים שיוחזרו על-ידי הממשק NULL / "full"
FromAppSentDate DATE Minimum Application sent date from which applications will be pulled, תאריך שליחת הפניה לחברה הנמענת המינימלי אשר ממנו ימשכו פניות עד לתאריך המקסימלי המצוין בשדה הבא

"2023-01-03T17:32:544"
[YYYY-MM-DDTHH:MM:SS]
ModifiedOn DATE Application last modification date, תאריך עדכון אחרון של הפניה

"2023-04-01T09:00:124"
[YYYY-MM-DDTHH:MM:SS]
MotherCompanyId STRING Mother company identifier, מזהה חברת אם "9b65af7-7ffa-4f16-bbe9-c58069716"
OwnerID STRING Application approver identifier, מזהה מטפל בפניה "acc04bb6-b2f5-4e4c-b6fa-12f640ae111a"
ToAppSentDate DATE Maximum Application sent date to which applications will be pulled, תאריךשליחת הפניה לחברה הנמענת המקסימלי אשר עד אליו ימשכו פניות

"2023-04-03T10:30:124"
[YYYY-MM-DDTHH:MM:SS]


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

Field name Type Description Data sample
AppClassificationId STRING Application Classification Id,מזהה סיווג פניה "1d188f-f5bf-411d-8b6d-9a6856aedbc4"
AppClassificationName STRING Application Classification Name,שם סיווג פניה "התחברות לדרך"
ApplicationCreatedByMail STRING Application creator mail,דוא"ל יוצר הפניה "example@example.com"
ApplicationCreatedByName STRING Application creator name, שם יוצר הפניה "נתי כהן"
ApplicationCreatedByPhone STRING Application creator phone, טלפון יוצר הפניה "0520000000"
ApplicationCreatedOn DATE Application creation date, תאריך יצירת פניה "15/03/2021 12:38:08"
ApplicationId STRING Application identifier, מזהה פניה "acc04bb6-b2f5-4e4c-b6fa-12f640ae111a"
ApplicationModifiedOn DATE Application last modification date, תאריך עדכון אחרון של הפניה "05/09/2021 02:11:55"
ApplicationName STRING Application name, שם הפניה "תיאום תכנון בשכונת הרכבת"
ApplicationNumber STRING Application number in the system, מספר הפניה במערכת "2739001"
ApplicationOwnerId STRING Application Owner,מזהה מטפל בפניה "4d188f-f5bf-446d-8b6d-9a6856aedbc4"
ApplicationOwnerName STRING Application Owner Name,שם מטפל בפניה "שם מטפל"
ApplicationSentDate DATE Application Sent Date,תאריך שליחת הפניה לחברה הנמענת "01/05/2023 10:00:00"
ApplicationStatusId STRING Application status identifier, מזהה סטטוס פניה "362220c4-8646-4ab7-8c73-46b1f02fddfd"
ApplicationStatusName STRING Application status, שם סטטוס פניה "נדרשות השלמות"
ApplyInternalReferenceNumber STRING Internal Reference Number,מספר סימוכין פנימי של החברה הנמענת "2345"
EstimatedEndDate DATE Estimate Project End Date,תאריך סיום משוער לעבודה "30/05/2023 10:00:00"
EstimateStartDate DATE Estimate Project Start Date,תאריך התחלה משוער לעבודה "30/01/2023 17:36:33"
InitiativeCompanyVatNumber STRING BN/Vat number of the initiating company, מספר ח.פ./עוסק מורשה של החברה היוזמת "520010472"
KilometersInApplication STRING Kilometers,מספר הק"מ יחסית לכביש/קו "4-5"
NumberOfRoadOrLine STRING Number Of Road Or Line,מספר כביש/קו "8655"
NumMainProgramNum STRING Number Of Main Program,מספר תכנית ראשית "400030732-3"
PreviousOwnerId STRING Previous Owner Id,מזהה מטפל קודם בפניה "1d188f-f5bf-411d-8b6d-9a6856aedbc4"
PreviousOwnerName STRING Previous Owner,שם מטפל קודם בפניה "שם מטפל"
ProjectCompanyInitiateId STRING Identifier of the company that initiates the project, מזהה חברה היוזמת את הפרויקט "1b7024-d03-4cb1-a070-7d1629454f"
  • «
  • 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:

Field name Type Description Data sample
ActualTreatmentDaysTreater STRING Working days on the approver side,ימי עבודה בצד המטפל בפניה (סטטוס "נשלחה והועברה לטיפול") "26"
ActuaTreatmentTaysInnitiate STRING Working days on the applicant side,ימי עבודה בצד מגיש הפניה (סטטוס "נדרשות השלמות") "7"
AOICode STRING Polygon Id,מזהה פוליגון אזור העבודה "29623025-23dc-4ca7-9af1-b8c49e82a07a"
ApplicaitonInternalReferenceNumber STRING Application's internal reference number, מספר סימוכין פנימי של הפניה במערכות החברה המטפלת "4430-ab"
ApplicationCreatorCompanyId STRING Application creator company Id,מזהה חברת יוצר הפניה "11452025-23dc-4ca7-9af1-b8c49e82a07a"
ApplicationCreatorCompanyName STRING Application creator company name,שם חברת יוצר הפניה "שפיר הנדסה"
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"
ApplyNumber STRING Application number,מספר הפניה כפי שמופיע במערכת תשתיות לאומית "4239/1"
AttachmentDetails Object Attached files table, טבלת מסמכים מצורפים לפניה

Details of the object fields later on the page,
פירוט השדות והערכים בהמשך העמוד
CalanderDaysInnitiate STRING Calendar days on the applicant side,ימים קלנדרים בצד מגיש הפניה (סטטוס "נדרשות השלמות") "10"
CalanderDaysTreater STRING Calendar days on the approver side,ימים קלנדרים בצד המטפל בפניה (סטטוס "נשלחה והועברה לטיפול") "30"
CancelledReason STRING Reason of canceling the request, סיבת ביטול הפניה "בקשה לא פעילה"
ContactDetails Object Project contacts table, טבלת אנשי קשר בפרויקט ממנו יצאה הפניה

Details of the object fields later on the page,
פירוט השדות והערכים בהמשך העמוד
DateFinishTreatment DATE Application completion date,תאריך סיום טיפול בפניה "19/09/2021 14:12:19"
InternalApplictionIsExists BOOLEAN Field indicating whether internal treatment exists, שדה המציין אם קיים טיפול פנימי בפניה "FALSE"
MessageDetails Object Message board table, טבלת לוח הודעות בפניה

Details of the object fields later on the page,
פירוט השדות והערכים בהמשך העמוד
NotificationDate DATE Email sent date before closing application,תאריך שליחת מייל לפני סגירת פניה שהייתה בהשלמות מעל 60 יום "4239/1"
PolygonCreatedDate DATE Working area polygon creation date, תאריך בו נוצר פוליגון אזור העבודה "15/03/2021 12:38:08"
ProjectDescription STRING Project description, תיאור קצר של הפרויקט "החלפת קו מים ראשי"
ProjectNumber STRING Project number, מספר הפרויקט במערכת אליו משויכת הפניה "1823.1"
ProjectPlaceDescription STRING Description of the project location, תיאור מיקום הפרויקט "רחוב הרצל עפולה"
ProjectTypeDesc STRING Project Classification Description,תיאור סיווג פרויקט מיוחד (חשיבות לאומית, שבילי אופניים, קידוחים גישושים ועוד) "חשיבות לאומית"
ProjectTypeId STRING Project Classification Id,מזהה סיווג פרויקט מיוחד "11623025-23dc-4ca7-9af1-b8c49e82a07a"
ReasonFinishTreatment STRING Reason of finish the treatment, סיבת סיום הטיפול בפניה (במידה והפניה בסטטוס "סיום טיפול") "ניתן מידע"
RequestId STRING Request identifier, מזהה הבקשה במערכת אליה משויכת הפניה "1b1c54ba-381b-42e4-bd94-ef41a916fe31"
  • «
  • 1 (current)
  • 2


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"
AttachedDocumentsToRequestFile STRING Attachment identifier, מזהה קובץ מצורף "ea33cf8b-3b7b-42c0-8235-1c1333fb3957"
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"
Canceled BOOLEAN A marker indicating that a file has been canceled by the applicant, סמן לקובץ שבוטל על ידי מגיש הפניה ואין להתייחס אליו "True"/"False"
DocCreatedBy STRING Document creator name, שם יוצר המסמך "נתי כהן"
DocCreatedById STRING Document creator identifier, מזהה יוצר המסמך "4d1a38f-f5bf-446d-8b6d-9a66aec4"
DocCreatedOn DATE Date of uploading the file, תאריך העלאת הקובץ "19/09/2021 14:12:19"
DocSize STRING Document size in Bytes, גודל הקובץ "72401"
DocType STRING Document type, סוג קובץ "PDF"
DocumentCreatedOn DATE Document creation date, תאריך יצירת המסמך "19/09/2021 14:12:19"
DocumentId STRING Document identifier, מזהה מסמך "29623025-23dc-4ca7-9af1-b8c49e82a07a"
DocumentType STRING Document type name, שם סוג המסמך "תכנית תנוחה כללית"
DocUploadBy STRING Name of the person who uploaded the file, שם מעלה הקובץ "רובי גורן"
DocUploadById STRING Identifier of the person who uploaded the file, מזהה מעלה הקובץ "4d1a38f-f5bf-446d-8b6d-9a66aec4"
FileName STRING File name, שם קובץ "תכנית עבודה 4537586"


Application statuses details ("Detail_level" parameter = "full") - details of the "StatusDetails" 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"
AttachedDocumentsToRequestFile STRING Attachment identifier, מזהה קובץ מצורף "ea33cf8b-3b7b-42c0-8235-1c1333fb3957"
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"
Canceled BOOLEAN A marker indicating that a file has been canceled by the applicant, סמן לקובץ שבוטל על ידי מגיש הפניה ואין להתייחס אליו "True"/"False"
DocCreatedBy STRING Document creator name, שם יוצר המסמך "נתי כהן"
DocCreatedById STRING Document creator identifier, מזהה יוצר המסמך "4d1a38f-f5bf-446d-8b6d-9a66aec4"
DocCreatedOn DATE Date of uploading the file, תאריך העלאת הקובץ "19/09/2021 14:12:19"
DocSize STRING Document size in Bytes, גודל הקובץ "72401"
DocType STRING Document type, סוג קובץ "PDF"
DocumentCreatedOn DATE Document creation date, תאריך יצירת המסמך "19/09/2021 14:12:19"
DocumentId STRING Document identifier, מזהה מסמך "29623025-23dc-4ca7-9af1-b8c49e82a07a"
DocumentType STRING Document type name, שם סוג המסמך "תכנית תנוחה כללית"
DocUploadBy STRING Name of the person who uploaded the file, שם מעלה הקובץ "רובי גורן"
DocUploadById STRING Identifier of the person who uploaded the file, מזהה מעלה הקובץ "4d1a38f-f5bf-446d-8b6d-9a66aec4"
FileName STRING File name, שם קובץ "תכנית עבודה 4537586"


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

Field name Type Description Data sample
CompanyID STRING Company identifier, מזהה חברה של איש הקשר "7d4040a-e855-4695-9039-0f2e77bdc0"
CompanyName STRING Company name, שם החברה של איש הקשר "יורי עבודות בניה ופיתוח בע\"מ"""
CompanyVatNumber STRING Company BN/Vat number, מספר ח.פ./עוסק מורשה של חברת איש הקשר "513400554"
ContactAppointmentType STRING Contact role in the specific project, מינוי תפקיד איש הקשר "מנהל פרויקט"
ContactId STRING Contact identifier, מזהה איש קשר "72ba9f-8a5f-421f-8469-00c917a65c"
CreatedOn DATE Contact creation date, תאריך הוספת איש הקשר "19/09/2021 14:29:30"
Email STRING Contact email, דוא"ל של איש הקשר "kablan1@gmail.com"
JobTitle STRING Job description of the contact, תיאור תפקיד של איש הקשר "מהנדס"
MobilePhone STRING Contact mobile phone, טלפון של איש הקשר "0500000000"
Name STRING Contact name, שם איש קשר "אבי רון"
Role STRING Contact role, תפקיד איש קשר במערכת "קבלן"
Usrcurrent STRING Application current or previous approver, מאפשר לדעת האם איש הקשר הינו המטפל הנוכחי או הקודם בפניה "נוכחי"/"קודם"


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

Field name Type Description Data sample
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"
MessageDescription STRING Message content, תוכן ההודעה "העליתי את התוכניות שביקשת, אשמח לבדיקתך בהקדם, תודה."
MessageId STRING Message identifier, מזהה הודעה "72436804-d1cd-4d82-b77f-95140333c"
MessageRecipients STRING Message Recipients, מקבלי ההודעה "יוגב כהן"


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

Field name Type Description Data sample
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"
TaskId STRING Task identifier, מזהה משימה "da11ba4e-5847-491e-9c4f-ca8fd83663"
TaskOwnerId STRING Task owner identifier, מזהה מבצע המשימה "4d1a388f-f5bf-446d-8b6d-9a685dbc4"
TaskOwnerName STRING Task owner name, שם מבצע המשימה "רוני דומי"
TaskStatusId STRING Task status identifier, מזהה סטטוס המשימה "384d4b84-58e6-df11-971b-001d60e938c6"
TaskStatusName STRING Task status name, שם סטטוס המשימה "לא התחיל"
TaskTitle STRING Task description including the required document, תיאור המשימה "לחברת נתיבי ישראל נדרשת תוכנית תנוחה כללית בפניה 2536/8"