Table of Contents

Search

  1. Preface
  2. Introduction to Services Integration Framework
  3. Setting Up the SIF SDK
  4. Request and Response Objects
  5. Transactions and Exception Handling
  6. ORS-Specific SIF API
  7. Asynchronous SIF Requests
  8. ORS-Specific JMS Event Messages
  9. Using Security Access Manager
  10. Using Dynamic Data Masking
  11. SIF API Reference
  12. Troubleshooting
  13. Appendix A: Identifiers
  14. Appendix B: Frequently Asked Questions

Services Integration Framework Guide

Services Integration Framework Guide

GetEffectivePeriods

GetEffectivePeriods

The GetEffectivePeriods API retrieves the aggregate effective period for the specified base object record.
The GetEffectivePeriods request contains the key to the base object record for which the aggregate effective period must be retrieved. The response contains a list that includes all effective periods for the requested base object record.

Required Parameter

The RecordKey parameter is required to uniquely identify the record for which the aggregate effective period must be retrieved.

Optional Parameter

The HistoryDate parameter specifies the date for which you retrieve base object data that is effective at the specified point in time. If HistoryDate is equal to or earlier than HIST_CREATE_DATE, no records are returned.
For Oracle environments, milliseconds for HistoryDate are truncated. If HistoryDate is later than HIST_CREATE_DATE by less than a second, no records are returned. If you have Daylight Saving Time (DST) enabled for the operating system and HistoryDate is later than HIST_CREATE_DATE by less than one hour during DST, no records are returned.
HistoryDate must be used only for timeline-enabled base objects.

Use Case

The following is a common scenario for using the GetEffectivePeriods request:
Retrieve the period for which a customer's billing address is valid.

Usage Example

The following example gets the effective period for a record with ROWID_OBJECT key 28 from the base object C_BO:
GetEffectivePeriodsRequest req=new GetEffectivePeriodsRequest(); RecordKey rec=new RecordKey(); rec.setRowid("28"); req.setRecordKey(rec); req.setSiperianObjectUid("BASE_OBJECT.C_BO"); GetEffectivePeriodsResponse response = (GetEffectivePeriodsResponse)sipClient.process(req);

0 COMMENTS

We’d like to hear from you!