Contact_IsLoggedIn

Checks to see if an entity is already authenticated and logged in.

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)
  • entityId - (integer)
  • sessionId - (string) this is the value of the cookie VSV[Site ID]. For example if my site ID is "12345" the cookie's name will become VSV12345. This cookie is created right after the user logs into the site's front-end

Response

A Contact_IsLoggedInResponse object with the following properties:

  • Contact_IsLoggedInResult - (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_IsLoggedIn xmlns="http://tempuri.org/CatalystDeveloperService/CatalystCRMWebservice">
      <siteId>12345</siteId>
      <entityId>1234</entityId>
      <sessionId>ifagu1rxd5z4303vk3i4fn455gwtGt0F/Nn4zgMaMV6W7j3Q89Y=</sessionId>
    </Contact_IsLoggedIn>
  </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_IsLoggedInResponse xmlns="http://tempuri.org/CatalystDeveloperService/CatalystCRMWebservice">
      <Contact_IsLoggedInResult>true</Contact_IsLoggedInResult>
    </Contact_IsLoggedInResponse>
  </soap12:Body>
</soap12:Envelope>