Service Directory > v31.2 > Cash_Management > Get_Authority_Types
 

Operation: Get_Authority_Types

Retrieves the Authority Types 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_Authority_Types_Request

The request to retrieve Authority Types.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Authority_Type_Request_References  [0..1]  Contains the reference to the Authority Type.   
Request_Criteria [Choice]   Authority_Type_Request_Criteria  [0..1]  The search criteria for the request.   
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  Authority_Type_Response_Group  [0..1]  Contains a flag that determines whether the reference is included in the response.   
top
 

Response Element: Get_Authority_Types_Response

The response which contains the Authority Type data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Authority_Type_Request_References  [0..1]  Contains the reference to the Authority Type.   
Request_Criteria  Authority_Type_Request_Criteria  [0..1]  The search criteria for the request.   
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  Authority_Type_Response_Group  [0..1]  Contains a flag that determines whether the reference is included in the response.   
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  Authority_Type_Response_Data  [0..1]  Wrapper containing the response data.   
top
 

Authority_Type_Request_References

part of: Get_Authority_Types_Request, Get_Authority_Types_Response
Contains the reference to the Authority Type.
 
Parameter name Type/Value Cardinality Description Validations
Authority_Type_Reference  Authority_TypeObject  [1..*]  Reference to the Authority Type.   
top
 

Authority_TypeObject

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

Authority_TypeObjectID

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

Authority_Type_Request_Criteria

part of: Get_Authority_Types_Request, Get_Authority_Types_Response
The search criteria for the request.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Authority_Types_Request, Get_Authority_Types_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
 

Authority_Type_Response_Group

part of: Get_Authority_Types_Request, Get_Authority_Types_Response
Contains a flag that determines whether the reference is included in the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag to determine whether the reference is included in the response.   
top
 

Response_Results

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

Authority_Type_Response_Data

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

Authority_Type

part of: Authority_Type_Response_Data
Response data containing the reference and data items.
 
Parameter name Type/Value Cardinality Description Validations
Authority_Type_Reference  Authority_TypeObject  [0..1]  Reference to the Authority Type.   
Authority_Type_Data  Authority_Type_Data  [0..*]  Authority Type data.   
top
 

Authority_Type_Data

part of: Authority_Type
Authority Type data.
 
Parameter name Type/Value Cardinality Description Validations
Authority_Type_ID  string  [0..1]  This is the Authority Type unique identifier.   
Authority_Type  string  [1..1]  This is the Authority Type in text. 
Validation Description
An Authority Type already exists with this name.   
 
Authority_Designation_Reference  Authority_DesignationObject  [1..1]  Defines whether an individual or multiple individuals are required to sign off.   
Description  string  [0..1]  This is the description of the Authority Type.   
top
 

Authority_DesignationObject

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

Authority_DesignationObjectID

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

Authority_TypeReferenceEnumeration

part of: Authority_TypeObjectID
Base Type
string
top
 

Authority_DesignationReferenceEnumeration

part of: Authority_DesignationObjectID
Base Type
string
top