Trendsic Platform Service

<back to all web services

CoverageSelfClaimRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/coverage/self/claim
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 CoverageSelfEligibility:
    tone: Optional[str] = None
    text: Optional[str] = None
    can_claim: bool = False
    claim_label: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageSelfMatrixRow:
    name: Optional[str] = None
    note: Optional[str] = None
    tone: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageSelfCard:
    coverage_gap_id: int = 0
    kind: Optional[str] = None
    status: Optional[str] = None
    shift_day: Optional[str] = None
    shift_window: Optional[str] = None
    shift_start_utc: Optional[datetime.datetime] = None
    site: Optional[str] = None
    role_needed: Optional[str] = None
    expiry_label: Optional[str] = None
    poster_name: Optional[str] = None
    eligible_count: int = 0
    ineligible_count: int = 0
    my_eligibility: Optional[CoverageSelfEligibility] = None
    matrix: List[CoverageSelfMatrixRow] = field(default_factory=list)
    swap_state: Optional[str] = None
    swap_from_name: Optional[str] = None
    swap_target_name: Optional[str] = None
    offer_shift: Optional[str] = None
    want_shift: Optional[str] = None
    conflict_ok: bool = False
    conflict_label: Optional[str] = None
    can_respond: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageSelfCardResponse:
    response_status: Optional[ResponseStatus] = None
    card: Optional[CoverageSelfCard] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageSelfClaimRequest:
    coverage_gap_id: int = 0

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

POST /v1/coverage/self/claim HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CoverageGapId":0}

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

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Card":{"CoverageGapId":0,"Kind":"String","Status":"String","ShiftDay":"String","ShiftWindow":"String","ShiftStartUtc":"0001-01-01T00:00:00.0000000","Site":"String","RoleNeeded":"String","ExpiryLabel":"String","PosterName":"String","EligibleCount":0,"IneligibleCount":0,"MyEligibility":{"Tone":"String","Text":"String","CanClaim":false,"ClaimLabel":"String"},"Matrix":[{"Name":"String","Note":"String","Tone":"String"}],"SwapState":"String","SwapFromName":"String","SwapTargetName":"String","OfferShift":"String","WantShift":"String","ConflictOk":false,"ConflictLabel":"String","CanRespond":false}}