Service Directory > v31.2 > Human_Resources > Get_Location_Attributes
 

Operation: Get_Location_Attributes

Public Web Service Operation for Retrieving Location Attributes


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

Get Location Attributes Request Web Service Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Location_Attribute_Request_References  [0..1]  Location Attribute Request References Web Service Element   
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_Location_Attributes_Response

Get Location Attributes Response Web Service Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Location_Attribute_Request_References  [0..1]  Location Attribute Request References Web Service Element   
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  Location_Attribute_Response_Data  [0..1]  Location Attribute Response Data Web Service Element   
top
 

Location_Attribute_Request_References

part of: Get_Location_Attributes_Request, Get_Location_Attributes_Response
Location Attribute Request References Web Service Element
 
Parameter name Type/Value Cardinality Description Validations
Location_Attribute_Reference  Location_AttributeObject  [1..*]  The Location Attribute(s) to be returned   
top
 

Location_AttributeObject

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

Location_AttributeObjectID

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

Location_Attribute_Response_Data

part of: Get_Location_Attributes_Response
Location Attribute Response Data Web Service Element
 
Parameter name Type/Value Cardinality Description Validations
Location_Attribute  Location_Attribute  [0..*]  Location Attribute Web Service Element   
top
 

Location_Attribute

part of: Location_Attribute_Response_Data
Location Attribute Web Service Element
 
Parameter name Type/Value Cardinality Description Validations
Location_Attribute_Reference  Location_AttributeObject  [1..1]  The Location Attribute reference   
Location_Attribute_Data  Location_Attribute_Data  [1..1]  The Web Service Element holding Location Attribute Data   
top
 

Location_Attribute_Data

part of: Location_Attribute
The Web Service Element holding Location Attribute Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for the Location Attribute   
Location_Attribute_Name  string  [1..1]  The Location Attribute Name 
Validation Description
Enter a Location Attribute Name not already in use.   
 
Location_Usage_Reference  Location_UsageObject  [1..*]  References the Location Usages of the Location Attribute   
Location_Attribute_Inactive  boolean  [0..1]  Location Attribute is Inactive   
top
 

Location_UsageObject

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

Location_UsageObjectID

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

Location_AttributeReferenceEnumeration

part of: Location_AttributeObjectID
Base Type
string
top
 

Location_UsageReferenceEnumeration

part of: Location_UsageObjectID
Base Type
string
top