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
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class BranchApptCreateRequest
    {
        public UUID LocationId = null;
        public String Date = null;
        public String StartLocal = null;
        public ArrayList<UUID> LineIds = new ArrayList<UUID>();
        public Integer ContactId = null;
        public BranchApptNewContact NewContact = null;
        public String Via = null;
        public Boolean Notify = null;
        public String Note = null;
        public Boolean Overbook = null;
        
        public UUID getLocationId() { return LocationId; }
        public BranchApptCreateRequest setLocationId(UUID value) { this.LocationId = value; return this; }
        public String getDate() { return Date; }
        public BranchApptCreateRequest setDate(String value) { this.Date = value; return this; }
        public String getStartLocal() { return StartLocal; }
        public BranchApptCreateRequest setStartLocal(String value) { this.StartLocal = value; return this; }
        public ArrayList<UUID> getLineIds() { return LineIds; }
        public BranchApptCreateRequest setLineIds(ArrayList<UUID> value) { this.LineIds = value; return this; }
        public Integer getContactId() { return ContactId; }
        public BranchApptCreateRequest setContactId(Integer value) { this.ContactId = value; return this; }
        public BranchApptNewContact getNewContact() { return NewContact; }
        public BranchApptCreateRequest setNewContact(BranchApptNewContact value) { this.NewContact = value; return this; }
        public String getVia() { return Via; }
        public BranchApptCreateRequest setVia(String value) { this.Via = value; return this; }
        public Boolean isNotify() { return Notify; }
        public BranchApptCreateRequest setNotify(Boolean value) { this.Notify = value; return this; }
        public String getNote() { return Note; }
        public BranchApptCreateRequest setNote(String value) { this.Note = value; return this; }
        public Boolean isOverbook() { return Overbook; }
        public BranchApptCreateRequest setOverbook(Boolean value) { this.Overbook = value; return this; }
    }

    public static class BranchApptNewContact
    {
        public String Name = null;
        public String Phone = null;
        public String Email = null;
        
        public String getName() { return Name; }
        public BranchApptNewContact setName(String value) { this.Name = value; return this; }
        public String getPhone() { return Phone; }
        public BranchApptNewContact setPhone(String value) { this.Phone = value; return this; }
        public String getEmail() { return Email; }
        public BranchApptNewContact setEmail(String value) { this.Email = value; return this; }
    }

    public static class BranchApptWriteResponse
    {
        public ResponseStatus ResponseStatus = null;
        public Integer CalendarEventId = null;
        public UUID CheckInId = null;
        public Date StartLocal = null;
        public Date EndLocal = null;
        public Integer ContactId = null;
        public Boolean ContactExisted = null;
        public Boolean Notified = null;
        public Integer Open = null;
        public Integer Capacity = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public BranchApptWriteResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public Integer getCalendarEventId() { return CalendarEventId; }
        public BranchApptWriteResponse setCalendarEventId(Integer value) { this.CalendarEventId = value; return this; }
        public UUID getCheckInId() { return CheckInId; }
        public BranchApptWriteResponse setCheckInId(UUID value) { this.CheckInId = value; return this; }
        public Date getStartLocal() { return StartLocal; }
        public BranchApptWriteResponse setStartLocal(Date value) { this.StartLocal = value; return this; }
        public Date getEndLocal() { return EndLocal; }
        public BranchApptWriteResponse setEndLocal(Date value) { this.EndLocal = value; return this; }
        public Integer getContactId() { return ContactId; }
        public BranchApptWriteResponse setContactId(Integer value) { this.ContactId = value; return this; }
        public Boolean isContactExisted() { return ContactExisted; }
        public BranchApptWriteResponse setContactExisted(Boolean value) { this.ContactExisted = value; return this; }
        public Boolean isNotified() { return Notified; }
        public BranchApptWriteResponse setNotified(Boolean value) { this.Notified = value; return this; }
        public Integer getOpen() { return Open; }
        public BranchApptWriteResponse setOpen(Integer value) { this.Open = value; return this; }
        public Integer getCapacity() { return Capacity; }
        public BranchApptWriteResponse setCapacity(Integer value) { this.Capacity = value; return this; }
    }

}

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