Service Directory > v32.1 > Settlement_Services > Get_Bank_Institution_Record_Branches
 

Operation: Get_Bank_Institution_Record_Branches

Web service to get Bank Institution Record Branches from workday.


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

Get Bank Institution Record Branches Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Bank_Institution_Record_Branch_Request_Reference  [0..1]  Request References   
Request_Criteria [Choice]   Bank_Institution_Record_Branches_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Bank_Institution_Record_Branches_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Bank_Institution_Record_Branches_Response

Get Bank Institution Record Branches Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Bank_Institution_Record_Branch_Request_Reference  [0..*]  Request References   
Request_Criteria  Bank_Institution_Record_Branches_Request_Criteria  [0..*]  Request Criteria   
Response_Filter  Response_Filter  [0..*]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Bank_Institution_Record_Branches_Response_Group  [0..*]  Response Group   
Response_Results  Response_Results  [0..*]  Response Results   
Response_Data  Bank_Institution_Record_Branches_Response_Data  [0..*]  Response Data   
top
 

Bank_Institution_Record_Branch_Request_Reference

part of: Get_Bank_Institution_Record_Branches_Request, Get_Bank_Institution_Record_Branches_Response
Request Reference
 
Parameter name Type/Value Cardinality Description Validations
Bank_Institution_Record_Branch_Reference  Bank_Institution_BranchObject  [1..*]  Bank Institution Record Branch Reference   
top
 

Bank_Institution_BranchObject

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

Bank_Institution_BranchObjectID

part of: Bank_Institution_BranchObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Bank_Institution_Record_Unique_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [1..1]  The unique identifier type of a parent object   
top
 

Bank_Institution_Record_Branches_Request_Criteria

part of: Get_Bank_Institution_Record_Branches_Request, Get_Bank_Institution_Record_Branches_Response
Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Country_Reference  CountryObject  [1..*]  Country References   
Bank_Name  string  [0..1]  Bank Name   
Bank_ID  string  [0..1]  Bank ID   
Branch_Name  string  [0..1]  Branch Name   
Branch_ID  string  [0..1]  Branch ID Number   
top
 

CountryObject

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

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [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_Bank_Institution_Record_Branches_Request, Get_Bank_Institution_Record_Branches_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
 

Bank_Institution_Record_Branches_Response_Group

part of: Get_Bank_Institution_Record_Branches_Request, Get_Bank_Institution_Record_Branches_Response
Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Bank_Institution_Record_Branches_Response_Data

part of: Get_Bank_Institution_Record_Branches_Response
Get Bank Institution Record Branches Response
 
Parameter name Type/Value Cardinality Description Validations
Bank_Institution_Record_Branch  Bank_Institution_Record_Branch  [0..*]  Bank Institution Record Branch   
top
 

Bank_Institution_Record_Branch

part of: Bank_Institution_Record_Branches_Response_Data
Bank Institution Record Branch
 
Parameter name Type/Value Cardinality Description Validations
Bank_Institution_Record_Branch_Reference  Bank_Institution_BranchObject  [0..1]  Bank Institution Record Branch Reference   
Bank_Institution_Record_Branch_Data  Branch_Data  [0..1]  Bank Institution Record Branch Data 
Validation Description
Enter or omit a Bank Name. You need a Bank Name to create a branch. If the branch already exists, enter or omit the Bank Name.   
Enter or omit Bank ID, Branch ID, or Bank Identification Code. The resulting branches must have 1 or more of these fields.   
Enter a region that is available for the country. This region isn't available for the country.   
 
top
 

Branch_Data

part of: Bank_Institution_Record_Branch
Bank Institution Record Branch Data
 
Parameter name Type/Value Cardinality Description Validations
Record_Action_Reference  Bank_Institution_Record_ActionObject  [1..1]  Action to take on Bank Institution Record.   
Country_Reference  CountryObject  [1..1]  Country Reference   
Unique_ID  string  [1..1]  Unique ID   
Bank_ID  string  [0..1]  Bank ID   
Bank_Name  string  [0..1]  Bank Name   
Alternate_Bank_Name  string  [0..1]  Alternate Bank Name   
Branch_ID  string  [0..1]  Branch ID   
Branch_Name  string  [0..1]  Branch Name   
Alternate_Branch_Name  string  [0..1]  Alternate Branch Name   
Bank_Identification_Code  string  [0..1]  Bank Identification Code   
Address_Line  string  [0..1]  Address Line   
Alternate_Address_Line  string  [0..1]  Alternate Address Line   
City  string  [0..1]  City   
Alternate_City  string  [0..1]  Alternate City   
Region_Reference  Country_RegionObject  [0..1]  Region Reference   
Postal_Code  string  [0..1]  Postal Code   
Validation Description
Enter or omit a Bank Name. You need a Bank Name to create a branch. If the branch already exists, enter or omit the Bank Name.   
Enter or omit Bank ID, Branch ID, or Bank Identification Code. The resulting branches must have 1 or more of these fields.   
Enter a region that is available for the country. This region isn't available for the country.   
top
 

Bank_Institution_Record_ActionObject

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

Bank_Institution_Record_ActionObjectID

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

Country_RegionObject

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

Country_RegionObjectID

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

Bank_Institution_BranchReferenceEnumeration

part of: Bank_Institution_BranchObjectID
Base Type
string
top
 

Base Type
string

top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Bank_Institution_Record_ActionReferenceEnumeration

part of: Bank_Institution_Record_ActionObjectID
Base Type
string
top
 

Country_RegionReferenceEnumeration

part of: Country_RegionObjectID
Base Type
string
top