API Integration

OTG API Documentation

To use the OTG API, you should reference:

https://www.beautyschooltestingonline.com/OTGAPI.asmx (production)

http://dev.ravineware.com/otg/OTGAPI.asmx (development)

The API is developed as an ASP.Net webservice. The API may also be accessed using SOAP protocols or HTTP Post. Results are returned as XML.

To make your API calls, you will need an API Key. This key will be provided to you by OTG technical staff. This API Key must be passed in with every API call.

Methods

GetSchools
CreateStudent
GetTokenLogin
GetStudentScores

GetSchools

To assign students to a school, you first need the school ID. We provided the GetSchools method so that you may obtain a list of all the schools you have access to with your API Key. Contact us if a school you
need access to is not on the list. You may cache this data if you wish as the list probably will remain relatively stable. Once you have the list of schools, use the SchoolID that is returned to create
students, or to perform other operations at the school level.

The call to GetSchools expects only one argument, your API Key. It will return a list of all schools you have access to.

The examples below show all of the return fields along with their data types. Check the ErrorMessage property for any errors.

 

This is a form/post example:

Parameter Value
APIKey:

 

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /OTGWeb/OTGAPI.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.beautyschooltestingonline.com/webservices/GetSchools"
<?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>
    <GetSchools xmlns="https://www.beautyschooltestingonline.com/webservices">
      <APIKey>string</APIKey>
    </GetSchools>
  </soap:Body>
</soap:Envelope>
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>
    <GetSchoolsResponse xmlns="https://www.beautyschooltestingonline.com/webservices">
      <GetSchoolsResult>
        <SchoolRecord>
          <SchoolID>int</SchoolID>
          <SchoolName>string</SchoolName>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <City>string</City>
          <State>string</State>
          <Country>string</Country>
          <Zipcode>string</Zipcode>
          <Telephone>string</Telephone>
          <Fax>string</Fax>
          <Email>string</Email>
          <Contact>string</Contact>
          <Active>boolean</Active>
          <ContactTitle>string</ContactTitle>
          <UniqueKey>string</UniqueKey>
          <ErrorMessage>string</ErrorMessage>
        </SchoolRecord>
        <SchoolRecord>
          <SchoolID>int</SchoolID>
          <SchoolName>string</SchoolName>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <City>string</City>
          <State>string</State>
          <Country>string</Country>
          <Zipcode>string</Zipcode>
          <Telephone>string</Telephone>
          <Fax>string</Fax>
          <Email>string</Email>
          <Contact>string</Contact>
          <Active>boolean</Active>
          <ContactTitle>string</ContactTitle>
          <UniqueKey>string</UniqueKey>
          <ErrorMessage>string</ErrorMessage>
        </SchoolRecord>
      </GetSchoolsResult>
    </GetSchoolsResponse>
  </soap:Body>
</soap:Envelope>

 

 

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 /OTGWeb/OTGAPI.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="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetSchools xmlns="https://www.beautyschooltestingonline.com/webservices">
      <APIKey>string</APIKey>
    </GetSchools>
  </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="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetSchoolsResponse xmlns="https://www.beautyschooltestingonline.com/webservices">
      <GetSchoolsResult>
        <SchoolRecord>
          <SchoolID>int</SchoolID>
          <SchoolName>string</SchoolName>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <City>string</City>
          <State>string</State>
          <Country>string</Country>
          <Zipcode>string</Zipcode>
          <Telephone>string</Telephone>
          <Fax>string</Fax>
          <Email>string</Email>
          <Contact>string</Contact>
          <Active>boolean</Active>
          <ContactTitle>string</ContactTitle>
          <UniqueKey>string</UniqueKey>
          <ErrorMessage>string</ErrorMessage>
        </SchoolRecord>
        <SchoolRecord>
          <SchoolID>int</SchoolID>
          <SchoolName>string</SchoolName>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <City>string</City>
          <State>string</State>
          <Country>string</Country>
          <Zipcode>string</Zipcode>
          <Telephone>string</Telephone>
          <Fax>string</Fax>
          <Email>string</Email>
          <Contact>string</Contact>
          <Active>boolean</Active>
          <ContactTitle>string</ContactTitle>
          <UniqueKey>string</UniqueKey>
          <ErrorMessage>string</ErrorMessage>
        </SchoolRecord>
      </GetSchoolsResult>
    </GetSchoolsResponse>
  </soap12:Body>
</soap12:Envelope>

 

 

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /OTGWeb/OTGAPI.asmx/GetSchools HTTP/1.1
Host: localhost
Content-Type: application/x-www-form-urlencoded
Content-Length: length
APIKey=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfSchoolRecord xmlns="https://www.beautyschooltestingonline.com/webservices">
  <SchoolRecord>
    <SchoolID>int</SchoolID>
    <SchoolName>string</SchoolName>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <City>string</City>
    <State>string</State>
    <Country>string</Country>
    <Zipcode>string</Zipcode>
    <Telephone>string</Telephone>
    <Fax>string</Fax>
    <Email>string</Email>
    <Contact>string</Contact>
    <Active>boolean</Active>
    <ContactTitle>string</ContactTitle>
    <UniqueKey>string</UniqueKey>
    <ErrorMessage>string</ErrorMessage>
  </SchoolRecord>
  <SchoolRecord>
    <SchoolID>int</SchoolID>
    <SchoolName>string</SchoolName>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <City>string</City>
    <State>string</State>
    <Country>string</Country>
    <Zipcode>string</Zipcode>
    <Telephone>string</Telephone>
    <Fax>string</Fax>
    <Email>string</Email>
    <Contact>string</Contact>
    <Active>boolean</Active>
    <ContactTitle>string</ContactTitle>
    <UniqueKey>string</UniqueKey>
    <ErrorMessage>string</ErrorMessage>
  </SchoolRecord>
</ArrayOfSchoolRecord>

CreateStudent

Before any student gets access to the OTG system, their account must be created and they must be assigned to a school. Required fields would be API Key, School ID, Email Address, Password, First Name, and Last Name. You may also pass
your internal Student ID to us. This helps with tracking the students, especially when exporting data or trying to tie a student in our system back to your system.

All parameters are string except for SchoolID, which is an integer.

The return XML packet will include the same data with the addition of our numeric UserID, and an ErrorMessage for you to review if any error occurred. If you can, we recommend that you record the UserID in your system.

 

This is a form/post example:

Parameter Value
APIKey:
SchoolID:
EmailAddress:
Password:
Title:
FirstName:
MiddleName:
LastName:
Address1:
Address2:
City:
State:
Country:
Zipcode:
Telephone:
YourInternalStudentID:

 

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /OTGWeb/OTGAPI.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.beautyschooltestingonline.com/webservices/CreateStudent"
<?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>
    <CreateStudent xmlns="https://www.beautyschooltestingonline.com/webservices">
      <APIKey>string</APIKey>
      <SchoolID>int</SchoolID>
      <EmailAddress>string</EmailAddress>
      <Password>string</Password>
      <Title>string</Title>
      <FirstName>string</FirstName>
      <MiddleName>string</MiddleName>
      <LastName>string</LastName>
      <Address1>string</Address1>
      <Address2>string</Address2>
      <City>string</City>
      <State>string</State>
      <Country>string</Country>
      <Zipcode>string</Zipcode>
      <Telephone>string</Telephone>
      <YourInternalStudentID>string</YourInternalStudentID>
    </CreateStudent>
  </soap:Body>
</soap:Envelope>
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>
    <CreateStudentResponse xmlns="https://www.beautyschooltestingonline.com/webservices">
      <CreateStudentResult>
        <UserID>int</UserID>
        <UserName>string</UserName>
        <Password>string</Password>
        <SchoolID>int</SchoolID>
        <Title>string</Title>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <City>string</City>
        <State>string</State>
        <Country>string</Country>
        <Zipcode>string</Zipcode>
        <Telephone>string</Telephone>
        <EmailAddress>string</EmailAddress>
        <LoginDisable>boolean</LoginDisable>
        <LoginCount>int</LoginCount>
        <StudentID>string</StudentID>
        <ErrorMessage>string</ErrorMessage>
      </CreateStudentResult>
    </CreateStudentResponse>
  </soap:Body>
</soap:Envelope>

 

 

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 /OTGWeb/OTGAPI.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="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CreateStudent xmlns="https://www.beautyschooltestingonline.com/webservices">
      <APIKey>string</APIKey>
      <SchoolID>int</SchoolID>
      <EmailAddress>string</EmailAddress>
      <Password>string</Password>
      <Title>string</Title>
      <FirstName>string</FirstName>
      <MiddleName>string</MiddleName>
      <LastName>string</LastName>
      <Address1>string</Address1>
      <Address2>string</Address2>
      <City>string</City>
      <State>string</State>
      <Country>string</Country>
      <Zipcode>string</Zipcode>
      <Telephone>string</Telephone>
      <YourInternalStudentID>string</YourInternalStudentID>
    </CreateStudent>
  </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="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CreateStudentResponse xmlns="https://www.beautyschooltestingonline.com/webservices">
      <CreateStudentResult>
        <UserID>int</UserID>
        <UserName>string</UserName>
        <Password>string</Password>
        <SchoolID>int</SchoolID>
        <Title>string</Title>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <City>string</City>
        <State>string</State>
        <Country>string</Country>
        <Zipcode>string</Zipcode>
        <Telephone>string</Telephone>
        <EmailAddress>string</EmailAddress>
        <LoginDisable>boolean</LoginDisable>
        <LoginCount>int</LoginCount>
        <StudentID>string</StudentID>
        <ErrorMessage>string</ErrorMessage>
      </CreateStudentResult>
    </CreateStudentResponse>
  </soap12:Body>
</soap12:Envelope>

 

 

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /OTGWeb/OTGAPI.asmx/CreateStudent HTTP/1.1
Host: localhost
Content-Type: application/x-www-form-urlencoded
Content-Length: length
APIKey=string&SchoolID=string&EmailAddress=string&Password=string&Title=string&FirstName=string&MiddleName=string&LastName=string&Address1=string&Address2=string&City=string&State=string&Country=string&Zipcode=string&Telephone=string&YourInternalStudentID=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<StudentRecord xmlns="https://www.beautyschooltestingonline.com/webservices">
  <UserID>int</UserID>
  <UserName>string</UserName>
  <Password>string</Password>
  <SchoolID>int</SchoolID>
  <Title>string</Title>
  <FirstName>string</FirstName>
  <MiddleName>string</MiddleName>
  <LastName>string</LastName>
  <Address1>string</Address1>
  <Address2>string</Address2>
  <City>string</City>
  <State>string</State>
  <Country>string</Country>
  <Zipcode>string</Zipcode>
  <Telephone>string</Telephone>
  <EmailAddress>string</EmailAddress>
  <LoginDisable>boolean</LoginDisable>
  <LoginCount>int</LoginCount>
  <StudentID>string</StudentID>
  <ErrorMessage>string</ErrorMessage>
</StudentRecord>

GetTokenLogin

Gets a unique expiring login token for a student. Token login is only allowed for students created by your API Key. The token expires within ten minutes of the returned UTC date time value. Also returns the URL to redirect the student.

The parameters you need to pass are API Key (string) and User ID (integer). The User ID would have been returned from a call to the CreateStudent method.

This will return the TokenID, the UTC Expiration Date, the User ID, a Token Login URL, and an ErrorMessage, if any occur. To log the student into the system, simply redirect the student to the Token Login URL once you have received it back from the API call.

This is a form/post example:

Parameter Value
APIKey:
UserID:

 

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /OTGWeb/OTGAPI.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.beautyschooltestingonline.com/webservices/GetLoginToken"
<?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>
    <GetLoginToken xmlns="https://www.beautyschooltestingonline.com/webservices">
      <APIKey>string</APIKey>
      <UserID>int</UserID>
    </GetLoginToken>
  </soap:Body>
</soap:Envelope>
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>
    <GetLoginTokenResponse xmlns="https://www.beautyschooltestingonline.com/webservices">
      <GetLoginTokenResult>
        <TokenID>string</TokenID>
        <ExpirationDateTimeUTC>dateTime</ExpirationDateTimeUTC>
        <UserID>int</UserID>
        <TokenLoginURL>string</TokenLoginURL>
        <ErrorMessage>string</ErrorMessage>
      </GetLoginTokenResult>
    </GetLoginTokenResponse>
  </soap:Body>
</soap:Envelope>

 

 

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 /OTGWeb/OTGAPI.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="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetLoginToken xmlns="https://www.beautyschooltestingonline.com/webservices">
      <APIKey>string</APIKey>
      <UserID>int</UserID>
    </GetLoginToken>
  </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="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetLoginTokenResponse xmlns="https://www.beautyschooltestingonline.com/webservices">
      <GetLoginTokenResult>
        <TokenID>string</TokenID>
        <ExpirationDateTimeUTC>dateTime</ExpirationDateTimeUTC>
        <UserID>int</UserID>
        <TokenLoginURL>string</TokenLoginURL>
        <ErrorMessage>string</ErrorMessage>
      </GetLoginTokenResult>
    </GetLoginTokenResponse>
  </soap12:Body>
</soap12:Envelope>

 

 

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /OTGWeb/OTGAPI.asmx/GetLoginToken HTTP/1.1
Host: localhost
Content-Type: application/x-www-form-urlencoded
Content-Length: length
APIKey=string&UserID=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<TokenRecord xmlns="https://www.beautyschooltestingonline.com/webservices">
  <TokenID>string</TokenID>
  <ExpirationDateTimeUTC>dateTime</ExpirationDateTimeUTC>
  <UserID>int</UserID>
  <TokenLoginURL>string</TokenLoginURL>
  <ErrorMessage>string</ErrorMessage>
</TokenRecord>

GetStudentScores

Gets score records. Use a 0 for UserID, ExamID, or InstructorID to search all students, exams, or instructors. Date range is required.

This method will return score records for the provided search parameters. The data will include School ID and User ID, along with some basic Student and Exam information, what the passing score is,
the instructor information, and the student’s score. There is also an ErrorMessage parameter if an error occurs.

 

This is a form/post example:

Parameter Value
APIKey:
UserID:
ExamID:
InstructorID:
CompanyID:
FromDate:
ToDate:

 

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /OTGWeb/OTGAPI.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.beautyschooltestingonline.com/webservices/GetStudentScores"
<?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>
    <GetStudentScores xmlns="https://www.beautyschooltestingonline.com/webservices">
      <APIKey>string</APIKey>
      <UserID>int</UserID>
      <ExamID>int</ExamID>
      <InstructorID>int</InstructorID>
      <CompanyID>int</CompanyID>
      <FromDate>dateTime</FromDate>
      <ToDate>dateTime</ToDate>
    </GetStudentScores>
  </soap:Body>
</soap:Envelope>
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>
    <GetStudentScoresResponse xmlns="https://www.beautyschooltestingonline.com/webservices">
      <GetStudentScoresResult>
        <ScoreRecord>
          <SchoolID>int</SchoolID>
          <UserID>int</UserID>
          <UserName>string</UserName>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <ExamID>int</ExamID>
          <ExamName>string</ExamName>
          <Description>string</Description>
          <QuestionCount>int</QuestionCount>
          <PassingScore>string</PassingScore>
          <DateCompletedUTC>dateTime</DateCompletedUTC>
          <TestOverallScore>double</TestOverallScore>
          <InstructorID>int</InstructorID>
          <InstructorName>string</InstructorName>
          <InstructorEmail>string</InstructorEmail>
          <StudentID>string</StudentID>
          <ErrorMessage>string</ErrorMessage>
        </ScoreRecord>
        <ScoreRecord>
          <SchoolID>int</SchoolID>
          <UserID>int</UserID>
          <UserName>string</UserName>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <ExamID>int</ExamID>
          <ExamName>string</ExamName>
          <Description>string</Description>
          <QuestionCount>int</QuestionCount>
          <PassingScore>string</PassingScore>
          <DateCompletedUTC>dateTime</DateCompletedUTC>
          <TestOverallScore>double</TestOverallScore>
          <InstructorID>int</InstructorID>
          <InstructorName>string</InstructorName>
          <InstructorEmail>string</InstructorEmail>
          <StudentID>string</StudentID>
          <ErrorMessage>string</ErrorMessage>
        </ScoreRecord>
      </GetStudentScoresResult>
    </GetStudentScoresResponse>
  </soap:Body>
</soap:Envelope>

 

 

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 /OTGWeb/OTGAPI.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="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetStudentScores xmlns="https://www.beautyschooltestingonline.com/webservices">
      <APIKey>string</APIKey>
      <UserID>int</UserID>
      <ExamID>int</ExamID>
      <InstructorID>int</InstructorID>
      <CompanyID>int</CompanyID>
      <FromDate>dateTime</FromDate>
      <ToDate>dateTime</ToDate>
    </GetStudentScores>
  </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="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetStudentScoresResponse xmlns="https://www.beautyschooltestingonline.com/webservices">
      <GetStudentScoresResult>
        <ScoreRecord>
          <SchoolID>int</SchoolID>
          <UserID>int</UserID>
          <UserName>string</UserName>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <ExamID>int</ExamID>
          <ExamName>string</ExamName>
          <Description>string</Description>
          <QuestionCount>int</QuestionCount>
          <PassingScore>string</PassingScore>
          <DateCompletedUTC>dateTime</DateCompletedUTC>
          <TestOverallScore>double</TestOverallScore>
          <InstructorID>int</InstructorID>
          <InstructorName>string</InstructorName>
          <InstructorEmail>string</InstructorEmail>
          <StudentID>string</StudentID>
          <ErrorMessage>string</ErrorMessage>
        </ScoreRecord>
        <ScoreRecord>
          <SchoolID>int</SchoolID>
          <UserID>int</UserID>
          <UserName>string</UserName>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <ExamID>int</ExamID>
          <ExamName>string</ExamName>
          <Description>string</Description>
          <QuestionCount>int</QuestionCount>
          <PassingScore>string</PassingScore>
          <DateCompletedUTC>dateTime</DateCompletedUTC>
          <TestOverallScore>double</TestOverallScore>
          <InstructorID>int</InstructorID>
          <InstructorName>string</InstructorName>
          <InstructorEmail>string</InstructorEmail>
          <StudentID>string</StudentID>
          <ErrorMessage>string</ErrorMessage>
        </ScoreRecord>
      </GetStudentScoresResult>
    </GetStudentScoresResponse>
  </soap12:Body>
</soap12:Envelope>

 

 

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /OTGWeb/OTGAPI.asmx/GetStudentScores HTTP/1.1
Host: localhost
Content-Type: application/x-www-form-urlencoded
Content-Length: length
APIKey=string&UserID=string&ExamID=string&InstructorID=string&CompanyID=string&FromDate=string&ToDate=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfScoreRecord xmlns="https://www.beautyschooltestingonline.com/webservices">
  <ScoreRecord>
    <SchoolID>int</SchoolID>
    <UserID>int</UserID>
    <UserName>string</UserName>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <ExamID>int</ExamID>
    <ExamName>string</ExamName>
    <Description>string</Description>
    <QuestionCount>int</QuestionCount>
    <PassingScore>string</PassingScore>
    <DateCompletedUTC>dateTime</DateCompletedUTC>
    <TestOverallScore>double</TestOverallScore>
    <InstructorID>int</InstructorID>
    <InstructorName>string</InstructorName>
    <InstructorEmail>string</InstructorEmail>
    <StudentID>string</StudentID>
    <ErrorMessage>string</ErrorMessage>
  </ScoreRecord>
  <ScoreRecord>
    <SchoolID>int</SchoolID>
    <UserID>int</UserID>
    <UserName>string</UserName>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <ExamID>int</ExamID>
    <ExamName>string</ExamName>
    <Description>string</Description>
    <QuestionCount>int</QuestionCount>
    <PassingScore>string</PassingScore>
    <DateCompletedUTC>dateTime</DateCompletedUTC>
    <TestOverallScore>double</TestOverallScore>
    <InstructorID>int</InstructorID>
    <InstructorName>string</InstructorName>
    <InstructorEmail>string</InstructorEmail>
    <StudentID>string</StudentID>
    <ErrorMessage>string</ErrorMessage>
  </ScoreRecord>
</ArrayOfScoreRecord>