Trendsic Platform Service

<back to all web services

VisitChecklistAddRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/visit/{AgreementJobID}/checklist/add
import 'package:servicestack/servicestack.dart';

class VisitChecklistItem implements IConvertible
{
    int? VisitChecklistItemID;
    int? AgreementJobID;
    int? ServiceTaskID;
    String? Name;
    int? Status;
    String? Note;
    String? QaResult;
    int? AttachmentId;
    String? CompletedBy;
    DateTime? CompletedAt;
    int? SortOrder;

    VisitChecklistItem({this.VisitChecklistItemID,this.AgreementJobID,this.ServiceTaskID,this.Name,this.Status,this.Note,this.QaResult,this.AttachmentId,this.CompletedBy,this.CompletedAt,this.SortOrder});
    VisitChecklistItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        VisitChecklistItemID = json['VisitChecklistItemID'];
        AgreementJobID = json['AgreementJobID'];
        ServiceTaskID = json['ServiceTaskID'];
        Name = json['Name'];
        Status = json['Status'];
        Note = json['Note'];
        QaResult = json['QaResult'];
        AttachmentId = json['AttachmentId'];
        CompletedBy = json['CompletedBy'];
        CompletedAt = JsonConverters.fromJson(json['CompletedAt'],'DateTime',context!);
        SortOrder = json['SortOrder'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'VisitChecklistItemID': VisitChecklistItemID,
        'AgreementJobID': AgreementJobID,
        'ServiceTaskID': ServiceTaskID,
        'Name': Name,
        'Status': Status,
        'Note': Note,
        'QaResult': QaResult,
        'AttachmentId': AttachmentId,
        'CompletedBy': CompletedBy,
        'CompletedAt': JsonConverters.toJson(CompletedAt,'DateTime',context!),
        'SortOrder': SortOrder
    };

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

class VisitChecklistResponse implements IConvertible
{
    List<VisitChecklistItem>? Items = [];
    ResponseStatus? ResponseStatus;

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

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

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

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

class VisitChecklistAddRequest implements IConvertible
{
    int? AgreementJobID;
    int? ServiceTaskID;
    String? Name;

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

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

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

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

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

Dart VisitChecklistAddRequest 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/visit/{AgreementJobID}/checklist/add HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<VisitChecklistResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Items>
    <VisitChecklistItem>
      <AgreementJobID>0</AgreementJobID>
      <AttachmentId>0</AttachmentId>
      <CompletedAt>0001-01-01T00:00:00</CompletedAt>
      <CompletedBy>String</CompletedBy>
      <Name>String</Name>
      <Note>String</Note>
      <QaResult>String</QaResult>
      <ServiceTaskID>0</ServiceTaskID>
      <SortOrder>0</SortOrder>
      <Status>0</Status>
      <VisitChecklistItemID>0</VisitChecklistItemID>
    </VisitChecklistItem>
  </Items>
  <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>
</VisitChecklistResponse>