Trendsic Platform Service

CoverageSelfClaimRequest

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 .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 /v1/coverage/self/claim HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CoverageSelfClaimRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CoverageGapId>0</CoverageGapId>
</CoverageSelfClaimRequest>

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

<CoverageSelfCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Card>
    <CanRespond>false</CanRespond>
    <ConflictLabel>String</ConflictLabel>
    <ConflictOk>false</ConflictOk>
    <CoverageGapId>0</CoverageGapId>
    <EligibleCount>0</EligibleCount>
    <ExpiryLabel>String</ExpiryLabel>
    <IneligibleCount>0</IneligibleCount>
    <Kind>String</Kind>
    <Matrix>
      <CoverageSelfMatrixRow>
        <Name>String</Name>
        <Note>String</Note>
        <Tone>String</Tone>
      </CoverageSelfMatrixRow>
    </Matrix>
    <MyEligibility>
      <CanClaim>false</CanClaim>
      <ClaimLabel>String</ClaimLabel>
      <Text>String</Text>
      <Tone>String</Tone>
    </MyEligibility>
    <OfferShift>String</OfferShift>
    <PosterName>String</PosterName>
    <RoleNeeded>String</RoleNeeded>
    <ShiftDay>String</ShiftDay>
    <ShiftStartUtc>0001-01-01T00:00:00</ShiftStartUtc>
    <ShiftWindow>String</ShiftWindow>
    <Site>String</Site>
    <Status>String</Status>
    <SwapFromName>String</SwapFromName>
    <SwapState>String</SwapState>
    <SwapTargetName>String</SwapTargetName>
    <WantShift>String</WantShift>
  </Card>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1: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>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1: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>
    </d2p1:Meta>
  </ResponseStatus>
</CoverageSelfCardResponse>