Trendsic Platform Service

<back to all web services

AvailabilityRefreshRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/Rfp/Availability/Refresh
"use strict";
export class AvailabilityRowView {
    /** @param {{ResourceAvailabilityID?:number,ResourceType?:string,Label?:string,EquipmentName?:string,RolesCsv?:string,InternalRate?:number,RentalRate?:number,PremiumPerHour?:number,AvailableFrom?:string,FreedFromProjectLabel?:string,Source?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ResourceAvailabilityID;
    /** @type {string} */
    ResourceType;
    /** @type {string} */
    Label;
    /** @type {string} */
    EquipmentName;
    /** @type {string} */
    RolesCsv;
    /** @type {?number} */
    InternalRate;
    /** @type {?number} */
    RentalRate;
    /** @type {?number} */
    PremiumPerHour;
    /** @type {string} */
    AvailableFrom;
    /** @type {string} */
    FreedFromProjectLabel;
    /** @type {string} */
    Source;
}
export class AvailabilityRefreshSummary {
    /** @param {{Derived?:number,DeactivatedStale?:number,SkippedManualPrecedence?:number,SkippedNoRentalSource?:number,SkippedNoDayRate?:number,Notes?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Derived;
    /** @type {number} */
    DeactivatedStale;
    /** @type {number} */
    SkippedManualPrecedence;
    /** @type {number} */
    SkippedNoRentalSource;
    /** @type {number} */
    SkippedNoDayRate;
    /** @type {string[]} */
    Notes = [];
}
export class AvailabilityListResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Rows?:AvailabilityRowView[],EquipmentNames?:string[],CrewRoles?:string[],Summary?:AvailabilityRefreshSummary}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {AvailabilityRowView[]} */
    Rows = [];
    /** @type {string[]} */
    EquipmentNames = [];
    /** @type {string[]} */
    CrewRoles = [];
    /** @type {AvailabilityRefreshSummary} */
    Summary;
}
export class AvailabilityRefreshRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript AvailabilityRefreshRequest DTOs

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

HTTP + OTHER

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

POST /v1/Rfp/Availability/Refresh HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Rows":[{"ResourceAvailabilityID":0,"ResourceType":"String","Label":"String","EquipmentName":"String","RolesCsv":"String","InternalRate":0,"RentalRate":0,"PremiumPerHour":0,"AvailableFrom":"0001-01-01T00:00:00.0000000","FreedFromProjectLabel":"String","Source":"String"}],"EquipmentNames":["String"],"CrewRoles":["String"],"Summary":{"Derived":0,"DeactivatedStale":0,"SkippedManualPrecedence":0,"SkippedNoRentalSource":0,"SkippedNoDayRate":0,"Notes":["String"]}}