PassportApplicationSvc Web Service

PassportApplicationSvc

Click here for a complete list of operations.

CreateAccountWithConfirmationWithCredentials

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

<?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>
    <CreateAccountWithConfirmationWithCredentials xmlns="http://services.simplicitycrm.com/passportapplication">
      <Key>string</Key>
      <AuthPassword>string</AuthPassword>
      <CampaignName>string</CampaignName>
      <CampaignSegment>string</CampaignSegment>
      <AuthorizingApplicationName>string</AuthorizingApplicationName>
      <AuthorizingAccountName>string</AuthorizingAccountName>
      <AuthorizingAccountPassword>string</AuthorizingAccountPassword>
      <ApplicationName>string</ApplicationName>
      <NewAccountName>string</NewAccountName>
      <NewPassword>string</NewPassword>
      <GivenName>string</GivenName>
      <FamilyName>string</FamilyName>
      <EmailAddress>string</EmailAddress>
      <PermissionsToSet>None or CreateAccount or DeleteAccount or EnableAccount or DisableAccount or ImpersonateLogin or SetPassword or ResetPassword or SetEmailAddress or AccessDataIntegration or AlterAccount</PermissionsToSet>
      <CreateGlobalAccessCode>boolean</CreateGlobalAccessCode>
      <AccountStatus>Active or Inactive or ActivationPending</AccountStatus>
      <ConfirmationEmailTemplateName>string</ConfirmationEmailTemplateName>
      <ResponseDevices>
        <ResponseDevice>
          <ResponseDevice_Type>string</ResponseDevice_Type>
          <ResponseDevice_DisplayValue>string</ResponseDevice_DisplayValue>
          <ResponseDevice_RSN>string</ResponseDevice_RSN>
          <LabelCodeName>string</LabelCodeName>
        </ResponseDevice>
        <ResponseDevice>
          <ResponseDevice_Type>string</ResponseDevice_Type>
          <ResponseDevice_DisplayValue>string</ResponseDevice_DisplayValue>
          <ResponseDevice_RSN>string</ResponseDevice_RSN>
          <LabelCodeName>string</LabelCodeName>
        </ResponseDevice>
      </ResponseDevices>
      <CampaignSegment_RSN>string</CampaignSegment_RSN>
    </CreateAccountWithConfirmationWithCredentials>
  </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>
    <CreateAccountWithConfirmationWithCredentialsResponse xmlns="http://services.simplicitycrm.com/passportapplication">
      <CreateAccountWithConfirmationWithCredentialsResult>
        <ErrorCode>int</ErrorCode>
        <AccountActivationRequest_RSN>string</AccountActivationRequest_RSN>
        <GlobalAccessLabelCode>string</GlobalAccessLabelCode>
        <Account_RSN>string</Account_RSN>
        <AccountOwner_RSN>string</AccountOwner_RSN>
      </CreateAccountWithConfirmationWithCredentialsResult>
    </CreateAccountWithConfirmationWithCredentialsResponse>
  </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>
    <CreateAccountWithConfirmationWithCredentials xmlns="http://services.simplicitycrm.com/passportapplication">
      <Key>string</Key>
      <AuthPassword>string</AuthPassword>
      <CampaignName>string</CampaignName>
      <CampaignSegment>string</CampaignSegment>
      <AuthorizingApplicationName>string</AuthorizingApplicationName>
      <AuthorizingAccountName>string</AuthorizingAccountName>
      <AuthorizingAccountPassword>string</AuthorizingAccountPassword>
      <ApplicationName>string</ApplicationName>
      <NewAccountName>string</NewAccountName>
      <NewPassword>string</NewPassword>
      <GivenName>string</GivenName>
      <FamilyName>string</FamilyName>
      <EmailAddress>string</EmailAddress>
      <PermissionsToSet>None or CreateAccount or DeleteAccount or EnableAccount or DisableAccount or ImpersonateLogin or SetPassword or ResetPassword or SetEmailAddress or AccessDataIntegration or AlterAccount</PermissionsToSet>
      <CreateGlobalAccessCode>boolean</CreateGlobalAccessCode>
      <AccountStatus>Active or Inactive or ActivationPending</AccountStatus>
      <ConfirmationEmailTemplateName>string</ConfirmationEmailTemplateName>
      <ResponseDevices>
        <ResponseDevice>
          <ResponseDevice_Type>string</ResponseDevice_Type>
          <ResponseDevice_DisplayValue>string</ResponseDevice_DisplayValue>
          <ResponseDevice_RSN>string</ResponseDevice_RSN>
          <LabelCodeName>string</LabelCodeName>
        </ResponseDevice>
        <ResponseDevice>
          <ResponseDevice_Type>string</ResponseDevice_Type>
          <ResponseDevice_DisplayValue>string</ResponseDevice_DisplayValue>
          <ResponseDevice_RSN>string</ResponseDevice_RSN>
          <LabelCodeName>string</LabelCodeName>
        </ResponseDevice>
      </ResponseDevices>
      <CampaignSegment_RSN>string</CampaignSegment_RSN>
    </CreateAccountWithConfirmationWithCredentials>
  </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>
    <CreateAccountWithConfirmationWithCredentialsResponse xmlns="http://services.simplicitycrm.com/passportapplication">
      <CreateAccountWithConfirmationWithCredentialsResult>
        <ErrorCode>int</ErrorCode>
        <AccountActivationRequest_RSN>string</AccountActivationRequest_RSN>
        <GlobalAccessLabelCode>string</GlobalAccessLabelCode>
        <Account_RSN>string</Account_RSN>
        <AccountOwner_RSN>string</AccountOwner_RSN>
      </CreateAccountWithConfirmationWithCredentialsResult>
    </CreateAccountWithConfirmationWithCredentialsResponse>
  </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/CreateAccountWithConfirmationWithCredentials 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,
  "AuthorizingApplicationName":string,
  "AuthorizingAccountName":string,
  "AuthorizingAccountPassword":string,
  "ApplicationName":string,
  "NewAccountName":string,
  "NewPassword":string,
  "GivenName":string,
  "FamilyName":string,
  "EmailAddress":string,
  "PermissionsToSet":"None" or "CreateAccount" or "DeleteAccount" or "EnableAccount" or "DisableAccount" or "ImpersonateLogin" or "SetPassword" or "ResetPassword" or "SetEmailAddress" or "AccessDataIntegration" or "AlterAccount",
  "CreateGlobalAccessCode":boolean,
  "AccountStatus":"Active" or "Inactive" or "ActivationPending",
  "ConfirmationEmailTemplateName":string,
  "ResponseDevices":[
    {
      "ResponseDevice_Type":string,
      "ResponseDevice_DisplayValue":string,
      "ResponseDevice_RSN":string,
      "LabelCodeName":string,
    },
    {
      "ResponseDevice_Type":string,
      "ResponseDevice_DisplayValue":string,
      "ResponseDevice_RSN":string,
      "LabelCodeName":string,
    },
  ],
  "CampaignSegment_RSN":string,
},

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

{
  "ErrorCode":int,
  "AccountActivationRequest_RSN":string,
  "GlobalAccessLabelCode":string,
  "Account_RSN":string,
  "AccountOwner_RSN":string,
},