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
import 'package:servicestack/servicestack.dart';

class AgreementVisit implements IConvertible
{
    int? AgreementJobID;
    int? AgreementID;
    int? JobID;
    DateTime? OccurrenceDate;
    String? Status;
    DateTime? CompletedAt;
    DateTime? CancelledAt;
    String? CancelReason;
    DateTime? ShiftedToDate;
    int? ActualDurationMinutes;

    AgreementVisit({this.AgreementJobID,this.AgreementID,this.JobID,this.OccurrenceDate,this.Status,this.CompletedAt,this.CancelledAt,this.CancelReason,this.ShiftedToDate,this.ActualDurationMinutes});
    AgreementVisit.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AgreementJobID = json['AgreementJobID'];
        AgreementID = json['AgreementID'];
        JobID = json['JobID'];
        OccurrenceDate = JsonConverters.fromJson(json['OccurrenceDate'],'DateTime',context!);
        Status = json['Status'];
        CompletedAt = JsonConverters.fromJson(json['CompletedAt'],'DateTime',context!);
        CancelledAt = JsonConverters.fromJson(json['CancelledAt'],'DateTime',context!);
        CancelReason = json['CancelReason'];
        ShiftedToDate = JsonConverters.fromJson(json['ShiftedToDate'],'DateTime',context!);
        ActualDurationMinutes = json['ActualDurationMinutes'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AgreementJobID': AgreementJobID,
        'AgreementID': AgreementID,
        'JobID': JobID,
        'OccurrenceDate': JsonConverters.toJson(OccurrenceDate,'DateTime',context!),
        'Status': Status,
        'CompletedAt': JsonConverters.toJson(CompletedAt,'DateTime',context!),
        'CancelledAt': JsonConverters.toJson(CancelledAt,'DateTime',context!),
        'CancelReason': CancelReason,
        'ShiftedToDate': JsonConverters.toJson(ShiftedToDate,'DateTime',context!),
        'ActualDurationMinutes': ActualDurationMinutes
    };

    getTypeName() => "AgreementVisit";
    TypeContext? context = _ctx;
}

class AgreementVisitsResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<AgreementVisit>? Visits = [];

    AgreementVisitsResponse({this.ResponseStatus,this.Visits});
    AgreementVisitsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        Visits = JsonConverters.fromJson(json['Visits'],'List<AgreementVisit>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'Visits': JsonConverters.toJson(Visits,'List<AgreementVisit>',context!)
    };

    getTypeName() => "AgreementVisitsResponse";
    TypeContext? context = _ctx;
}

class AgreementVisitCompleteRequest implements IConvertible
{
    int? AgreementJobID;

    AgreementVisitCompleteRequest({this.AgreementJobID});
    AgreementVisitCompleteRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AgreementJobID = json['AgreementJobID'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AgreementJobID': AgreementJobID
    };

    getTypeName() => "AgreementVisitCompleteRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'AgreementVisit': TypeInfo(TypeOf.Class, create:() => AgreementVisit()),
    'AgreementVisitsResponse': TypeInfo(TypeOf.Class, create:() => AgreementVisitsResponse()),
    'List<AgreementVisit>': TypeInfo(TypeOf.Class, create:() => <AgreementVisit>[]),
    'AgreementVisitCompleteRequest': TypeInfo(TypeOf.Class, create:() => AgreementVisitCompleteRequest()),
});

Dart 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>