Bxp API APP - Function - Diary

From All n One's bxp software Wixi

Jump to: navigation, search

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" ?>
	<dtePeriodStart>2015-01-01 00:00:00</dtePeriodStart>
	<dtePeriodEnd>2015-01-02 00:00:00</dtePeriodEnd>
		<title>Demo Item 1</title>
		<title>Demo Item 2</title>
		<title>Demo Item 3</title>


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