Trendsic Platform Service

<back to all web services

AgreementVisitCompleteRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/serviceagreement/visit/{AgreementJobID}/complete
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 AgreementVisitCompleteRequest() = 
        member val AgreementJobID:Int32 = new Int32() with get,set

F# AgreementVisitCompleteRequest DTOs

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

HTTP + XML

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

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

<AgreementVisitCompleteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgreementJobID>0</AgreementJobID>
</AgreementVisitCompleteRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgreementVisitsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Visits>
    <AgreementVisit>
      <ActualDurationMinutes>0</ActualDurationMinutes>
      <AgreementID>0</AgreementID>
      <AgreementJobID>0</AgreementJobID>
      <CancelReason>String</CancelReason>
      <CancelledAt>0001-01-01T00:00:00</CancelledAt>
      <CompletedAt>0001-01-01T00:00:00</CompletedAt>
      <JobID>0</JobID>
      <OccurrenceDate>0001-01-01T00:00:00</OccurrenceDate>
      <ShiftedToDate>0001-01-01T00:00:00</ShiftedToDate>
      <Status>String</Status>
    </AgreementVisit>
  </Visits>
</AgreementVisitsResponse>