Service Directory > v31.2 > Human_Resources > Get_Safety_Incident_Locations
 

Operation: Get_Safety_Incident_Locations

This web service allows a Safety Incident Location to be retrieved 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_Safety_Incident_Locations_Request

Get Safety Incident Locations Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Safety_Incident_Location_Request_Reference  [0..1]  Safety Incident Location Request Reference   
Request_Criteria [Choice]   Safety_Incident_Location_Request_Criteria  [0..1]  Safety Incident Location Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Safety_Incident_Location_Response_Group  [0..1]  Safety Incident Location Response Group   
top
 

Response Element: Get_Safety_Incident_Locations_Response

Get Safety Incident Locations Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Safety_Incident_Location_Request_Reference  [0..1]  Safety Incident Location Request Reference   
Request_Criteria  Safety_Incident_Location_Request_Criteria  [0..1]  Safety Incident Location Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Safety_Incident_Location_Response_Group  [0..1]  Safety Incident Location Response Group   
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Safety_Incident_Location_Response_Data  [0..1]  Safety Incident Location Response Data   
top
 

Safety_Incident_Location_Request_Reference

part of: Get_Safety_Incident_Locations_Request, Get_Safety_Incident_Locations_Response
Safety Incident Location Request Reference
 
Parameter name Type/Value Cardinality Description Validations
Safety_Incident_Location_Reference  Safety_Incident_LocationObject  [1..*]  Safety Incident Location   
top
 

Safety_Incident_LocationObject

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

Safety_Incident_LocationObjectID

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

Safety_Incident_Location_Request_Criteria

part of: Get_Safety_Incident_Locations_Request, Get_Safety_Incident_Locations_Response
Safety Incident Location Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Safety_Incident_Locations_Request, Get_Safety_Incident_Locations_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
 

Safety_Incident_Location_Response_Group

part of: Get_Safety_Incident_Locations_Request, Get_Safety_Incident_Locations_Response
Safety Incident Location Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Safety_Incident_Location_Response_Data

part of: Get_Safety_Incident_Locations_Response
Safety Incident Location Response Data
 
Parameter name Type/Value Cardinality Description Validations
Safety_Incident_Location  Safety_Incident_Location  [0..*]  Safety Incident Location   
top
 

Safety_Incident_Location

part of: Safety_Incident_Location_Response_Data
Safety Incident Location
 
Parameter name Type/Value Cardinality Description Validations
Safety_Incident_Location_Reference  Safety_Incident_LocationObject  [0..1]  Safety Incident Location   
Safety_Incident_Location_Data  Safety_Incident_Location_Data  [0..1]  Safety Incident Location Data   
top
 

Safety_Incident_Location_Data

part of: Safety_Incident_Location
Safety Incident Location Data
 
Parameter name Type/Value Cardinality Description Validations
Safety_Incident_Location_Name  string  [1..1]  Safety Incident Location Name   
Code  string  [0..1]  Code   
Safety_Incident_Location_Description  string  [0..1]  Safety Incident Location Description   
Location_Reference  LocationObject  [1..1]  Location 
Validation Description
Location must be of usage Business Site.  Location must be of usage Business Site. 
 
Government_Reporting_Agency_Reference  Government_Reporting_AgencyObject  [1..1]  Government Reporting Agency   
Related_Reporting_Agency_s_Grouping_ID  string  [1..1]  Related Reporting Agency's Grouping ID   
Inactive  boolean  [0..1]  Inactive   
top
 

LocationObject

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

LocationObjectID

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

Government_Reporting_AgencyObject

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

Government_Reporting_AgencyObjectID

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

Safety_Incident_LocationReferenceEnumeration

part of: Safety_Incident_LocationObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Government_Reporting_AgencyReferenceEnumeration

part of: Government_Reporting_AgencyObjectID
Base Type
string
top