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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class AgreementVisit
            Public Overridable Property AgreementJobID As Integer
            Public Overridable Property AgreementID As Integer
            Public Overridable Property JobID As Integer
            Public Overridable Property OccurrenceDate As Date?
            Public Overridable Property Status As String
            Public Overridable Property CompletedAt As Date?
            Public Overridable Property CancelledAt As Date?
            Public Overridable Property CancelReason As String
            Public Overridable Property ShiftedToDate As Date?
            Public Overridable Property ActualDurationMinutes As Integer?
        End Class

        Public Partial Class AgreementVisitCancelRequest
            Public Overridable Property AgreementJobID As Integer
            Public Overridable Property Reason As String
        End Class

        Public Partial Class AgreementVisitsResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Visits As List(Of AgreementVisit) = New List(Of AgreementVisit)
        End Class
    End Namespace
End Namespace

VB.NET 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}]}