Service Directory > v31.2 > Payroll_GBR > Get_Company_Vehicle_Assignments
 

Operation: Get_Company_Vehicle_Assignments

This public web service operation is designed to retrieve Company Vehicle Assignments for a UK Pay Group, group of ~Workers~ or all data.


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

Get Company Vehicle Assignment Request Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Company_Vehicle_Assignment_Request_Criteria  [0..1]  Get Company Vehicle Assignment 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. 
 
top
 

Response Element: Get_Company_Vehicle_Assignments_Response

Get Company Vehicle Assignments Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Company_Vehicle_Assignment_Request_Criteria  [0..1]  Get Company Vehicle Assignment 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_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_Assignment_Response_Data  [0..1]  Company Vehicle Assignment Response Element   
top
 

Company_Vehicle_Assignment_Request_Criteria

part of: Get_Company_Vehicle_Assignments_Response, Get_Company_Vehicle_Assignments_Request
Get Company Vehicle Assignment Criteria
 
Parameter name Type/Value Cardinality Description Validations
Pay_Group_Reference [Choice]   Pay_GroupObject  [0..1]  UK Pay Group to filter retrieval of Company Vehicle Assignments   
Worker_Reference [Choice]   WorkerObject  [0..*]  Workers to filter retrieval of Company Vehicle Assignments   
top
 

Pay_GroupObject

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

Pay_GroupObjectID

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

WorkerObject

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

WorkerObjectID

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

Response_Results

part of: Get_Company_Vehicle_Assignments_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_Assignment_Response_Data

part of: Get_Company_Vehicle_Assignments_Response
Company Vehicle Assignment Response Element
 
Parameter name Type/Value Cardinality Description Validations
Company_Vehicle_Assignment  Company_Vehicle_Assignment  [0..*]  Company Vehicle Assignment Element   
top
 

Company_Vehicle_Assignment

part of: Company_Vehicle_Assignment_Response_Data
Company Vehicle Assignment Element
 
Parameter name Type/Value Cardinality Description Validations
Company_Vehicle_Assignment_Reference  Unique_IdentifierObject  [0..1]  Company Vehicle Assignment instance reference   
Company_Vehicle_Assignment_Data  Company_Vehicle_Assignment_Data  [0..*]  Company Vehicle Assignment Data   
top
 

Unique_IdentifierObject

part of: Company_Vehicle_Assignment_Capital_Contribution_Data, Company_Vehicle_Assignment_Free_Fuel_Data, Company_Vehicle_Assignment, Company_Vehicle_Assignment_Payments_Private_Use_Data, Company_Vehicle_Assignment_Unavailability_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  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

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

part of: Company_Vehicle_Assignment
Company Vehicle Assignment Data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Worker Reference   
Company_Vehicle_Reference  Company_VehicleObject  [1..1]  Vehicle ID   
From_Date  date  [1..1]  From Date   
To_Date  date  [0..1]  To Date 
Validation Description
Assigned To Date must be on or after the Assigned From Date   
 
Car_Incorrectly_Submitted_to_HMRC  boolean  [0..1]  Car Incorrectly Submitted to HMRC 
Validation Description
The Free Fuel Date Withdrawn and From dates must be the same.   
The From and To dates must be the same.   
 
Company_Vehicle_Assignment_Unavailability_Data  Company_Vehicle_Assignment_Unavailability_Data  [0..*]  Company Vehicle Assignment Unavailability Data   
Company_Vehicle_Assignment_Capital_Contribution_Data  Company_Vehicle_Assignment_Capital_Contribution_Data  [0..*]  Company Vehicle Assignment Capital Contribution Data   
Company_Vehicle_Assignment_Payments_Private_Use_Data  Company_Vehicle_Assignment_Payments_Private_Use_Data  [0..*]  Company Vehicle Assignment Payments Private Use Data   
Company_Vehicle_Assignment_Free_Fuel_Data  Company_Vehicle_Assignment_Free_Fuel_Data  [0..*]  Company Vehicle Assignment Free Fuel Data   
top
 

Company_VehicleObject

part of: Company_Vehicle_Assignment_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_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
 

Company_Vehicle_Assignment_Unavailability_Data

part of: Company_Vehicle_Assignment_Data
Company Vehicle Assignment Unavailability Data
 
Parameter name Type/Value Cardinality Description Validations
Company_Vehicle_Assignment_Unavailability_Reference  Unique_IdentifierObject  [0..1]  Company Vehicle Assignment Unavailability instance reference   
Unavailable_From_Date  date  [1..1]  Unavailable From Date 
Validation Description
Unavailability From Date must be on or after the Assignment From Date   
 
Unavailable_To_Date  date  [0..1]  Unavailable To Date 
Validation Description
Unavailability To Date must be on or after the Unavailability From Date   
 
top
 

Company_Vehicle_Assignment_Capital_Contribution_Data

part of: Company_Vehicle_Assignment_Data
Company Vehicle Assignment Capital Contribution Data
 
Parameter name Type/Value Cardinality Description Validations
Company_Vehicle_Assignment_Capital_Contribution_Reference  Unique_IdentifierObject  [0..1]  Company Vehicle Assignment Capital Contribution instance reference   
Contribution_Date  date  [1..1]  Contribution Date 
Validation Description
Capital Contribution Effective Date must be on or after the Assignment From Date   
 
Contribution_Amount  decimal (14, 2)   [0..1]  Contribution Amount   
top
 

Company_Vehicle_Assignment_Payments_Private_Use_Data

part of: Company_Vehicle_Assignment_Data
Company Vehicle Assignment Payments Private Use Data
 
Parameter name Type/Value Cardinality Description Validations
Company_Vehicle_Assignment_Payments_Private_Use_Reference  Unique_IdentifierObject  [0..1]  Company Vehicle Assignment Payments Private Use instance reference   
Private_Use_Payment_Date  date  [1..1]  Private Use Payment Date 
Validation Description
Payments Made Towards Private Use Effective Date must be on or after the Assignment From Date   
 
Private_Use_Payment_Amount  decimal (14, 2)   [0..1]  Private Use Payment Amount   
top
 

Company_Vehicle_Assignment_Free_Fuel_Data

part of: Company_Vehicle_Assignment_Data
Company Vehicle Assignment Free Fuel Data
 
Parameter name Type/Value Cardinality Description Validations
Company_Vehicle_Assignment_Free_Fuel_Reference  Unique_IdentifierObject  [0..1]  Company Vehicle Assignment Free Fuel instance reference   
Free_Fuel_From_Date  date  [1..1]  Free Fuel Provided Date 
Validation Description
Free Fuel Date Provided must be on or after the Assignment From Date   
Free Fuel Date Provided must be on or before the Assignment To Date   
 
Free_Fuel_To_Date  date  [0..1]  Free Fuel Withdrawn Date 
Validation Description
Date Withdrawn must be on or after the Date Provided   
 
top
 

Pay_GroupReferenceEnumeration

part of: Pay_GroupObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Company_VehicleReferenceEnumeration

part of: Company_VehicleObjectID
Base Type
string
top