| GET | /campaign/customers/ | Get Campaign Customers |
|---|
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 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
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LookupCampaignCustomers(QueryDb[CampaignCustomersView]):
pass
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 LookupCampaignCustomers DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /campaign/customers/ HTTP/1.1 Host: duengageapi.uat.scadsoftware.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Id":0,"Name":"String","Description":"String","CustomersId":0,"FirstName":"String","LastName":"String","IdNumber":"String","PassportNumber":"String","Email":"String","MobileNumber":"String","CustomerUniqueIdentifier":"String","CustomerPublicAccessGuid":"00000000000000000000000000000000","CampaignPublicAccessGuid":"00000000000000000000000000000000","TenantsId":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}