ClipsProjectInformation Web Service

ClipsProjectInformation

Click here for a complete list of operations.

GetAllClipsProjects

This method retrieves all CLIPS projects found in Active Projects (\\otfwinclcli\Active_Projects\) where a corresponding project in Project Central was also found. if 'readyProjects' is flagged then only CLIPS projects found in Active Projects where the folder is not empty, and where a corresponding project in Project Central was also found. A CLIPS Project is ready if it's Active Projects folder contains a 'Project name' folder that contains files or folders.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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 /ClipsProjectInformation.asmx HTTP/1.1
Host: vle-web-services-pre.azurewebsites.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws.cli.det.nsw.edu.au/lspwebservices/GetAllClipsProjects"

<?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>
    <GetAllClipsProjects xmlns="http://ws.cli.det.nsw.edu.au/lspwebservices/">
      <readyProjects>boolean</readyProjects>
    </GetAllClipsProjects>
  </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>
    <GetAllClipsProjectsResponse xmlns="http://ws.cli.det.nsw.edu.au/lspwebservices/">
      <GetAllClipsProjectsResult>
        <CLIPSProject>
          <ProjectID>string</ProjectID>
          <Folder>string</Folder>
          <CustomFolder>string</CustomFolder>
          <ClipsReady>boolean</ClipsReady>
          <Project>
            <ProjectNumber>string</ProjectNumber>
            <ManagerUsername>string</ManagerUsername>
            <ProjectName>string</ProjectName>
            <SubProjectID>decimal</SubProjectID>
            <Source>NotSet or ProjectDatabase or Legacy</Source>
          </Project>
          <CheckedWithDB>boolean</CheckedWithDB>
        </CLIPSProject>
        <CLIPSProject>
          <ProjectID>string</ProjectID>
          <Folder>string</Folder>
          <CustomFolder>string</CustomFolder>
          <ClipsReady>boolean</ClipsReady>
          <Project>
            <ProjectNumber>string</ProjectNumber>
            <ManagerUsername>string</ManagerUsername>
            <ProjectName>string</ProjectName>
            <SubProjectID>decimal</SubProjectID>
            <Source>NotSet or ProjectDatabase or Legacy</Source>
          </Project>
          <CheckedWithDB>boolean</CheckedWithDB>
        </CLIPSProject>
      </GetAllClipsProjectsResult>
    </GetAllClipsProjectsResponse>
  </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 /ClipsProjectInformation.asmx HTTP/1.1
Host: vle-web-services-pre.azurewebsites.net
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>
    <GetAllClipsProjects xmlns="http://ws.cli.det.nsw.edu.au/lspwebservices/">
      <readyProjects>boolean</readyProjects>
    </GetAllClipsProjects>
  </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>
    <GetAllClipsProjectsResponse xmlns="http://ws.cli.det.nsw.edu.au/lspwebservices/">
      <GetAllClipsProjectsResult>
        <CLIPSProject>
          <ProjectID>string</ProjectID>
          <Folder>string</Folder>
          <CustomFolder>string</CustomFolder>
          <ClipsReady>boolean</ClipsReady>
          <Project>
            <ProjectNumber>string</ProjectNumber>
            <ManagerUsername>string</ManagerUsername>
            <ProjectName>string</ProjectName>
            <SubProjectID>decimal</SubProjectID>
            <Source>NotSet or ProjectDatabase or Legacy</Source>
          </Project>
          <CheckedWithDB>boolean</CheckedWithDB>
        </CLIPSProject>
        <CLIPSProject>
          <ProjectID>string</ProjectID>
          <Folder>string</Folder>
          <CustomFolder>string</CustomFolder>
          <ClipsReady>boolean</ClipsReady>
          <Project>
            <ProjectNumber>string</ProjectNumber>
            <ManagerUsername>string</ManagerUsername>
            <ProjectName>string</ProjectName>
            <SubProjectID>decimal</SubProjectID>
            <Source>NotSet or ProjectDatabase or Legacy</Source>
          </Project>
          <CheckedWithDB>boolean</CheckedWithDB>
        </CLIPSProject>
      </GetAllClipsProjectsResult>
    </GetAllClipsProjectsResponse>
  </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 /ClipsProjectInformation.asmx/GetAllClipsProjects?readyProjects=string HTTP/1.1
Host: vle-web-services-pre.azurewebsites.net

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfCLIPSProject xmlns="http://ws.cli.det.nsw.edu.au/lspwebservices/">
  <CLIPSProject>
    <ProjectID>string</ProjectID>
    <Folder>string</Folder>
    <CustomFolder>string</CustomFolder>
    <ClipsReady>boolean</ClipsReady>
    <Project>
      <ProjectNumber>string</ProjectNumber>
      <ManagerUsername>string</ManagerUsername>
      <ProjectName>string</ProjectName>
      <SubProjectID>decimal</SubProjectID>
      <Source>NotSet or ProjectDatabase or Legacy</Source>
    </Project>
    <CheckedWithDB>boolean</CheckedWithDB>
  </CLIPSProject>
  <CLIPSProject>
    <ProjectID>string</ProjectID>
    <Folder>string</Folder>
    <CustomFolder>string</CustomFolder>
    <ClipsReady>boolean</ClipsReady>
    <Project>
      <ProjectNumber>string</ProjectNumber>
      <ManagerUsername>string</ManagerUsername>
      <ProjectName>string</ProjectName>
      <SubProjectID>decimal</SubProjectID>
      <Source>NotSet or ProjectDatabase or Legacy</Source>
    </Project>
    <CheckedWithDB>boolean</CheckedWithDB>
  </CLIPSProject>
</ArrayOfCLIPSProject>

HTTP POST

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

POST /ClipsProjectInformation.asmx/GetAllClipsProjects HTTP/1.1
Host: vle-web-services-pre.azurewebsites.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

readyProjects=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfCLIPSProject xmlns="http://ws.cli.det.nsw.edu.au/lspwebservices/">
  <CLIPSProject>
    <ProjectID>string</ProjectID>
    <Folder>string</Folder>
    <CustomFolder>string</CustomFolder>
    <ClipsReady>boolean</ClipsReady>
    <Project>
      <ProjectNumber>string</ProjectNumber>
      <ManagerUsername>string</ManagerUsername>
      <ProjectName>string</ProjectName>
      <SubProjectID>decimal</SubProjectID>
      <Source>NotSet or ProjectDatabase or Legacy</Source>
    </Project>
    <CheckedWithDB>boolean</CheckedWithDB>
  </CLIPSProject>
  <CLIPSProject>
    <ProjectID>string</ProjectID>
    <Folder>string</Folder>
    <CustomFolder>string</CustomFolder>
    <ClipsReady>boolean</ClipsReady>
    <Project>
      <ProjectNumber>string</ProjectNumber>
      <ManagerUsername>string</ManagerUsername>
      <ProjectName>string</ProjectName>
      <SubProjectID>decimal</SubProjectID>
      <Source>NotSet or ProjectDatabase or Legacy</Source>
    </Project>
    <CheckedWithDB>boolean</CheckedWithDB>
  </CLIPSProject>
</ArrayOfCLIPSProject>

Parameter	Value
readyProjects: