UCC_WebServices Web Service

UCC_WebServices

Click here for a complete list of operations.

PickUpMail

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 /ucc_ws/uccservice.asmx HTTP/1.1
Host: sosdirectws.sos.state.tx.us
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://sosdirectws.sos.state.tx.us/ucc_ws/PickUpMail"

<?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>
    <PickUpMail xmlns="https://sosdirectws.sos.state.tx.us/ucc_ws/">
      <PickUpEnvelope>
        <ResponseTime>dateTime</ResponseTime>
        <Envelope_Count>int</Envelope_Count>
        <Client>
          <ClientID>unsignedLong</ClientID>
          <Password>string</Password>
          <OrganizationsName>string</OrganizationsName>
          <FirstPersonalName>string</FirstPersonalName>
          <AdditionalNamesOrInitials>string</AdditionalNamesOrInitials>
          <IndividualsSurname>string</IndividualsSurname>
          <NameSuffix>None or Sr or Jr or I or II or III or IV or V or VI or X or VII or VIII</NameSuffix>
          <AddressLine1>string</AddressLine1>
          <AddressLine2>string</AddressLine2>
          <City>string</City>
          <StateCode>string</StateCode>
          <PostalCode>string</PostalCode>
          <PostalCodeExtension>string</PostalCodeExtension>
          <Country>string</Country>
          <PhoneNumber>string</PhoneNumber>
          <PhoneExtension>string</PhoneExtension>
          <FaxNumber>string</FaxNumber>
          <EMail>string</EMail>
        </Client>
        <Envelopes>
          <clsResponseEnvelope>
            <EnvelopeID>unsignedLong</EnvelopeID>
            <Received_Date>dateTime</Received_Date>
            <Transaction_Count>int</Transaction_Count>
            <Transactions xsi:nil="true" />
          </clsResponseEnvelope>
          <clsResponseEnvelope>
            <EnvelopeID>unsignedLong</EnvelopeID>
            <Received_Date>dateTime</Received_Date>
            <Transaction_Count>int</Transaction_Count>
            <Transactions xsi:nil="true" />
          </clsResponseEnvelope>
        </Envelopes>
      </PickUpEnvelope>
    </PickUpMail>
  </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>
    <PickUpMailResponse xmlns="https://sosdirectws.sos.state.tx.us/ucc_ws/">
      <PickUpMailResult>string</PickUpMailResult>
      <PickUpEnvelope>
        <ResponseTime>dateTime</ResponseTime>
        <Envelope_Count>int</Envelope_Count>
        <Client>
          <ClientID>unsignedLong</ClientID>
          <Password>string</Password>
          <OrganizationsName>string</OrganizationsName>
          <FirstPersonalName>string</FirstPersonalName>
          <AdditionalNamesOrInitials>string</AdditionalNamesOrInitials>
          <IndividualsSurname>string</IndividualsSurname>
          <NameSuffix>None or Sr or Jr or I or II or III or IV or V or VI or X or VII or VIII</NameSuffix>
          <AddressLine1>string</AddressLine1>
          <AddressLine2>string</AddressLine2>
          <City>string</City>
          <StateCode>string</StateCode>
          <PostalCode>string</PostalCode>
          <PostalCodeExtension>string</PostalCodeExtension>
          <Country>string</Country>
          <PhoneNumber>string</PhoneNumber>
          <PhoneExtension>string</PhoneExtension>
          <FaxNumber>string</FaxNumber>
          <EMail>string</EMail>
        </Client>
        <Envelopes>
          <clsResponseEnvelope>
            <EnvelopeID>unsignedLong</EnvelopeID>
            <Received_Date>dateTime</Received_Date>
            <Transaction_Count>int</Transaction_Count>
            <Transactions xsi:nil="true" />
          </clsResponseEnvelope>
          <clsResponseEnvelope>
            <EnvelopeID>unsignedLong</EnvelopeID>
            <Received_Date>dateTime</Received_Date>
            <Transaction_Count>int</Transaction_Count>
            <Transactions xsi:nil="true" />
          </clsResponseEnvelope>
        </Envelopes>
      </PickUpEnvelope>
    </PickUpMailResponse>
  </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 /ucc_ws/uccservice.asmx HTTP/1.1
Host: sosdirectws.sos.state.tx.us
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>
    <PickUpMail xmlns="https://sosdirectws.sos.state.tx.us/ucc_ws/">
      <PickUpEnvelope>
        <ResponseTime>dateTime</ResponseTime>
        <Envelope_Count>int</Envelope_Count>
        <Client>
          <ClientID>unsignedLong</ClientID>
          <Password>string</Password>
          <OrganizationsName>string</OrganizationsName>
          <FirstPersonalName>string</FirstPersonalName>
          <AdditionalNamesOrInitials>string</AdditionalNamesOrInitials>
          <IndividualsSurname>string</IndividualsSurname>
          <NameSuffix>None or Sr or Jr or I or II or III or IV or V or VI or X or VII or VIII</NameSuffix>
          <AddressLine1>string</AddressLine1>
          <AddressLine2>string</AddressLine2>
          <City>string</City>
          <StateCode>string</StateCode>
          <PostalCode>string</PostalCode>
          <PostalCodeExtension>string</PostalCodeExtension>
          <Country>string</Country>
          <PhoneNumber>string</PhoneNumber>
          <PhoneExtension>string</PhoneExtension>
          <FaxNumber>string</FaxNumber>
          <EMail>string</EMail>
        </Client>
        <Envelopes>
          <clsResponseEnvelope>
            <EnvelopeID>unsignedLong</EnvelopeID>
            <Received_Date>dateTime</Received_Date>
            <Transaction_Count>int</Transaction_Count>
            <Transactions xsi:nil="true" />
          </clsResponseEnvelope>
          <clsResponseEnvelope>
            <EnvelopeID>unsignedLong</EnvelopeID>
            <Received_Date>dateTime</Received_Date>
            <Transaction_Count>int</Transaction_Count>
            <Transactions xsi:nil="true" />
          </clsResponseEnvelope>
        </Envelopes>
      </PickUpEnvelope>
    </PickUpMail>
  </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>
    <PickUpMailResponse xmlns="https://sosdirectws.sos.state.tx.us/ucc_ws/">
      <PickUpMailResult>string</PickUpMailResult>
      <PickUpEnvelope>
        <ResponseTime>dateTime</ResponseTime>
        <Envelope_Count>int</Envelope_Count>
        <Client>
          <ClientID>unsignedLong</ClientID>
          <Password>string</Password>
          <OrganizationsName>string</OrganizationsName>
          <FirstPersonalName>string</FirstPersonalName>
          <AdditionalNamesOrInitials>string</AdditionalNamesOrInitials>
          <IndividualsSurname>string</IndividualsSurname>
          <NameSuffix>None or Sr or Jr or I or II or III or IV or V or VI or X or VII or VIII</NameSuffix>
          <AddressLine1>string</AddressLine1>
          <AddressLine2>string</AddressLine2>
          <City>string</City>
          <StateCode>string</StateCode>
          <PostalCode>string</PostalCode>
          <PostalCodeExtension>string</PostalCodeExtension>
          <Country>string</Country>
          <PhoneNumber>string</PhoneNumber>
          <PhoneExtension>string</PhoneExtension>
          <FaxNumber>string</FaxNumber>
          <EMail>string</EMail>
        </Client>
        <Envelopes>
          <clsResponseEnvelope>
            <EnvelopeID>unsignedLong</EnvelopeID>
            <Received_Date>dateTime</Received_Date>
            <Transaction_Count>int</Transaction_Count>
            <Transactions xsi:nil="true" />
          </clsResponseEnvelope>
          <clsResponseEnvelope>
            <EnvelopeID>unsignedLong</EnvelopeID>
            <Received_Date>dateTime</Received_Date>
            <Transaction_Count>int</Transaction_Count>
            <Transactions xsi:nil="true" />
          </clsResponseEnvelope>
        </Envelopes>
      </PickUpEnvelope>
    </PickUpMailResponse>
  </soap12:Body>
</soap12:Envelope>