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
import Foundation
import ServiceStack

public class AgreementVisitCancelRequest : Codable
{
    public var agreementJobID:Int
    public var reason:String

    required public init(){}
}

public class AgreementVisitsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var visits:[AgreementVisit] = []

    required public init(){}
}

public class AgreementVisit : Codable
{
    public var agreementJobID:Int
    public var agreementID:Int
    public var jobID:Int
    public var occurrenceDate:Date?
    public var status:String
    public var completedAt:Date?
    public var cancelledAt:Date?
    public var cancelReason:String
    public var shiftedToDate:Date?
    public var actualDurationMinutes:Int?

    required public init(){}
}


Swift 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}]}