OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

GetCustomerInfoWithShipping_v4

GetCustomerInfoWithShipping() with the addition of the PreferredCulture and ReferCustomer and CustomersReferred in the response.

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 /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.bydesign.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.securefreedom.com/GetCustomerInfoWithShipping_v4"

<?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>
    <GetCustomerInfoWithShipping_v4 xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <CustomerID>string</CustomerID>
    </GetCustomerInfoWithShipping_v4>
  </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>
    <GetCustomerInfoWithShipping_v4Response xmlns="http://www.securefreedom.com/">
      <GetCustomerInfoWithShipping_v4Result>
        <CustomerID>string</CustomerID>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <Company>string</Company>
        <Email>string</Email>
        <BillStreet1>string</BillStreet1>
        <BillStreet2>string</BillStreet2>
        <BillCity>string</BillCity>
        <BillState>string</BillState>
        <BillPostalCode>string</BillPostalCode>
        <BillCounty>string</BillCounty>
        <BillCountry>string</BillCountry>
        <ShipStreet1>string</ShipStreet1>
        <ShipStreet2>string</ShipStreet2>
        <ShipCity>string</ShipCity>
        <ShipState>string</ShipState>
        <ShipPostalCode>string</ShipPostalCode>
        <ShipCounty>string</ShipCounty>
        <ShipCountry>string</ShipCountry>
        <Phone1>string</Phone1>
        <Phone2>string</Phone2>
        <Phone3>string</Phone3>
        <Phone4>string</Phone4>
        <Phone5>string</Phone5>
        <Phone6>string</Phone6>
        <JoinDate>dateTime</JoinDate>
        <SponserRepID>string</SponserRepID>
        <CustomerType>string</CustomerType>
        <PreferredCulture>string</PreferredCulture>
        <CustStatus>
          <CustomerStatusTypeID>int</CustomerStatusTypeID>
          <CustomerStatusDescription>string</CustomerStatusDescription>
          <CustomerStatusAbbreviation>string</CustomerStatusAbbreviation>
        </CustStatus>
        <ReferCustomerID>int</ReferCustomerID>
        <CustomersReferred>
          <string>string</string>
          <string>string</string>
        </CustomersReferred>
        <CustomerTypeID>string</CustomerTypeID>
        <RepID>string</RepID>
        <DateOfBirth>dateTime</DateOfBirth>
        <Gender>string</Gender>
        <PasswordSet>boolean</PasswordSet>
        <RepRank>
          <RankTypeID>string</RankTypeID>
          <Description>string</Description>
          <Abbreviation>string</Abbreviation>
        </RepRank>
      </GetCustomerInfoWithShipping_v4Result>
    </GetCustomerInfoWithShipping_v4Response>
  </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 /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.bydesign.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>
    <GetCustomerInfoWithShipping_v4 xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <CustomerID>string</CustomerID>
    </GetCustomerInfoWithShipping_v4>
  </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>
    <GetCustomerInfoWithShipping_v4Response xmlns="http://www.securefreedom.com/">
      <GetCustomerInfoWithShipping_v4Result>
        <CustomerID>string</CustomerID>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <Company>string</Company>
        <Email>string</Email>
        <BillStreet1>string</BillStreet1>
        <BillStreet2>string</BillStreet2>
        <BillCity>string</BillCity>
        <BillState>string</BillState>
        <BillPostalCode>string</BillPostalCode>
        <BillCounty>string</BillCounty>
        <BillCountry>string</BillCountry>
        <ShipStreet1>string</ShipStreet1>
        <ShipStreet2>string</ShipStreet2>
        <ShipCity>string</ShipCity>
        <ShipState>string</ShipState>
        <ShipPostalCode>string</ShipPostalCode>
        <ShipCounty>string</ShipCounty>
        <ShipCountry>string</ShipCountry>
        <Phone1>string</Phone1>
        <Phone2>string</Phone2>
        <Phone3>string</Phone3>
        <Phone4>string</Phone4>
        <Phone5>string</Phone5>
        <Phone6>string</Phone6>
        <JoinDate>dateTime</JoinDate>
        <SponserRepID>string</SponserRepID>
        <CustomerType>string</CustomerType>
        <PreferredCulture>string</PreferredCulture>
        <CustStatus>
          <CustomerStatusTypeID>int</CustomerStatusTypeID>
          <CustomerStatusDescription>string</CustomerStatusDescription>
          <CustomerStatusAbbreviation>string</CustomerStatusAbbreviation>
        </CustStatus>
        <ReferCustomerID>int</ReferCustomerID>
        <CustomersReferred>
          <string>string</string>
          <string>string</string>
        </CustomersReferred>
        <CustomerTypeID>string</CustomerTypeID>
        <RepID>string</RepID>
        <DateOfBirth>dateTime</DateOfBirth>
        <Gender>string</Gender>
        <PasswordSet>boolean</PasswordSet>
        <RepRank>
          <RankTypeID>string</RankTypeID>
          <Description>string</Description>
          <Abbreviation>string</Abbreviation>
        </RepRank>
      </GetCustomerInfoWithShipping_v4Result>
    </GetCustomerInfoWithShipping_v4Response>
  </soap12:Body>
</soap12:Envelope>