ClipsProjectInformation


Click here for a complete list of operations.

GetClipsProjectByClipsFolderName

This method retrieves a CLIP project matching the search criteria. This method performs a linear search on the result set of GetClipsProjects to retrieve the CLIPSProject. If project folder name is specified, it overrides default project folder.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
projectNumber:
readyProjects:
wildCards:
projectFolderName:

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/GetClipsProjectByClipsFolderName"

<?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>
    <GetClipsProjectByClipsFolderName xmlns="http://ws.cli.det.nsw.edu.au/lspwebservices/">
      <projectNumber>string</projectNumber>
      <readyProjects>boolean</readyProjects>
      <wildCards>boolean</wildCards>
      <projectFolderName>string</projectFolderName>
    </GetClipsProjectByClipsFolderName>
  </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>
    <GetClipsProjectByClipsFolderNameResponse xmlns="http://ws.cli.det.nsw.edu.au/lspwebservices/">
      <GetClipsProjectByClipsFolderNameResult>
        <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>
      </GetClipsProjectByClipsFolderNameResult>
    </GetClipsProjectByClipsFolderNameResponse>
  </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>
    <GetClipsProjectByClipsFolderName xmlns="http://ws.cli.det.nsw.edu.au/lspwebservices/">
      <projectNumber>string</projectNumber>
      <readyProjects>boolean</readyProjects>
      <wildCards>boolean</wildCards>
      <projectFolderName>string</projectFolderName>
    </GetClipsProjectByClipsFolderName>
  </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>
    <GetClipsProjectByClipsFolderNameResponse xmlns="http://ws.cli.det.nsw.edu.au/lspwebservices/">
      <GetClipsProjectByClipsFolderNameResult>
        <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>
      </GetClipsProjectByClipsFolderNameResult>
    </GetClipsProjectByClipsFolderNameResponse>
  </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/GetClipsProjectByClipsFolderName?projectNumber=string&readyProjects=string&wildCards=string&projectFolderName=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/GetClipsProjectByClipsFolderName HTTP/1.1
Host: vle-web-services-pre.azurewebsites.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

projectNumber=string&readyProjects=string&wildCards=string&projectFolderName=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>