Trendsic Platform Service

<back to all web services

LineImageSaveRequest

Requires Authentication
Required roles:Administrator, Administrator
The following routes are available for this service:
POST,PUT,OPTIONS/v1/LineImage/{LineId}
DELETE,OPTIONS/v1/LineImage/{ImageId}
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 Document:
    document_id: Optional[str] = None
    doc_type: Optional[str] = None
    doc_category: Optional[str] = None
    doc_sub_category: Optional[str] = None
    doc_title: Optional[str] = None
    doc_description: Optional[str] = None
    doc_data: bytes = field(default_factory=list)
    doc_expiration: Optional[datetime.datetime] = None
    doc_mime_type: Optional[str] = None
    display_order: int = 0
    file_size_in_k_b: float = 0.0
    link: Optional[str] = None
    upload_date: Optional[datetime.datetime] = None
    doc_key: Optional[str] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LineImageSaveRequest:
    document: List[Document] = field(default_factory=list)
    line_id: Optional[str] = None
    image_id: Optional[str] = None
    fields: Dict[str, str] = field(default_factory=dict)

Python LineImageSaveRequest 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.

POST /v1/LineImage/{LineId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Document":[{"DocumentId":"00000000000000000000000000000000","DocType":"String","DocCategory":"String","DocSubCategory":"String","DocTitle":"String","DocDescription":"String","DocData":"AA==","DocExpiration":"0001-01-01T00:00:00.0000000","DocMimeType":"String","DisplayOrder":0,"FileSizeInKB":0,"Link":"String","UploadDate":"0001-01-01T00:00:00.0000000","DocKey":"String"}],"LineId":"00000000000000000000000000000000","ImageId":"00000000000000000000000000000000","Fields":{"String":"String"}}
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"}},"Document":[{"DocumentId":"00000000000000000000000000000000","DocType":"String","DocCategory":"String","DocSubCategory":"String","DocTitle":"String","DocDescription":"String","DocData":"AA==","DocExpiration":"0001-01-01T00:00:00.0000000","DocMimeType":"String","DisplayOrder":0,"FileSizeInKB":0,"Link":"String","UploadDate":"0001-01-01T00:00:00.0000000","DocKey":"String"}]}