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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class AgreementVisitCancelRequest
    {
        public Integer AgreementJobID = null;
        public String Reason = null;
        
        public Integer getAgreementJobID() { return AgreementJobID; }
        public AgreementVisitCancelRequest setAgreementJobID(Integer value) { this.AgreementJobID = value; return this; }
        public String getReason() { return Reason; }
        public AgreementVisitCancelRequest setReason(String value) { this.Reason = value; return this; }
    }

    public static class AgreementVisitsResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<AgreementVisit> Visits = new ArrayList<AgreementVisit>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public AgreementVisitsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<AgreementVisit> getVisits() { return Visits; }
        public AgreementVisitsResponse setVisits(ArrayList<AgreementVisit> value) { this.Visits = value; return this; }
    }

    public static class AgreementVisit
    {
        public Integer AgreementJobID = null;
        public Integer AgreementID = null;
        public Integer JobID = null;
        public Date OccurrenceDate = null;
        public String Status = null;
        public Date CompletedAt = null;
        public Date CancelledAt = null;
        public String CancelReason = null;
        public Date ShiftedToDate = null;
        public Integer ActualDurationMinutes = null;
        
        public Integer getAgreementJobID() { return AgreementJobID; }
        public AgreementVisit setAgreementJobID(Integer value) { this.AgreementJobID = value; return this; }
        public Integer getAgreementID() { return AgreementID; }
        public AgreementVisit setAgreementID(Integer value) { this.AgreementID = value; return this; }
        public Integer getJobID() { return JobID; }
        public AgreementVisit setJobID(Integer value) { this.JobID = value; return this; }
        public Date getOccurrenceDate() { return OccurrenceDate; }
        public AgreementVisit setOccurrenceDate(Date value) { this.OccurrenceDate = value; return this; }
        public String getStatus() { return Status; }
        public AgreementVisit setStatus(String value) { this.Status = value; return this; }
        public Date getCompletedAt() { return CompletedAt; }
        public AgreementVisit setCompletedAt(Date value) { this.CompletedAt = value; return this; }
        public Date getCancelledAt() { return CancelledAt; }
        public AgreementVisit setCancelledAt(Date value) { this.CancelledAt = value; return this; }
        public String getCancelReason() { return CancelReason; }
        public AgreementVisit setCancelReason(String value) { this.CancelReason = value; return this; }
        public Date getShiftedToDate() { return ShiftedToDate; }
        public AgreementVisit setShiftedToDate(Date value) { this.ShiftedToDate = value; return this; }
        public Integer getActualDurationMinutes() { return ActualDurationMinutes; }
        public AgreementVisit setActualDurationMinutes(Integer value) { this.ActualDurationMinutes = value; return this; }
    }

}

Java AgreementVisitCancelRequest 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}/cancel HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AgreementVisitCancelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgreementJobID>0</AgreementJobID>
  <Reason>String</Reason>
</AgreementVisitCancelRequest>
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>