Trendsic Platform Service

<back to all web services

CoverageSelfAvailGetRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/coverage/self/availability
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 CoverageSelfAvailWindow:
    start: Optional[str] = None
    end: Optional[str] = None
    preferred: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageSelfAvailDay:
    day: Optional[str] = None
    open: bool = False
    windows: List[CoverageSelfAvailWindow] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkerSchedulingPrefs:
    contact_i_d: int = 0
    preferred_weekly_hours: Optional[int] = None
    preferred_monthly_hours: Optional[int] = None
    min_shift_minutes: Optional[int] = None
    max_consecutive_days: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageSelfAvailResponse:
    response_status: Optional[ResponseStatus] = None
    days: List[CoverageSelfAvailDay] = field(default_factory=list)
    prefs: Optional[WorkerSchedulingPrefs] = None
    rules_summary: Optional[str] = None
    time_off_notice_days: int = 0


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

Python CoverageSelfAvailGetRequest 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 /v1/coverage/self/availability HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
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"}},"Days":[{"Day":"String","Open":false,"Windows":[{"Start":"String","End":"String","Preferred":false}]}],"Prefs":{"ContactID":0,"PreferredWeeklyHours":0,"PreferredMonthlyHours":0,"MinShiftMinutes":0,"MaxConsecutiveDays":0},"RulesSummary":"String","TimeOffNoticeDays":0}