Service Directory > v32.1 > Academic_Foundation > Get_Accommodations_for_Student
 

Operation: Get_Accommodations_for_Student

Returns the Accommodation, Disability and supporting document information for a Student's approved Student Accommodation request using the Student and Institutional Academic Unit request Criteria, or returns Accommodation information for all Students if no criteria is specified. This task does not support request references; request criteria should be used to identify the specific Students and Academic Units for which Accommodation information should be returned.


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

Top-level request element for the Get Accommodations for Student task
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Accommodation_for_Student_Request_References  [0..1]  Accommodation for Student Request References   
Request_Criteria [Choice]   Accommodation_for_Student_Request_Criteria  [0..1]  Accommodation for Student 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_Accommodations_for_Student_Response

Top-level response element for the Get Accommodations for Student task
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Accommodation_for_Student_Request_References  [0..1]  Accommodation for Student Request References   
Request_Criteria  Accommodation_for_Student_Request_Criteria  [0..1]  Accommodation for Student 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  Accommodation_for_Student_Response_Data  [0..1]  Accommodation for Student Response Data   
top
 

Accommodation_for_Student_Request_References

part of: Get_Accommodations_for_Student_Response, Get_Accommodations_for_Student_Request
Accommodation for Student Request References
 
Parameter name Type/Value Cardinality Description Validations
top
 

Accommodation_for_Student_Request_Criteria

part of: Get_Accommodations_for_Student_Response, Get_Accommodations_for_Student_Request
Accommodation for Student Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..*]  Student Reference   
Institutional_Academic_Unit_Reference  Academic_UnitObject  [0..*]  Institutional Academic Unit Reference   
top
 

StudentObject

part of: Accommodation_for_Student_Request_Criteria, Accommodation_for_Student_Data, Accommodation_for_Student
 
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_UnitObject

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

Academic_UnitObjectID

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

Accommodation_for_Student_Response_Data

part of: Get_Accommodations_for_Student_Response
Accommodation for Student Response Data
 
Parameter name Type/Value Cardinality Description Validations
Accommodation_for_Student  Accommodation_for_Student  [0..*]  Accommodation for Student element   
top
 

Accommodation_for_Student

part of: Accommodation_for_Student_Response_Data
Accommodation for Student element
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..1]  Student Reference   
Accommodation_for_Student_Data  Accommodation_for_Student_Data  [1..*]  Accommodation for Student Data 
Validation Description
Please submit a valid institutional academic unit for this student.   
 
top
 

Accommodation_for_Student_Data

part of: Accommodation_for_Student
Accommodation for Student Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [1..1]  Student Reference   
Academic_Unit_Reference  Academic_UnitObject  [1..1]  Institutional Academic Unit Reference   
Student_Accommodation_Assignment_Data  Student_Accommodation_Assignment_Data  [1..*]  Student Accommodation Assignment Data 
Validation Description
One or more accommodations are invalid because they have been inactivated.   
All accommodations must be associated with the submitted academic unit.   
Student disability for accommodation must be active.   
Date requested must be in the past.   
 
Validation Description
Please submit a valid institutional academic unit for this student.   
top
 

Student_Accommodation_Assignment_Data

part of: Accommodation_for_Student_Data
Student Accommodation Assignment Data
 
Parameter name Type/Value Cardinality Description Validations
Date_Requested  dateTime  [0..1]  Date on which the accommodation was requested.   
Additional_Information_for_Administrator  string  [0..1]  Additional Information for Administrator   
Start_Date  date  [0..1]  Start Date   
End_Date  date  [0..1]  End Date   
Student_Accommodation_Reference  Student_AccommodationObject  [1..*]  Student Accommodation Reference   
Student_Disability_for_Accommodation_Reference  Student_Disability_for_AccommodationObject  [1..1]  Student Disability for Accommodation Reference   
Student_Attachment_Data  Student_Attachment_Drag_and_Drop_Data  [0..*]  Wrapper element for Student Attachments   
Accommodation_Approval_Document_Data  Student_Document_Data  [0..*]  Student Document Data element 
Validation Description
You cannot assign student documents to inactive student document types.   
 
Validation Description
One or more accommodations are invalid because they have been inactivated.   
All accommodations must be associated with the submitted academic unit.   
Student disability for accommodation must be active.   
Date requested must be in the past.   
top
 

Student_AccommodationObject

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

Student_AccommodationObjectID

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

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

Student_Disability_for_AccommodationObjectID

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

part of: Student_Accommodation_Assignment_Data
Wrapper element for Student Attachments
 
Parameter name Type/Value Cardinality Description Validations
Student_Attachment_Reference  Student_AttachmentObject  [0..1]  The instance of the Student Attachment.   
Attachments  Attachment_WWS_Data  [0..*]  Attachment WWS Data element that provides the attachment functionality   
top
 

Student_AttachmentObject

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

Student_AttachmentObjectID

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

Attachment_WWS_Data

part of: Student_Attachment_Drag_and_Drop_Data, Student_Document_Attachment_Data
Attachment WWS Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Text attribute identifying a unique ID for Attachment.   
Filename  string (255)   [1..1]  Filename for the attachment.   
File_Content  base64Binary  [1..1]  File content in binary format.   
Mime_Type_Reference  Mime_TypeObject  [0..1]  Mime Type Reference   
Comment  string  [0..1]  Comment   
top
 

Mime_TypeObject

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

Mime_TypeObjectID

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

Student_Document_Data

part of: Student_Accommodation_Assignment_Data
Student Document Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID of the Student Document   
Student_Document_Type_Reference  Student_Document_TypeObject  [1..1]  Student Document Type Reference   
Upload_Date  dateTime  [0..1]  Upload Date   
Date_Received  date  [0..1]  Date Received   
Official  boolean  [0..1]  Official   
Student_Document_Attachment_Data  Student_Document_Attachment_Data  [0..1]  Student Document Attachment Data element   
Validation Description
You cannot assign student documents to inactive student document types.   
top
 

Student_Document_TypeObject

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

Student_Document_TypeObjectID

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

Student_Document_Attachment_Data

part of: Student_Document_Data
Student Document Attachment Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID of the Student Document Attachment   
Attachment_WWS_Data  Attachment_WWS_Data  [1..1]  Attachment WWS Data element   
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

Student_AccommodationReferenceEnumeration

part of: Student_AccommodationObjectID
Base Type
string
top
 

Student_Disability_for_AccommodationReferenceEnumeration

part of: Student_Disability_for_AccommodationObjectID
Base Type
string
top
 

Student_AttachmentReferenceEnumeration

part of: Student_AttachmentObjectID
Base Type
string
top
 

Mime_TypeReferenceEnumeration

part of: Mime_TypeObjectID
Base Type
string
top
 

Student_Document_TypeReferenceEnumeration

part of: Student_Document_TypeObjectID
Base Type
string
top