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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentShareAccessLog:
    document_share_access_log_id: int = 0
    document_share_id: int = 0
    event_type: Optional[str] = None
    outcome: Optional[str] = None
    detail_message: Optional[str] = None
    ip_address: Optional[str] = None
    user_agent: Optional[str] = None
    actor_user_id: Optional[str] = None
    created_at_utc: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentShareLogResponse:
    response_status: Optional[ResponseStatus] = None
    access_log: List[DocumentShareAccessLog] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentShareLogRequest:
    document_share_id: int = 0

Python DocumentShareLogRequest DTOs

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

HTTP + OTHER

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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"AccessLog":[{"DocumentShareAccessLogId":0,"DocumentShareId":0,"EventType":"String","Outcome":"String","DetailMessage":"String","IpAddress":"String","UserAgent":"String","ActorUserId":"00000000000000000000000000000000","CreatedAtUtc":"0001-01-01T00:00:00.0000000"}]}