View source for UMS Webservice

The module UMS Webservice allows other providers to access the UMS database as a web service. Selected data can be retrieved securely through UMS Webservice.

This is a soap service for more about [https://smartbear.com/blog/soap-vs-rest-whats-the-difference/ soap]

For the wsdl go to <nowiki>https://your-ums-server.com/Webservices/DataExport.asmx?wsdl</nowiki>

===Setup===
UMS has web services. These can be found under this path on the webserver c:\inetpub\wwwroot\Webservices or where the UMS Frontend is installed.

The web services need two kinds of authentication.

#To access the ASMX file use windows authentication. This is a user that the webserver can find either local or domain.
#To call any of the web services you need a username and password that can be set in UMS configurator
##You can find it here Configurator -> Settings -> Web services
##[[File:Webservice setup.png|none|thumb|link=http://wiki.inlogic.dk/index.php/File:Webservice_setup.png]]
##The username must be between 8 - 100 characters
##The password must be between 16 - 100 characters
##Changing this requires a restart of the website.

===='''Data export'''====
(Requires a license)

These are used to extract data from the UMS database.

They are found here http://<DNS>/WebServices/DataExport.asmx. Just remember to replace <DNS> with the URL with the UMS webserver address. 
===='''Test web services'''====
This an example of the data export web service. Change the ASMX name to test other services.

To test the web services you can use SOAP UI <nowiki>http://www.soapui.org/</nowiki>. Download the free version.

Connect to the web services URL http://&#x3C;DNS&#x3E;/WebServices/DataExport.asmx?wsdl[[File:Webservice url.png|none|thumb|link=http://wiki.inlogic.dk/index.php/File:Webservice_url.png]]Accessing this http://<DNS>/WebServices/DataExport.asmx?wsdl with a browser will show the WSDL as readable XML.
===ActivitiesInfo===
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
 POST /Webservices/DataExport.asmx HTTP/1.1
 Host: localhost
 Content-Type: application/soap+xml; charset=utf-8
 Content-Length: length
 
 <?xml version="1.0" encoding="utf-8"?>
 <soap12:Envelope xmlns:xsi="<nowiki>http://www.w3.org/2001/XMLSchema-instance</nowiki>" xmlns:xsd="<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>" xmlns:soap12="<nowiki>http://www.w3.org/2003/05/soap-envelope</nowiki>">
   <soap12:Body>
     <ActivitiesInfo xmlns="<nowiki>http://DataExport.inlogic.dk/</nowiki>">
       <UserName>string</UserName>
       <Password>string</Password>
       <Activities>
         <AllActivities>boolean</AllActivities>
         <AllDepartments>boolean</AllDepartments>
         <OnlyActiveActivities>boolean</OnlyActiveActivities>
         <OnlyActiveUsers>boolean</OnlyActiveUsers>
         <DepartmentNames>
           <string>string</string>
           <string>string</string>
         </DepartmentNames>
         <Activities>
           <string>string</string>
           <string>string</string>
         </Activities>
       </Activities>
     </ActivitiesInfo>
   </soap12:Body>
 </soap12:Envelope>

 HTTP/1.1 200 OK
 Content-Type: application/soap+xml; charset=utf-8
 Content-Length: length
 
 <?xml version="1.0" encoding="utf-8"?>
 <soap12:Envelope xmlns:xsi="<nowiki>http://www.w3.org/2001/XMLSchema-instance</nowiki>" xmlns:xsd="<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>" xmlns:soap12="<nowiki>http://www.w3.org/2003/05/soap-envelope</nowiki>">
   <soap12:Body>
     <ActivitiesInfoResponse xmlns="<nowiki>http://DataExport.inlogic.dk/</nowiki>">
       <ActivitiesInfoResult>
         <ErrorMessage>string</ErrorMessage>
         <ErrCode>int</ErrCode>
         <Activities>
           <Activity>
             <RowType>string</RowType>
             <Activity>string</Activity>
             <ActivityDisplayName>string</ActivityDisplayName>
             <Activity_ShortDescription>string</Activity_ShortDescription>
             <ActivityDescription>string</ActivityDescription>
             <ActivityDepartmentNumber>string</ActivityDepartmentNumber>
             <Activity_StartDate>dateTime</Activity_StartDate>
             <Activity_EndDate>dateTime</Activity_EndDate>
             <Participants xsi:nil="true" />
             <Teachers xsi:nil="true" />
             <Courses xsi:nil="true" />
           </Activity>
           <Activity>
             <RowType>string</RowType>
             <Activity>string</Activity>
             <ActivityDisplayName>string</ActivityDisplayName>
             <Activity_ShortDescription>string</Activity_ShortDescription>
             <ActivityDescription>string</ActivityDescription>
             <ActivityDepartmentNumber>string</ActivityDepartmentNumber>
             <Activity_StartDate>dateTime</Activity_StartDate>
             <Activity_EndDate>dateTime</Activity_EndDate>
             <Participants xsi:nil="true" />
             <Teachers xsi:nil="true" />
             <Courses xsi:nil="true" />
           </Activity>
         </Activities>
       </ActivitiesInfoResult>
     </ActivitiesInfoResponse>
   </soap12:Body>
 </soap12:Envelope>

===CheckLogin===

====SOAP 1.2====
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
 POST /Webservices/DataExport.asmx HTTP/1.1
 Host: localhost
 Content-Type: application/soap+xml; charset=utf-8
 Content-Length: length
 
 <?xml version="1.0" encoding="utf-8"?>
 <soap12:Envelope xmlns:xsi="<nowiki>http://www.w3.org/2001/XMLSchema-instance</nowiki>" xmlns:xsd="<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>" xmlns:soap12="<nowiki>http://www.w3.org/2003/05/soap-envelope</nowiki>">
   <soap12:Body>
     <CheckLogin xmlns="<nowiki>http://DataExport.inlogic.dk/</nowiki>">
       <WebserviceUserName>string</WebserviceUserName>
       <WebservicePassword>string</WebservicePassword>
       <UserName>string</UserName>
       <Password>string</Password>
       <Domain>string</Domain>
     </CheckLogin>
   </soap12:Body>
 </soap12:Envelope>

 HTTP/1.1 200 OK
 Content-Type: application/soap+xml; charset=utf-8
 Content-Length: length
 
 <?xml version="1.0" encoding="utf-8"?>
 <soap12:Envelope xmlns:xsi="<nowiki>http://www.w3.org/2001/XMLSchema-instance</nowiki>" xmlns:xsd="<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>" xmlns:soap12="<nowiki>http://www.w3.org/2003/05/soap-envelope</nowiki>">
   <soap12:Body>
     <CheckLoginResponse xmlns="<nowiki>http://DataExport.inlogic.dk/</nowiki>">
       <CheckLoginResult>
         <ErrorMessage>string</ErrorMessage>
         <ErrCode>int</ErrCode>
       </CheckLoginResult>
     </CheckLoginResponse>
   </soap12:Body>
 </soap12:Envelope>

====HTTP GET====
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
 GET /Webservices/DataExport.asmx/CheckLogin?WebserviceUserName=string&WebservicePassword=string&UserName=string&Password=string&Domain=string HTTP/1.1
 Host: localhost

 HTTP/1.1 200 OK
 Content-Type: text/xml; charset=utf-8
 Content-Length: length
 
 <?xml version="1.0" encoding="utf-8"?>
 <RequestResult xmlns="<nowiki>http://DataExport.inlogic.dk/</nowiki>">
   <ErrorMessage>string</ErrorMessage>
   <ErrCode>int</ErrCode>
 </RequestResult>

====HTTP POST====
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
 POST /Webservices/DataExport.asmx/CheckLogin HTTP/1.1
 Host: localhost
 Content-Type: application/x-www-form-urlencoded
 Content-Length: length
 
 WebserviceUserName=string&WebservicePassword=string&UserName=string&Password=string&Domain=string

 HTTP/1.1 200 OK
 Content-Type: text/xml; charset=utf-8
 Content-Length: length
 
 <?xml version="1.0" encoding="utf-8"?>
 <RequestResult xmlns="<nowiki>http://DataExport.inlogic.dk/</nowiki>">
   <ErrorMessage>string</ErrorMessage>
   <ErrCode>int</ErrCode>
 </RequestResult>

===EmployeeEmploymentInfo===
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
 POST /Webservices/DataExport.asmx HTTP/1.1
 Host: localhost
 Content-Type: application/soap+xml; charset=utf-8
 Content-Length: length
 
 <?xml version="1.0" encoding="utf-8"?>
 <soap12:Envelope xmlns:xsi="<nowiki>http://www.w3.org/2001/XMLSchema-instance</nowiki>" xmlns:xsd="<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>" xmlns:soap12="<nowiki>http://www.w3.org/2003/05/soap-envelope</nowiki>">
   <soap12:Body>
     <EmployeeEmploymentInfo xmlns="<nowiki>http://DataExport.inlogic.dk/</nowiki>">
       <UserName>string</UserName>
       <Password>string</Password>
       <Employees>
         <AllUsers>boolean</AllUsers>
         <OnlyActiveUsers>boolean</OnlyActiveUsers>
         <ShowInitialPassword>boolean</ShowInitialPassword>
         <ShowCurrentPassword>boolean</ShowCurrentPassword>
         <Usernames>
           <string>string</string>
           <string>string</string>
         </Usernames>
       </Employees>
     </EmployeeEmploymentInfo>
   </soap12:Body>
 </soap12:Envelope>

 HTTP/1.1 200 OK
 Content-Type: application/soap+xml; charset=utf-8
 Content-Length: length
 
 <?xml version="1.0" encoding="utf-8"?>
 <soap12:Envelope xmlns:xsi="<nowiki>http://www.w3.org/2001/XMLSchema-instance</nowiki>" xmlns:xsd="<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>" xmlns:soap12="<nowiki>http://www.w3.org/2003/05/soap-envelope</nowiki>">
   <soap12:Body>
     <EmployeeEmploymentInfoResponse xmlns="<nowiki>http://DataExport.inlogic.dk/</nowiki>">
       <EmployeeEmploymentInfoResult>
         <ErrorMessage>string</ErrorMessage>
         <ErrCode>int</ErrCode>
         <EmployeesEmployment>
           <EmployeeEmployment>
             <UserName>string</UserName>
             <Employments xsi:nil="true" />
             <Departments xsi:nil="true" />
             <Salaries xsi:nil="true" />
           </EmployeeEmployment>
           <EmployeeEmployment>
             <UserName>string</UserName>
             <Employments xsi:nil="true" />
             <Departments xsi:nil="true" />
             <Salaries xsi:nil="true" />
           </EmployeeEmployment>
         </EmployeesEmployment>
       </EmployeeEmploymentInfoResult>
     </EmployeeEmploymentInfoResponse>
   </soap12:Body>
 </soap12:Envelope>

===EmployeePersonalInfo===
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
 POST /Webservices/DataExport.asmx HTTP/1.1
 Host: localhost
 Content-Type: application/soap+xml; charset=utf-8
 Content-Length: length
 
 <?xml version="1.0" encoding="utf-8"?>
 <soap12:Envelope xmlns:xsi="<nowiki>http://www.w3.org/2001/XMLSchema-instance</nowiki>" xmlns:xsd="<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>" xmlns:soap12="<nowiki>http://www.w3.org/2003/05/soap-envelope</nowiki>">
   <soap12:Body>
     <EmployeePersonalInfo xmlns="<nowiki>http://DataExport.inlogic.dk/</nowiki>">
       <UserName>string</UserName>
       <Password>string</Password>
       <Employees>
         <AllUsers>boolean</AllUsers>
         <OnlyActiveUsers>boolean</OnlyActiveUsers>
         <ShowInitialPassword>boolean</ShowInitialPassword>
         <ShowCurrentPassword>boolean</ShowCurrentPassword>
         <Usernames>
           <string>string</string>
           <string>string</string>
         </Usernames>
       </Employees>
     </EmployeePersonalInfo>
   </soap12:Body>
 </soap12:Envelope>

 HTTP/1.1 200 OK
 Content-Type: application/soap+xml; charset=utf-8
 Content-Length: length
 
 <?xml version="1.0" encoding="utf-8"?>
 <soap12:Envelope xmlns:xsi="<nowiki>http://www.w3.org/2001/XMLSchema-instance</nowiki>" xmlns:xsd="<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>" xmlns:soap12="<nowiki>http://www.w3.org/2003/05/soap-envelope</nowiki>">
   <soap12:Body>
     <EmployeePersonalInfoResponse xmlns="<nowiki>http://DataExport.inlogic.dk/</nowiki>">
       <EmployeePersonalInfoResult>
         <ErrorMessage>string</ErrorMessage>
         <ErrCode>int</ErrCode>
         <Employees>
           <Employee>
             <AdministrativeSystem xsi:nil="true" />
             <UserName>string</UserName>
             <SSN>string</SSN>
             <GivenName>string</GivenName>
             <SurName>string</SurName>
             <Employee_Type>string</Employee_Type>
             <CurrentPassword>string</CurrentPassword>
             <InitialPassword>string</InitialPassword>
             <Addresses xsi:nil="true" />
             <PhoneNumbers xsi:nil="true" />
             <MobilePhones xsi:nil="true" />
             <WorkMailAddresses xsi:nil="true" />
           </Employee>
           <Employee>
             <AdministrativeSystem xsi:nil="true" />
             <UserName>string</UserName>
             <SSN>string</SSN>
             <GivenName>string</GivenName>
             <SurName>string</SurName>
             <Employee_Type>string</Employee_Type>
             <CurrentPassword>string</CurrentPassword>
             <InitialPassword>string</InitialPassword>
             <Addresses xsi:nil="true" />
             <PhoneNumbers xsi:nil="true" />
             <MobilePhones xsi:nil="true" />
             <WorkMailAddresses xsi:nil="true" />
           </Employee>
         </Employees>
       </EmployeePersonalInfoResult>
     </EmployeePersonalInfoResponse>
   </soap12:Body>
 </soap12:Envelope>

===StudentPersonalInfo===
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
 POST /Webservices/DataExport.asmx HTTP/1.1
 Host: localhost
 Content-Type: application/soap+xml; charset=utf-8
 Content-Length: length
 
 <?xml version="1.0" encoding="utf-8"?>
 <soap12:Envelope xmlns:xsi="<nowiki>http://www.w3.org/2001/XMLSchema-instance</nowiki>" xmlns:xsd="<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>" xmlns:soap12="<nowiki>http://www.w3.org/2003/05/soap-envelope</nowiki>">
   <soap12:Body>
     <StudentPersonalInfo xmlns="<nowiki>http://DataExport.inlogic.dk/</nowiki>">
       <UserName>string</UserName>
       <Password>string</Password>
       <Students>
         <AllUsers>boolean</AllUsers>
         <OnlyActiveUsers>boolean</OnlyActiveUsers>
         <ShowInitialPassword>boolean</ShowInitialPassword>
         <ShowCurrentPassword>boolean</ShowCurrentPassword>
         <Usernames>
           <string>string</string>
           <string>string</string>
         </Usernames>
       </Students>
     </StudentPersonalInfo>
   </soap12:Body>
 </soap12:Envelope>

 HTTP/1.1 200 OK
 Content-Type: application/soap+xml; charset=utf-8
 Content-Length: length
 
 <?xml version="1.0" encoding="utf-8"?>
 <soap12:Envelope xmlns:xsi="<nowiki>http://www.w3.org/2001/XMLSchema-instance</nowiki>" xmlns:xsd="<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>" xmlns:soap12="<nowiki>http://www.w3.org/2003/05/soap-envelope</nowiki>">
   <soap12:Body>
     <StudentPersonalInfoResponse xmlns="<nowiki>http://DataExport.inlogic.dk/</nowiki>">
       <StudentPersonalInfoResult>
         <ErrorMessage>string</ErrorMessage>
         <ErrCode>int</ErrCode>
         <Students>
           <Student>
             <AdministrativeSystem xsi:nil="true" />
             <UserName>string</UserName>
             <SSN>string</SSN>
             <GivenName>string</GivenName>
             <SurName>string</SurName>
             <CurrentPassword>string</CurrentPassword>
             <InitialPassword>string</InitialPassword>
             <Addresses xsi:nil="true" />
             <PhoneNumbers xsi:nil="true" />
             <MobilePhones xsi:nil="true" />
             <PrivateMailAddresses xsi:nil="true" />
             <Educations xsi:nil="true" />
           </Student>
           <Student>
             <AdministrativeSystem xsi:nil="true" />
             <UserName>string</UserName>
             <SSN>string</SSN>
             <GivenName>string</GivenName>
             <SurName>string</SurName>
             <CurrentPassword>string</CurrentPassword>
             <InitialPassword>string</InitialPassword>
             <Addresses xsi:nil="true" />
             <PhoneNumbers xsi:nil="true" />
             <MobilePhones xsi:nil="true" />
             <PrivateMailAddresses xsi:nil="true" />
             <Educations xsi:nil="true" />
           </Student>
         </Students>
       </StudentPersonalInfoResult>
     </StudentPersonalInfoResponse>
   </soap12:Body>
 </soap12:Envelope>

===UsersOnActivities===
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
 POST /Webservices/DataExport.asmx HTTP/1.1
 Host: localhost
 Content-Type: application/soap+xml; charset=utf-8
 Content-Length: length
 
 <?xml version="1.0" encoding="utf-8"?>
 <soap12:Envelope xmlns:xsi="<nowiki>http://www.w3.org/2001/XMLSchema-instance</nowiki>" xmlns:xsd="<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>" xmlns:soap12="<nowiki>http://www.w3.org/2003/05/soap-envelope</nowiki>">
   <soap12:Body>
     <UsersOnActivities xmlns="<nowiki>http://DataExport.inlogic.dk/</nowiki>">
       <UserName>string</UserName>
       <Password>string</Password>
       <Activities>
         <AllActivities>boolean</AllActivities>
         <AllDepartments>boolean</AllDepartments>
         <OnlyActiveActivities>boolean</OnlyActiveActivities>
         <OnlyActiveUsers>boolean</OnlyActiveUsers>
         <DepartmentNames>
           <string>string</string>
           <string>string</string>
         </DepartmentNames>
         <Activities>
           <string>string</string>
           <string>string</string>
         </Activities>
       </Activities>
       <RecordType>Students or Employees or All</RecordType>
     </UsersOnActivities>
   </soap12:Body>
 </soap12:Envelope>

 HTTP/1.1 200 OK
 Content-Type: application/soap+xml; charset=utf-8
 Content-Length: length
 
 <?xml version="1.0" encoding="utf-8"?>
 <soap12:Envelope xmlns:xsi="<nowiki>http://www.w3.org/2001/XMLSchema-instance</nowiki>" xmlns:xsd="<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>" xmlns:soap12="<nowiki>http://www.w3.org/2003/05/soap-envelope</nowiki>">
   <soap12:Body>
     <UsersOnActivitiesResponse xmlns="<nowiki>http://DataExport.inlogic.dk/</nowiki>">
       <UsersOnActivitiesResult>
         <ErrorMessage>string</ErrorMessage>
         <ErrCode>int</ErrCode>
         <Activities>
           <Activity>
             <RowType>string</RowType>
             <Activity>string</Activity>
             <ActivityDisplayName>string</ActivityDisplayName>
             <Activity_ShortDescription>string</Activity_ShortDescription>
             <ActivityDescription>string</ActivityDescription>
             <ActivityDepartmentNumber>string</ActivityDepartmentNumber>
             <Activity_StartDate>dateTime</Activity_StartDate>
             <Activity_EndDate>dateTime</Activity_EndDate>
             <Participants xsi:nil="true" />
             <Teachers xsi:nil="true" />
             <Courses xsi:nil="true" />
           </Activity>
           <Activity>
             <RowType>string</RowType>
             <Activity>string</Activity>
             <ActivityDisplayName>string</ActivityDisplayName>
             <Activity_ShortDescription>string</Activity_ShortDescription>
             <ActivityDescription>string</ActivityDescription>
             <ActivityDepartmentNumber>string</ActivityDepartmentNumber>
             <Activity_StartDate>dateTime</Activity_StartDate>
             <Activity_EndDate>dateTime</Activity_EndDate>
             <Participants xsi:nil="true" />
             <Teachers xsi:nil="true" />
             <Courses xsi:nil="true" />
           </Activity>
         </Activities>
       </UsersOnActivitiesResult>
     </UsersOnActivitiesResponse>
   </soap12:Body>
 </soap12:Envelope>