Trendsic Platform Service

<back to all web services

CoverageBoardRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/coverage/board
import 'package:servicestack/servicestack.dart';

class CoverageSelfMatrixRow implements IConvertible
{
    String? Name;
    String? Note;
    String? Tone;

    CoverageSelfMatrixRow({this.Name,this.Note,this.Tone});
    CoverageSelfMatrixRow.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Name = json['Name'];
        Note = json['Note'];
        Tone = json['Tone'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Name': Name,
        'Note': Note,
        'Tone': Tone
    };

    getTypeName() => "CoverageSelfMatrixRow";
    TypeContext? context = _ctx;
}

class CoverageBoardShift implements IConvertible
{
    int? CoverageGapId;
    String? State;
    String? Day;
    String? Window;
    String? Site;
    String? Role;
    String? Poster;
    String? ExpiryLabel;
    bool? ExpiresSoon;
    int? EligibleCount;
    int? IneligibleCount;
    int? OfferedCount;
    int? ClaimsCount;
    String? ClaimantName;
    String? AudienceTier;
    List<CoverageSelfMatrixRow>? Matrix = [];
    int? NotYetOffered;

    CoverageBoardShift({this.CoverageGapId,this.State,this.Day,this.Window,this.Site,this.Role,this.Poster,this.ExpiryLabel,this.ExpiresSoon,this.EligibleCount,this.IneligibleCount,this.OfferedCount,this.ClaimsCount,this.ClaimantName,this.AudienceTier,this.Matrix,this.NotYetOffered});
    CoverageBoardShift.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CoverageGapId = json['CoverageGapId'];
        State = json['State'];
        Day = json['Day'];
        Window = json['Window'];
        Site = json['Site'];
        Role = json['Role'];
        Poster = json['Poster'];
        ExpiryLabel = json['ExpiryLabel'];
        ExpiresSoon = json['ExpiresSoon'];
        EligibleCount = json['EligibleCount'];
        IneligibleCount = json['IneligibleCount'];
        OfferedCount = json['OfferedCount'];
        ClaimsCount = json['ClaimsCount'];
        ClaimantName = json['ClaimantName'];
        AudienceTier = json['AudienceTier'];
        Matrix = JsonConverters.fromJson(json['Matrix'],'List<CoverageSelfMatrixRow>',context!);
        NotYetOffered = json['NotYetOffered'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CoverageGapId': CoverageGapId,
        'State': State,
        'Day': Day,
        'Window': Window,
        'Site': Site,
        'Role': Role,
        'Poster': Poster,
        'ExpiryLabel': ExpiryLabel,
        'ExpiresSoon': ExpiresSoon,
        'EligibleCount': EligibleCount,
        'IneligibleCount': IneligibleCount,
        'OfferedCount': OfferedCount,
        'ClaimsCount': ClaimsCount,
        'ClaimantName': ClaimantName,
        'AudienceTier': AudienceTier,
        'Matrix': JsonConverters.toJson(Matrix,'List<CoverageSelfMatrixRow>',context!),
        'NotYetOffered': NotYetOffered
    };

    getTypeName() => "CoverageBoardShift";
    TypeContext? context = _ctx;
}

class CoverageBoardApproval implements IConvertible
{
    int? CoverageApprovalId;
    int? CoverageGapId;
    String? Claimant;
    String? Poster;
    String? Day;
    String? Window;
    String? Site;
    String? Role;
    String? OtText;
    String? OtNote;
    bool? OtWarn;
    String? MarginText;
    String? MarginNote;
    String? MarginTone;
    String? EligText;
    String? EligNote;
    bool? EligWarn;
    String? Channel;

    CoverageBoardApproval({this.CoverageApprovalId,this.CoverageGapId,this.Claimant,this.Poster,this.Day,this.Window,this.Site,this.Role,this.OtText,this.OtNote,this.OtWarn,this.MarginText,this.MarginNote,this.MarginTone,this.EligText,this.EligNote,this.EligWarn,this.Channel});
    CoverageBoardApproval.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CoverageApprovalId = json['CoverageApprovalId'];
        CoverageGapId = json['CoverageGapId'];
        Claimant = json['Claimant'];
        Poster = json['Poster'];
        Day = json['Day'];
        Window = json['Window'];
        Site = json['Site'];
        Role = json['Role'];
        OtText = json['OtText'];
        OtNote = json['OtNote'];
        OtWarn = json['OtWarn'];
        MarginText = json['MarginText'];
        MarginNote = json['MarginNote'];
        MarginTone = json['MarginTone'];
        EligText = json['EligText'];
        EligNote = json['EligNote'];
        EligWarn = json['EligWarn'];
        Channel = json['Channel'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CoverageApprovalId': CoverageApprovalId,
        'CoverageGapId': CoverageGapId,
        'Claimant': Claimant,
        'Poster': Poster,
        'Day': Day,
        'Window': Window,
        'Site': Site,
        'Role': Role,
        'OtText': OtText,
        'OtNote': OtNote,
        'OtWarn': OtWarn,
        'MarginText': MarginText,
        'MarginNote': MarginNote,
        'MarginTone': MarginTone,
        'EligText': EligText,
        'EligNote': EligNote,
        'EligWarn': EligWarn,
        'Channel': Channel
    };

    getTypeName() => "CoverageBoardApproval";
    TypeContext? context = _ctx;
}

class CoverageBoardHistoryRow implements IConvertible
{
    String? Kind;
    String? Title;
    String? Detail;
    String? Outcome;
    String? WhenLabel;

    CoverageBoardHistoryRow({this.Kind,this.Title,this.Detail,this.Outcome,this.WhenLabel});
    CoverageBoardHistoryRow.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Kind = json['Kind'];
        Title = json['Title'];
        Detail = json['Detail'];
        Outcome = json['Outcome'];
        WhenLabel = json['WhenLabel'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Kind': Kind,
        'Title': Title,
        'Detail': Detail,
        'Outcome': Outcome,
        'WhenLabel': WhenLabel
    };

    getTypeName() => "CoverageBoardHistoryRow";
    TypeContext? context = _ctx;
}

class CoverageBoardResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<CoverageBoardShift>? Shifts = [];
    List<CoverageBoardApproval>? Approvals = [];
    List<CoverageBoardHistoryRow>? History = [];
    bool? CanApprove;

    CoverageBoardResponse({this.ResponseStatus,this.Shifts,this.Approvals,this.History,this.CanApprove});
    CoverageBoardResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        Shifts = JsonConverters.fromJson(json['Shifts'],'List<CoverageBoardShift>',context!);
        Approvals = JsonConverters.fromJson(json['Approvals'],'List<CoverageBoardApproval>',context!);
        History = JsonConverters.fromJson(json['History'],'List<CoverageBoardHistoryRow>',context!);
        CanApprove = json['CanApprove'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'Shifts': JsonConverters.toJson(Shifts,'List<CoverageBoardShift>',context!),
        'Approvals': JsonConverters.toJson(Approvals,'List<CoverageBoardApproval>',context!),
        'History': JsonConverters.toJson(History,'List<CoverageBoardHistoryRow>',context!),
        'CanApprove': CanApprove
    };

    getTypeName() => "CoverageBoardResponse";
    TypeContext? context = _ctx;
}

class CoverageBoardRequest implements IConvertible
{
    String? BranchId;

    CoverageBoardRequest({this.BranchId});
    CoverageBoardRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        BranchId = json['BranchId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'BranchId': BranchId
    };

    getTypeName() => "CoverageBoardRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'CoverageSelfMatrixRow': TypeInfo(TypeOf.Class, create:() => CoverageSelfMatrixRow()),
    'CoverageBoardShift': TypeInfo(TypeOf.Class, create:() => CoverageBoardShift()),
    'List<CoverageSelfMatrixRow>': TypeInfo(TypeOf.Class, create:() => <CoverageSelfMatrixRow>[]),
    'CoverageBoardApproval': TypeInfo(TypeOf.Class, create:() => CoverageBoardApproval()),
    'CoverageBoardHistoryRow': TypeInfo(TypeOf.Class, create:() => CoverageBoardHistoryRow()),
    'CoverageBoardResponse': TypeInfo(TypeOf.Class, create:() => CoverageBoardResponse()),
    'List<CoverageBoardShift>': TypeInfo(TypeOf.Class, create:() => <CoverageBoardShift>[]),
    'List<CoverageBoardApproval>': TypeInfo(TypeOf.Class, create:() => <CoverageBoardApproval>[]),
    'List<CoverageBoardHistoryRow>': TypeInfo(TypeOf.Class, create:() => <CoverageBoardHistoryRow>[]),
    'CoverageBoardRequest': TypeInfo(TypeOf.Class, create:() => CoverageBoardRequest()),
});

Dart CoverageBoardRequest 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.

GET /v1/coverage/board HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CoverageBoardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Approvals>
    <CoverageBoardApproval>
      <Channel>String</Channel>
      <Claimant>String</Claimant>
      <CoverageApprovalId>0</CoverageApprovalId>
      <CoverageGapId>0</CoverageGapId>
      <Day>String</Day>
      <EligNote>String</EligNote>
      <EligText>String</EligText>
      <EligWarn>false</EligWarn>
      <MarginNote>String</MarginNote>
      <MarginText>String</MarginText>
      <MarginTone>String</MarginTone>
      <OtNote>String</OtNote>
      <OtText>String</OtText>
      <OtWarn>false</OtWarn>
      <Poster>String</Poster>
      <Role>String</Role>
      <Site>String</Site>
      <Window>String</Window>
    </CoverageBoardApproval>
  </Approvals>
  <CanApprove>false</CanApprove>
  <History>
    <CoverageBoardHistoryRow>
      <Detail>String</Detail>
      <Kind>String</Kind>
      <Outcome>String</Outcome>
      <Title>String</Title>
      <WhenLabel>String</WhenLabel>
    </CoverageBoardHistoryRow>
  </History>
  <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>
  <Shifts>
    <CoverageBoardShift>
      <AudienceTier>String</AudienceTier>
      <ClaimantName>String</ClaimantName>
      <ClaimsCount>0</ClaimsCount>
      <CoverageGapId>0</CoverageGapId>
      <Day>String</Day>
      <EligibleCount>0</EligibleCount>
      <ExpiresSoon>false</ExpiresSoon>
      <ExpiryLabel>String</ExpiryLabel>
      <IneligibleCount>0</IneligibleCount>
      <Matrix>
        <CoverageSelfMatrixRow>
          <Name>String</Name>
          <Note>String</Note>
          <Tone>String</Tone>
        </CoverageSelfMatrixRow>
      </Matrix>
      <NotYetOffered>0</NotYetOffered>
      <OfferedCount>0</OfferedCount>
      <Poster>String</Poster>
      <Role>String</Role>
      <Site>String</Site>
      <State>String</State>
      <Window>String</Window>
    </CoverageBoardShift>
  </Shifts>
</CoverageBoardResponse>