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

export class AgreementVisit
{
    public AgreementJobID: number;
    public AgreementID: number;
    public JobID: number;
    public OccurrenceDate?: string;
    public Status: string;
    public CompletedAt?: string;
    public CancelledAt?: string;
    public CancelReason: string;
    public ShiftedToDate?: string;
    public ActualDurationMinutes?: number;

    public constructor(init?: Partial<AgreementVisit>) { (Object as any).assign(this, init); }
}

export class AgreementVisitsResponse
{
    public ResponseStatus: ResponseStatus;
    public Visits: AgreementVisit[] = [];

    public constructor(init?: Partial<AgreementVisitsResponse>) { (Object as any).assign(this, init); }
}

export class AgreementVisitsRequest
{
    public AgreementID: number;

    public constructor(init?: Partial<AgreementVisitsRequest>) { (Object as any).assign(this, init); }
}

TypeScript AgreementVisitsRequest 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.

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