Trendsic Platform Service

<back to all web services

CoverageSelfAvailPutRequest

Requires Authentication
The following routes are available for this service:
PUT,OPTIONS/v1/coverage/self/availability
"use strict";
export class CoverageSelfAvailWindow {
    /** @param {{Start?:string,End?:string,Preferred?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Start;
    /** @type {string} */
    End;
    /** @type {boolean} */
    Preferred;
}
export class CoverageSelfAvailDay {
    /** @param {{Day?:string,Open?:boolean,Windows?:CoverageSelfAvailWindow[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Day;
    /** @type {boolean} */
    Open;
    /** @type {CoverageSelfAvailWindow[]} */
    Windows = [];
}
export class WorkerSchedulingPrefs {
    /** @param {{ContactID?:number,PreferredWeeklyHours?:number,PreferredMonthlyHours?:number,MinShiftMinutes?:number,MaxConsecutiveDays?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ContactID;
    /** @type {?number} */
    PreferredWeeklyHours;
    /** @type {?number} */
    PreferredMonthlyHours;
    /** @type {?number} */
    MinShiftMinutes;
    /** @type {?number} */
    MaxConsecutiveDays;
}
export class CoverageSelfAvailResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Days?:CoverageSelfAvailDay[],Prefs?:WorkerSchedulingPrefs,RulesSummary?:string,TimeOffNoticeDays?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {CoverageSelfAvailDay[]} */
    Days = [];
    /** @type {WorkerSchedulingPrefs} */
    Prefs;
    /** @type {string} */
    RulesSummary;
    /** @type {number} */
    TimeOffNoticeDays;
}
export class CoverageSelfAvailPutRequest {
    /** @param {{Days?:CoverageSelfAvailDay[],Prefs?:WorkerSchedulingPrefs}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CoverageSelfAvailDay[]} */
    Days = [];
    /** @type {WorkerSchedulingPrefs} */
    Prefs;
}

JavaScript CoverageSelfAvailPutRequest DTOs

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

HTTP + CSV

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

PUT /v1/coverage/self/availability HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Days":[{"Day":"String","Open":false,"Windows":[{"Start":"String","End":"String","Preferred":false}]}],"Prefs":{"ContactID":0,"PreferredWeeklyHours":0,"PreferredMonthlyHours":0,"MinShiftMinutes":0,"MaxConsecutiveDays":0}}

HTTP/1.1 200 OK
Content-Type: text/csv
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}