Trendsic Platform Service

<back to all web services

DocumentShareLogRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/documentshare/{DocumentShareId}/log
"use strict";
export class DocumentShareAccessLog {
    /** @param {{DocumentShareAccessLogId?:number,DocumentShareId?:number,EventType?:string,Outcome?:string,DetailMessage?:string,IpAddress?:string,UserAgent?:string,ActorUserId?:string,CreatedAtUtc?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    DocumentShareAccessLogId;
    /** @type {number} */
    DocumentShareId;
    /** @type {string} */
    EventType;
    /** @type {string} */
    Outcome;
    /** @type {string} */
    DetailMessage;
    /** @type {string} */
    IpAddress;
    /** @type {string} */
    UserAgent;
    /** @type {?string} */
    ActorUserId;
    /** @type {string} */
    CreatedAtUtc;
}
export class DocumentShareLogResponse {
    /** @param {{ResponseStatus?:ResponseStatus,AccessLog?:DocumentShareAccessLog[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {DocumentShareAccessLog[]} */
    AccessLog = [];
}
export class DocumentShareLogRequest {
    /** @param {{DocumentShareId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    DocumentShareId;
}

JavaScript DocumentShareLogRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/documentshare/{DocumentShareId}/log HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentShareLogResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AccessLog>
    <DocumentShareAccessLog>
      <ActorUserId>00000000-0000-0000-0000-000000000000</ActorUserId>
      <CreatedAtUtc>0001-01-01T00:00:00</CreatedAtUtc>
      <DetailMessage>String</DetailMessage>
      <DocumentShareAccessLogId>0</DocumentShareAccessLogId>
      <DocumentShareId>0</DocumentShareId>
      <EventType>String</EventType>
      <IpAddress>String</IpAddress>
      <Outcome>String</Outcome>
      <UserAgent>String</UserAgent>
    </DocumentShareAccessLog>
  </AccessLog>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</DocumentShareLogResponse>