| PUT | /newsletter/subscribe | Subscribed to newsletter |
|---|
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 SubscribedUserResponse:
subscribed: bool = False
company_id: Optional[str] = None
# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscribeToNewsletter(ICompany):
# @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
company_id: Optional[str] = None
"""
The company id, if empty will use the company id for the user you are logged in with.
"""
# @ApiMember(Description="Companies for which user is subscribed.", IsRequired=true)
subscribed_companies: Optional[List[SubscribedUserResponse]] = None
"""
Companies for which user is subscribed.
"""
Python SubscribeToNewsletter DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /newsletter/subscribe HTTP/1.1
Host: api.bookmore.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SubscribeToNewsletter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<SubscribedCompanies>
<SubscribedUserResponse>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Subscribed>false</Subscribed>
</SubscribedUserResponse>
</SubscribedCompanies>
</SubscribeToNewsletter>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ArrayOfSubscribedUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<SubscribedUserResponse>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Subscribed>false</Subscribed>
</SubscribedUserResponse>
</ArrayOfSubscribedUserResponse>