Trendsic Platform Service

<back to all web services

AgreementVisitCancelRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/serviceagreement/visit/{AgreementJobID}/cancel
"use strict";
export class AgreementVisit {
    /** @param {{AgreementJobID?:number,AgreementID?:number,JobID?:number,OccurrenceDate?:string,Status?:string,CompletedAt?:string,CancelledAt?:string,CancelReason?:string,ShiftedToDate?:string,ActualDurationMinutes?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgreementJobID;
    /** @type {number} */
    AgreementID;
    /** @type {number} */
    JobID;
    /** @type {?string} */
    OccurrenceDate;
    /** @type {string} */
    Status;
    /** @type {?string} */
    CompletedAt;
    /** @type {?string} */
    CancelledAt;
    /** @type {string} */
    CancelReason;
    /** @type {?string} */
    ShiftedToDate;
    /** @type {?number} */
    ActualDurationMinutes;
}
export class AgreementVisitsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Visits?:AgreementVisit[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {AgreementVisit[]} */
    Visits = [];
}
export class AgreementVisitCancelRequest {
    /** @param {{AgreementJobID?:number,Reason?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgreementJobID;
    /** @type {string} */
    Reason;
}

JavaScript AgreementVisitCancelRequest 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.

POST /v1/serviceagreement/visit/{AgreementJobID}/cancel HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"AgreementJobID":0,"Reason":"String"}

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"}},"Visits":[{"AgreementJobID":0,"AgreementID":0,"JobID":0,"OccurrenceDate":"0001-01-01T00:00:00.0000000","Status":"String","CompletedAt":"0001-01-01T00:00:00.0000000","CancelledAt":"0001-01-01T00:00:00.0000000","CancelReason":"String","ShiftedToDate":"0001-01-01T00:00:00.0000000","ActualDurationMinutes":0}]}