Trendsic Platform Service

<back to all web services

BranchApptChangeRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/queue/appointments/{CheckInId}/change
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class BranchApptWriteResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    int? CalendarEventId;
    String? CheckInId;
    DateTime? StartLocal;
    DateTime? EndLocal;
    int? ContactId;
    bool? ContactExisted;
    bool? Notified;
    int? Open;
    int? Capacity;

    BranchApptWriteResponse({this.ResponseStatus,this.CalendarEventId,this.CheckInId,this.StartLocal,this.EndLocal,this.ContactId,this.ContactExisted,this.Notified,this.Open,this.Capacity});
    BranchApptWriteResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        CalendarEventId = json['CalendarEventId'];
        CheckInId = json['CheckInId'];
        StartLocal = JsonConverters.fromJson(json['StartLocal'],'DateTime',context!);
        EndLocal = JsonConverters.fromJson(json['EndLocal'],'DateTime',context!);
        ContactId = json['ContactId'];
        ContactExisted = json['ContactExisted'];
        Notified = json['Notified'];
        Open = json['Open'];
        Capacity = json['Capacity'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'CalendarEventId': CalendarEventId,
        'CheckInId': CheckInId,
        'StartLocal': JsonConverters.toJson(StartLocal,'DateTime',context!),
        'EndLocal': JsonConverters.toJson(EndLocal,'DateTime',context!),
        'ContactId': ContactId,
        'ContactExisted': ContactExisted,
        'Notified': Notified,
        'Open': Open,
        'Capacity': Capacity
    };

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

class BranchApptChangeRequest implements IConvertible
{
    String? CheckInId;
    String? Date;
    String? StartLocal;
    List<String>? LineIds = [];
    bool? Notify;
    String? Reason;
    String? Note;
    bool? Overbook;

    BranchApptChangeRequest({this.CheckInId,this.Date,this.StartLocal,this.LineIds,this.Notify,this.Reason,this.Note,this.Overbook});
    BranchApptChangeRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CheckInId = json['CheckInId'];
        Date = json['Date'];
        StartLocal = json['StartLocal'];
        LineIds = JsonConverters.fromJson(json['LineIds'],'List<String>',context!);
        Notify = json['Notify'];
        Reason = json['Reason'];
        Note = json['Note'];
        Overbook = json['Overbook'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CheckInId': CheckInId,
        'Date': Date,
        'StartLocal': StartLocal,
        'LineIds': JsonConverters.toJson(LineIds,'List<String>',context!),
        'Notify': Notify,
        'Reason': Reason,
        'Note': Note,
        'Overbook': Overbook
    };

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'BranchApptWriteResponse': TypeInfo(TypeOf.Class, create:() => BranchApptWriteResponse()),
    'BranchApptChangeRequest': TypeInfo(TypeOf.Class, create:() => BranchApptChangeRequest()),
});

Dart BranchApptChangeRequest 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/queue/appointments/{CheckInId}/change HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BranchApptChangeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CheckInId>00000000-0000-0000-0000-000000000000</CheckInId>
  <Date>String</Date>
  <LineIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </LineIds>
  <Note>String</Note>
  <Notify>false</Notify>
  <Overbook>false</Overbook>
  <Reason>String</Reason>
  <StartLocal>String</StartLocal>
</BranchApptChangeRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BranchApptWriteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CalendarEventId>0</CalendarEventId>
  <Capacity>0</Capacity>
  <CheckInId>00000000-0000-0000-0000-000000000000</CheckInId>
  <ContactExisted>false</ContactExisted>
  <ContactId>0</ContactId>
  <EndLocal>0001-01-01T00:00:00</EndLocal>
  <Notified>false</Notified>
  <Open>0</Open>
  <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>
  <StartLocal>0001-01-01T00:00:00</StartLocal>
</BranchApptWriteResponse>