Service Webdienst

Service

Klicken Sie hier, um die vollständige Vorgangsliste anzuzeigen.

getDocumentMetadata

Läd eine Liste an Dokument Metadaten aus dem HRM-Archiv, welche den übergebenen Suchkriterien entsprechen.
Parameter: Token token, SearchCriteria searchCriteria
- token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
- searchCriteria: Suchkriterien, für welche Dokument Metadaten geladen werden sollen
Rückgabewert List:
- Liste der angeforderten Metadaten

Test

Das Testformular ist nur für Anforderungen vom lokalen Computer verfügbar.

SOAP 1.1

Es folgt ein Beispiel für eine SOAP 1.1-Anforderung und -Antwort. Die angezeigten Platzhalter müssen durch tatsächliche Werte ersetzt werden.

POST /Service.asmx HTTP/1.1
Host: hrm.spprev.in-reach.de
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.spdata.de/getDocumentMetadata"

<?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>
    <getDocumentMetadata xmlns="https://www.spdata.de/">
      <token>
        <id>int</id>
        <token>string</token>
      </token>
      <searchCriteria>
        <creationDateFrom>dateTime</creationDateFrom>
        <creationDateTo>dateTime</creationDateTo>
        <creationUser>string</creationUser>
        <documentName>string</documentName>
        <searchCriteria>
          <SearchCriterion>
            <Name>string</Name>
            <Value>string</Value>
            <ValueList xsi:nil="true" />
            <Operator>Equal or NotEqual or Greater or GreaterOrEqual or Less or LessOrEqual or Like or NotLike or In or NotIn or Between</Operator>
          </SearchCriterion>
          <SearchCriterion>
            <Name>string</Name>
            <Value>string</Value>
            <ValueList xsi:nil="true" />
            <Operator>Equal or NotEqual or Greater or GreaterOrEqual or Less or LessOrEqual or Like or NotLike or In or NotIn or Between</Operator>
          </SearchCriterion>
        </searchCriteria>
      </searchCriteria>
    </getDocumentMetadata>
  </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>
    <getDocumentMetadataResponse xmlns="https://www.spdata.de/">
      <getDocumentMetadataResult>
        <DocumentMetadata>
          <Id>int</Id>
          <DocumentAttributes>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </DocumentAttributes>
          <CreationDate>dateTime</CreationDate>
          <CreationUser>string</CreationUser>
          <DocumentName>string</DocumentName>
          <DocumentTypeDescription>string</DocumentTypeDescription>
          <DocumentCategoryDescription>string</DocumentCategoryDescription>
          <SyncId>string</SyncId>
          <RootSyncId>string</RootSyncId>
          <EmployeeSyncId>string</EmployeeSyncId>
          <EmployeeNumber>string</EmployeeNumber>
          <ClientNumber>string</ClientNumber>
          <Year>int</Year>
          <Month>int</Month>
          <Extension>string</Extension>
          <CheckedOutBy>string</CheckedOutBy>
          <Loeschsperre>boolean</Loeschsperre>
          <NewestVersion>int</NewestVersion>
          <CurrentVersion>
            <id>int</id>
            <comment>string</comment>
            <documentLength>int</documentLength>
            <documentHash>string</documentHash>
            <zipHash>string</zipHash>
            <modifyDate>dateTime</modifyDate>
            <modifyUser>string</modifyUser>
            <version>int</version>
          </CurrentVersion>
        </DocumentMetadata>
        <DocumentMetadata>
          <Id>int</Id>
          <DocumentAttributes>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </DocumentAttributes>
          <CreationDate>dateTime</CreationDate>
          <CreationUser>string</CreationUser>
          <DocumentName>string</DocumentName>
          <DocumentTypeDescription>string</DocumentTypeDescription>
          <DocumentCategoryDescription>string</DocumentCategoryDescription>
          <SyncId>string</SyncId>
          <RootSyncId>string</RootSyncId>
          <EmployeeSyncId>string</EmployeeSyncId>
          <EmployeeNumber>string</EmployeeNumber>
          <ClientNumber>string</ClientNumber>
          <Year>int</Year>
          <Month>int</Month>
          <Extension>string</Extension>
          <CheckedOutBy>string</CheckedOutBy>
          <Loeschsperre>boolean</Loeschsperre>
          <NewestVersion>int</NewestVersion>
          <CurrentVersion>
            <id>int</id>
            <comment>string</comment>
            <documentLength>int</documentLength>
            <documentHash>string</documentHash>
            <zipHash>string</zipHash>
            <modifyDate>dateTime</modifyDate>
            <modifyUser>string</modifyUser>
            <version>int</version>
          </CurrentVersion>
        </DocumentMetadata>
      </getDocumentMetadataResult>
      <token>
        <id>int</id>
        <token>string</token>
      </token>
    </getDocumentMetadataResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

Es folgt ein Beispiel für eine SOAP 1.2-Anforderung und -Antwort. Die angezeigten Platzhalter müssen durch tatsächliche Werte ersetzt werden.

POST /Service.asmx HTTP/1.1
Host: hrm.spprev.in-reach.de
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>
    <getDocumentMetadata xmlns="https://www.spdata.de/">
      <token>
        <id>int</id>
        <token>string</token>
      </token>
      <searchCriteria>
        <creationDateFrom>dateTime</creationDateFrom>
        <creationDateTo>dateTime</creationDateTo>
        <creationUser>string</creationUser>
        <documentName>string</documentName>
        <searchCriteria>
          <SearchCriterion>
            <Name>string</Name>
            <Value>string</Value>
            <ValueList xsi:nil="true" />
            <Operator>Equal or NotEqual or Greater or GreaterOrEqual or Less or LessOrEqual or Like or NotLike or In or NotIn or Between</Operator>
          </SearchCriterion>
          <SearchCriterion>
            <Name>string</Name>
            <Value>string</Value>
            <ValueList xsi:nil="true" />
            <Operator>Equal or NotEqual or Greater or GreaterOrEqual or Less or LessOrEqual or Like or NotLike or In or NotIn or Between</Operator>
          </SearchCriterion>
        </searchCriteria>
      </searchCriteria>
    </getDocumentMetadata>
  </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>
    <getDocumentMetadataResponse xmlns="https://www.spdata.de/">
      <getDocumentMetadataResult>
        <DocumentMetadata>
          <Id>int</Id>
          <DocumentAttributes>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </DocumentAttributes>
          <CreationDate>dateTime</CreationDate>
          <CreationUser>string</CreationUser>
          <DocumentName>string</DocumentName>
          <DocumentTypeDescription>string</DocumentTypeDescription>
          <DocumentCategoryDescription>string</DocumentCategoryDescription>
          <SyncId>string</SyncId>
          <RootSyncId>string</RootSyncId>
          <EmployeeSyncId>string</EmployeeSyncId>
          <EmployeeNumber>string</EmployeeNumber>
          <ClientNumber>string</ClientNumber>
          <Year>int</Year>
          <Month>int</Month>
          <Extension>string</Extension>
          <CheckedOutBy>string</CheckedOutBy>
          <Loeschsperre>boolean</Loeschsperre>
          <NewestVersion>int</NewestVersion>
          <CurrentVersion>
            <id>int</id>
            <comment>string</comment>
            <documentLength>int</documentLength>
            <documentHash>string</documentHash>
            <zipHash>string</zipHash>
            <modifyDate>dateTime</modifyDate>
            <modifyUser>string</modifyUser>
            <version>int</version>
          </CurrentVersion>
        </DocumentMetadata>
        <DocumentMetadata>
          <Id>int</Id>
          <DocumentAttributes>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </DocumentAttributes>
          <CreationDate>dateTime</CreationDate>
          <CreationUser>string</CreationUser>
          <DocumentName>string</DocumentName>
          <DocumentTypeDescription>string</DocumentTypeDescription>
          <DocumentCategoryDescription>string</DocumentCategoryDescription>
          <SyncId>string</SyncId>
          <RootSyncId>string</RootSyncId>
          <EmployeeSyncId>string</EmployeeSyncId>
          <EmployeeNumber>string</EmployeeNumber>
          <ClientNumber>string</ClientNumber>
          <Year>int</Year>
          <Month>int</Month>
          <Extension>string</Extension>
          <CheckedOutBy>string</CheckedOutBy>
          <Loeschsperre>boolean</Loeschsperre>
          <NewestVersion>int</NewestVersion>
          <CurrentVersion>
            <id>int</id>
            <comment>string</comment>
            <documentLength>int</documentLength>
            <documentHash>string</documentHash>
            <zipHash>string</zipHash>
            <modifyDate>dateTime</modifyDate>
            <modifyUser>string</modifyUser>
            <version>int</version>
          </CurrentVersion>
        </DocumentMetadata>
      </getDocumentMetadataResult>
      <token>
        <id>int</id>
        <token>string</token>
      </token>
    </getDocumentMetadataResponse>
  </soap12:Body>
</soap12:Envelope>