ScribeSampleWebService


Click here for a complete list of operations.

GetContacts

Will return an array of Contact[] values containing contact information.

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 /ScribeSample/ScribeSampleWebService.asmx HTTP/1.1
Host: community.scribesoft.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.scribesoft.com/ScribeWebServiceSample/GetContacts"

<?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>
    <GetContacts xmlns="http://www.scribesoft.com/ScribeWebServiceSample/" />
  </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>
    <GetContactsResponse xmlns="http://www.scribesoft.com/ScribeWebServiceSample/">
      <GetContactsResult>
        <Contact>
          <ContactID>string</ContactID>
          <Name>string</Name>
          <Company>string</Company>
          <BillToAddress>
            <Street>string</Street>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
          </BillToAddress>
          <ShipToAddress>
            <Street>string</Street>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
          </ShipToAddress>
        </Contact>
        <Contact>
          <ContactID>string</ContactID>
          <Name>string</Name>
          <Company>string</Company>
          <BillToAddress>
            <Street>string</Street>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
          </BillToAddress>
          <ShipToAddress>
            <Street>string</Street>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
          </ShipToAddress>
        </Contact>
      </GetContactsResult>
    </GetContactsResponse>
  </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 /ScribeSample/ScribeSampleWebService.asmx HTTP/1.1
Host: community.scribesoft.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>
    <GetContacts xmlns="http://www.scribesoft.com/ScribeWebServiceSample/" />
  </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>
    <GetContactsResponse xmlns="http://www.scribesoft.com/ScribeWebServiceSample/">
      <GetContactsResult>
        <Contact>
          <ContactID>string</ContactID>
          <Name>string</Name>
          <Company>string</Company>
          <BillToAddress>
            <Street>string</Street>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
          </BillToAddress>
          <ShipToAddress>
            <Street>string</Street>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
          </ShipToAddress>
        </Contact>
        <Contact>
          <ContactID>string</ContactID>
          <Name>string</Name>
          <Company>string</Company>
          <BillToAddress>
            <Street>string</Street>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
          </BillToAddress>
          <ShipToAddress>
            <Street>string</Street>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
          </ShipToAddress>
        </Contact>
      </GetContactsResult>
    </GetContactsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /ScribeSample/ScribeSampleWebService.asmx/GetContacts? HTTP/1.1
Host: community.scribesoft.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfContact xmlns="http://www.scribesoft.com/ScribeWebServiceSample/">
  <Contact>
    <ContactID>string</ContactID>
    <Name>string</Name>
    <Company>string</Company>
    <BillToAddress>
      <Street>string</Street>
      <City>string</City>
      <State>string</State>
      <Zip>string</Zip>
    </BillToAddress>
    <ShipToAddress>
      <Street>string</Street>
      <City>string</City>
      <State>string</State>
      <Zip>string</Zip>
    </ShipToAddress>
  </Contact>
  <Contact>
    <ContactID>string</ContactID>
    <Name>string</Name>
    <Company>string</Company>
    <BillToAddress>
      <Street>string</Street>
      <City>string</City>
      <State>string</State>
      <Zip>string</Zip>
    </BillToAddress>
    <ShipToAddress>
      <Street>string</Street>
      <City>string</City>
      <State>string</State>
      <Zip>string</Zip>
    </ShipToAddress>
  </Contact>
</ArrayOfContact>

HTTP POST

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

POST /ScribeSample/ScribeSampleWebService.asmx/GetContacts HTTP/1.1
Host: community.scribesoft.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfContact xmlns="http://www.scribesoft.com/ScribeWebServiceSample/">
  <Contact>
    <ContactID>string</ContactID>
    <Name>string</Name>
    <Company>string</Company>
    <BillToAddress>
      <Street>string</Street>
      <City>string</City>
      <State>string</State>
      <Zip>string</Zip>
    </BillToAddress>
    <ShipToAddress>
      <Street>string</Street>
      <City>string</City>
      <State>string</State>
      <Zip>string</Zip>
    </ShipToAddress>
  </Contact>
  <Contact>
    <ContactID>string</ContactID>
    <Name>string</Name>
    <Company>string</Company>
    <BillToAddress>
      <Street>string</Street>
      <City>string</City>
      <State>string</State>
      <Zip>string</Zip>
    </BillToAddress>
    <ShipToAddress>
      <Street>string</Street>
      <City>string</City>
      <State>string</State>
      <Zip>string</Zip>
    </ShipToAddress>
  </Contact>
</ArrayOfContact>