Service Directory > v32.1 > Revenue_Management > Get_Customer_Date_Milestones
 

Operation: Get_Customer_Date_Milestones

this service provides the ability to get Customer Date Milestones already defined in the system. Get will retrieve Customer, Customer Date Milestone Type, Customer Milestone Name, Estimated Completion Date, Completed boolean, Completed on Date, and Comments


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

Contains request reference, criteria, filter and response group for getting Customer Date Milestone Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Customer_Date_Milestone_Request_References  [0..1]  Element containing reference instances for a Customer Date Milestone   
Request_Criteria [Choice]   Customer_Date_Milestone_Request_Criteria  [0..1]  Element containing customer date milestone 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  Customer_Date_Milestone_Response_Group  [0..1]  Element containing customer date milestone response grouping options   
top
 

Response Element: Get_Customer_Date_Milestones_Response

Element containing the Customer Date Milestone Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Customer_Date_Milestone_Request_References  [0..1]  Get Customer Date Milestone References   
Request_Criteria  Customer_Date_Milestone_Request_Criteria  [0..1]  Get Customer Date Milestone Response   
Response_Filter  Response_Filter  [0..1]  Get Customer Date Milestone Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Customer_Date_Milestone_Response_Group  [0..1]  Get Customer Date Milestone Response Group   
Response_Results  Response_Results  [0..1]  Get Customer Date Milestone Response Results   
Response_Data  Customer_Date_Milestone_Response_Data  [0..1]  Get Customer Date Milestone Response Data   
top
 

Customer_Date_Milestone_Request_References

part of: Get_Customer_Date_Milestones_Request, Get_Customer_Date_Milestones_Response
Element containing reference instances for a Customer Date Milestone
 
Parameter name Type/Value Cardinality Description Validations
Customer_Date_Milestone_Reference  Customer_Date_MilestoneObject  [1..*]  Get Customer Date Milestone   
top
 

Customer_Date_MilestoneObject

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

Customer_Date_MilestoneObjectID

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

Customer_Date_Milestone_Request_Criteria

part of: Get_Customer_Date_Milestones_Request, Get_Customer_Date_Milestones_Response
Element containing customer date milestone request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Customer_Date_Milestones_Request, Get_Customer_Date_Milestones_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
 

Customer_Date_Milestone_Response_Group

part of: Get_Customer_Date_Milestones_Request, Get_Customer_Date_Milestones_Response
Element containing customer date milestone response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Customer Date Milestone Request Reference   
top
 

Response_Results

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

Customer_Date_Milestone_Response_Data

part of: Get_Customer_Date_Milestones_Response
Element contains the Customer Date Milestone responses
 
Parameter name Type/Value Cardinality Description Validations
Customer_Date_Milestone  Customer_Date_Milestone  [0..*]  Element Contain Customer Date Milestone Reference   
top
 

Customer_Date_Milestone

part of: Customer_Date_Milestone_Response_Data
Element Contain Customer Date Milestone Reference
 
Parameter name Type/Value Cardinality Description Validations
Customer_Date_Milestone_Reference  Customer_Date_MilestoneObject  [0..1]  Customer Date Milestone Reference   
Customer_Date_Milestone_Data  Customer_Date_Milestone_Data  [0..*]  Customer Date Milestone Data 
Validation Description
If a Milestone Completion date is set, Milestone Complete must be checked.   
If Milestone Complete is checked, a completion date must be set.   
 
top
 

Customer_Date_Milestone_Data

part of: Customer_Date_Milestone
Customer Date Milestone Data Element
 
Parameter name Type/Value Cardinality Description Validations
Customer_Milestone_ID  string  [0..1]  Customer Date Milestone ID. This is a unique identifier.   
Customer_Reference  Billable_EntityObject  [1..1]  Customer who uses the Customer Date Milestone feature   
Customer_Date_Milestone_Type_Reference  Milestone_TypeObject  [1..1]  Customer Date Milestone Type -- defined by customers -- this type gives customers ability to group "like" milestones   
Customer_Milestone_Name  string  [1..1]  Customer Date Milestone Name -- customers will define this name 
Validation Description
Customer Date Milestone Name must be unique for Customer.   
 
Estimated_Completion_Date  date  [0..1]  Customer date Milestone -- estimated completion date   
Complete  boolean  [0..1]  Customer Date Milestone Completion Flag   
Completed_On  date  [0..1]  Customer Date Milestone - Date Completed -- if Completion flag is true - then a Date Completed entry is required.   
Comments  string  [0..1]  Customer Date Milestone - General Comment section...   
Validation Description
If a Milestone Completion date is set, Milestone Complete must be checked.   
If Milestone Complete is checked, a completion date must be set.   
top
 

Billable_EntityObject

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

Billable_EntityObjectID

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

Milestone_TypeObject

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

Milestone_TypeObjectID

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

Customer_Date_MilestoneReferenceEnumeration

part of: Customer_Date_MilestoneObjectID
Base Type
string
top
 

Billable_EntityReferenceEnumeration

part of: Billable_EntityObjectID
Base Type
string
top
 

Milestone_TypeReferenceEnumeration

part of: Milestone_TypeObjectID
Base Type
string
top