ClubManager.Api

FindMessageTemplate

**Requires Authentication**
Required role:	API

The following routes are available for this service:
All Verbs	/api/Query/MessageTemplate

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 QueryBase:
    skip: Optional[int] = None
    take: Optional[int] = None
    order_by: Optional[str] = None
    order_by_desc: Optional[str] = None
    include: Optional[str] = None
    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb(Generic[T], QueryBase, IReturn[QueryResponse[T]]):
    @staticmethod
    def response_type(): return QueryResponse[T]


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MessageTemplateInstance:
    message_template_id: Optional[int] = None
    name: Optional[str] = None
    subject: Optional[str] = None
    body: Optional[str] = None
    report_id: Optional[int] = None
    template_type: Optional[int] = None
    created: Optional[datetime.datetime] = None
    created_by: Optional[int] = None
    modified: Optional[datetime.datetime] = None
    modified_by: Optional[int] = None
    deleted: Optional[datetime.datetime] = None
    deleted_by: Optional[int] = None
    event_type: Optional[int] = None
    content_type: Optional[int] = None
    hidden: Optional[bool] = None
    parent_message_template_id: Optional[int] = None
    inclusion_tags: Optional[str] = None
    exclusion_tags: Optional[str] = None


# @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="MessageTemplate")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FindMessageTemplate(QueryDb[MessageTemplateInstance]):
    pass


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[T]):
    offset: Optional[int] = None
    total: Optional[int] = None
    results: Optional[List[T]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

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

POST /api/Query/MessageTemplate HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FindMessageTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</FindMessageTemplate>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfMessageTemplateInstancePEZRWkv_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
    <d2p1:MessageTemplateInstance>
      <d2p1:Body>String</d2p1:Body>
      <d2p1:ContentType>0</d2p1:ContentType>
      <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
      <d2p1:CreatedBy>0</d2p1:CreatedBy>
      <d2p1:Deleted>0001-01-01T00:00:00</d2p1:Deleted>
      <d2p1:DeletedBy>0</d2p1:DeletedBy>
      <d2p1:EventType>0</d2p1:EventType>
      <d2p1:ExclusionTags>String</d2p1:ExclusionTags>
      <d2p1:Hidden>false</d2p1:Hidden>
      <d2p1:InclusionTags>String</d2p1:InclusionTags>
      <d2p1:MessageTemplateId>0</d2p1:MessageTemplateId>
      <d2p1:Modified>0001-01-01T00:00:00</d2p1:Modified>
      <d2p1:ModifiedBy>0</d2p1:ModifiedBy>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:ParentMessageTemplateId>0</d2p1:ParentMessageTemplateId>
      <d2p1:ReportId>0</d2p1:ReportId>
      <d2p1:Subject>String</d2p1:Subject>
      <d2p1:TemplateType>0</d2p1:TemplateType>
    </d2p1:MessageTemplateInstance>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfMessageTemplateInstancePEZRWkv_P>