GetByTime Method

This method is used to retrieve information about entities that have been created or modified within a particular time period. Multiple information fields may be specified depending on the information required. The GetFields Method can be used to determine all the available information fields.

Arguments

1. string Reference
2. DataSet RequestDataSet

Reference should contain the Reference returned by the Login Method and is used to identify the user of the Web Service.

RequestDataSet should contain a Parameters DataTable with a single row and the following columns:

• Type of Change
  Specifies whether information is required for newly created entities, modified entities or both
  Values can be:
  
  • 1 for New
  • 2 for Updated
  • 3 for New or Updated
• From Time
  Specifies the start of the time period within which entities that have been created or modified will be included in the response
  Note that the time must be specified as Universal Coordinated time (UTC)
  A variety of time formats are acceptable but the suggested format is, for example, 06 Apr 2009 06:10:30
• To Time (optional)
  Specifies the end of the time period within which entities that have been created or modified will be included in the response
  If this column is not specified, the current time is assumed
  Note that the time must be specified as Universal Coordinated time (UTC)
  A variety of time formats are acceptable but the suggested format is, for example, 06 Apr 2009 06:10:30

and a Data DataTable with zero rows and the following columns defining which fields are required:

• <Field 1>
• <Field 2>
• ...

Response

1. DataSet ResponseDataSet

ResponseDataSet will contain a Status DataTable with the following columns:

• Code
  0 for success or any other value for failure
• Text
  Descriptive status text

and a Data DataTable with zero or more rows and the following columns:

• <Field 1>
  Field value
• <Field 2>
  Field value
• ...
• Creation Time
  The time the entity was created
  This column will not be present if only modified entities are required
• Update Time
  The time the entity was last modified
  This column will not be present if only newly created entities are required

Example

The following Web Service call to retrieve information on a particular Contact:

GetByTime("18,23", RequestDataSet)

where RequestDataSet contains the following Parameters DataTable:

Type of Change	From Time
3	21 Jan 2010 12:45:00

and the following Data DataTable:

Contact Title	Contact Given Names	Contact Family Name	Contact Company

could produce a DataSet with the following Status DataTable:

Code	Text
0	OK

and the following Data DataTable:

Contact Title	Contact Given Names	Contact Family Name	Contact Company	Creation Time	Update Time
Miss	Angela	Ardley	AA Booksellers	09 May 2010 09:21:00	29 Jul 2010 17:54:03
Mrs	Beryl	Bainbridge	BB Office Supplies	13 Feb 2009 12:14:47	04 Feb 2010 10:06:33
Mr	Harvey	HeadBanger	Hard Rock Guitars	17 Aug 2009 05:15:00