Bxp API APP - Function - Diary
From All n One's bxp software Wixi
1 Overview
This function is part of the bxp API App suite of functions. Bxp_API_-_APP_API
2 Diary Function
Primary Function: Provide listing of diary events
You must post five key pair values. (not including the semi colons)
- strFunction:diary
- strSystem:client_demo
- intClient_Id:123
- strClient_SessionField:asdfasdfasdf
- intDiary:1
The strFunction setting can have a number of settings.
- diary - defaults for today
- diary_today - explicitly today listing
- diary_tomorrow - explicitly tomorrow listing
- diary_thisweek - explicitly this week listing
- diary_nextweek - explicitly next week listing
- diary_thismonth - explicitly this month listing
- diary_nextmonth - explicitly next month listing
The intDiary is the specific diary to be queried.
The system will respond with XML.
<?xml version="1.0" encoding="UTF-8" ?>
<data>
<strFunction>diary_today</strFunction>
<intErrorId>0</intErrorId>
<strError></strError>
<dtePeriodStart>2015-01-01 00:00:00</dtePeriodStart>
<dtePeriodEnd>2015-01-02 00:00:00</dtePeriodEnd>
<item>
<id>2490</id>
<title>Demo Item 1</title>
<start>2015-01-03T14:30:00</start>
<end>2015-01-03T17:30:00</end>
<url>../appointment/userTimeEvent_Edit-details.asp?intTime_Event_Id=2490</url>
</item>
<item>
<id>2491</id>
<title>Demo Item 2</title>
<start>2015-01-06T14:00:00</start>
<end>2015-01-06T15:30:00</end>
<url>../appointment/userTimeEvent_Edit-details.asp?intTime_Event_Id=2491</url>
</item>
<item>
<id>1171</id>
<title>Demo Item 3</title>
<start>2015-01-08T10:00:00</start>
<end>2015-01-08T14:00:00</end>
<url>../appointment/userTimeEvent_Edit-details.asp?intTime_Event_Id=1171</url>
</item>
</data>
Notes:
- Each item represents a calendar entry. Id is unique for each entry.
- All titles are HTML encoded.
- Time is separated with a T.
- The URL represents navigation within the bxp system to be able to edit that item.