GET api/EmployeeData/GetRelatedSharePointDocuments?pageURL={pageURL}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageURL

string

Required

Body Parameters

None.

Response Information

Resource Description

ECMGetRelatedDocumentsResponse
NameDescriptionTypeAdditional information
RelatedDocuments

Collection of ECMDocument

None.

SiteUrl

string

None.

FolderName

string

None.

IsSuccess

boolean

None.

ErrorMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "relatedDocuments": [
    {
      "listId": "sample string 1",
      "listItemId": "sample string 2",
      "siteUrl": "sample string 3",
      "title": "sample string 4",
      "url": "sample string 5",
      "fileName": "sample string 6"
    },
    {
      "listId": "sample string 1",
      "listItemId": "sample string 2",
      "siteUrl": "sample string 3",
      "title": "sample string 4",
      "url": "sample string 5",
      "fileName": "sample string 6"
    }
  ],
  "siteUrl": "sample string 1",
  "folderName": "sample string 2",
  "isSuccess": true,
  "errorMessage": "sample string 4"
}

application/xml, text/xml

Sample:
<ECMGetRelatedDocumentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GTI.DW.PeopleProfile.Domain.Models.ECM">
  <ErrorMessage>sample string 4</ErrorMessage>
  <FolderName>sample string 2</FolderName>
  <IsSuccess>true</IsSuccess>
  <RelatedDocuments>
    <ECMDocument>
      <FileName>sample string 6</FileName>
      <ListId>sample string 1</ListId>
      <ListItemId>sample string 2</ListItemId>
      <SiteUrl>sample string 3</SiteUrl>
      <Title>sample string 4</Title>
      <Url>sample string 5</Url>
    </ECMDocument>
    <ECMDocument>
      <FileName>sample string 6</FileName>
      <ListId>sample string 1</ListId>
      <ListItemId>sample string 2</ListItemId>
      <SiteUrl>sample string 3</SiteUrl>
      <Title>sample string 4</Title>
      <Url>sample string 5</Url>
    </ECMDocument>
  </RelatedDocuments>
  <SiteUrl>sample string 1</SiteUrl>
</ECMGetRelatedDocumentsResponse>