CollectionsAPI

<back to all web services

PutCollectionSettingsRequest

Requires Authentication
The following routes are available for this service:
PUT/v4/collections/settings
PUT/v4/collections/settings/{Id}
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 V4BaseRequest:
    pass


class SignatureAppearance(str, Enum):
    NONE = 'none'
    TEXT = 'text'
    UPLOAD = 'upload'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CollectionSettingsBaseRequest(V4BaseRequest, ICollectionSettingsBaseRequest):
    profile_image_id: Optional[str] = None
    signature_image_id: Optional[str] = None
    signature_text: Optional[str] = None
    signature_font: Optional[str] = None
    signature_appearance: Optional[SignatureAppearance] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class V4BaseResponse:
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PutCollectionSettingsResponse(V4BaseResponse):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PutCollectionSettingsRequest(CollectionSettingsBaseRequest, IPutCollectionSettingsRequest):
    id: Optional[str] = None

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

PUT /v4/collections/settings HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"id":"String","profileImageId":"String","signatureImageId":"String","signatureText":"String","signatureFont":"String","signatureAppearance":"none"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"status":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}