Records Repository Web Service Methods

  • Article

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Any application you employ as a records repository must implement the records repository Web service. The records repository Web service contains the following methods:

SubmitFile   Submit a file as a given record routing type, along with its metadata and, optionally, its audit history.

SubmitFile Method

SubmitFile(byte[] fileToSubmit , OfficialFileProperty[] properties, string recordSeries, string sourceUrl, string userLoginName)

Use this method to submit a file as a given record routing type, along with its metadata and audit history. The SubmitFile method takes the following parameters:

fileToSubmit   A byte array that represents the file being submitted.

properties   An OfficialFileProperty array that represents the metadata being submitted with the file. Each OfficialFileProperty object has the following public string fields:

  • Name   The name of the metadata property.

  • Other   Any additional information to be sent with the property.

  • Type   The data type of the property, if it corresponds to a SharePoint field data type.

  • Value   The value of the metadata property.

Optionally, you can include XML that represents the audit history of the file being submitted. To do this, include a property named Audit History, with a Type property of XML. Store the actual audit history as XML in the Other property.

recordSeries   A string that represents the record routing type of the file.

sourceUrl   A string that represents the original URL of the file being submitted.

userLoginName   A string that represents the user who is submitting the file.

The SubmitFile method returns an XML structure that represents the result of the method call. If more information is necessary, the SubmitFile method returns the following XML structure:

<ResultCode>MoreInformation</ResultCode>
<ResultUrl>
https://servername/officialsitename/MissingProperties/Forms/EditForm.aspx?ID=SomeGUID
</ResultUrl>

The ResultUrl element represents the path to the edit form for the item, where the user can enter the missing properties for the item.

If the file is successfully uploaded, the SubmitFile method returns the following XML structure:

<ResultCode>Success</ResultCode>

GetRecordSeriesCollection Method

GetRecordSeriesCollection()

Use this method to obtain the properties of all record routing types for a records repository, as well as the metadata schema for each. This method returns a string representing an XML document that contains the definition information for each record routing type:

  • Name

  • Description

  • Location

  • Aliases

Also included is the property schema for each record routing type.

Following is an example of the XML structure of a successful call to the GetRecordSeriesCollection method:

<RecordSeriesCollection>
  <RecordSeries>
    <Name> value </Name>
    <Description> value </Description>
    <Default> value </Default>
    <Location> value </Location>
    <Mappings>
      <Mapping> value </Mapping>
    </Mappings>
  </RecordSeries>
</RecordSeriesCollection>

In the case of an exception, this method may instead return a string representing an exception message, depending on the application implementing the Web service.

When Microsoft Windows SharePoint Services 3.0 implements the Web service, the following XML structure is returned in case of error:

<ResultCode>InvalidConfiguration</ResultCode>

GetRecordSeries Method

GetRecordSeries(string recordSeries)

Use this method to get the properties of a given record routing type, as well as its metadata schema. The GetRecordSeries method takes the following parameter:

recordSeries   A string the represents the record routing type name for which you want to get information.

This method returns a string representing an XML document that contains the definition information for the specified record routing type:

  • Name

  • Description

  • Location

  • Aliases

Also included is the property schema for that record routing type.

Below is an example of the XML structure of a successful call to the GetRecordSeries method:

  <RecordSeries>
    <Name>value</Name>
    <Description>value</Description>
    <Default>value</Default>
    <Location>value</Location>
    <Mappings>
       <Mapping> value </Mapping>
    </Mappings>
  </RecordSeries>

In the case of an exception, this method may instead return a string representing an exception message, depending on the application implementing the Web service.

When Microsoft Windows SharePoint Services 3.0 implements the Web service, the following XML structure is returned in case of error:

<ResultCode>InvalidConfiguration</ResultCode>

GetServer Method

GetServerInformation()

Use this method to get information on an implementation of the records repository. This method returns a string representing an XML document that contains information on the server acting as the records repository for this site collection.

Below is an example of the XML structure of a successful call to the GetServerInformation method:

<ServerInfo>
<ServerType>Microsoft.Office.Server</ServerType>
<ServerVersion>Microsoft.Office.OfficialFileSoap, Version=12.0.0.0,   Culture=neutral, PublicKeyToken=71e9bce111e9429c
</ServerVersion>
</ServerInfo>

In the case of an exception, this method may instead return a string representing an exception message, depending on the application implementing the Web service.

See Also

Concepts

Introduction to the Records Repository Web Service
Record Routing Types
Storage Location Metadata