Service Directory > v31.2 > Student_Records > Get_Study_Abroads
 

Operation: Get_Study_Abroads

Web service for getting Study Abroads.


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

Web Service for getting Study Abroads
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Study_Abroad_Request_References  [0..1]  Study Abroad Request References   
Request_Criteria [Choice]   Study_Abroad_Request_Criteria  [0..1]  Study Abroad 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. 
 
top
 

Response Element: Get_Study_Abroads_Response

Get Study Abroads Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Study_Abroad_Request_References  [0..1]  Study Abroad Request References   
Request_Criteria  Study_Abroad_Request_Criteria  [0..1]  Study Abroad 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_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  Study_Abroad_Response_Data  [0..1]  Study Abroad Response Data   
top
 

Study_Abroad_Request_References

part of: Get_Study_Abroads_Response, Get_Study_Abroads_Request
Study Abroad Request References
 
Parameter name Type/Value Cardinality Description Validations
Study_Abroad_Reference  Study_AbroadObject  [1..*]  Study Abroad Reference   
top
 

Study_AbroadObject

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

Study_AbroadObjectID

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

Study_Abroad_Request_Criteria

part of: Get_Study_Abroads_Response, Get_Study_Abroads_Request
Study Abroad Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [0..1]  Academic Unit Reference   
top
 

Academic_Curricular_DivisionObject

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

Academic_Curricular_DivisionObjectID

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

Study_Abroad_Response_Data

part of: Get_Study_Abroads_Response
Study Abroad Response Data
 
Parameter name Type/Value Cardinality Description Validations
Study_Abroad  Study_Abroad  [0..*]  Study Abroad   
top
 

Study_Abroad

part of: Study_Abroad_Response_Data
Study Abroad
 
Parameter name Type/Value Cardinality Description Validations
Study_Abroad_Reference  Study_AbroadObject  [0..1]  Study Abroad Reference   
Study_Abroad_Data  Study_Abroad_Data  [0..*]  Study Abroad Data 
Validation Description
Must select the Billable Activity Behavior to submit Billable Data.   
Must select the Enrollable Activity Behavior to submit Enrollable Data.   
Schedulable (SCHEDULABLE) is not a valid Activity Behavior for Study Abroad.   
 
top
 

Study_Abroad_Data

part of: Study_Abroad
Study Abroad Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID   
Configurable_Activity_Data  Configurable_Activity_Data_Snapshot_Data  [1..1]  Configurable Activity Data Snapshot Data   
Study_Abroad_Specific_Data  Study_Abroad_Specific_Data_Data  [0..1]  Study Abroad Specific Data   
Has_Academic_Unit_Data  Academic_Curricular_Division_Subedit_Level_Optional_Data  [1..1]  Contains Academic Unit information for a Student Prospect where the Academic Level is optional 
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
 
Has_Enrollment_Eligibility_Defaults_Data  Has_Enrollment_Eligibility_Defaults_Data  [0..1]  Enrollment Eligibility Defaults Data 
Validation Description
Cannot submit limited capacity options with unlimited option selected.   
 
Has_Billable_Load_Status_Defaults_Data  Has_Billable_Load_Status_Defaults_Data  [0..1]  Billable Load Status Defaults Data 
Validation Description
Must set "Repeatable" to true to submit Repeatable Data.   
You must specify at least 1 Other Unit Type and Other Unit Value when you select the Other Unit Values check box.   
 
Validation Description
Must select the Billable Activity Behavior to submit Billable Data.   
Must select the Enrollable Activity Behavior to submit Enrollable Data.   
Schedulable (SCHEDULABLE) is not a valid Activity Behavior for Study Abroad.   
top
 

Configurable_Activity_Data_Snapshot_Data

part of: Study_Abroad_Data
Configurable Activity Data Snapshot Data
 
Parameter name Type/Value Cardinality Description Validations
Title  string  [1..1]  Title   
Abbreviated_Title  string  [1..1]  Abbreviated Title   
Activity_Behavior_Reference  Activity_BehaviorObject  [1..*]  Activity Behavior Reference   
top
 

Activity_BehaviorObject

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

Activity_BehaviorObjectID

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

Study_Abroad_Specific_Data_Data

part of: Study_Abroad_Data
Study Abroad Data
 
Parameter name Type/Value Cardinality Description Validations
Educational_Institution_Reference  Educational_InstitutionObject  [0..1]  Educational Institution Reference   
Country_Reference  CountryObject  [0..1]  Country Reference   
top
 

Educational_InstitutionObject

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

Educational_InstitutionObjectID

part of: Educational_InstitutionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Educational_Institution_CCD_ID, Educational_Institution_ID, Educational_Institution_Postsecondary_CEEB_ATP_ID, Educational_Institution_Postsecondary_Federal_ID, Educational_Institution_Postsecondary_IPEDS_ID, Educational_Institution_Postsecondary_Local_ID, Educational_Institution_Postsecondary_OPEID_ID, Educational_Institution_Postsecondary_Other_ID, Educational_Institution_Postsecondary_State_ID, Educational_Institution_Secondary_CEEB_ATP_ID, Educational_Institution_Secondary_Local_ID, Educational_Institution_Secondary_NCES_ID, Educational_Institution_Secondary_Other_ID, Educational_Institution_Secondary_State_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
 

CountryObject

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

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [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_Curricular_Division_Subedit_Level_Optional_Data

part of: Study_Abroad_Data
Contains Academic Unit information for a Student Prospect where the Academic Level is optional
 
Parameter name Type/Value Cardinality Description Validations
Academic_Level_Reference  Academic_LevelObject  [0..1]  References an Academic Level for a Student Prospect   
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [1..1]  Academic Unit Reference 
Validation Description
The Academic Unit Reference must be an Academic Unit.   
 
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
top
 

Academic_LevelObject

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

Academic_LevelObjectID

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

Has_Enrollment_Eligibility_Defaults_Data

part of: Study_Abroad_Data
Enrollment Eligibility Defaults Data
 
Parameter name Type/Value Cardinality Description Validations
Unlimited_Orientation_Capacity  boolean  [0..1]  Unlimited Orientation Capacity   
Default_Orientation_Capacity  decimal (4, 0) >0   [0..1]  Default Orientation Capacity   
Default_Orientation_Projected_Enrollment  decimal (12, 0) >0   [0..1]  Default Orientation Projected Enrollment   
Default_Orientation_Wait_List_Capacity  decimal (3, 0) >0   [0..1]  Default Orientation Wait List Capacity   
Validation Description
Cannot submit limited capacity options with unlimited option selected.   
top
 

Has_Billable_Load_Status_Defaults_Data

part of: Study_Abroad_Data
Billable Load Status Defaults Data
 
Parameter name Type/Value Cardinality Description Validations
Contact_Hours  decimal (6, 2) >0   [0..1]  Contact Hours   
Unit_Type_Reference  Other_Unit_TypeObject  [0..1]  Unit Type Reference   
Minimum_Units  decimal (6, 2) >0   [0..1]  Minimum Units   
Maximum_Units  decimal (6, 2) >0   [0..1]  Maximum Units   
Repeatable  boolean  [0..1]  Repeatable   
Repeat_Maximum_Attempts  decimal (3, 0) >0   [0..1]  Repeat Maximum Attempts   
Repeat_Maximum_Credits  decimal (6, 2) >0   [0..1]  Repeat Maximum Credits   
Other_Unit_Values  boolean  [0..1]  Other Unit Values   
Other_Credit_Type_Value_Data  Other_Credit_Type_Value_Data  [0..*]  Other Credit Type Value Data   
Validation Description
Must set "Repeatable" to true to submit Repeatable Data.   
You must specify at least 1 Other Unit Type and Other Unit Value when you select the Other Unit Values check box.   
top
 

Other_Unit_TypeObject

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

Other_Unit_TypeObjectID

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

Other_Credit_Type_Value_Data

part of: Has_Billable_Load_Status_Defaults_Data
Other Credit Type Value Data
 
Parameter name Type/Value Cardinality Description Validations
Other_Unit_Type_Reference  Other_Credit_TypeObject  [1..*]  Other Credit Type Value Reference 
Validation Description
Other Credit Values must be true in order to submit an Other Credit Type and value combination.   
 
Other_Credit_Value  decimal (5, 2) >0   [0..1]  Other Credit Value   
top
 

Other_Credit_TypeObject

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

Other_Credit_TypeObjectID

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

Study_AbroadReferenceEnumeration

part of: Study_AbroadObjectID
Base Type
string
top
 

Academic_Curricular_DivisionReferenceEnumeration

part of: Academic_Curricular_DivisionObjectID
Base Type
string
top
 

Activity_BehaviorReferenceEnumeration

part of: Activity_BehaviorObjectID
Base Type
string
top
 

Educational_InstitutionReferenceEnumeration

part of: Educational_InstitutionObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

Other_Unit_TypeReferenceEnumeration

part of: Other_Unit_TypeObjectID
Base Type
string
top
 

Other_Credit_TypeReferenceEnumeration

part of: Other_Credit_TypeObjectID
Base Type
string
top