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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type AgreementVisit() = 
        member val AgreementJobID:Int32 = new Int32() with get,set
        member val AgreementID:Int32 = new Int32() with get,set
        member val JobID:Int32 = new Int32() with get,set
        member val OccurrenceDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Status:String = null with get,set
        member val CompletedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CancelledAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CancelReason:String = null with get,set
        member val ShiftedToDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ActualDurationMinutes:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type AgreementVisitsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Visits:ResizeArray<AgreementVisit> = new ResizeArray<AgreementVisit>() with get,set

    [<AllowNullLiteral>]
    type AgreementVisitCancelRequest() = 
        member val AgreementJobID:Int32 = new Int32() with get,set
        member val Reason:String = null with get,set

F# AgreementVisitCancelRequest 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.

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

{"AgreementJobID":0,"Reason":"String"}
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"}},"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}]}