Service Directory > v31.2 > Payroll_FRA > Get_DSN_Data
 

Operation: Get_DSN_Data

Return rubric values for outbound DSN processing.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_DSN_Data_Request

Get DSN Data Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  DSN_Data_Request_References  [0..1]  Element used to obtain DSN Submission references for the Get DSN Data Web Service task   
Request_Criteria  DSN_Data_Request_Criteria  [0..1]  Element used to apply filters on DSN Submission for the Get DSN Data Web Service task   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_DSN_Data_Response

Get DSN Data Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  DSN_Data_Request_References  [0..1]  Element used to obtain DSN Submission references for the Get DSN Data Web Service task   
Request_Filters  DSN_Data_Request_Criteria  [0..1]  Element used to apply filters on DSN Submission for the Get DSN Data Web Service task   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  DSN_Data_Response_Data  [0..1]  DSN Data Response Data   
top
 

DSN_Data_Request_References

part of: Get_DSN_Data_Request, Get_DSN_Data_Response
Element used to obtain DSN Submission references for the Get DSN Data Web Service task
 
Parameter name Type/Value Cardinality Description Validations
DSN_Submission_Reference  DSN_SubmissionObject  [1..1]  DSN Data Reference   
top
 

DSN_SubmissionObject

part of: DSN_Data_Request_References
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  DSN_SubmissionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

DSN_SubmissionObjectID

part of: DSN_SubmissionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, DSN_Submission_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

DSN_Data_Request_Criteria

part of: Get_DSN_Data_Request, Get_DSN_Data_Response
Element used to apply filters on DSN Submission for the Get DSN Data Web Service task
 
Parameter name Type/Value Cardinality Description Validations
DSN_Filters_Reference  DSNObject  [0..*]  DSN Request Filters   
Show_DSN_Structure  boolean  [0..1]  Set to true to display the DSN structure   
top
 

DSNObject

part of: DSN_Data_Request_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  DSNObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

DSNObjectID

part of: DSNObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, DSN_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Response_Filter

part of: Get_DSN_Data_Request, Get_DSN_Data_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_DSN_Data_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

DSN_Data_Response_Data

part of: Get_DSN_Data_Response
DSN Data Response Data
 
Parameter name Type/Value Cardinality Description Validations
DSN_Structure  DSN_Structure_EL  [0..*]  Element containing the DSN meta model   
DSN_Data  DSN_Data  [0..*]  Element containing the DSN Submission Data   
top
 

DSN_Structure_EL

part of: DSN_Data_Response_Data
Element containing the DSN meta model
 
Parameter name Type/Value Cardinality Description Validations
DSN_Block_Structure  DSN_Block_Structure_EL  [0..*]  Element containing the DSN Block structure   
top
 

DSN_Block_Structure_EL

part of: DSN_Block_Structure_EL, DSN_Structure_EL
Element containing the DSN Block structure
 
Parameter name Type/Value Cardinality Description Validations
@Name  string  [1..1]  The block name   
@Order  string  [1..1]  The block order   
@Header  string  [1..1]  The header name   
DSN_Rubric_Structure  DSN_Rubric_Structure_EL  [0..*]  Element containing the Rubric structure   
DSN_Block_Structure  DSN_Block_Structure_EL  [0..*]  Element containing the DSN Block structure   
top
 

DSN_Rubric_Structure_EL

part of: DSN_Block_Structure_EL
Element containing the Rubric structure
 
Parameter name Type/Value Cardinality Description Validations
@Order  string  [1..1]  The order   
@Type  string  [1..1]  The rubric data type   
@Name  string  [1..1]  The rubric name   
@Header  string  [1..1]  The rubric label   
DSN_Rubric_Value  DSN_Rubric_Value_EL  [0..*]  Element containing the Rubric Values   
top
 

DSN_Rubric_Value_EL

part of: DSN_Rubric_Structure_EL
Element containing the Rubric Values
 
Parameter name Type/Value Cardinality Description Validations
@Code  string  [1..1]  The rubric value code   
@Name  string  [1..1]  The rubric value name   
top
 

DSN_Data

part of: DSN_Data_Response_Data
Element containing the DSN Submission Data
 
Parameter name Type/Value Cardinality Description Validations
DSN_Block  DSN_Block  [0..1]  Element containing the DSN Block   
top
 

DSN_Block

part of: DSN_Data, DSN_Block
Element containing the DSN Block
 
Parameter name Type/Value Cardinality Description Validations
@Context_ID  string  [1..1]  Context identification for the block   
@Name  string  [1..1]  The block name   
DSN_Rubric_Detail  DSN_Rubric_Detail  [0..*]  Element containing the DSN Rubric   
DSN_Block  DSN_Block  [0..*]  Element containing the DSN Block   
top
 

DSN_Rubric_Detail

part of: DSN_Block
Element containing the DSN Rubric
 
Parameter name Type/Value Cardinality Description Validations
@Name  string  [1..1]  The rubric name   
DSN_Rubric  string  [0..1]  DSN Rubric Display ID   
top
 

DSN_SubmissionReferenceEnumeration

part of: DSN_SubmissionObjectID
Base Type
string
top
 

DSNReferenceEnumeration

part of: DSNObjectID
Base Type
string
top