GET api/Documents?sessionKey={sessionKey}&memberID={memberID}

Get a list of available communications

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sessionKey

Login session key

string

Required

memberID

Member identifier

integer

Required

Body Parameters

None.

Response Information

Resource Description

DocumentResult
NameDescriptionTypeAdditional information
Documents

Collection of DocumentItem

None.

Success

boolean

None.

SessionExpired

boolean

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Documents": [
    {
      "$type": "EBSphere.Service.Models.DocumentItem, EBSphere.Service",
      "Id": 1,
      "Description": "sample string 2",
      "ContentUrl": "sample string 3"
    },
    {
      "$type": "EBSphere.Service.Models.DocumentItem, EBSphere.Service",
      "Id": 1,
      "Description": "sample string 2",
      "ContentUrl": "sample string 3"
    }
  ],
  "Success": true,
  "SessionExpired": true,
  "Message": "sample string 3"
}

application/xml, text/xml

Sample:
<DocumentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EBSphere.Service.Models">
  <Message>sample string 3</Message>
  <SessionExpired>true</SessionExpired>
  <Success>true</Success>
  <Documents>
    <DocumentItem>
      <ContentUrl>sample string 3</ContentUrl>
      <Description>sample string 2</Description>
      <Id>1</Id>
    </DocumentItem>
    <DocumentItem>
      <ContentUrl>sample string 3</ContentUrl>
      <Description>sample string 2</Description>
      <Id>1</Id>
    </DocumentItem>
  </Documents>
</DocumentResult>