POST api/appointment

Create an appointment.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, POSTapi/appointment. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

None.

Body Parameters

Appointment data.

CUAppointmentDto

Name	Description	Type	Additional information
CUAppointmentID	Appointment unique identifier.	integer
AppointmentType	Appointment type.	integer
OwnerID	Identifier of the user who created the appointment.	integer
StartTime	Appointment start time.	string
EndTime	Appointment end time.	string
Subject	Subject of the appointment.	string	Required
Location	User location.	string
Description	Description of the appointment.	string	Required
AllDayEvent	Defines whether the appointment is all day event or not.	boolean
AppointmentCompleted	Defines whether appointment is completed or not.	boolean
CustomerID	Unique identifier of the customer.	integer
AppointmentNotes	Appointment notes.	Collection of AppointmentNoteDto
AppointmentUser	Collection of appointment users.	Collection of CUAppointmentUserDto
AppointmentCustomer	Collection of appointment customers.	Collection of CUAppointmentCustomerDto
CULoanID	Unique identifier of the loan.	integer
CustomerName	Name of the customer.	string
CustomerNumber	Customer number.	string
CustomerAddress	Customer address.	string

Request Formats

application/json, text/json

Sample:

{
  "cuAppointmentID": 1,
  "appointmentType": 1,
  "ownerID": 1,
  "startTime": "sample string 1",
  "endTime": "sample string 2",
  "subject": "sample string 3",
  "location": "sample string 4",
  "description": "sample string 5",
  "allDayEvent": true,
  "appointmentCompleted": true,
  "customerID": 1,
  "appointmentNotes": [
    {
      "cuAppointmentNotesLinkID": 1,
      "noteID": 1,
      "note": "sample string 1",
      "creationDate": "sample string 2",
      "editDate": "sample string 3",
      "userName": "sample string 4",
      "userID": 1,
      "terminalName": "sample string 5",
      "terminalID": 1,
      "timestamp": "sample string 6"
    },
    {
      "cuAppointmentNotesLinkID": 1,
      "noteID": 1,
      "note": "sample string 1",
      "creationDate": "sample string 2",
      "editDate": "sample string 3",
      "userName": "sample string 4",
      "userID": 1,
      "terminalName": "sample string 5",
      "terminalID": 1,
      "timestamp": "sample string 6"
    }
  ],
  "appointmentUser": [
    {
      "cuAppointmentUserId": 1,
      "cuAppointmentId": 1,
      "userId": 1,
      "userName": "sample string 1"
    },
    {
      "cuAppointmentUserId": 1,
      "cuAppointmentId": 1,
      "userId": 1,
      "userName": "sample string 1"
    }
  ],
  "appointmentCustomer": [
    {
      "cuAppointmentCustomerId": 1,
      "cuAppointmentId": 1,
      "customerId": 1,
      "customerCRMId": 1,
      "customerName": "sample string 1",
      "customerNumber": "sample string 2",
      "customerAddress": "sample string 3"
    },
    {
      "cuAppointmentCustomerId": 1,
      "cuAppointmentId": 1,
      "customerId": 1,
      "customerCRMId": 1,
      "customerName": "sample string 1",
      "customerNumber": "sample string 2",
      "customerAddress": "sample string 3"
    }
  ],
  "cuLoanID": 1,
  "customerName": "sample string 6",
  "customerNumber": "sample string 7",
  "customerAddress": "sample string 8"
}

application/xml, text/xml

Sample:

<CUAppointmentDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU">
  <AllDayEvent>true</AllDayEvent>
  <AppointmentCompleted>true</AppointmentCompleted>
  <AppointmentCustomer>
    <CUAppointmentCustomerDto>
      <CUAppointmentCustomerId>1</CUAppointmentCustomerId>
      <CUAppointmentId>1</CUAppointmentId>
      <CustomerAddress>sample string 3</CustomerAddress>
      <CustomerCRMId>1</CustomerCRMId>
      <CustomerId>1</CustomerId>
      <CustomerName>sample string 1</CustomerName>
      <CustomerNumber>sample string 2</CustomerNumber>
    </CUAppointmentCustomerDto>
    <CUAppointmentCustomerDto>
      <CUAppointmentCustomerId>1</CUAppointmentCustomerId>
      <CUAppointmentId>1</CUAppointmentId>
      <CustomerAddress>sample string 3</CustomerAddress>
      <CustomerCRMId>1</CustomerCRMId>
      <CustomerId>1</CustomerId>
      <CustomerName>sample string 1</CustomerName>
      <CustomerNumber>sample string 2</CustomerNumber>
    </CUAppointmentCustomerDto>
  </AppointmentCustomer>
  <AppointmentNotes>
    <AppointmentNoteDto>
      <CUAppointmentNotesLinkID>1</CUAppointmentNotesLinkID>
      <CreationDate>sample string 2</CreationDate>
      <EditDate>sample string 3</EditDate>
      <Note>sample string 1</Note>
      <NoteID>1</NoteID>
      <TerminalID>1</TerminalID>
      <TerminalName>sample string 5</TerminalName>
      <Timestamp>sample string 6</Timestamp>
      <UserID>1</UserID>
      <UserName>sample string 4</UserName>
    </AppointmentNoteDto>
    <AppointmentNoteDto>
      <CUAppointmentNotesLinkID>1</CUAppointmentNotesLinkID>
      <CreationDate>sample string 2</CreationDate>
      <EditDate>sample string 3</EditDate>
      <Note>sample string 1</Note>
      <NoteID>1</NoteID>
      <TerminalID>1</TerminalID>
      <TerminalName>sample string 5</TerminalName>
      <Timestamp>sample string 6</Timestamp>
      <UserID>1</UserID>
      <UserName>sample string 4</UserName>
    </AppointmentNoteDto>
  </AppointmentNotes>
  <AppointmentType>1</AppointmentType>
  <AppointmentUser>
    <CUAppointmentUserDto>
      <CUAppointmentId>1</CUAppointmentId>
      <CUAppointmentUserId>1</CUAppointmentUserId>
      <UserId>1</UserId>
      <UserName>sample string 1</UserName>
    </CUAppointmentUserDto>
    <CUAppointmentUserDto>
      <CUAppointmentId>1</CUAppointmentId>
      <CUAppointmentUserId>1</CUAppointmentUserId>
      <UserId>1</UserId>
      <UserName>sample string 1</UserName>
    </CUAppointmentUserDto>
  </AppointmentUser>
  <CUAppointmentID>1</CUAppointmentID>
  <CULoanID>1</CULoanID>
  <CustomerAddress>sample string 8</CustomerAddress>
  <CustomerID>1</CustomerID>
  <CustomerName>sample string 6</CustomerName>
  <CustomerNumber>sample string 7</CustomerNumber>
  <Description>sample string 5</Description>
  <EndTime>sample string 2</EndTime>
  <Location>sample string 4</Location>
  <OwnerID>1</OwnerID>
  <StartTime>sample string 1</StartTime>
  <Subject>sample string 3</Subject>
</CUAppointmentDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response Codes

Success Status:

Created (201), please see resource description below.

Failed Status(es):

Resource Description

Returns created appointment.

CUAppointmentDto

Name	Description	Type	Additional information
CUAppointmentID	Appointment unique identifier.	integer
AppointmentType	Appointment type.	integer
OwnerID	Identifier of the user who created the appointment.	integer
StartTime	Appointment start time.	string
EndTime	Appointment end time.	string
Subject	Subject of the appointment.	string	Required
Location	User location.	string
Description	Description of the appointment.	string	Required
AllDayEvent	Defines whether the appointment is all day event or not.	boolean
AppointmentCompleted	Defines whether appointment is completed or not.	boolean
CustomerID	Unique identifier of the customer.	integer
AppointmentNotes	Appointment notes.	Collection of AppointmentNoteDto
AppointmentUser	Collection of appointment users.	Collection of CUAppointmentUserDto
AppointmentCustomer	Collection of appointment customers.	Collection of CUAppointmentCustomerDto
CULoanID	Unique identifier of the loan.	integer
CustomerName	Name of the customer.	string
CustomerNumber	Customer number.	string
CustomerAddress	Customer address.	string

Response Formats

application/json, text/json

Sample:

{
  "cuAppointmentID": 1,
  "appointmentType": 1,
  "ownerID": 1,
  "startTime": "sample string 1",
  "endTime": "sample string 2",
  "subject": "sample string 3",
  "location": "sample string 4",
  "description": "sample string 5",
  "allDayEvent": true,
  "appointmentCompleted": true,
  "customerID": 1,
  "appointmentNotes": [
    {
      "cuAppointmentNotesLinkID": 1,
      "noteID": 1,
      "note": "sample string 1",
      "creationDate": "sample string 2",
      "editDate": "sample string 3",
      "userName": "sample string 4",
      "userID": 1,
      "terminalName": "sample string 5",
      "terminalID": 1,
      "timestamp": "sample string 6"
    },
    {
      "cuAppointmentNotesLinkID": 1,
      "noteID": 1,
      "note": "sample string 1",
      "creationDate": "sample string 2",
      "editDate": "sample string 3",
      "userName": "sample string 4",
      "userID": 1,
      "terminalName": "sample string 5",
      "terminalID": 1,
      "timestamp": "sample string 6"
    }
  ],
  "appointmentUser": [
    {
      "cuAppointmentUserId": 1,
      "cuAppointmentId": 1,
      "userId": 1,
      "userName": "sample string 1"
    },
    {
      "cuAppointmentUserId": 1,
      "cuAppointmentId": 1,
      "userId": 1,
      "userName": "sample string 1"
    }
  ],
  "appointmentCustomer": [
    {
      "cuAppointmentCustomerId": 1,
      "cuAppointmentId": 1,
      "customerId": 1,
      "customerCRMId": 1,
      "customerName": "sample string 1",
      "customerNumber": "sample string 2",
      "customerAddress": "sample string 3"
    },
    {
      "cuAppointmentCustomerId": 1,
      "cuAppointmentId": 1,
      "customerId": 1,
      "customerCRMId": 1,
      "customerName": "sample string 1",
      "customerNumber": "sample string 2",
      "customerAddress": "sample string 3"
    }
  ],
  "cuLoanID": 1,
  "customerName": "sample string 6",
  "customerNumber": "sample string 7",
  "customerAddress": "sample string 8"
}

application/xml, text/xml

Sample:

<CUAppointmentDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU">
  <AllDayEvent>true</AllDayEvent>
  <AppointmentCompleted>true</AppointmentCompleted>
  <AppointmentCustomer>
    <CUAppointmentCustomerDto>
      <CUAppointmentCustomerId>1</CUAppointmentCustomerId>
      <CUAppointmentId>1</CUAppointmentId>
      <CustomerAddress>sample string 3</CustomerAddress>
      <CustomerCRMId>1</CustomerCRMId>
      <CustomerId>1</CustomerId>
      <CustomerName>sample string 1</CustomerName>
      <CustomerNumber>sample string 2</CustomerNumber>
    </CUAppointmentCustomerDto>
    <CUAppointmentCustomerDto>
      <CUAppointmentCustomerId>1</CUAppointmentCustomerId>
      <CUAppointmentId>1</CUAppointmentId>
      <CustomerAddress>sample string 3</CustomerAddress>
      <CustomerCRMId>1</CustomerCRMId>
      <CustomerId>1</CustomerId>
      <CustomerName>sample string 1</CustomerName>
      <CustomerNumber>sample string 2</CustomerNumber>
    </CUAppointmentCustomerDto>
  </AppointmentCustomer>
  <AppointmentNotes>
    <AppointmentNoteDto>
      <CUAppointmentNotesLinkID>1</CUAppointmentNotesLinkID>
      <CreationDate>sample string 2</CreationDate>
      <EditDate>sample string 3</EditDate>
      <Note>sample string 1</Note>
      <NoteID>1</NoteID>
      <TerminalID>1</TerminalID>
      <TerminalName>sample string 5</TerminalName>
      <Timestamp>sample string 6</Timestamp>
      <UserID>1</UserID>
      <UserName>sample string 4</UserName>
    </AppointmentNoteDto>
    <AppointmentNoteDto>
      <CUAppointmentNotesLinkID>1</CUAppointmentNotesLinkID>
      <CreationDate>sample string 2</CreationDate>
      <EditDate>sample string 3</EditDate>
      <Note>sample string 1</Note>
      <NoteID>1</NoteID>
      <TerminalID>1</TerminalID>
      <TerminalName>sample string 5</TerminalName>
      <Timestamp>sample string 6</Timestamp>
      <UserID>1</UserID>
      <UserName>sample string 4</UserName>
    </AppointmentNoteDto>
  </AppointmentNotes>
  <AppointmentType>1</AppointmentType>
  <AppointmentUser>
    <CUAppointmentUserDto>
      <CUAppointmentId>1</CUAppointmentId>
      <CUAppointmentUserId>1</CUAppointmentUserId>
      <UserId>1</UserId>
      <UserName>sample string 1</UserName>
    </CUAppointmentUserDto>
    <CUAppointmentUserDto>
      <CUAppointmentId>1</CUAppointmentId>
      <CUAppointmentUserId>1</CUAppointmentUserId>
      <UserId>1</UserId>
      <UserName>sample string 1</UserName>
    </CUAppointmentUserDto>
  </AppointmentUser>
  <CUAppointmentID>1</CUAppointmentID>
  <CULoanID>1</CULoanID>
  <CustomerAddress>sample string 8</CustomerAddress>
  <CustomerID>1</CustomerID>
  <CustomerName>sample string 6</CustomerName>
  <CustomerNumber>sample string 7</CustomerNumber>
  <Description>sample string 5</Description>
  <EndTime>sample string 2</EndTime>
  <Location>sample string 4</Location>
  <OwnerID>1</OwnerID>
  <StartTime>sample string 1</StartTime>
  <Subject>sample string 3</Subject>
</CUAppointmentDto>