| GET | /auto/customerssegments/{Id} | ||
|---|---|---|---|
| GET | /auto/customerssegments |
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 CustomersSegments:
# @Required()
id: int = 0
# @Required()
# @References(typeof(Tenants))
tenants_id: int = 0
# @Required()
# @References(typeof(Customers))
customers_id: int = 0
# @Required()
# @References(typeof(Segments))
segments_id: int = 0
# @Required()
public_access_guid: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomersSegmentsAutoQueryLookup(QueryDb[CustomersSegments]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignCustomersView:
id: Optional[int] = None
name: Optional[str] = None
description: Optional[str] = None
customers_id: Optional[int] = None
first_name: Optional[str] = None
last_name: Optional[str] = None
id_number: Optional[str] = None
passport_number: Optional[str] = None
email: Optional[str] = None
mobile_number: Optional[str] = None
customer_unique_identifier: Optional[str] = None
customer_public_access_guid: Optional[str] = None
campaign_public_access_guid: Optional[str] = None
tenants_id: Optional[int] = None
T = TypeVar('T')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[T]):
offset: int = 0
total: int = 0
results: Optional[List[CampaignCustomersView]] = None
meta: Optional[Dict[str, str]] = None
response_status: Optional[ResponseStatus] = None
Python CustomersSegmentsAutoQueryLookup DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /auto/customerssegments/{Id} HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
Id: 0,
TenantsId: 0,
CustomersId: 0,
SegmentsId: 0,
PublicAccessGuid: 00000000000000000000000000000000
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}