Service Directory > v31.2 > Revenue_Management > Get_Subrecipient_Risk_Records
 

Operation: Get_Subrecipient_Risk_Records

Retrieves Subrecipient Risk Records for the specified request references or criteria. If neither are specified, all Subrecipient Risk Records are returned.


@ - 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_Subrecipient_Risk_Records_Request

Element containing request references, criteria, filter and response group for getting Subrecipient Risk Record data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Subrecipient_Risk_Record_Request_References  [0..1]  Element containing references to Subrecipient Risk Records.   
Request_Criteria [Choice]   Subrecipient_Risk_Record_Request_Criteria  [0..1]  Element containing request criteria for finding Subrecipient Risk Records.   
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_Group  Subrecipient_Risk_Record_Response_Group  [0..1]  Element containing Subrecipient Risk Record response grouping options.   
top
 

Response Element: Get_Subrecipient_Risk_Records_Response

Element containing Subrecipient Risk Record response elements.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Subrecipient_Risk_Record_Request_References  [0..1]  Element containing references to Subrecipient Risk Records.   
Request_Criteria  Subrecipient_Risk_Record_Request_Criteria  [0..1]  Element containing request criteria for finding Subrecipient Risk Records.   
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_Group  Subrecipient_Risk_Record_Response_Group  [0..1]  Element containing Subrecipient Risk Record response grouping options.   
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  Subrecipient_Risk_Record_Response_Data  [0..1]  Element containing Subrecipient Risk Record instances and data.   
top
 

Subrecipient_Risk_Record_Request_References

part of: Get_Subrecipient_Risk_Records_Request, Get_Subrecipient_Risk_Records_Response
Element containing references to Subrecipient Risk Records.
 
Parameter name Type/Value Cardinality Description Validations
Subrecipient_Risk_Record_Reference  Risk_EvaluationObject  [1..*]  References to Subrecipient Risk Records   
top
 

Risk_EvaluationObject

part of: Subrecipient_Risk_Record_Request_References, Subrecipient_Risk_Record
 
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  Risk_EvaluationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Risk_EvaluationObjectID

part of: Risk_EvaluationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Risk_Evaluation_Reference_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
 

Subrecipient_Risk_Record_Request_Criteria

part of: Get_Subrecipient_Risk_Records_Request, Get_Subrecipient_Risk_Records_Response
Element containing request criteria for finding Subrecipient Risk Records.
 
Parameter name Type/Value Cardinality Description Validations
Subrecipient_Reference  Subrecipient_AbstractObject  [0..1]  Subrecipient for the Risk Records.   
top
 

Subrecipient_AbstractObject

part of: Subrecipient_Risk_Record_Request_Criteria, Subrecipient_Risk_Record_Data
 
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  Subrecipient_AbstractObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Subrecipient_AbstractObjectID

part of: Subrecipient_AbstractObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Supplier_ID, Supplier_Reference_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_Subrecipient_Risk_Records_Request, Get_Subrecipient_Risk_Records_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
 

Subrecipient_Risk_Record_Response_Group

part of: Get_Subrecipient_Risk_Records_Request, Get_Subrecipient_Risk_Records_Response
Element containing Subrecipient Risk Record response grouping options.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean flag to include Reference in response.   
top
 

Response_Results

part of: Get_Subrecipient_Risk_Records_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
 

Subrecipient_Risk_Record_Response_Data

part of: Get_Subrecipient_Risk_Records_Response
Element containing Subrecipient Risk Record instances and data.
 
Parameter name Type/Value Cardinality Description Validations
Subrecipient_Risk_Record  Subrecipient_Risk_Record  [0..*]  Element containing a Subrecipient Risk Record Reference and all data for the single Subrecipient Risk Record.   
top
 

Subrecipient_Risk_Record

part of: Subrecipient_Risk_Record_Response_Data
Element containing a Subrecipient Risk Record Reference and all data for the single Subrecipient Risk Record.
 
Parameter name Type/Value Cardinality Description Validations
Subrecipient_Risk_Record_Reference  Risk_EvaluationObject  [0..1]  Reference to the Subrecipient Risk Record for which data is returned.   
Subrecipient_Risk_Record_Data  Subrecipient_Risk_Record_Data  [0..1]  Element containing data for a single Subrecipient Risk Record. 
Validation Description
End Date must be equal to or greater than the Start Date.  End Date must be equal to or greater than the Start Date. 
 
top
 

Subrecipient_Risk_Record_Data

part of: Subrecipient_Risk_Record
Element containing data for a single Subrecipient Risk Record.
 
Parameter name Type/Value Cardinality Description Validations
Subrecipient_Risk_Record_ID  string  [0..1]  The Reference ID of this Subrecipient Risk Record. 
Validation Description
ID provided is in use but is not for a Subrecipient Risk Record.  ID provided is in use but is not for a Subrecipient Risk Record. 
The Subrecipient Risk Record entered does not belong to the Subrecipient.  The Subrecipient Risk Record entered does not belong to the Subrecipient. 
 
Subrecipient_Reference  Subrecipient_AbstractObject  [1..1]  Reference to the Subrecipient this Subrecipient Risk Record is for. 
Validation Description
Risk Records can only be entered for Subrecipients. Please provide a Subrecipient's ID.   
 
Start_Date  date  [0..1]  The start date of this Subrecipient Risk Record.   
End_Date  date  [0..1]  The end date of this Subrecipient Risk Record.   
Evaluation_Date  date  [0..1]  The evaluation date of this Subrecipient Risk Record.   
Risk_Level_Reference  Risk_Evaluation_LevelObject  [0..1]  The risk level for this Subrecipient Risk Record.   
Comments  RichText  [0..1]  Comments for this Subrecipient Risk Record.   
URL  RichText  [0..1]  The URL for this Subrecipient Risk Record.   
Attachment_Data  Financials_Attachment_Data  [0..*]  Encapsulating element containing all Business Document Attachment data. 
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
 
Validation Description
End Date must be equal to or greater than the Start Date.  End Date must be equal to or greater than the Start Date. 
top
 

Risk_Evaluation_LevelObject

part of: Subrecipient_Risk_Record_Data
 
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  Risk_Evaluation_LevelObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Risk_Evaluation_LevelObjectID

part of: Risk_Evaluation_LevelObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Risk_Evaluation_Level_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
 

Financials_Attachment_Data

part of: Subrecipient_Risk_Record_Data
Encapsulating element containing all Business Document Attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
@Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
@Encoding  string  [1..1]  Text attribute identifying Encoding of the Attachment.   
@Compressed  boolean  [1..1]  Boolean attribute identifying whether the Attachment is compressed.   
File_Content  base64Binary  [0..1]  File content in binary format.   
Comment  string  [0..1]  Comment   
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
top
 

Risk_EvaluationReferenceEnumeration

part of: Risk_EvaluationObjectID
Base Type
string
top
 

Subrecipient_AbstractReferenceEnumeration

part of: Subrecipient_AbstractObjectID
Base Type
string
top
 

Risk_Evaluation_LevelReferenceEnumeration

part of: Risk_Evaluation_LevelObjectID
Base Type
string
top
 

RichText

part of: Subrecipient_Risk_Record_Data, Subrecipient_Risk_Record_Data
Base Type
string
top