Service Directory > v32.1 > Human_Resources > Get_External_Disability_Self_Identification_Records
 

Operation: Get_External_Disability_Self_Identification_Records

This operation retrieves the External Disability Self-Identification Records that are currently defined


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

Request element for Get External Disability Self-Identification Record
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   External_Disability_Self-Identification_Record_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of a Record and its data   
Request_Criteria [Choice]   External_Disability_Self-Identification_Record_Request_Criteria  [0..1]  Element containing the request criteria for an External Disability Self-Identification Record   
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_External_Disability_Self_Identification_Records_Response

Contains the response elements for the Get External Disability Self-Identification Record
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  External_Disability_Self-Identification_Record_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of a Record and its data   
Request_Criteria  External_Disability_Self-Identification_Record_Request_Criteria  [0..1]  Element containing the request criteria for an External Disability Self-Identification Record   
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  External_Disability_Self-Identification_Record_Response_Data  [0..1]  Encapsulating element containing all External Disability Self-Identification Record data.   
top
 

External_Disability_Self-Identification_Record_Request_References

part of: Get_External_Disability_Self_Identification_Records_Request, Get_External_Disability_Self_Identification_Records_Response
Utilize the Request References element to retrieve a specific instance(s) of a Record and its data
 
Parameter name Type/Value Cardinality Description Validations
External_Disability_Self_Identification_Record_Reference  External_Disability_Self-Identification_RecordObject  [1..*]  A unique identifier used to reference an External Disability Self-Identification Record   
top
 

External_Disability_Self-Identification_RecordObject

part of: External_Disability_Self-Identification_Record_Request_References, External_Disability_Self-Identification_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  External_Disability_Self-Identification_RecordObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

External_Disability_Self-Identification_RecordObjectID

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

External_Disability_Self-Identification_Record_Request_Criteria

part of: Get_External_Disability_Self_Identification_Records_Request, Get_External_Disability_Self_Identification_Records_Response
Element containing the request criteria for an External Disability Self-Identification Record
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_External_Disability_Self_Identification_Records_Request, Get_External_Disability_Self_Identification_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
 

Response_Results

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

External_Disability_Self-Identification_Record_Response_Data

part of: Get_External_Disability_Self_Identification_Records_Response
Encapsulating element containing all External Disability Self-Identification Record data.
 
Parameter name Type/Value Cardinality Description Validations
External_Disability_Self_Identification_Record  External_Disability_Self-Identification_Record  [0..*]  Reference element representing a unique instance of External Disability Self-Identification Record   
top
 

External_Disability_Self-Identification_Record

part of: External_Disability_Self-Identification_Record_Response_Data
Reference element representing a unique instance of External Disability Self-Identification Record
 
Parameter name Type/Value Cardinality Description Validations
External_Disability_Self_Identification_Record_Reference  External_Disability_Self-Identification_RecordObject  [0..1]  A unique identifier used to reference an External Disability Self-Identification Record   
External_Disability_Self_Identification_Record_Data  External_Disability_Self-Identification_Record_Data  [0..1]  Encapsulating element containing all External Disability Self-Identification Record data. 
Validation Description
Enter both a Record Reference and an Employee Reference to delete the record.   
Enter a valid Employee Reference for this record.   
You must enter either an Invitation Date, a Response Date with a Disability Status, or both.   
 
top
 

External_Disability_Self-Identification_Record_Data

part of: External_Disability_Self-Identification_Record
Encapsulating element containing all External Disability Self-Identification Record data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID for the External Disability Self-Identification Record.   
Employee_Reference  EmployeeObject  [1..1]  The employee for which the External Disability Self-Identification Record refers.   
Disability_Status_Reference  Self-Identification_of_Disability_StatusObject  [0..1]  The disability status of the External Disability Self-Identification Record.   
Invitation_Date  date  [0..1]  The invitation date for the External Disability Self-Identification Record. 
Validation Description
You can't enter a date that is in the future.   
 
Response_Date  date  [0..1]  The response date for External Disability Self-Identification Record. 
Validation Description
You can't enter a date that is in the future.   
 
Validation Description
Enter both a Record Reference and an Employee Reference to delete the record.   
Enter a valid Employee Reference for this record.   
You must enter either an Invitation Date, a Response Date with a Disability Status, or both.   
top
 

EmployeeObject

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

EmployeeObjectID

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

Self-Identification_of_Disability_StatusObject

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

Self-Identification_of_Disability_StatusObjectID

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

External_Disability_Self-Identification_RecordReferenceEnumeration

part of: External_Disability_Self-Identification_RecordObjectID
Base Type
string
top
 

EmployeeReferenceEnumeration

part of: EmployeeObjectID
Base Type
string
top
 

Self-Identification_of_Disability_StatusReferenceEnumeration

part of: Self-Identification_of_Disability_StatusObjectID
Base Type
string
top