VT_API Web Service

VT_API

Click here for a complete list of operations.

GetWebOccurrencesOverlappingDateRangeForProgramme

Gets a list of web-enabled occurrences within the specified date range for the specified programme

Test

The test form is only available for requests from the local machine.

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 /VT_API.asmx HTTP/1.1
Host: vettrak.jmdr.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.ozsoft.com.au/VETtrak/api/complete/GetWebOccurrencesOverlappingDateRangeForProgramme"

<?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>
    <GetWebOccurrencesOverlappingDateRangeForProgramme xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <rangeStart>dateTime</rangeStart>
      <rangeEnd>dateTime</rangeEnd>
      <programmeId>int</programmeId>
    </GetWebOccurrencesOverlappingDateRangeForProgramme>
  </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>
    <GetWebOccurrencesOverlappingDateRangeForProgrammeResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetWebOccurrencesOverlappingDateRangeForProgrammeResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <OccuList>
          <TOccu>
            <Prog_ID>int</Prog_ID>
            <Prog_Code>string</Prog_Code>
            <Prog_Name>string</Prog_Name>
            <Vacancies>int</Vacancies>
            <Uploaded>int</Uploaded>
            <Reportable>int</Reportable>
            <WebPublished>int</WebPublished>
            <Colour>string</Colour>
          </TOccu>
          <TOccu>
            <Prog_ID>int</Prog_ID>
            <Prog_Code>string</Prog_Code>
            <Prog_Name>string</Prog_Name>
            <Vacancies>int</Vacancies>
            <Uploaded>int</Uploaded>
            <Reportable>int</Reportable>
            <WebPublished>int</WebPublished>
            <Colour>string</Colour>
          </TOccu>
        </OccuList>
      </GetWebOccurrencesOverlappingDateRangeForProgrammeResult>
    </GetWebOccurrencesOverlappingDateRangeForProgrammeResponse>
  </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 /VT_API.asmx HTTP/1.1
Host: vettrak.jmdr.com
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>
    <GetWebOccurrencesOverlappingDateRangeForProgramme xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <token>string</token>
      <rangeStart>dateTime</rangeStart>
      <rangeEnd>dateTime</rangeEnd>
      <programmeId>int</programmeId>
    </GetWebOccurrencesOverlappingDateRangeForProgramme>
  </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>
    <GetWebOccurrencesOverlappingDateRangeForProgrammeResponse xmlns="http://www.ozsoft.com.au/VETtrak/api/complete">
      <GetWebOccurrencesOverlappingDateRangeForProgrammeResult>
        <Auth>
          <ID>int</ID>
          <Token>string</Token>
          <Status>int</Status>
          <StatusMessage>string</StatusMessage>
          <Identifier>string</Identifier>
          <TokenType>string</TokenType>
        </Auth>
        <OccuList>
          <TOccu>
            <Prog_ID>int</Prog_ID>
            <Prog_Code>string</Prog_Code>
            <Prog_Name>string</Prog_Name>
            <Vacancies>int</Vacancies>
            <Uploaded>int</Uploaded>
            <Reportable>int</Reportable>
            <WebPublished>int</WebPublished>
            <Colour>string</Colour>
          </TOccu>
          <TOccu>
            <Prog_ID>int</Prog_ID>
            <Prog_Code>string</Prog_Code>
            <Prog_Name>string</Prog_Name>
            <Vacancies>int</Vacancies>
            <Uploaded>int</Uploaded>
            <Reportable>int</Reportable>
            <WebPublished>int</WebPublished>
            <Colour>string</Colour>
          </TOccu>
        </OccuList>
      </GetWebOccurrencesOverlappingDateRangeForProgrammeResult>
    </GetWebOccurrencesOverlappingDateRangeForProgrammeResponse>
  </soap12:Body>
</soap12:Envelope>