CollectionsAPI

<back to all web services

GetCollectionSettingsRequest

Requires Authentication
The following routes are available for this service:
GET/v4/collections/settings
GET/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


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


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

Python GetCollectionSettingsRequest 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 /v4/collections/settings HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCollectionSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CollectionsAPI.ServiceModel.V4.Responses">
  <data xmlns:d2p1="http://schemas.datacontract.org/2004/07/CollectionsAPI.ServiceModel.V4.DTOs" i:nil="true" />
</GetCollectionSettingsResponse>