GET api/BusinessIntelligence/GetJournalPlanData?from={from}&to={to}
Get journal plan data. Used for initial load of the data. After initial fetch, the call GetUpdatedJournalPlanData should be used.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
from |
Filter data from this date (inclusive), must be before or equal to . |
date |
Required |
to |
Filter data to this date (inclusive), must be after or equal to . |
date |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of JournalPlanStatisticsDataDtoName | Description | Type | Additional Information |
---|---|---|---|
PlanId |
Internal plan id. This id might not be unique in the dataset. Any statistics counting the number of plans needs to do a distinct count. |
integer |
None. |
PlanName |
The name of the plan. |
string |
None. |
Law |
Name of the law (lagrum) for this plan. |
string |
None. |
GroupId |
Internal group id. To get a full list of group ids and names, use call getActiveGroups |
integer |
None. |
PlanType |
Name of the plan type. (Implementation plan IBIC/BBIC, Health plan) |
string |
None. |
PlanTypeId |
Internal ID of the plan type. |
integer |
None. |
Created |
The date when the plan was created. |
date |
None. |
Closed |
The date when the plan is closed. This is set specifically for health plans by the user. For implementation plans it is set when the plan's order is either replaced or archived. |
date |
None. |
Established |
The date when the plan was established. If the plan type is health plan this will always be null. |
date |
None. |
FollowUp |
The date when the plan should be followed up next. |
date |
None. |
ClientId |
Internal id of the client. Can be used to count or group data when the PNR is missing. |
integer |
None. |
ClientPnr |
Client personal number |
string |
None. |
ClientPnrGender |
Client gender according to the personal number |
character |
None. |
ClientBirthDate |
Client birth date |
date |
None. |
ClientStatus |
Client status |
ClientStatus |
None. |
OrderId |
The OrderId this Plan belongs to (if any) |
integer |
None. |
Archived |
The date this plan was archived or null if the plan is still active |
date |
None. |
Response Formats
application/json, text/json
[ { "PlanId": 1, "PlanName": "sample string 2", "Law": "sample string 3", "GroupId": 4, "PlanType": "sample string 5", "PlanTypeId": 6, "Created": "2025-05-23T20:27:55.1733534+02:00", "Closed": "2025-05-23T20:27:55.1733534+02:00", "Established": "2025-05-23T20:27:55.1733534+02:00", "FollowUp": "2025-05-23T20:27:55.1733534+02:00", "ClientId": 8, "ClientPnr": "sample string 9", "ClientPnrGender": "A", "ClientBirthDate": "2025-05-23T20:27:55.1733534+02:00", "ClientStatus": 0, "OrderId": 1, "Archived": "2025-05-23T20:27:55.1733534+02:00" }, { "PlanId": 1, "PlanName": "sample string 2", "Law": "sample string 3", "GroupId": 4, "PlanType": "sample string 5", "PlanTypeId": 6, "Created": "2025-05-23T20:27:55.1733534+02:00", "Closed": "2025-05-23T20:27:55.1733534+02:00", "Established": "2025-05-23T20:27:55.1733534+02:00", "FollowUp": "2025-05-23T20:27:55.1733534+02:00", "ClientId": 8, "ClientPnr": "sample string 9", "ClientPnrGender": "A", "ClientBirthDate": "2025-05-23T20:27:55.1733534+02:00", "ClientStatus": 0, "OrderId": 1, "Archived": "2025-05-23T20:27:55.1733534+02:00" } ]
application/xml, text/xml
<ArrayOfJournalPlanStatisticsDataDto xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <JournalPlanStatisticsDataDto> <PlanId>1</PlanId> <PlanName>sample string 2</PlanName> <Law>sample string 3</Law> <GroupId>4</GroupId> <PlanType>sample string 5</PlanType> <PlanTypeId>6</PlanTypeId> <Created>2025-05-23T20:27:55.1733534+02:00</Created> <Closed>2025-05-23T20:27:55.1733534+02:00</Closed> <Established>2025-05-23T20:27:55.1733534+02:00</Established> <FollowUp>2025-05-23T20:27:55.1733534+02:00</FollowUp> <ClientId>8</ClientId> <ClientPnr>sample string 9</ClientPnr> <ClientPnrGender>65</ClientPnrGender> <ClientBirthDate>2025-05-23T20:27:55.1733534+02:00</ClientBirthDate> <ClientStatus>Inskriven</ClientStatus> <OrderId>1</OrderId> <Archived>2025-05-23T20:27:55.1733534+02:00</Archived> </JournalPlanStatisticsDataDto> <JournalPlanStatisticsDataDto> <PlanId>1</PlanId> <PlanName>sample string 2</PlanName> <Law>sample string 3</Law> <GroupId>4</GroupId> <PlanType>sample string 5</PlanType> <PlanTypeId>6</PlanTypeId> <Created>2025-05-23T20:27:55.1733534+02:00</Created> <Closed>2025-05-23T20:27:55.1733534+02:00</Closed> <Established>2025-05-23T20:27:55.1733534+02:00</Established> <FollowUp>2025-05-23T20:27:55.1733534+02:00</FollowUp> <ClientId>8</ClientId> <ClientPnr>sample string 9</ClientPnr> <ClientPnrGender>65</ClientPnrGender> <ClientBirthDate>2025-05-23T20:27:55.1733534+02:00</ClientBirthDate> <ClientStatus>Inskriven</ClientStatus> <OrderId>1</OrderId> <Archived>2025-05-23T20:27:55.1733534+02:00</Archived> </JournalPlanStatisticsDataDto> </ArrayOfJournalPlanStatisticsDataDto>