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" |
| CreatedOnTo | DATE | Maximum Application creation date to which applications will be pulled, תאריך יצירת פניה מקסימלי אשר עד אליו ימשכו פניות |
"2023-04-03T10:30:124" |
| 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" |
| ModifiedOn | DATE | Application last modification date, תאריך עדכון אחרון של הפניה |
"2023-04-01T09:00:124" |
| 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" |
Responses
1. Shortened data list
When "Detail_level" parameter = NULL.
Complete data list
When "Detail_level" parameter = "full", includes all the fields that appear in the shortened list above and in addition.Attachments details ("Detail_level" parameter = "full")
Details of the "AttachmentDetails" object fieldApplication statuses details ("Detail_level" parameter = "full")
Details of the "StatusDetails" object fieldsProject contacts details ("Detail_level" parameter = "full")
Details of the "ContactDetails" object fieldsMessages posted in the application's message board ("Detail_level" parameter = "full")
Details of the "MessageDetails" object fieldsTasks created during the treatment ("Detail_level" parameter = "full")
Details of the "TasksDetails" object fields