|
»Click here to display Table of Contents«
|
Sample XML |
|
|
|
|
Sample XML |
|
|
|
|
»Click here to display Table of Contents«
|
Sample XML |
|
|
|
|
Sample XML |
|
|
|
|
|
||
There is no defined response to an ACK or NAK request. Astra will ignore
the return document.
The ACK/NAK requests are noticational in nature only and no specific action
or respose is required of the web service when received.
-------------------------------------------------------------------------------
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AdAstraStatusResultRequest_MTResponse xmlns="http://aais.com/AteWebTestService" />
</soap:Body>
</soap:Envelope>
This respose message is used by Astra to log information about any room assignments
that could not be made by the web service, or warn about any issues the web service
may encounter.
This respose is required for every request, but it is not required to contain
any warnings or errors (ie, there is no special 'success' StatusCode that needs
to be sent for successful assignments. The lack of any Errors or Warnings for
a meeting is assumed to be an indication of success.)
Resposes that do not need to send any warnings or errors should inlucde empty
Errors and Warnings nodes in the response XML (<Errors/>, <Warnings/>)
-------------------------------------------------------------------------------
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AdAstraRoomsToSectionMeetingsResponse_MT xmlns="http://aais.com/AteWebTestService">
<Errors>
<Error>
<SectionMeetingSisKey>string</SectionMeetingSisKey>
<StatusCode>string</StatusCode>
<Message>string</Message>
</Error>
<Error>
<SectionMeetingSisKey>string</SectionMeetingSisKey>
<StatusCode>string</StatusCode>
<Message>string</Message>
</Error>
</Errors>
<Warnings>
<Warning>
<SectionMeetingSisKey>string</SectionMeetingSisKey>
<StatusCode>string</StatusCode>
<Message>string</Message>
</Warning>
<Warning>
<SectionMeetingSisKey>string</SectionMeetingSisKey>
<StatusCode>string</StatusCode>
<Message>string</Message>
</Warning>
</Warnings>
</AdAstraRoomsToSectionMeetingsResponse_MT>
</soap:Body>
</soap:Envelope>
Regardless of the type of the import request (Batch, OnDemand, ChangedSectionsOnly)
there is only one expected response (below).
If none of a request item exist, it is legal for the web service to return an empty collection
for that type. For example, if none of the requested meetings are crosslisted, then the web service
may return an empty crosslists node '<Crosslists/>' to indicate such.
The columns shown below illustrate a typical import example. Some columns shown are optional and
can be omitted by customers who do not wish them, and some columns that are not shown may be
imported if included in the response XML. Please contact Astra for more information.
-------------------------------------------------------------------------------
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AdAstraResponse_MT xmlns="http://aais.com/AteWebTestService">
<Sections>
<Section>
<SectionSisKey>string</SectionSisKey>
<SectionCode>string</SectionCode>
<TermSisKey>string</TermSisKey>
<CourseSisKey>string</CourseSisKey>
<CourseName>string</CourseName>
<CourseCourseNumber>string</CourseCourseNumber>
<SubjectSisKey>string</SubjectSisKey>
<SubjectName>string</SubjectName>
<CampusSisKey>string</CampusSisKey>
<CampusName>string</CampusName>
<DeliveryMethodSisKey>string</DeliveryMethodSisKey>
<DeliveryMethodName>string</DeliveryMethodName>
<CourseCourseTitle>string</CourseCourseTitle>
<SectionSectionTitle>string</SectionSectionTitle>
<SectionSISEnrollment>string</SectionSISEnrollment>
<SectionMaxEnrollment>string</SectionMaxEnrollment>
<SectionIsActive>string</SectionIsActive>
<SectionIsCanceled>string</SectionIsCanceled>
</Section>
<Section>
<SectionSisKey>string</SectionSisKey>
<SectionCode>string</SectionCode>
<TermSisKey>string</TermSisKey>
<CourseSisKey>string</CourseSisKey>
<CourseName>string</CourseName>
<CourseCourseNumber>string</CourseCourseNumber>
<SubjectSisKey>string</SubjectSisKey>
<SubjectName>string</SubjectName>
<CampusSisKey>string</CampusSisKey>
<CampusName>string</CampusName>
<DeliveryMethodSisKey>string</DeliveryMethodSisKey>
<DeliveryMethodName>string</DeliveryMethodName>
<CourseCourseTitle>string</CourseCourseTitle>
<SectionSectionTitle>string</SectionSectionTitle>
<SectionSISEnrollment>string</SectionSISEnrollment>
<SectionMaxEnrollment>string</SectionMaxEnrollment>
<SectionIsActive>string</SectionIsActive>
<SectionIsCanceled>string</SectionIsCanceled>
</Section>
</Sections>
<SectionMeetings>
<SectionMeeting>
<SectionSisKey>string</SectionSisKey>
<SectionMeetingSiskey>string</SectionMeetingSiskey>
<MeetingTypeSisKey>string</MeetingTypeSisKey>
<MeetingTypeName>string</MeetingTypeName>
<SectionMeetingDaysMetPattern>string</SectionMeetingDaysMetPattern>
<SectionMeetingStartTime>string</SectionMeetingStartTime>
<SectionMeetingEndTime>string</SectionMeetingEndTime>
<SectionMeetingStartDate>string</SectionMeetingStartDate>
<SectionMeetingEndDate>string</SectionMeetingEndDate>
<RoomSisKey>string</RoomSisKey>
<SectionMeetingIsArranged>string</SectionMeetingIsArranged>
</SectionMeeting>
<SectionMeeting>
<SectionSisKey>string</SectionSisKey>
<SectionMeetingSiskey>string</SectionMeetingSiskey>
<MeetingTypeSisKey>string</MeetingTypeSisKey>
<MeetingTypeName>string</MeetingTypeName>
<SectionMeetingDaysMetPattern>string</SectionMeetingDaysMetPattern>
<SectionMeetingStartTime>string</SectionMeetingStartTime>
<SectionMeetingEndTime>string</SectionMeetingEndTime>
<SectionMeetingStartDate>string</SectionMeetingStartDate>
<SectionMeetingEndDate>string</SectionMeetingEndDate>
<RoomSisKey>string</RoomSisKey>
<SectionMeetingIsArranged>string</SectionMeetingIsArranged>
</SectionMeeting>
</SectionMeetings>
<Crosslists>
<Crosslist>
<CrosslistSisKey>string</CrosslistSisKey>
<SectionMeetingSisKey>string</SectionMeetingSisKey>
<CrosslistName>string</CrosslistName>
<TermSisKey>string</TermSisKey>
<CrosslistEnrollment>string</CrosslistEnrollment>
<CrosslistMaxEnrollment>string</CrosslistMaxEnrollment>
</Crosslist>
<Crosslist>
<CrosslistSisKey>string</CrosslistSisKey>
<CrosslistName>string</CrosslistName>
<TermSisKey>string</TermSisKey>
<CrosslistEnrollment>string</CrosslistEnrollment>
<CrosslistMaxEnrollment>string</CrosslistMaxEnrollment>
</Crosslist>
</Crosslists>
<Instructors>
<Instructor>
<SectionMeetingSisKey>string</SectionMeetingSisKey>
<InstructorSisKey>string</InstructorSisKey>
<TermSisKey>string</TermSisKey>
<InstructorEMail>string</InstructorEMail>
<PersonFullName>string</PersonFullName>
<PersonFirstName>string</PersonFirstName>
<PersonMiddleName>string</PersonMiddleName>
<PersonLastName>string</PersonLastName>
<PersonTitle>string</PersonTitle>
<ContactInformationPhone>string</ContactInformationPhone>
<ContactInformationMobile>string</ContactInformationMobile>
<ContactInformationEmail>string</ContactInformationEmail>
<InstructorIsActive>string</InstructorIsActive>
<DepartmentSisKey>string</DepartmentSisKey>
</Instructor>
<Instructor>
<SectionMeetingSisKey>string</SectionMeetingSisKey>
<InstructorSisKey>string</InstructorSisKey>
<TermSisKey>string</TermSisKey>
<InstructorEMail>string</InstructorEMail>
<PersonFullName>string</PersonFullName>
<PersonFirstName>string</PersonFirstName>
<PersonMiddleName>string</PersonMiddleName>
<PersonLastName>string</PersonLastName>
<PersonTitle>string</PersonTitle>
<ContactInformationPhone>string</ContactInformationPhone>
<ContactInformationMobile>string</ContactInformationMobile>
<ContactInformationEmail>string</ContactInformationEmail>
<InstructorIsActive>string</InstructorIsActive>
<DepartmentSisKey>string</DepartmentSisKey>
</Instructor>
</Instructors>
</AdAstraResponse_MT>
</soap:Body>
</soap:Envelope>
This example shows a modified ImportResponse that contains optional data for
user fields. The example contains the same data as the ImportRespones.txt file,
with the addition of the <SectionUserFieldValues> and <SectionMeetingUserFieldValues> nodes.
- User fields can only be imported for Sections and Section Meetings.
- User field information is not required in any response. The import will process
this information only if and when provided. A web service could send only
Section values, only Meeting values, both, or neither.
- The user fields must be defined in Astra before they can be imported.
- The names of the XML column containing the user field values must match the
names of the user fields in Astra.
For purposes of this example, we will assume that Sections have one user
field defined named 'XXX' and that SectionMeetings have two user fields named 'YYY'
and 'ZZZ'.
- It is legal to specify fewer user field values for an entity than what is defined
on it. This allows for update of select user field values while leaving the
other values unchanged during an update. (See note below)
Continuing with our example, it would be legal to send XML only for the
‘YYY’ user field for section meetings and not send any XML for the 'ZZZ'
values.
NOTE: The choice of what user fields to send for a type must be made for
the entire response (the data must look uniform). This means that the same
set of user fields must be sent for each entity in the <XxxUserFields> node.
One cannot send some values for some RecordSisKeys and not for others.
-------------------------------------------------------------------------------
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AdAstraResponse_MT xmlns="http://aais.com/AteWebTestService">
<Sections>
<Section>
<SectionSisKey>string</SectionSisKey>
<SectionCode>string</SectionCode>
<TermSisKey>string</TermSisKey>
<CourseSisKey>string</CourseSisKey>
<CourseName>string</CourseName>
<CourseCourseNumber>string</CourseCourseNumber>
<SubjectSisKey>string</SubjectSisKey>
<SubjectName>string</SubjectName>
<CampusSisKey>string</CampusSisKey>
<CampusName>string</CampusName>
<DeliveryMethodSisKey>string</DeliveryMethodSisKey>
<DeliveryMethodName>string</DeliveryMethodName>
<CourseCourseTitle>string</CourseCourseTitle>
<SectionSectionTitle>string</SectionSectionTitle>
<SectionSISEnrollment>string</SectionSISEnrollment>
<SectionMaxEnrollment>string</SectionMaxEnrollment>
<SectionIsActive>string</SectionIsActive>
<SectionIsCanceled>string</SectionIsCanceled>
</Section>
<Section>
<SectionSisKey>string</SectionSisKey>
<SectionCode>string</SectionCode>
<TermSisKey>string</TermSisKey>
<CourseSisKey>string</CourseSisKey>
<CourseName>string</CourseName>
<CourseCourseNumber>string</CourseCourseNumber>
<SubjectSisKey>string</SubjectSisKey>
<SubjectName>string</SubjectName>
<CampusSisKey>string</CampusSisKey>
<CampusName>string</CampusName>
<DeliveryMethodSisKey>string</DeliveryMethodSisKey>
<DeliveryMethodName>string</DeliveryMethodName>
<CourseCourseTitle>string</CourseCourseTitle>
<SectionSectionTitle>string</SectionSectionTitle>
<SectionSISEnrollment>string</SectionSISEnrollment>
<SectionMaxEnrollment>string</SectionMaxEnrollment>
<SectionIsActive>string</SectionIsActive>
<SectionIsCanceled>string</SectionIsCanceled>
</Section>
</Sections>
<SectionMeetings>
<SectionMeeting>
<SectionSisKey>string</SectionSisKey>
<SectionMeetingSiskey>string</SectionMeetingSiskey>
<MeetingTypeSisKey>string</MeetingTypeSisKey>
<MeetingTypeName>string</MeetingTypeName>
<SectionMeetingDaysMetPattern>string</SectionMeetingDaysMetPattern>
<SectionMeetingStartTime>string</SectionMeetingStartTime>
<SectionMeetingEndTime>string</SectionMeetingEndTime>
<SectionMeetingStartDate>string</SectionMeetingStartDate>
<SectionMeetingEndDate>string</SectionMeetingEndDate>
<RoomSisKey>string</RoomSisKey>
<SectionMeetingIsArranged>string</SectionMeetingIsArranged>
</SectionMeeting>
<SectionMeeting>
<SectionSisKey>string</SectionSisKey>
<SectionMeetingSiskey>string</SectionMeetingSiskey>
<MeetingTypeSisKey>string</MeetingTypeSisKey>
<MeetingTypeName>string</MeetingTypeName>
<SectionMeetingDaysMetPattern>string</SectionMeetingDaysMetPattern>
<SectionMeetingStartTime>string</SectionMeetingStartTime>
<SectionMeetingEndTime>string</SectionMeetingEndTime>
<SectionMeetingStartDate>string</SectionMeetingStartDate>
<SectionMeetingEndDate>string</SectionMeetingEndDate>
<RoomSisKey>string</RoomSisKey>
<SectionMeetingIsArranged>string</SectionMeetingIsArranged>
</SectionMeeting>
</SectionMeetings>
<Crosslists>
<Crosslist>
<CrosslistSisKey>string</CrosslistSisKey>
<SectionMeetingSisKey>string</SectionMeetingSisKey>
<CrosslistName>string</CrosslistName>
<TermSisKey>string</TermSisKey>
<CrosslistEnrollment>string</CrosslistEnrollment>
<CrosslistMaxEnrollment>string</CrosslistMaxEnrollment>
</Crosslist>
<Crosslist>
<CrosslistSisKey>string</CrosslistSisKey>
<CrosslistName>string</CrosslistName>
<TermSisKey>string</TermSisKey>
<CrosslistEnrollment>string</CrosslistEnrollment>
<CrosslistMaxEnrollment>string</CrosslistMaxEnrollment>
</Crosslist>
</Crosslists>
<Instructors>
<Instructor>
<SectionMeetingSisKey>string</SectionMeetingSisKey>
<InstructorSisKey>string</InstructorSisKey>
<TermSisKey>string</TermSisKey>
<InstructorEMail>string</InstructorEMail>
<PersonFullName>string</PersonFullName>
<PersonFirstName>string</PersonFirstName>
<PersonMiddleName>string</PersonMiddleName>
<PersonLastName>string</PersonLastName>
<PersonTitle>string</PersonTitle>
<ContactInformationPhone>string</ContactInformationPhone>
<ContactInformationMobile>string</ContactInformationMobile>
<ContactInformationEmail>string</ContactInformationEmail>
<InstructorIsActive>string</InstructorIsActive>
<DepartmentSisKey>string</DepartmentSisKey>
</Instructor>
<Instructor>
<SectionMeetingSisKey>string</SectionMeetingSisKey>
<InstructorSisKey>string</InstructorSisKey>
<TermSisKey>string</TermSisKey>
<InstructorEMail>string</InstructorEMail>
<PersonFullName>string</PersonFullName>
<PersonFirstName>string</PersonFirstName>
<PersonMiddleName>string</PersonMiddleName>
<PersonLastName>string</PersonLastName>
<PersonTitle>string</PersonTitle>
<ContactInformationPhone>string</ContactInformationPhone>
<ContactInformationMobile>string</ContactInformationMobile>
<ContactInformationEmail>string</ContactInformationEmail>
<InstructorIsActive>string</InstructorIsActive>
<DepartmentSisKey>string</DepartmentSisKey>
</Instructor>
</Instructors>
<SectionUserFields>
<SectionUserField>
<RecordSisKey>string</RecordSisKey>
<XXX>string</XXX>
</SectionUserField>
<SectionUserField>
<RecordSisKey>string</RecordSisKey>
<XXX>string</XXX>
</SectionUserField>
</SectionUserFields>
<SectionMeetingUserFields>
<SectionMeetingUserField>
<RecordSisKey>string</RecordSisKey>
<YYY>string</YYY>
<ZZZ>string</ZZZ>
</SectionMeetingUserField>
<SectionUserField>
<RecordSisKey>string</RecordSisKey>
<YYY>string</YYY>
<ZZZ>string</ZZZ>
</SectionUserField>
</SectionMeetingUserFields>
</AdAstraResponse_MT>
</soap:Body>
</soap:Envelope>
