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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class BranchApptChangeRequest
            Public Overridable Property CheckInId As Guid
            Public Overridable Property [Date] As String
            Public Overridable Property StartLocal As String
            Public Overridable Property LineIds As List(Of Guid) = New List(Of Guid)
            Public Overridable Property Notify As Boolean
            Public Overridable Property Reason As String
            Public Overridable Property Note As String
            Public Overridable Property Overbook As Boolean
        End Class

        Public Partial Class BranchApptWriteResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property CalendarEventId As Integer
            Public Overridable Property CheckInId As Guid
            Public Overridable Property StartLocal As Date?
            Public Overridable Property EndLocal As Date?
            Public Overridable Property ContactId As Integer
            Public Overridable Property ContactExisted As Boolean
            Public Overridable Property Notified As Boolean
            Public Overridable Property Open As Integer?
            Public Overridable Property Capacity As Integer?
        End Class
    End Namespace
End Namespace

VB.NET 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>