POST V1/CustomerSupport.{ext}/DocumentDetails?actionType={actionType}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
actionType

No description available

string

Required

ext

Which media types are acceptable for the response, such as json/xml

If no matches are found, the content negotiator tries to match on the media type of the request body, if any. For example, if the request contains JSON data, the content negotiator looks for a JSON formatter.

string

Content-Type: application/json OR application/xml

Body Parameters

EMS.Inventory.Entities.DocumentDetails
NameDescriptionTypeAdditional information
Client

No description available

string

None.

DocumentId

No description available

string

None.

SavePreferenceId

No description available

string

None.

CurrentUserEmailId

No description available

string

None.

CurrentUserRole

No description available

string

None.

CurrentUserName

No description available

string

None.

ClientName

No description available

string

None.

PreferenceTitle

No description available

string

None.

DocumentTitle

No description available

string

None.

ValidityFromDate

No description available

string

None.

ValidityEndDate

No description available

string

None.

TriggerDate

No description available

string

None.

TriggerTime

No description available

string

None.

AccessCriteria

No description available

string

None.

PreferenceStatus

No description available

string

None.

AttachmentName

No description available

string

None.

DocumentCreatedDate

No description available

string

None.

DeletedAttachmentName

No description available

string

None.

Version

No description available

string

None.

TagType

No description available

string

None.

tagToType

No description available

string

None.

CreatedFullName

No description available

string

None.

TagDescription

No description available

string

None.

ShareType

No description available

string

None.

ShareTo

No description available

string

None.

versionOld

No description available

string

None.

Notify

No description available

string

None.

AssignedTags

No description available

Collection of EMS.Inventory.Entities.Tag

None.

AssignedTagsTo

No description available

Collection of EMS.Inventory.Entities.Tag

None.

UserID

No description available

string

None.

Request Formats

application/json, text/json

Sample:
{
  "client": "sample string 1",
  "documentId": "sample string 2",
  "savePreferenceId": "sample string 3",
  "currentUserEmailId": "sample string 4",
  "currentUserRole": "sample string 5",
  "currentUserName": "sample string 6",
  "clientName": "sample string 7",
  "preferenceTitle": "sample string 8",
  "documentTitle": "sample string 9",
  "validityFromDate": "sample string 10",
  "validityEndDate": "sample string 11",
  "triggerDate": "sample string 12",
  "triggerTime": "sample string 13",
  "accessCriteria": "sample string 14",
  "preferenceStatus": "sample string 15",
  "attachmentName": "sample string 16",
  "documentCreatedDate": "sample string 17",
  "deletedAttachmentName": "sample string 18",
  "version": "sample string 19",
  "tagType": "sample string 20",
  "tagToType": "sample string 21",
  "createdFullName": "sample string 22",
  "tagDescription": "sample string 23",
  "shareType": "sample string 24",
  "shareTo": "sample string 25",
  "versionOld": "sample string 26",
  "notify": "sample string 27",
  "assignedTags": [
    {
      "tagId": "sample string 1",
      "tagType": "sample string 2",
      "tagValue": "sample string 3",
      "hasConflict": 64
    },
    {
      "tagId": "sample string 1",
      "tagType": "sample string 2",
      "tagValue": "sample string 3",
      "hasConflict": 64
    }
  ],
  "assignedTagsTo": [
    {
      "tagId": "sample string 1",
      "tagType": "sample string 2",
      "tagValue": "sample string 3",
      "hasConflict": 64
    },
    {
      "tagId": "sample string 1",
      "tagType": "sample string 2",
      "tagValue": "sample string 3",
      "hasConflict": 64
    }
  ],
  "userID": "sample string 28"
}

application/xml, text/xml

Sample:
<DocumentDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EMS.Inventory.Entities">
  <AccessCriteria>sample string 14</AccessCriteria>
  <AssignedTags>
    <Tag>
      <HasConflict>64</HasConflict>
      <TagId>sample string 1</TagId>
      <TagType>sample string 2</TagType>
      <TagValue>sample string 3</TagValue>
    </Tag>
    <Tag>
      <HasConflict>64</HasConflict>
      <TagId>sample string 1</TagId>
      <TagType>sample string 2</TagType>
      <TagValue>sample string 3</TagValue>
    </Tag>
  </AssignedTags>
  <AssignedTagsTo>
    <Tag>
      <HasConflict>64</HasConflict>
      <TagId>sample string 1</TagId>
      <TagType>sample string 2</TagType>
      <TagValue>sample string 3</TagValue>
    </Tag>
    <Tag>
      <HasConflict>64</HasConflict>
      <TagId>sample string 1</TagId>
      <TagType>sample string 2</TagType>
      <TagValue>sample string 3</TagValue>
    </Tag>
  </AssignedTagsTo>
  <AttachmentName>sample string 16</AttachmentName>
  <Client>sample string 1</Client>
  <ClientName>sample string 7</ClientName>
  <CreatedFullName>sample string 22</CreatedFullName>
  <CurrentUserEmailId>sample string 4</CurrentUserEmailId>
  <CurrentUserName>sample string 6</CurrentUserName>
  <CurrentUserRole>sample string 5</CurrentUserRole>
  <DeletedAttachmentName>sample string 18</DeletedAttachmentName>
  <DocumentCreatedDate>sample string 17</DocumentCreatedDate>
  <DocumentId>sample string 2</DocumentId>
  <DocumentTitle>sample string 9</DocumentTitle>
  <Notify>sample string 27</Notify>
  <PreferenceStatus>sample string 15</PreferenceStatus>
  <PreferenceTitle>sample string 8</PreferenceTitle>
  <SavePreferenceId>sample string 3</SavePreferenceId>
  <ShareTo>sample string 25</ShareTo>
  <ShareType>sample string 24</ShareType>
  <TagDescription>sample string 23</TagDescription>
  <TagType>sample string 20</TagType>
  <TriggerDate>sample string 12</TriggerDate>
  <TriggerTime>sample string 13</TriggerTime>
  <UserID>sample string 28</UserID>
  <ValidityEndDate>sample string 11</ValidityEndDate>
  <ValidityFromDate>sample string 10</ValidityFromDate>
  <Version>sample string 19</Version>
  <tagToType>sample string 21</tagToType>
  <versionOld>sample string 26</versionOld>
</DocumentDetails>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

EMSResponseOfEMS.Common.TransactionResults
NameDescriptionTypeAdditional information
ResponseType

No description available

string

None.

Response

No description available

EMS.Common.TransactionResults

None.

Error

No description available

EMS.Common.Error

None.

Response Formats

application/json, text/json

Sample:
{
  "responseType": "TransactionResults",
  "response": {
    "transactionResult": [
      {
        "status": "sample string 1",
        "message": "sample string 2",
        "result": "sample string 3"
      },
      {
        "status": "sample string 1",
        "message": "sample string 2",
        "result": "sample string 3"
      }
    ]
  },
  "error": {
    "errorCode": "sample string 1",
    "errorDescription": "sample string 2"
  }
}

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.