EffectiveChanges

Generates effective change data for organizations or workers based on request parameters.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	Id of the instance
RequestCriteria_AllEffective	Bool	False	Default is false. Only set to true if you want all effective changes in the effective range. Otherwise, it will only give incremental changes entered within the entry range.
RequestCriteria_EffectiveFrom	Datetime	False	The date from which the effective moment for the request should query data for.
RequestCriteria_EffectiveTo	Datetime	False	The date up until which the entry moment for the request should query data for.
RequestCriteria_EntryMomentFrom	Datetime	False	The date from which the entry moment for the request should query data for.
RequestCriteria_EntryMomentTo	Datetime	False	The date up until which the entry moment for the request should query data for.
RequestCriteria_ExcludeWorkers	Bool	False	If set to true, workers in the "workers" request parameter will be excluded from the output. By default, the parameter is inclusive.
RequestCriteria_ExtendedAllEffectiveTo	Datetime	False	Upper limit of the optional extended all effective range.
RequestCriteria_Fields_FieldSetVersion	String	False	Version of fields that changes are requested for.
RequestCriteria_Fields_OnlyInclude_Aggregate	String	False	A list of fields that changes are requested for.
RequestCriteria_ForceRerun	Bool	False	This boolean is used to force a new request to be generated even if the same parameters as a prior request are sent. Force Rerun should only be used if the previous request is complete or has failed for some reason.
RequestCriteria_IncludeRequestCriteriaInResponse	Bool	False	Default is false. When true, the original request will be shown in the response.
RequestCriteria_Organizations_Aggregate	String	False	Organization for external data request (e.g. pay group).
RequestCriteria_ResponseFilter_AdditionalNameTypes_Aggregate	String	False	Filter Additional Names by Additional Name Types to include in output.
RequestCriteria_ResponseFilter_CountryNameFormat	String	False	Format for Country Name.
RequestCriteria_ResponseFilter_CountryRegionNameFormat	String	False	Format for Country Region Name.
RequestCriteria_ResponseFilter_ExcludeAdditionalJobs	Bool	False	Exclude Additional Job data from output.
RequestCriteria_ResponseFilter_FullSnapshot	Bool	False	If true, returns all workers in the request regardless if the worker has changes to report or not.
RequestCriteria_ResponseFilter_IncludeEndedContracts	Bool	False	Include Ended Contracts in output.
RequestCriteria_ResponseFilter_OrganizationRoles_Aggregate	String	False	Organization Roles to include in Position data section.
RequestCriteria_ResponseFilter_OrganizationTypes_Aggregate	String	False	Filter Organizations by Organization Types.
RequestCriteria_ResponseFilter_PaymentElectionRules_Aggregate	String	False	Filter Payment Elections by Payment Election Rules to include in output.
RequestCriteria_ResponseFilter_ReportPostTermCompensation	Bool	False	Include Post Termination compensation changes in output.
RequestCriteria_SchemaOnly	Bool	False	If true, the API only returns the schema file. If false, the API returns the schema file and other output files. Use this option to identify available API fields and map to external vendor fields as needed.
RequestCriteria_WorkerOverrides_Aggregate	String	False	Worker Overrides for data request.
RequestCriteria_Workers_Aggregate	String	False	Workers for data request.
ResponseData_Documents_Aggregate	String	False	IDs of documents containing data produced with the parameters of the request. One can use the Blobitory REST API to retrieve the documents.
ResponseData_Status_Descriptor	String	False	A description of the instance
ResponseData_Status_Href	String	False	A link to the instance
ResponseData_Status_Id	String	False	wid / id / reference id

ADO.NET Provider for Workday

EffectiveChanges

Columns