| GET,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 CoverageSelfAvailGetRequest {
constructor(init) { Object.assign(this, init) }
}
JavaScript CoverageSelfAvailGetRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CoverageSelfAvailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Days>
<CoverageSelfAvailDay>
<Day>String</Day>
<Open>false</Open>
<Windows>
<CoverageSelfAvailWindow>
<End>String</End>
<Preferred>false</Preferred>
<Start>String</Start>
</CoverageSelfAvailWindow>
</Windows>
</CoverageSelfAvailDay>
</Days>
<Prefs>
<ContactID>0</ContactID>
<MaxConsecutiveDays>0</MaxConsecutiveDays>
<MinShiftMinutes>0</MinShiftMinutes>
<PreferredMonthlyHours>0</PreferredMonthlyHours>
<PreferredWeeklyHours>0</PreferredWeeklyHours>
</Prefs>
<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>
<RulesSummary>String</RulesSummary>
<TimeOffNoticeDays>0</TimeOffNoticeDays>
</CoverageSelfAvailResponse>