NAV

CampaignsGetList

The following routes are available for this service:
GET	/campaigns

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 CampaignDetails:
    campaign_number: Optional[int] = None
    campaign_name: Optional[str] = None
    batch_number: Optional[Decimal] = None
    batch_name: Optional[str] = None
    campaigns_away_from_current: Optional[int] = None
    cycle: Optional[int] = None
    period_start_time: Optional[datetime.datetime] = None
    period_end_time: Optional[datetime.datetime] = None
    fiscal_year: Optional[int] = None
    status: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignViewModel:
    current_campaign_number: Optional[int] = None
    prior_year_campaign_number: Optional[int] = None
    campaigns: Optional[List[CampaignDetails]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignsGetListResponse(GetResponse[CampaignViewModel]):
    pass


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


TEntity = TypeVar('TEntity')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetResponse(Generic[TEntity]):
    item: Optional[TEntity] = None
    response_status: Optional[ResponseStatus] = None

Python CampaignsGetList DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /campaigns HTTP/1.1 
Host: extensions.avon.ca 
Accept: application/json

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

{"item":{"currentCampaignNumber":0,"priorYearCampaignNumber":0,"campaigns":[{"campaignNumber":0,"campaignName":"String","batchNumber":0,"batchName":"String","campaignsAwayFromCurrent":0,"cycle":0,"periodStartTime":"0001-01-01T00:00:00.0000000","periodEndTime":"0001-01-01T00:00:00.0000000","fiscalYear":0,"status":"String"}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}