Service Directory > v31.2 > Cash_Management > Get_Signers
 

Operation: Get_Signers

Retrieves the Signers used within Bank Account Signatories.


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

The request to retrieve Signers.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Signer_Request_References  [0..1]  Contains the reference to the Signer.   
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_Signers_Response

The response which contains the Signer data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Signer_Request_References  [0..1]  Contains the reference to the Signer.   
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  Signer_Response_Data  [0..1]  Wrapper containing the response data.   
top
 

Signer_Request_References

part of: Get_Signers_Request, Get_Signers_Response
Contains the reference to the Signer.
 
Parameter name Type/Value Cardinality Description Validations
Signer_Reference  SignerObject  [1..*]  Reference to the Signer   
top
 

SignerObject

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

SignerObjectID

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

Signer_Response_Data

part of: Get_Signers_Response
Wrapper containing the response data.
 
Parameter name Type/Value Cardinality Description Validations
Signer  Signer  [0..*]  Response data containing the reference and data items.   
top
 

Signer

part of: Signer_Response_Data
Response data containing the reference and data items.
 
Parameter name Type/Value Cardinality Description Validations
Signer_Reference  SignerObject  [0..1]  Reference to the Signer   
Signer_Data  Signer_Data  [0..1]  Signer data.   
top
 

Signer_Data

part of: Signer
Signer data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  This is the Signer unique identifier.   
Employee_Reference [Choice]   EmployeeObject  [1..1]  Reference element representing a unique instance of Employee. 
Validation Description
Employee [employee] already exists as a Signer.   
Employee must be active (not terminated).   
The Employee cannot be changed.   
 
External_Committee_Member_Reference [Choice]   External_Committee_MemberObject  [1..1]  Reference element representing a unique instance of External Committee Member. 
Validation Description
External Committee Member [ecm] already exists as a Signer.   
External Committee Member must be active (not terminated or expired).   
The External Committee Member cannot be changed.   
 
Secured_Attachment  Attachment_Data_WWS  [0..*]  The details of a resume (resume, name, comments).   
top
 

EmployeeObject

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

External_Committee_MemberObject

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

External_Committee_MemberObjectID

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

Attachment_Data_WWS

part of: Signer_Data
The details of a resume (resume, name, comments).
 
Parameter name Type/Value Cardinality Description Validations
File_ID  string  [0..1]  The Reference ID for the resume.   
File  base64Binary  [0..1]  A comment about the resume.   
FileName  string (255)   [0..1]  The name of the resume.   
Comments  string  [0..1]  The resume that was attached for the applicant.   
top
 

SignerReferenceEnumeration

part of: SignerObjectID
Base Type
string
top
 

EmployeeReferenceEnumeration

part of: EmployeeObjectID
Base Type
string
top
 

External_Committee_MemberReferenceEnumeration

part of: External_Committee_MemberObjectID
Base Type
string
top