PassportApplicationSvc

Click here for a complete list of operations.

Authenticate

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 /SingleView/Common/PassportApplicationSvc.asmx HTTP/1.1
Host: www.simplicitycrm.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://services.simplicitycrm.com/passportapplication/Authenticate"

<?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>
    <Authenticate xmlns="http://services.simplicitycrm.com/passportapplication">
      <Key>string</Key>
      <AuthPassword>string</AuthPassword>
      <Token>string</Token>
      <CampaignName>string</CampaignName>
      <CampaignSegment>string</CampaignSegment>
    </Authenticate>
  </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>
    <AuthenticateResponse xmlns="http://services.simplicitycrm.com/passportapplication">
      <AuthenticateResult>
        <Token>string</Token>
        <ErrorCode>int</ErrorCode>
        <AccountName>string</AccountName>
        <EmailAddress>string</EmailAddress>
        <AccountRSN>string</AccountRSN>
        <AccountOwnerRSN>string</AccountOwnerRSN>
        <AccountOwnerType>string</AccountOwnerType>
        <AccountOwnerDisplayValue>string</AccountOwnerDisplayValue>
        <AccountPermissions>
          <CreateAccount>boolean</CreateAccount>
          <DeleteAccount>boolean</DeleteAccount>
          <EnableAccount>boolean</EnableAccount>
          <DisableAccount>boolean</DisableAccount>
          <ImpersonateLogin>boolean</ImpersonateLogin>
          <SetPassword>boolean</SetPassword>
          <ResetPassword>boolean</ResetPassword>
          <SetEmailAddress>boolean</SetEmailAddress>
          <AccessDataIntegration>boolean</AccessDataIntegration>
          <AlterAccount>boolean</AlterAccount>
        </AccountPermissions>
        <AccountRoles>string</AccountRoles>
        <GlobalAccessCode>string</GlobalAccessCode>
      </AuthenticateResult>
    </AuthenticateResponse>
  </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 /SingleView/Common/PassportApplicationSvc.asmx HTTP/1.1
Host: www.simplicitycrm.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>
    <Authenticate xmlns="http://services.simplicitycrm.com/passportapplication">
      <Key>string</Key>
      <AuthPassword>string</AuthPassword>
      <Token>string</Token>
      <CampaignName>string</CampaignName>
      <CampaignSegment>string</CampaignSegment>
    </Authenticate>
  </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>
    <AuthenticateResponse xmlns="http://services.simplicitycrm.com/passportapplication">
      <AuthenticateResult>
        <Token>string</Token>
        <ErrorCode>int</ErrorCode>
        <AccountName>string</AccountName>
        <EmailAddress>string</EmailAddress>
        <AccountRSN>string</AccountRSN>
        <AccountOwnerRSN>string</AccountOwnerRSN>
        <AccountOwnerType>string</AccountOwnerType>
        <AccountOwnerDisplayValue>string</AccountOwnerDisplayValue>
        <AccountPermissions>
          <CreateAccount>boolean</CreateAccount>
          <DeleteAccount>boolean</DeleteAccount>
          <EnableAccount>boolean</EnableAccount>
          <DisableAccount>boolean</DisableAccount>
          <ImpersonateLogin>boolean</ImpersonateLogin>
          <SetPassword>boolean</SetPassword>
          <ResetPassword>boolean</ResetPassword>
          <SetEmailAddress>boolean</SetEmailAddress>
          <AccessDataIntegration>boolean</AccessDataIntegration>
          <AlterAccount>boolean</AlterAccount>
        </AccountPermissions>
        <AccountRoles>string</AccountRoles>
        <GlobalAccessCode>string</GlobalAccessCode>
      </AuthenticateResult>
    </AuthenticateResponse>
  </soap12:Body>
</soap12:Envelope>

JSON

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

POST /SingleView/api/Common/PassportApplicationSvc/Authenticate HTTP/1.1
Host: www.simplicitycrm.com
Content-Type: application/json; charset=utf-8
Content-Length: length
Authorization: Token string

{
  "Key":string,
  "AuthPassword":string,
  "CampaignName":string,
  "CampaignSegment":string,
},

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

{
  "Token":string,
  "ErrorCode":int,
  "AccountName":string,
  "EmailAddress":string,
  "AccountRSN":string,
  "AccountOwnerRSN":string,
  "AccountOwnerType":string,
  "AccountOwnerDisplayValue":string,
  "AccountPermissions":{
    "CreateAccount":boolean,
    "DeleteAccount":boolean,
    "EnableAccount":boolean,
    "DisableAccount":boolean,
    "ImpersonateLogin":boolean,
    "SetPassword":boolean,
    "ResetPassword":boolean,
    "SetEmailAddress":boolean,
    "AccessDataIntegration":boolean,
    "AlterAccount":boolean,
  },
  "AccountRoles":string,
  "GlobalAccessCode":string,
},