Service Directory > v31.2 > Student_Records > Get_Completed_PDF_Transcript_Orders
 

Operation: Get_Completed_PDF_Transcript_Orders

Get Request to return PDFs for Completed Transcript Orders


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

Wrapper element for the Get Completed PDF Transcript Orders Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Completed_PDF_Transcript_Order_Request_References  [1..1]  Element containing the list of Completed Transcript Orders for which data is requested. 
Validation Description
No completed PDF transcripts were found for the Transcript Order references provided.   
 
Request_Criteria [Choice]   Completed_PDF_Transcript_Order_Request_Criteria  [1..1]  Request Criteria for Get Completed PDF Transcript Orders WS 
Validation Description
You must provide From Date or To Date   
 
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_Completed_PDF_Transcript_Orders_Response

Wrapper element for the Get Completed PDF Transcript Orders Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Completed_PDF_Transcript_Order_Request_References  [0..1]  Completed PDF Transcript Order Request References 
Validation Description
No completed PDF transcripts were found for the Transcript Order references provided.   
 
Request_Criteria  Completed_PDF_Transcript_Order_Request_Criteria  [0..1]  Completed PDF Transcript Order Request Criteria 
Validation Description
You must provide From Date or To Date   
 
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  Completed_PDF_Transcript_Order_Response_Data  [0..1]  Responce Data for Completed PDF Transcript Order Web Service Operation   
top
 

Completed_PDF_Transcript_Order_Request_References

part of: Get_Completed_PDF_Transcript_Orders_Response, Get_Completed_PDF_Transcript_Orders_Request
Element containing the list of Completed Transcript Orders for which data is requested
 
Parameter name Type/Value Cardinality Description Validations
Completed_Transcript_Order_Reference  Transcript_OrderObject  [1..*]  Workset of completed Transcript Orders for which data is requested   
Validation Description
No completed PDF transcripts were found for the Transcript Order references provided.   
top
 

Transcript_OrderObject

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

Transcript_OrderObjectID

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

Completed_PDF_Transcript_Order_Request_Criteria

part of: Get_Completed_PDF_Transcript_Orders_Response, Get_Completed_PDF_Transcript_Orders_Request
The request criteria element for Completed PDF Transcript Order WS Operation
 
Parameter name Type/Value Cardinality Description Validations
From_Date  date  [0..1]  Start of the Date range search for completed Transcript Orders. Inclusive. Open if unspecified   
To_Date  date  [0..1]  End of the Date range search for completed Transcript Orders. Inclusive. Open if unspecified   
Validation Description
You must provide From Date or To Date   
top
 

Response_Filter

part of: Get_Completed_PDF_Transcript_Orders_Response, Get_Completed_PDF_Transcript_Orders_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_Completed_PDF_Transcript_Orders_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
 

Completed_PDF_Transcript_Order_Response_Data

part of: Get_Completed_PDF_Transcript_Orders_Response
Wrapper element for the Completed PDF Transcript Order Response data
 
Parameter name Type/Value Cardinality Description Validations
Completed_PDF_Transcript_Order  Completed_PDF_Transcript_Order  [0..*]  Wrapper element for the Completed PDF Transcript Order Get Response   
top
 

Completed_PDF_Transcript_Order

part of: Completed_PDF_Transcript_Order_Response_Data
Wrapper element for the Completed PDF Transcript Order Get Response
 
Parameter name Type/Value Cardinality Description Validations
Completed_PDF_Transcript_Order_Reference  Transcript_OrderObject  [0..1]  Reference ID for the Completed PDF Transcript Order   
Completed_PDF_Transcript_Order_Data  Completed_PDF_Transcript_Order_Data  [0..1]  Wrapper element for the Completed PDF Transcript Order Data   
top
 

Completed_PDF_Transcript_Order_Data

part of: Completed_PDF_Transcript_Order
Wrapper element for teh Completed PDF Transcript Oder Data
 
Parameter name Type/Value Cardinality Description Validations
Transcript_Request_Date  date  [0..1]  Transcript Request Date   
Student_Reference  Transcript_StudentObject  [0..1]  Student Reference   
Academic_Level  string  [0..1]  Academic Level Reference   
Number_of_Transcripts  decimal (6, 0) >0   [0..1]  Transcript Request Amount   
Recipient_Name_or_Organization  string  [0..1]  Transcript Order Recipient Name or Organization   
File  base64Binary  [0..1]  PDF File Base64 Encoded format   
top
 

Transcript_StudentObject

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

Transcript_StudentObjectID

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

Transcript_OrderReferenceEnumeration

part of: Transcript_OrderObjectID
Base Type
string
top
 

Transcript_StudentReferenceEnumeration

part of: Transcript_StudentObjectID
Base Type
string
top