Service Directory > v33.1 > Learning > Get_Learning_Content_Subscriptions
 

Operation: Get_Learning_Content_Subscriptions

Retrieve Learning Content Subscriptions.


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

Contains references to find and get Learning Content Subscriptions and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Learning_Content_Subscription_Request_References  [0..1]  Retrieves specific instances of Learning Content Subscriptions and their associated data.   
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_Learning_Content_Subscriptions_Response

Response containing data for requested Learning Content Subscriptions.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Learning_Content_Subscription_Request_References  [0..1]  Retrieves specific instances of Learning Content Subscriptions and their associated data.   
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  Learning_Content_Subscription_Response_Data  [0..1]  Contains Learning Content Subscription data for each request reference.   
top
 

Learning_Content_Subscription_Request_References

part of: Get_Learning_Content_Subscriptions_Response, Get_Learning_Content_Subscriptions_Request
Retrieves specific instances of Learning Content Subscriptions and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Content_Subscription_Reference  Learning_Content_SubscriptionObject  [1..*]  Reference to the Learning Content Subscription.   
top
 

Learning_Content_SubscriptionObject

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

Learning_Content_SubscriptionObjectID

part of: Learning_Content_SubscriptionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Learning_Content_Subscription_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_Learning_Content_Subscriptions_Response, Get_Learning_Content_Subscriptions_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, become effective (Also referred to as the Effective Moment). If you don't specify a date, this date defaults to today.{+4}   
As_Of_Entry_DateTime  dateTime  [0..1]  The date and time the data was entered into the system. (This field is also referred to as the Entry Moment). If the date isn't specified, the default date is the current date and time.   
Page  decimal (12, 0) >0   [0..1]  The numbered page of data Workday returns in the response. The default page is 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. Set a value between 1 and 999. The default value is 100.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Learning_Content_Subscriptions_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 your request returned.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages requested. A page of data in a WWS has a 100 entry maximum.   
Page_Results  decimal (12, 0) >0   [0..1]  The number of results in the current page.   
Page  decimal (12, 0) >0   [0..1]  The page number of the data the WWS returned for your request.   
top
 

Learning_Content_Subscription_Response_Data

part of: Get_Learning_Content_Subscriptions_Response
Contains Learning Content Subscription data for each request reference.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Content_Subscription  Learning_Content_Subscription  [0..*]  Contains Learning Content Subscription data for each request reference.   
top
 

Learning_Content_Subscription

part of: Learning_Content_Subscription_Response_Data
Contains Learning Content Subscription data for each request reference.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Content_Subscription_Reference  Learning_Content_SubscriptionObject  [0..1]  References a Learning Content Subscription.   
Learning_Content_Subscription_Data  Learning_Content_Subscription_Data  [0..*]  Contains detailed information about a Learning Content Subscription.   
top
 

Learning_Content_Subscription_Data

part of: Learning_Content_Subscription
Contains detailed information about a Learning Content Subscription.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for the Learning Content Subscription.   
Inactive  boolean  [0..1]  Specifies if the Learning Content Subscription is Inactive.   
Learning_Content_Subscriber_Reference  Learning_Content_SubscriberObject  [0..1]  Reference to the Learning Content Subscriber for the Learning Content Subscription. 
Validation Description
Learning Content Subscriber cannot be changed.   
 
Subscription_Expiration_Date  date  [0..1]  Subscription Expiration Date for the Learning Content Subscription. 
Validation Description
Subscription Expiration Date cannot be changed.   
 
Learning_Topic_Reference  Learning_TopicObject  [0..1]  Reference to the Learning Topic for the Learning Content Subscription. 
Validation Description
Learning Topic cannot be changed.   
 
top
 

Learning_Content_SubscriberObject

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

Learning_Content_SubscriberObjectID

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

Learning_TopicObject

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

Learning_TopicObjectID

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

Learning_Content_SubscriptionReferenceEnumeration

part of: Learning_Content_SubscriptionObjectID
Base Type
string
top
 

Learning_Content_SubscriberReferenceEnumeration

part of: Learning_Content_SubscriberObjectID
Base Type
string
top
 

Learning_TopicReferenceEnumeration

part of: Learning_TopicObjectID
Base Type
string
top