Service Directory > v31.2 > Payroll_GBR > Get_Company_Vehicles
 

Operation: Get_Company_Vehicles

Provides the ability to retrieve all or some Company Vehicles.


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

Company Vehicles Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Company_Vehicle_Request_References  [0..1]  Company Vehicle Request References   
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  Company_Vehicle_Response_Group  [0..1]  Company Vehicle Response Group   
top
 

Response Element: Get_Company_Vehicles_Response

Company Vehicles Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Company_Vehicle_Request_References  [0..1]  Company Vehicle Request References   
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  Company_Vehicle_Response_Group  [0..1]  Company Vehicle 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  Company_Vehicle_Response_Data  [0..1]  Company Vehicle Response   
top
 

Company_Vehicle_Request_References

part of: Get_Company_Vehicles_Response, Get_Company_Vehicles_Request
Company Vehicle Request References
 
Parameter name Type/Value Cardinality Description Validations
Company_Vehicle_Reference  Company_VehicleObject  [1..*]  Company Vehicle Request Reference   
top
 

Company_VehicleObject

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

Company_VehicleObjectID

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

Company_Vehicle_Response_Group

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

Response_Results

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

Company_Vehicle_Response_Data

part of: Get_Company_Vehicles_Response
Company Vehicle Response
 
Parameter name Type/Value Cardinality Description Validations
Company_Vehicle  Company_Vehicle  [0..*]  Company Vehicle Response Data   
top
 

Company_Vehicle

part of: Company_Vehicle_Response_Data
Company Vehicle Response Data
 
Parameter name Type/Value Cardinality Description Validations
Company_Vehicle_Reference  Company_VehicleObject  [0..1]  Company Vehicle Reference   
Company_Vehicle_Data  Company_Vehicle_Data  [0..*]  Company Vehicle Data 
Validation Description
The vehicle's fuel type must be Diesel.   
 
top
 

Company_Vehicle_Data

part of: Company_Vehicle
Company Vehicle Data
 
Parameter name Type/Value Cardinality Description Validations
Country_of_Registration_Reference  CountryObject  [1..1]  Country of Registration   
Vehicle_ID  string  [1..1]  Vehicle ID   
Vehicle_Registration  string  [1..1]  Vehicle Registration   
Date_First_Registered  date  [1..1]  Date First Registered   
Date_Vehicle_Terminated  date  [0..1]  Date Vehicle Terminated 
Validation Description
Date Vehicle Terminated must be on or after the Date First Registered   
 
Vehicle_Type_Reference  Company_Vehicle_TypeObject  [1..1]  Vehicle Type   
Model_Reference  Vehicle_ModelObject  [1..1]  Vehicle Make and Model   
Fuel_Type_Reference  Vehicle_Fuel_TypeObject  [1..1]  Fuel Type ID   
CO2_Emissions  decimal (4, 0) >0   [0..1]  CO2 Emissions 
Validation Description
CO2 Emissions cannot be greater than 999 for UK registered vehicles reported to HMRC   
 
No_Approved_CO2_Emissions  boolean  [0..1]  No Approved CO2 Emissions   
Engine_Capacity  decimal (5, 0) >0   [0..1]  Engine Capacity   
Rotary_Engine  boolean  [0..1]  Rotary Engine   
List_Price__including_VAT_  decimal (14, 2) >0   [0..1]  List Price (including VAT) 
Validation Description
List Price plus Accessories Price must be greater than or equal to £1000.00 for UK registered vehicles reported to HMRC   
 
Accessories_Price__including_VAT_  decimal (14, 2) >0   [0..1]  Accessories Price (including VAT) 
Validation Description
List Price plus Accessories Price must be greater than or equal to £1000.00 for UK registered vehicles reported to HMRC   
 
Validation Description
The vehicle's fuel type must be Diesel.   
top
 

CountryObject

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

Company_Vehicle_TypeObject

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

Company_Vehicle_TypeObjectID

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

Vehicle_ModelObject

part of: Company_Vehicle_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_Fuel_TypeObject

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

Vehicle_Fuel_TypeObjectID

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

Company_VehicleReferenceEnumeration

part of: Company_VehicleObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Company_Vehicle_TypeReferenceEnumeration

part of: Company_Vehicle_TypeObjectID
Base Type
string
top
 

Vehicle_ModelReferenceEnumeration

part of: Vehicle_ModelObjectID
Base Type
string
top
 

Base Type
string

top
 

Vehicle_Fuel_TypeReferenceEnumeration

part of: Vehicle_Fuel_TypeObjectID
Base Type
string
top