Service Directory > v32.1 > Payroll_GBR > Get_Vehicle_Models
 

Operation: Get_Vehicle_Models

Provides the ability to retrieve all or some Vehicles Model.


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

Vehicle Models Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Vehicle_Model_Request_References  [0..1]  Vehicle Model Request References   
Request_Criteria [Choice]   Vehicle_Model_Request_Criteria  [0..1]  Vehicle Model Request Criteria   
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  Vehicle_Model_Response_Group  [0..1]  Vehicle Model Response Group   
top
 

Response Element: Get_Vehicle_Models_Response

Vehicle Model Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Vehicle_Model_Request_References  [0..1]  Vehicle Model Request Reference   
Request_Criteria  Vehicle_Model_Request_Criteria  [0..1]  Vehicle Model Request Criteria   
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  Vehicle_Model_Response_Group  [0..1]  Vehicle Model Response Group   
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  Vehicle_Model_Response_Data  [0..1]  Vehicle Model Response Data   
top
 

Vehicle_Model_Request_References

part of: Get_Vehicle_Models_Request, Get_Vehicle_Models_Response
Vehicle Model Request References
 
Parameter name Type/Value Cardinality Description Validations
Vehicle_Model_Reference  Vehicle_ModelObject  [1..*]  Vehicle Model Request Reference   
top
 

Vehicle_ModelObject

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

Vehicle_ModelObjectID

part of: Vehicle_ModelObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Vehicle_Model  [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, Company_Vehicle_Make  [1..1]  The unique identifier type of a parent object   
top
 

Vehicle_Model_Request_Criteria

part of: Get_Vehicle_Models_Request, Get_Vehicle_Models_Response
Vehicle Model Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Vehicle_Make_Reference  Vehicle_MakeObject  [0..*]  Vehicle Model Request Criteria Reference   
top
 

Vehicle_MakeObject

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

Vehicle_MakeObjectID

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

Vehicle_Model_Response_Group

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

Response_Results

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

Vehicle_Model_Response_Data

part of: Get_Vehicle_Models_Response
Vehicle Model Response Data
 
Parameter name Type/Value Cardinality Description Validations
Vehicle_Model  Vehicle_Model_Get_Data  [0..*]  Vehicle Model   
top
 

Vehicle_Model_Get_Data

part of: Vehicle_Model_Response_Data
Vehicle Model
 
Parameter name Type/Value Cardinality Description Validations
Vehicle_Model_Reference  Vehicle_ModelObject  [0..1]  Vehicle Model   
Vehicle_Model_Data  Vehicle_Model_Data  [0..*]  Vehicle Model Data   
top
 

Vehicle_Model_Data

part of: Vehicle_Model_Get_Data
Vehicle Model Data
 
Parameter name Type/Value Cardinality Description Validations
Vehicle_Make_Reference  Vehicle_MakeObject  [1..1]  Vehicle Make   
Vehicle_Model_Name  string  [1..1]  Vehicle Model Name   
top
 

Vehicle_ModelReferenceEnumeration

part of: Vehicle_ModelObjectID
Base Type
string
top
 

Base Type
string

top
 

Vehicle_MakeReferenceEnumeration

part of: Vehicle_MakeObjectID
Base Type
string
top