Trendsic Platform Service

<back to all web services

AgreementVisitsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/serviceagreement/{AgreementID}/visits
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class AgreementVisitsRequest
    {
        public Integer AgreementID = null;
        
        public Integer getAgreementID() { return AgreementID; }
        public AgreementVisitsRequest setAgreementID(Integer value) { this.AgreementID = 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 AgreementVisitsRequest 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.

GET /v1/serviceagreement/{AgreementID}/visits HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
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}]}