POST api/GetSharePointDocuments

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
url	string	None.
searchText	string	None.
searchValues	Collection of string	None.
filePath	string	None.
UserId	integer	None.
PageName	string	None.
ProjectId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "url": "sample string 1",
  "searchText": "sample string 2",
  "searchValues": [
    "sample string 1",
    "sample string 2"
  ],
  "filePath": "sample string 3",
  "UserId": 4,
  "PageName": "sample string 5",
  "ProjectId": 6
}

application/xml, text/xml

Sample:

<SPInputParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Goaa.iPro.SharePoint">
  <PageName>sample string 5</PageName>
  <ProjectId>6</ProjectId>
  <UserId>4</UserId>
  <filePath>sample string 3</filePath>
  <searchText>sample string 2</searchText>
  <searchValues xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </searchValues>
  <url>sample string 1</url>
</SPInputParams>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SPSearchResults

Name	Description	Type	Additional information
SPDocuments		Collection of SharePointDocuments	None.
Result		string	None.

Response Formats

application/json, text/json

Sample:

{
  "SPDocuments": [
    {
      "DocumentId": 1,
      "ProjectId": 1,
      "DocId": 2,
      "Title": "sample string 3",
      "Path": "sample string 4",
      "Write": "sample string 5",
      "IsDocument": true,
      "FileType": "sample string 6",
      "ExtensionType": "sample string 7",
      "Description": "sample string 8",
      "Links": "sample string 9",
      "DocumentType": "sample string 10",
      "ParentLink": "sample string 11",
      "SiteName": "sample string 12",
      "UniqueId": "01971aff-a8a6-4032-b3ee-1f7d31225157",
      "OriginalPath": "sample string 13",
      "Favourite": "sample string 14",
      "UserIdCreated": 15,
      "UserId": 16,
      "PageName": "sample string 17"
    },
    {
      "DocumentId": 1,
      "ProjectId": 1,
      "DocId": 2,
      "Title": "sample string 3",
      "Path": "sample string 4",
      "Write": "sample string 5",
      "IsDocument": true,
      "FileType": "sample string 6",
      "ExtensionType": "sample string 7",
      "Description": "sample string 8",
      "Links": "sample string 9",
      "DocumentType": "sample string 10",
      "ParentLink": "sample string 11",
      "SiteName": "sample string 12",
      "UniqueId": "01971aff-a8a6-4032-b3ee-1f7d31225157",
      "OriginalPath": "sample string 13",
      "Favourite": "sample string 14",
      "UserIdCreated": 15,
      "UserId": 16,
      "PageName": "sample string 17"
    }
  ],
  "Result": "sample string 1"
}

application/xml, text/xml

Sample:

<SPSearchResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Goaa.iPro.SharePoint">
  <Result>sample string 1</Result>
  <SPDocuments>
    <SharePointDocuments>
      <Description>sample string 8</Description>
      <DocId>2</DocId>
      <DocumentId>1</DocumentId>
      <DocumentType>sample string 10</DocumentType>
      <ExtensionType>sample string 7</ExtensionType>
      <Favourite>sample string 14</Favourite>
      <FileType>sample string 6</FileType>
      <IsDocument>true</IsDocument>
      <Links>sample string 9</Links>
      <OriginalPath>sample string 13</OriginalPath>
      <PageName>sample string 17</PageName>
      <ParentLink>sample string 11</ParentLink>
      <Path>sample string 4</Path>
      <ProjectId>1</ProjectId>
      <SiteName>sample string 12</SiteName>
      <Title>sample string 3</Title>
      <UniqueId>01971aff-a8a6-4032-b3ee-1f7d31225157</UniqueId>
      <UserId>16</UserId>
      <UserIdCreated>15</UserIdCreated>
      <Write>sample string 5</Write>
    </SharePointDocuments>
    <SharePointDocuments>
      <Description>sample string 8</Description>
      <DocId>2</DocId>
      <DocumentId>1</DocumentId>
      <DocumentType>sample string 10</DocumentType>
      <ExtensionType>sample string 7</ExtensionType>
      <Favourite>sample string 14</Favourite>
      <FileType>sample string 6</FileType>
      <IsDocument>true</IsDocument>
      <Links>sample string 9</Links>
      <OriginalPath>sample string 13</OriginalPath>
      <PageName>sample string 17</PageName>
      <ParentLink>sample string 11</ParentLink>
      <Path>sample string 4</Path>
      <ProjectId>1</ProjectId>
      <SiteName>sample string 12</SiteName>
      <Title>sample string 3</Title>
      <UniqueId>01971aff-a8a6-4032-b3ee-1f7d31225157</UniqueId>
      <UserId>16</UserId>
      <UserIdCreated>15</UserIdCreated>
      <Write>sample string 5</Write>
    </SharePointDocuments>
  </SPDocuments>
</SPSearchResults>