Trendsic Platform Service

<back to all web services

BranchApptCreateRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/queue/appointments
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type BranchApptWriteResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val CalendarEventId:Int32 = new Int32() with get,set
        member val CheckInId:Guid = new Guid() with get,set
        member val StartLocal:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EndLocal:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ContactId:Int32 = new Int32() with get,set
        member val ContactExisted:Boolean = new Boolean() with get,set
        member val Notified:Boolean = new Boolean() with get,set
        member val Open:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Capacity:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type BranchApptNewContact() = 
        member val Name:String = null with get,set
        member val Phone:String = null with get,set
        member val Email:String = null with get,set

    [<AllowNullLiteral>]
    type BranchApptCreateRequest() = 
        member val LocationId:Guid = new Guid() with get,set
        member val Date:String = null with get,set
        member val StartLocal:String = null with get,set
        member val LineIds:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set
        member val ContactId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val NewContact:BranchApptNewContact = null with get,set
        member val Via:String = null with get,set
        member val Notify:Boolean = new Boolean() with get,set
        member val Note:String = null with get,set
        member val Overbook:Boolean = new Boolean() with get,set

F# BranchApptCreateRequest 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 HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BranchApptCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ContactId>0</ContactId>
  <Date>String</Date>
  <LineIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </LineIds>
  <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
  <NewContact>
    <Email>String</Email>
    <Name>String</Name>
    <Phone>String</Phone>
  </NewContact>
  <Note>String</Note>
  <Notify>false</Notify>
  <Overbook>false</Overbook>
  <StartLocal>String</StartLocal>
  <Via>String</Via>
</BranchApptCreateRequest>
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>