UsageService

Click here for a complete list of operations.

ValidateUserDirectory

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 /UsageService.asmx HTTP/1.1
Host: auth1.pencs.com.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.pencs.com.au/webservices/UsageService/ValidateUserDirectory"

<?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>
    <ValidateUserDirectory xmlns="http://www.pencs.com.au/webservices/UsageService">
      <account>string</account>
      <password>string</password>
      <orgId>string</orgId>
      <orgName>string</orgName>
      <orgStreetAddress>string</orgStreetAddress>
      <orgSuburb>string</orgSuburb>
      <orgPostcode>string</orgPostcode>
      <orgState>string</orgState>
      <orgPhone>string</orgPhone>
      <orgFax>string</orgFax>
      <orgEmail>string</orgEmail>
    </ValidateUserDirectory>
  </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>
    <ValidateUserDirectoryResponse xmlns="http://www.pencs.com.au/webservices/UsageService">
      <ValidateUserDirectoryResult>boolean</ValidateUserDirectoryResult>
      <registered>boolean</registered>
      <userName>string</userName>
      <userID>int</userID>
      <providerNumber>string</providerNumber>
      <dirIdentifiers>
        <string>string</string>
        <string>string</string>
      </dirIdentifiers>
      <title>string</title>
      <familyName>string</familyName>
      <givenName>string</givenName>
      <role>string</role>
      <personalEmail>string</personalEmail>
      <personalPhone>string</personalPhone>
    </ValidateUserDirectoryResponse>
  </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 /UsageService.asmx HTTP/1.1
Host: auth1.pencs.com.au
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>
    <ValidateUserDirectory xmlns="http://www.pencs.com.au/webservices/UsageService">
      <account>string</account>
      <password>string</password>
      <orgId>string</orgId>
      <orgName>string</orgName>
      <orgStreetAddress>string</orgStreetAddress>
      <orgSuburb>string</orgSuburb>
      <orgPostcode>string</orgPostcode>
      <orgState>string</orgState>
      <orgPhone>string</orgPhone>
      <orgFax>string</orgFax>
      <orgEmail>string</orgEmail>
    </ValidateUserDirectory>
  </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>
    <ValidateUserDirectoryResponse xmlns="http://www.pencs.com.au/webservices/UsageService">
      <ValidateUserDirectoryResult>boolean</ValidateUserDirectoryResult>
      <registered>boolean</registered>
      <userName>string</userName>
      <userID>int</userID>
      <providerNumber>string</providerNumber>
      <dirIdentifiers>
        <string>string</string>
        <string>string</string>
      </dirIdentifiers>
      <title>string</title>
      <familyName>string</familyName>
      <givenName>string</givenName>
      <role>string</role>
      <personalEmail>string</personalEmail>
      <personalPhone>string</personalPhone>
    </ValidateUserDirectoryResponse>
  </soap12:Body>
</soap12:Envelope>