PAS
Click here for a complete list of operations.
getBeneficiaries
Get participant's beneficiaries
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/getBeneficiaries"
<?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>
<getBeneficiaries xmlns="http://sdda.schwabrt.com/">
<sessionID>string</sessionID>
</getBeneficiaries>
</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>
<getBeneficiariesResponse xmlns="http://sdda.schwabrt.com/">
<getBeneficiariesResult>
<BeneficiaryDTO>
<ID>int</ID>
<FirstName>string</FirstName>
<TrustName>string</TrustName>
<LastName>string</LastName>
<OrigFirstName>string</OrigFirstName>
<OrigTrustName>string</OrigTrustName>
<OrigLastName>string</OrigLastName>
<MiddleInitial>string</MiddleInitial>
<TIN>string</TIN>
<DateOfBirthTrust>dateTime</DateOfBirthTrust>
<Relationship>NotSet or Spouse or Child or DomesticPartner or Mother or Father or Brother or Sister or Other</Relationship>
<IsPrimary>boolean</IsPrimary>
<OrigIsPrimary>boolean</OrigIsPrimary>
<Type>Individual or Trust</Type>
<SharePercentage>double</SharePercentage>
<OrigSharePercentage>double</OrigSharePercentage>
<PhoneNumber>string</PhoneNumber>
<RowStatus>Original or Insert or Update or Delete</RowStatus>
<Address>
<ID>int</ID>
<Address1>string</Address1>
<Address2>string</Address2>
<City>string</City>
<StateCode>string</StateCode>
<StateName>string</StateName>
<ZipCode>string</ZipCode>
<CountryCode>string</CountryCode>
</Address>
<IsOLEParticipant>boolean</IsOLEParticipant>
</BeneficiaryDTO>
<BeneficiaryDTO>
<ID>int</ID>
<FirstName>string</FirstName>
<TrustName>string</TrustName>
<LastName>string</LastName>
<OrigFirstName>string</OrigFirstName>
<OrigTrustName>string</OrigTrustName>
<OrigLastName>string</OrigLastName>
<MiddleInitial>string</MiddleInitial>
<TIN>string</TIN>
<DateOfBirthTrust>dateTime</DateOfBirthTrust>
<Relationship>NotSet or Spouse or Child or DomesticPartner or Mother or Father or Brother or Sister or Other</Relationship>
<IsPrimary>boolean</IsPrimary>
<OrigIsPrimary>boolean</OrigIsPrimary>
<Type>Individual or Trust</Type>
<SharePercentage>double</SharePercentage>
<OrigSharePercentage>double</OrigSharePercentage>
<PhoneNumber>string</PhoneNumber>
<RowStatus>Original or Insert or Update or Delete</RowStatus>
<Address>
<ID>int</ID>
<Address1>string</Address1>
<Address2>string</Address2>
<City>string</City>
<StateCode>string</StateCode>
<StateName>string</StateName>
<ZipCode>string</ZipCode>
<CountryCode>string</CountryCode>
</Address>
<IsOLEParticipant>boolean</IsOLEParticipant>
</BeneficiaryDTO>
</getBeneficiariesResult>
</getBeneficiariesResponse>
</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/getBeneficiaries?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"?>
<ArrayOfBeneficiaryDTO xmlns="http://sdda.schwabrt.com/">
<BeneficiaryDTO>
<ID>int</ID>
<FirstName>string</FirstName>
<TrustName>string</TrustName>
<LastName>string</LastName>
<OrigFirstName>string</OrigFirstName>
<OrigTrustName>string</OrigTrustName>
<OrigLastName>string</OrigLastName>
<MiddleInitial>string</MiddleInitial>
<TIN>string</TIN>
<DateOfBirthTrust>dateTime</DateOfBirthTrust>
<Relationship>NotSet or Spouse or Child or DomesticPartner or Mother or Father or Brother or Sister or Other</Relationship>
<IsPrimary>boolean</IsPrimary>
<OrigIsPrimary>boolean</OrigIsPrimary>
<Type>Individual or Trust</Type>
<SharePercentage>double</SharePercentage>
<OrigSharePercentage>double</OrigSharePercentage>
<PhoneNumber>string</PhoneNumber>
<RowStatus>Original or Insert or Update or Delete</RowStatus>
<Address>
<ID>int</ID>
<Address1>string</Address1>
<Address2>string</Address2>
<City>string</City>
<StateCode>string</StateCode>
<StateName>string</StateName>
<ZipCode>string</ZipCode>
<CountryCode>string</CountryCode>
</Address>
<IsOLEParticipant>boolean</IsOLEParticipant>
</BeneficiaryDTO>
<BeneficiaryDTO>
<ID>int</ID>
<FirstName>string</FirstName>
<TrustName>string</TrustName>
<LastName>string</LastName>
<OrigFirstName>string</OrigFirstName>
<OrigTrustName>string</OrigTrustName>
<OrigLastName>string</OrigLastName>
<MiddleInitial>string</MiddleInitial>
<TIN>string</TIN>
<DateOfBirthTrust>dateTime</DateOfBirthTrust>
<Relationship>NotSet or Spouse or Child or DomesticPartner or Mother or Father or Brother or Sister or Other</Relationship>
<IsPrimary>boolean</IsPrimary>
<OrigIsPrimary>boolean</OrigIsPrimary>
<Type>Individual or Trust</Type>
<SharePercentage>double</SharePercentage>
<OrigSharePercentage>double</OrigSharePercentage>
<PhoneNumber>string</PhoneNumber>
<RowStatus>Original or Insert or Update or Delete</RowStatus>
<Address>
<ID>int</ID>
<Address1>string</Address1>
<Address2>string</Address2>
<City>string</City>
<StateCode>string</StateCode>
<StateName>string</StateName>
<ZipCode>string</ZipCode>
<CountryCode>string</CountryCode>
</Address>
<IsOLEParticipant>boolean</IsOLEParticipant>
</BeneficiaryDTO>
</ArrayOfBeneficiaryDTO>
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/getBeneficiaries 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"?>
<ArrayOfBeneficiaryDTO xmlns="http://sdda.schwabrt.com/">
<BeneficiaryDTO>
<ID>int</ID>
<FirstName>string</FirstName>
<TrustName>string</TrustName>
<LastName>string</LastName>
<OrigFirstName>string</OrigFirstName>
<OrigTrustName>string</OrigTrustName>
<OrigLastName>string</OrigLastName>
<MiddleInitial>string</MiddleInitial>
<TIN>string</TIN>
<DateOfBirthTrust>dateTime</DateOfBirthTrust>
<Relationship>NotSet or Spouse or Child or DomesticPartner or Mother or Father or Brother or Sister or Other</Relationship>
<IsPrimary>boolean</IsPrimary>
<OrigIsPrimary>boolean</OrigIsPrimary>
<Type>Individual or Trust</Type>
<SharePercentage>double</SharePercentage>
<OrigSharePercentage>double</OrigSharePercentage>
<PhoneNumber>string</PhoneNumber>
<RowStatus>Original or Insert or Update or Delete</RowStatus>
<Address>
<ID>int</ID>
<Address1>string</Address1>
<Address2>string</Address2>
<City>string</City>
<StateCode>string</StateCode>
<StateName>string</StateName>
<ZipCode>string</ZipCode>
<CountryCode>string</CountryCode>
</Address>
<IsOLEParticipant>boolean</IsOLEParticipant>
</BeneficiaryDTO>
<BeneficiaryDTO>
<ID>int</ID>
<FirstName>string</FirstName>
<TrustName>string</TrustName>
<LastName>string</LastName>
<OrigFirstName>string</OrigFirstName>
<OrigTrustName>string</OrigTrustName>
<OrigLastName>string</OrigLastName>
<MiddleInitial>string</MiddleInitial>
<TIN>string</TIN>
<DateOfBirthTrust>dateTime</DateOfBirthTrust>
<Relationship>NotSet or Spouse or Child or DomesticPartner or Mother or Father or Brother or Sister or Other</Relationship>
<IsPrimary>boolean</IsPrimary>
<OrigIsPrimary>boolean</OrigIsPrimary>
<Type>Individual or Trust</Type>
<SharePercentage>double</SharePercentage>
<OrigSharePercentage>double</OrigSharePercentage>
<PhoneNumber>string</PhoneNumber>
<RowStatus>Original or Insert or Update or Delete</RowStatus>
<Address>
<ID>int</ID>
<Address1>string</Address1>
<Address2>string</Address2>
<City>string</City>
<StateCode>string</StateCode>
<StateName>string</StateName>
<ZipCode>string</ZipCode>
<CountryCode>string</CountryCode>
</Address>
<IsOLEParticipant>boolean</IsOLEParticipant>
</BeneficiaryDTO>
</ArrayOfBeneficiaryDTO>