SecondPersonSvc
Click here for a complete list of operations.
SelectByName
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/Entities/SecondPersonSvc.asmx HTTP/1.1 Host: simplicitycrm.com Content-Type: text/xml; charset=utf-8 Content-Length: length SoapAction: "http://services.simplicitycrm.com/dataintegration/SelectByName" <?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> <SelectByName xmlns="http://services.simplicitycrm.com/dataintegration"> <Token>string</Token> <NoOfResults>int</NoOfResults> <Firstname>string</Firstname> <Surname>string</Surname> </SelectByName> </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> <SelectByNameResponse xmlns="http://services.simplicitycrm.com/dataintegration"> <SelectByNameResult> <ErrorCode>int</ErrorCode> <PartialResultSet>boolean</PartialResultSet> <ResultSet> <value> <Accounting_PaymentDueDays>int</Accounting_PaymentDueDays> <DisplayValue>string</DisplayValue> <Invalid_Email>boolean</Invalid_Email> <Invalid_Email_Home>boolean</Invalid_Email_Home> <Invalid_Fax>boolean</Invalid_Fax> <Invalid_Mobile>boolean</Invalid_Mobile> <Invalid_PhoneBusiness>boolean</Invalid_PhoneBusiness> <Invalid_PhoneHome>boolean</Invalid_PhoneHome> <Invalid_PostalAddress>boolean</Invalid_PostalAddress> <Invalid_StreetAddress>boolean</Invalid_StreetAddress> <Invalid_WeChat>boolean</Invalid_WeChat> <RSN>string</RSN> <StreetAddress_Line1>string</StreetAddress_Line1> <StreetAddress_Line2>string</StreetAddress_Line2> <StreetAddress_Line3>string</StreetAddress_Line3> <StreetAddress_Line4>string</StreetAddress_Line4> <StreetAddress_Line5>string</StreetAddress_Line5> <StreetAddress_Line6>string</StreetAddress_Line6> <StreetAddress_Line7>string</StreetAddress_Line7> <Suppression_Codes> <Deceased>boolean</Deceased> <DoNotContact>boolean</DoNotContact> <DoNotSendEducation>boolean</DoNotSendEducation> <DoNotTeleMarket>boolean</DoNotTeleMarket> <EmailOpt_Out>boolean</EmailOpt_Out> <ExcludeFromListRental>boolean</ExcludeFromListRental> <GoneNoAddress>boolean</GoneNoAddress> <Overseas>boolean</Overseas> </Suppression_Codes> <Gender>DontKnow or Female or Male</Gender> </value> <value> <Accounting_PaymentDueDays>int</Accounting_PaymentDueDays> <DisplayValue>string</DisplayValue> <Invalid_Email>boolean</Invalid_Email> <Invalid_Email_Home>boolean</Invalid_Email_Home> <Invalid_Fax>boolean</Invalid_Fax> <Invalid_Mobile>boolean</Invalid_Mobile> <Invalid_PhoneBusiness>boolean</Invalid_PhoneBusiness> <Invalid_PhoneHome>boolean</Invalid_PhoneHome> <Invalid_PostalAddress>boolean</Invalid_PostalAddress> <Invalid_StreetAddress>boolean</Invalid_StreetAddress> <Invalid_WeChat>boolean</Invalid_WeChat> <RSN>string</RSN> <StreetAddress_Line1>string</StreetAddress_Line1> <StreetAddress_Line2>string</StreetAddress_Line2> <StreetAddress_Line3>string</StreetAddress_Line3> <StreetAddress_Line4>string</StreetAddress_Line4> <StreetAddress_Line5>string</StreetAddress_Line5> <StreetAddress_Line6>string</StreetAddress_Line6> <StreetAddress_Line7>string</StreetAddress_Line7> <Suppression_Codes> <Deceased>boolean</Deceased> <DoNotContact>boolean</DoNotContact> <DoNotSendEducation>boolean</DoNotSendEducation> <DoNotTeleMarket>boolean</DoNotTeleMarket> <EmailOpt_Out>boolean</EmailOpt_Out> <ExcludeFromListRental>boolean</ExcludeFromListRental> <GoneNoAddress>boolean</GoneNoAddress> <Overseas>boolean</Overseas> </Suppression_Codes> <Gender>DontKnow or Female or Male</Gender> </value> </ResultSet> </SelectByNameResult> </SelectByNameResponse> </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/Entities/SecondPersonSvc.asmx HTTP/1.1 Host: 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> <SelectByName xmlns="http://services.simplicitycrm.com/dataintegration"> <Token>string</Token> <NoOfResults>int</NoOfResults> <Firstname>string</Firstname> <Surname>string</Surname> </SelectByName> </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> <SelectByNameResponse xmlns="http://services.simplicitycrm.com/dataintegration"> <SelectByNameResult> <ErrorCode>int</ErrorCode> <PartialResultSet>boolean</PartialResultSet> <ResultSet> <value> <Accounting_PaymentDueDays>int</Accounting_PaymentDueDays> <DisplayValue>string</DisplayValue> <Invalid_Email>boolean</Invalid_Email> <Invalid_Email_Home>boolean</Invalid_Email_Home> <Invalid_Fax>boolean</Invalid_Fax> <Invalid_Mobile>boolean</Invalid_Mobile> <Invalid_PhoneBusiness>boolean</Invalid_PhoneBusiness> <Invalid_PhoneHome>boolean</Invalid_PhoneHome> <Invalid_PostalAddress>boolean</Invalid_PostalAddress> <Invalid_StreetAddress>boolean</Invalid_StreetAddress> <Invalid_WeChat>boolean</Invalid_WeChat> <RSN>string</RSN> <StreetAddress_Line1>string</StreetAddress_Line1> <StreetAddress_Line2>string</StreetAddress_Line2> <StreetAddress_Line3>string</StreetAddress_Line3> <StreetAddress_Line4>string</StreetAddress_Line4> <StreetAddress_Line5>string</StreetAddress_Line5> <StreetAddress_Line6>string</StreetAddress_Line6> <StreetAddress_Line7>string</StreetAddress_Line7> <Suppression_Codes> <Deceased>boolean</Deceased> <DoNotContact>boolean</DoNotContact> <DoNotSendEducation>boolean</DoNotSendEducation> <DoNotTeleMarket>boolean</DoNotTeleMarket> <EmailOpt_Out>boolean</EmailOpt_Out> <ExcludeFromListRental>boolean</ExcludeFromListRental> <GoneNoAddress>boolean</GoneNoAddress> <Overseas>boolean</Overseas> </Suppression_Codes> <Gender>DontKnow or Female or Male</Gender> </value> <value> <Accounting_PaymentDueDays>int</Accounting_PaymentDueDays> <DisplayValue>string</DisplayValue> <Invalid_Email>boolean</Invalid_Email> <Invalid_Email_Home>boolean</Invalid_Email_Home> <Invalid_Fax>boolean</Invalid_Fax> <Invalid_Mobile>boolean</Invalid_Mobile> <Invalid_PhoneBusiness>boolean</Invalid_PhoneBusiness> <Invalid_PhoneHome>boolean</Invalid_PhoneHome> <Invalid_PostalAddress>boolean</Invalid_PostalAddress> <Invalid_StreetAddress>boolean</Invalid_StreetAddress> <Invalid_WeChat>boolean</Invalid_WeChat> <RSN>string</RSN> <StreetAddress_Line1>string</StreetAddress_Line1> <StreetAddress_Line2>string</StreetAddress_Line2> <StreetAddress_Line3>string</StreetAddress_Line3> <StreetAddress_Line4>string</StreetAddress_Line4> <StreetAddress_Line5>string</StreetAddress_Line5> <StreetAddress_Line6>string</StreetAddress_Line6> <StreetAddress_Line7>string</StreetAddress_Line7> <Suppression_Codes> <Deceased>boolean</Deceased> <DoNotContact>boolean</DoNotContact> <DoNotSendEducation>boolean</DoNotSendEducation> <DoNotTeleMarket>boolean</DoNotTeleMarket> <EmailOpt_Out>boolean</EmailOpt_Out> <ExcludeFromListRental>boolean</ExcludeFromListRental> <GoneNoAddress>boolean</GoneNoAddress> <Overseas>boolean</Overseas> </Suppression_Codes> <Gender>DontKnow or Female or Male</Gender> </value> </ResultSet> </SelectByNameResult> </SelectByNameResponse> </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/Entities/SecondPersonSvc/SelectByName HTTP/1.1 Host: simplicitycrm.com Content-Type: application/json; charset=utf-8 Content-Length: length Authorization: Token string { "NoOfResults":int, "Firstname":string, "Surname":string, }
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: length { "ErrorCode":int, "PartialResultSet":boolean, "ResultSet":[ { "Accounting_PaymentDueDays":int, "DisplayValue":string, "Invalid_Email":boolean, "Invalid_Email_Home":boolean, "Invalid_Fax":boolean, "Invalid_Mobile":boolean, "Invalid_PhoneBusiness":boolean, "Invalid_PhoneHome":boolean, "Invalid_PostalAddress":boolean, "Invalid_StreetAddress":boolean, "Invalid_WeChat":boolean, "RSN":string, "StreetAddress_Line1":string, "StreetAddress_Line2":string, "StreetAddress_Line3":string, "StreetAddress_Line4":string, "StreetAddress_Line5":string, "StreetAddress_Line6":string, "StreetAddress_Line7":string, "Suppression_Codes":{ "Deceased":boolean, "DoNotContact":boolean, "DoNotSendEducation":boolean, "DoNotTeleMarket":boolean, "EmailOpt_Out":boolean, "ExcludeFromListRental":boolean, "GoneNoAddress":boolean, "Overseas":boolean, }, "Gender":"DontKnow" or "Female" or "Male", }, { "Accounting_PaymentDueDays":int, "DisplayValue":string, "Invalid_Email":boolean, "Invalid_Email_Home":boolean, "Invalid_Fax":boolean, "Invalid_Mobile":boolean, "Invalid_PhoneBusiness":boolean, "Invalid_PhoneHome":boolean, "Invalid_PostalAddress":boolean, "Invalid_StreetAddress":boolean, "Invalid_WeChat":boolean, "RSN":string, "StreetAddress_Line1":string, "StreetAddress_Line2":string, "StreetAddress_Line3":string, "StreetAddress_Line4":string, "StreetAddress_Line5":string, "StreetAddress_Line6":string, "StreetAddress_Line7":string, "Suppression_Codes":{ "Deceased":boolean, "DoNotContact":boolean, "DoNotSendEducation":boolean, "DoNotTeleMarket":boolean, "EmailOpt_Out":boolean, "ExcludeFromListRental":boolean, "GoneNoAddress":boolean, "Overseas":boolean, }, "Gender":"DontKnow" or "Female" or "Male", }, ], }