Contact_IsAuthenticated

Checks to see if a Contact can login to a given Secure Zone based on username/password.

Request

  • Method: SOAP
  • Server: https://[app key here]-[site_ID here]-apps.worldsecuresystems.com. Take a look at the Authorize your API calls document for more info on how this URL is formed.
  • Path: /catalystwebservice/catalystcrmwebservice.asmx
  • The username and password fields:You can make SOAP API calls can be authorized either by using the actual username or password of an Admin username or, if you are making the calls from an app leave the username field empty and use the authorization token as the password.

Parameters

  • siteId - ID of the site (integer)
  • customerUsername - (string)
  • customerPassword - (string)
  • zoneId - (integer)

Response

A Contact_IsAuthenticatedResponse object with the following properties:

  • Contact_IsAuthenticatedResult - (boolean)

Examples

Accepts and returns XML as Content-Type.

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values, please note the data in the request and response is only for explanatory purposes.

Request:

POST /catalystwebservice/catalystcrmwebservice.asmx HTTP/1.1
Host: worldsecuresystems.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>
    <Contact_IsAuthenticated xmlns="http://tempuri.org/CatalystDeveloperService/CatalystCRMWebservice">
      <siteId>12345</siteId>
      <customerUsername>John99</customerUsername>
      <customerPassword>Y0urP@ssw0rdH3re</customerPassword>
      <zoneId>51</zoneId>
    </Contact_IsAuthenticated>
  </soap12:Body>
</soap12:Envelope>

Response:

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>
    <Contact_IsAuthenticatedResponse xmlns="http://tempuri.org/CatalystDeveloperService/CatalystCRMWebservice">
      <Contact_IsAuthenticatedResult>true</Contact_IsAuthenticatedResult>
    </Contact_IsAuthenticatedResponse>
  </soap12:Body>
</soap12:Envelope>