DSAPIService Web Service

DSAPIService

Click here for a complete list of operations.

GetSharedAccess

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 /api/3.0/dsapi.asmx HTTP/1.1
Host: eu1.docusign.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.docusign.net/API/3.0/GetSharedAccess"

<?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>
    <GetSharedAccess xmlns="http://www.docusign.net/API/3.0">
      <AccountId>string</AccountId>
      <SharedAccessFilter>
        <UserIds>
          <UserId>string</UserId>
          <UserId>string</UserId>
        </UserIds>
        <ItemType>Envelopes</ItemType>
        <SearchText>string</SearchText>
        <Shared>NotShared or SharedFrom or SharedTo or SharedToAndFrom</Shared>
        <StartAtIndex>nonNegativeInteger</StartAtIndex>
        <Count>nonNegativeInteger</Count>
      </SharedAccessFilter>
    </GetSharedAccess>
  </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>
    <GetSharedAccessResponse xmlns="http://www.docusign.net/API/3.0">
      <GetSharedAccessResult>
        <AccountId>string</AccountId>
        <ResultSetSize>nonNegativeInteger</ResultSetSize>
        <TotalSetSize>nonNegativeInteger</TotalSetSize>
        <StartAtIndex>nonNegativeInteger</StartAtIndex>
        <EndAtIndex>nonNegativeInteger</EndAtIndex>
        <SharedItems>
          <User>
            <UserId>string</UserId>
            <Email>string</Email>
            <UserName>string</UserName>
          </User>
          <SharedItem>
            <User xsi:nil="true" />
            <Shared>NotShared or SharedFrom or SharedTo or SharedToAndFrom</Shared>
            <ItemType>Envelopes</ItemType>
            <ErrorDetails xsi:nil="true" />
          </SharedItem>
          <SharedItem>
            <User xsi:nil="true" />
            <Shared>NotShared or SharedFrom or SharedTo or SharedToAndFrom</Shared>
            <ItemType>Envelopes</ItemType>
            <ErrorDetails xsi:nil="true" />
          </SharedItem>
          <ErrorDetails>
            <ErrorCode>string</ErrorCode>
            <Message>string</Message>
          </ErrorDetails>
        </SharedItems>
        <SharedItems>
          <User>
            <UserId>string</UserId>
            <Email>string</Email>
            <UserName>string</UserName>
          </User>
          <SharedItem>
            <User xsi:nil="true" />
            <Shared>NotShared or SharedFrom or SharedTo or SharedToAndFrom</Shared>
            <ItemType>Envelopes</ItemType>
            <ErrorDetails xsi:nil="true" />
          </SharedItem>
          <SharedItem>
            <User xsi:nil="true" />
            <Shared>NotShared or SharedFrom or SharedTo or SharedToAndFrom</Shared>
            <ItemType>Envelopes</ItemType>
            <ErrorDetails xsi:nil="true" />
          </SharedItem>
          <ErrorDetails>
            <ErrorCode>string</ErrorCode>
            <Message>string</Message>
          </ErrorDetails>
        </SharedItems>
        <ErrorDetails>
          <ErrorCode>string</ErrorCode>
          <Message>string</Message>
        </ErrorDetails>
      </GetSharedAccessResult>
    </GetSharedAccessResponse>
  </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 /api/3.0/dsapi.asmx HTTP/1.1
Host: eu1.docusign.net
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>
    <GetSharedAccess xmlns="http://www.docusign.net/API/3.0">
      <AccountId>string</AccountId>
      <SharedAccessFilter>
        <UserIds>
          <UserId>string</UserId>
          <UserId>string</UserId>
        </UserIds>
        <ItemType>Envelopes</ItemType>
        <SearchText>string</SearchText>
        <Shared>NotShared or SharedFrom or SharedTo or SharedToAndFrom</Shared>
        <StartAtIndex>nonNegativeInteger</StartAtIndex>
        <Count>nonNegativeInteger</Count>
      </SharedAccessFilter>
    </GetSharedAccess>
  </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>
    <GetSharedAccessResponse xmlns="http://www.docusign.net/API/3.0">
      <GetSharedAccessResult>
        <AccountId>string</AccountId>
        <ResultSetSize>nonNegativeInteger</ResultSetSize>
        <TotalSetSize>nonNegativeInteger</TotalSetSize>
        <StartAtIndex>nonNegativeInteger</StartAtIndex>
        <EndAtIndex>nonNegativeInteger</EndAtIndex>
        <SharedItems>
          <User>
            <UserId>string</UserId>
            <Email>string</Email>
            <UserName>string</UserName>
          </User>
          <SharedItem>
            <User xsi:nil="true" />
            <Shared>NotShared or SharedFrom or SharedTo or SharedToAndFrom</Shared>
            <ItemType>Envelopes</ItemType>
            <ErrorDetails xsi:nil="true" />
          </SharedItem>
          <SharedItem>
            <User xsi:nil="true" />
            <Shared>NotShared or SharedFrom or SharedTo or SharedToAndFrom</Shared>
            <ItemType>Envelopes</ItemType>
            <ErrorDetails xsi:nil="true" />
          </SharedItem>
          <ErrorDetails>
            <ErrorCode>string</ErrorCode>
            <Message>string</Message>
          </ErrorDetails>
        </SharedItems>
        <SharedItems>
          <User>
            <UserId>string</UserId>
            <Email>string</Email>
            <UserName>string</UserName>
          </User>
          <SharedItem>
            <User xsi:nil="true" />
            <Shared>NotShared or SharedFrom or SharedTo or SharedToAndFrom</Shared>
            <ItemType>Envelopes</ItemType>
            <ErrorDetails xsi:nil="true" />
          </SharedItem>
          <SharedItem>
            <User xsi:nil="true" />
            <Shared>NotShared or SharedFrom or SharedTo or SharedToAndFrom</Shared>
            <ItemType>Envelopes</ItemType>
            <ErrorDetails xsi:nil="true" />
          </SharedItem>
          <ErrorDetails>
            <ErrorCode>string</ErrorCode>
            <Message>string</Message>
          </ErrorDetails>
        </SharedItems>
        <ErrorDetails>
          <ErrorCode>string</ErrorCode>
          <Message>string</Message>
        </ErrorDetails>
      </GetSharedAccessResult>
    </GetSharedAccessResponse>
  </soap12:Body>
</soap12:Envelope>