PAS Web Service

PAS

Click here for a complete list of operations.

GetParticipantWelcomeInfo

Returns information about the user for the welcome gadget

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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 /pas.asmx HTTP/1.1
Host: apa-sdda.retirement.schwabrt.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://sdda.schwabrt.com/GetParticipantWelcomeInfo"

<?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>
    <GetParticipantWelcomeInfo xmlns="http://sdda.schwabrt.com/">
      <sessionID>string</sessionID>
    </GetParticipantWelcomeInfo>
  </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>
    <GetParticipantWelcomeInfoResponse xmlns="http://sdda.schwabrt.com/">
      <GetParticipantWelcomeInfoResult>
        <BeneficiariesEnabled>boolean</BeneficiariesEnabled>
        <BeneficiariesSetup>boolean</BeneficiariesSetup>
        <SecretQAEnabled>boolean</SecretQAEnabled>
        <SecretQASetup>boolean</SecretQASetup>
        <PlanGreeting>string</PlanGreeting>
        <SponsorMessages>
          <ParticipantMessageDTO>
            <Message xsi:nil="true" />
            <IsRead>boolean</IsRead>
            <IsDeleted>boolean</IsDeleted>
          </ParticipantMessageDTO>
          <ParticipantMessageDTO>
            <Message xsi:nil="true" />
            <IsRead>boolean</IsRead>
            <IsDeleted>boolean</IsDeleted>
          </ParticipantMessageDTO>
        </SponsorMessages>
        <AdvisorMessages>
          <ParticipantMessageDTO>
            <Message xsi:nil="true" />
            <IsRead>boolean</IsRead>
            <IsDeleted>boolean</IsDeleted>
          </ParticipantMessageDTO>
          <ParticipantMessageDTO>
            <Message xsi:nil="true" />
            <IsRead>boolean</IsRead>
            <IsDeleted>boolean</IsDeleted>
          </ParticipantMessageDTO>
        </AdvisorMessages>
      </GetParticipantWelcomeInfoResult>
    </GetParticipantWelcomeInfoResponse>
  </soap:Body>
</soap:Envelope>

HTTP GET

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

GET /pas.asmx/GetParticipantWelcomeInfo?sessionID=string HTTP/1.1
Host: apa-sdda.retirement.schwabrt.com

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

<?xml version="1.0" encoding="utf-8"?>
<ParticipantWelcomeDTO xmlns="http://sdda.schwabrt.com/">
  <BeneficiariesEnabled>boolean</BeneficiariesEnabled>
  <BeneficiariesSetup>boolean</BeneficiariesSetup>
  <SecretQAEnabled>boolean</SecretQAEnabled>
  <SecretQASetup>boolean</SecretQASetup>
  <PlanGreeting>string</PlanGreeting>
  <SponsorMessages>
    <ParticipantMessageDTO>
      <Message>
        <MessageId>int</MessageId>
        <FAdetail d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <AccessType>int</AccessType>
        <MessageName>string</MessageName>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <IsActive>boolean</IsActive>
        <MessageContents d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <FilterSet d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CreatedDate>dateTime</CreatedDate>
        <ModifiedDate>dateTime</ModifiedDate>
      </Message>
      <IsRead>boolean</IsRead>
      <IsDeleted>boolean</IsDeleted>
    </ParticipantMessageDTO>
    <ParticipantMessageDTO>
      <Message>
        <MessageId>int</MessageId>
        <FAdetail d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <AccessType>int</AccessType>
        <MessageName>string</MessageName>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <IsActive>boolean</IsActive>
        <MessageContents d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <FilterSet d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CreatedDate>dateTime</CreatedDate>
        <ModifiedDate>dateTime</ModifiedDate>
      </Message>
      <IsRead>boolean</IsRead>
      <IsDeleted>boolean</IsDeleted>
    </ParticipantMessageDTO>
  </SponsorMessages>
  <AdvisorMessages>
    <ParticipantMessageDTO>
      <Message>
        <MessageId>int</MessageId>
        <FAdetail d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <AccessType>int</AccessType>
        <MessageName>string</MessageName>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <IsActive>boolean</IsActive>
        <MessageContents d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <FilterSet d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CreatedDate>dateTime</CreatedDate>
        <ModifiedDate>dateTime</ModifiedDate>
      </Message>
      <IsRead>boolean</IsRead>
      <IsDeleted>boolean</IsDeleted>
    </ParticipantMessageDTO>
    <ParticipantMessageDTO>
      <Message>
        <MessageId>int</MessageId>
        <FAdetail d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <AccessType>int</AccessType>
        <MessageName>string</MessageName>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <IsActive>boolean</IsActive>
        <MessageContents d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <FilterSet d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CreatedDate>dateTime</CreatedDate>
        <ModifiedDate>dateTime</ModifiedDate>
      </Message>
      <IsRead>boolean</IsRead>
      <IsDeleted>boolean</IsDeleted>
    </ParticipantMessageDTO>
  </AdvisorMessages>
</ParticipantWelcomeDTO>

HTTP POST

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

POST /pas.asmx/GetParticipantWelcomeInfo HTTP/1.1
Host: apa-sdda.retirement.schwabrt.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

sessionID=string

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

<?xml version="1.0" encoding="utf-8"?>
<ParticipantWelcomeDTO xmlns="http://sdda.schwabrt.com/">
  <BeneficiariesEnabled>boolean</BeneficiariesEnabled>
  <BeneficiariesSetup>boolean</BeneficiariesSetup>
  <SecretQAEnabled>boolean</SecretQAEnabled>
  <SecretQASetup>boolean</SecretQASetup>
  <PlanGreeting>string</PlanGreeting>
  <SponsorMessages>
    <ParticipantMessageDTO>
      <Message>
        <MessageId>int</MessageId>
        <FAdetail d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <AccessType>int</AccessType>
        <MessageName>string</MessageName>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <IsActive>boolean</IsActive>
        <MessageContents d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <FilterSet d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CreatedDate>dateTime</CreatedDate>
        <ModifiedDate>dateTime</ModifiedDate>
      </Message>
      <IsRead>boolean</IsRead>
      <IsDeleted>boolean</IsDeleted>
    </ParticipantMessageDTO>
    <ParticipantMessageDTO>
      <Message>
        <MessageId>int</MessageId>
        <FAdetail d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <AccessType>int</AccessType>
        <MessageName>string</MessageName>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <IsActive>boolean</IsActive>
        <MessageContents d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <FilterSet d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CreatedDate>dateTime</CreatedDate>
        <ModifiedDate>dateTime</ModifiedDate>
      </Message>
      <IsRead>boolean</IsRead>
      <IsDeleted>boolean</IsDeleted>
    </ParticipantMessageDTO>
  </SponsorMessages>
  <AdvisorMessages>
    <ParticipantMessageDTO>
      <Message>
        <MessageId>int</MessageId>
        <FAdetail d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <AccessType>int</AccessType>
        <MessageName>string</MessageName>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <IsActive>boolean</IsActive>
        <MessageContents d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <FilterSet d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CreatedDate>dateTime</CreatedDate>
        <ModifiedDate>dateTime</ModifiedDate>
      </Message>
      <IsRead>boolean</IsRead>
      <IsDeleted>boolean</IsDeleted>
    </ParticipantMessageDTO>
    <ParticipantMessageDTO>
      <Message>
        <MessageId>int</MessageId>
        <FAdetail d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <AccessType>int</AccessType>
        <MessageName>string</MessageName>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <IsActive>boolean</IsActive>
        <MessageContents d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <FilterSet d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CreatedDate>dateTime</CreatedDate>
        <ModifiedDate>dateTime</ModifiedDate>
      </Message>
      <IsRead>boolean</IsRead>
      <IsDeleted>boolean</IsDeleted>
    </ParticipantMessageDTO>
  </AdvisorMessages>
</ParticipantWelcomeDTO>

Parameter	Value
sessionID: