Service Directory > v31.2 > Student_Records > Get_Student_Transfer_Credit
 

Operation: Get_Student_Transfer_Credit

Gets data about a Student Articulation or all Student Articulations if a reference to one is not provided


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

The request to get a Student Application and its data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Articulation_Request_References  [0..1]  Request References for a Student Articulation request.   
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_Student_Transfer_Credit_Response

The response for a Student Articulation request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Articulation_Request_References  [0..1]  Contains reference to Student Articulations   
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  Student_Articulation_Response_Data  [0..1]  The response data for a Student Articulation request   
top
 

Student_Articulation_Request_References

part of: Get_Student_Transfer_Credit_Request, Get_Student_Transfer_Credit_Response
Contains reference to Student Articulations
 
Parameter name Type/Value Cardinality Description Validations
Student_Articulation_Reference  Student_ArticulationObject  [1..*]  Reference to Student Articulations   
top
 

Student_ArticulationObject

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

Student_ArticulationObjectID

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

Response_Results

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

Student_Articulation_Response_Data

part of: Get_Student_Transfer_Credit_Response
The response for a Student Articulation request
 
Parameter name Type/Value Cardinality Description Validations
Student_Articulation_Data  Student_Articulation_Data  [0..*]  Web Service container for Student Articulation data. 
Validation Description
You may not provide more than one Articulatable type for the Student Articulatable Reference.   
The Student External Transcript Course Records provided must be for the same Student External Transcript.   
The Education Test Section Results provided must be for the same Education Test Result associated with the Student provided.   
The Student tied to the External Transcript Course Record must match the Student provided.   
Student Articulations already exist for this Articulatable item.   
Historical Student Registrations are not valid for the Web Service.   
The referenced student has more than one academic record. Provide a reference to one of the academic records for the student.   
Please submit one of the following: a reference to an Academic Record, or a reference to a Student with only one Academic Record.   
 
top
 

Student_Articulation_Data

part of: Student_Articulation_Response_Data
Web Service container for Student Articulation data.
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..1]  Student Reference ID   
Academic_Record_Reference  Academic_RecordObject  [0..1]  Reference to an Academic Record   
Student_Articulatable_Reference  Student_ArticulatableObject  [1..*]  Reference ID of the Articulatable item   
Student_Articulated_Registration_Data  Student_Articulated_Registration_Data  [1..*]  Web Service container for Student Articulated Registration Data   
Student_Articulation_Exclude  boolean  [0..1]  Student Articulation Exclude   
Validation Description
You may not provide more than one Articulatable type for the Student Articulatable Reference.   
The Student External Transcript Course Records provided must be for the same Student External Transcript.   
The Education Test Section Results provided must be for the same Education Test Result associated with the Student provided.   
The Student tied to the External Transcript Course Record must match the Student provided.   
Student Articulations already exist for this Articulatable item.   
Historical Student Registrations are not valid for the Web Service.   
The referenced student has more than one academic record. Provide a reference to one of the academic records for the student.   
Please submit one of the following: a reference to an Academic Record, or a reference to a Student with only one Academic Record.   
top
 

StudentObject

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

StudentObjectID

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

Academic_RecordObject

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

Academic_RecordObjectID

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

Student_ArticulatableObject

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

Student_ArticulatableObjectID

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

Student_Articulated_Registration_Data

part of: Student_Articulation_Data
Web Service container for Student Articulated Registration Data
 
Parameter name Type/Value Cardinality Description Validations
Course_Listing_Reference  Course_ListingObject  [1..1]  Course Listing Reference   
Student_Grade_Reference  Student_GradeObject  [1..1]  Student Grade Reference   
Student_Registration_Units  decimal (8, 2) >0   [0..1]  The Student Course Registration Units   
top
 

Course_ListingObject

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

Course_ListingObjectID

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

Student_GradeObject

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

Student_GradeObjectID

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

Student_ArticulationReferenceEnumeration

part of: Student_ArticulationObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_RecordReferenceEnumeration

part of: Academic_RecordObjectID
Base Type
string
top
 

Student_ArticulatableReferenceEnumeration

part of: Student_ArticulatableObjectID
Base Type
string
top
 

Course_ListingReferenceEnumeration

part of: Course_ListingObjectID
Base Type
string
top
 

Student_GradeReferenceEnumeration

part of: Student_GradeObjectID
Base Type
string
top