Create Default Appointment Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Appointment/CreateDefaultAppointmentEntity");
var client = new RestClient(options);
var request = new RestRequest("");
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'POST'};

fetch('http://localhost:56350/api/v1/Agents/Appointment/CreateDefaultAppointmentEntity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Appointment/CreateDefaultAppointmentEntity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

const options = {method: 'POST'};

fetch('http://localhost:56350/api/v1/Agents/Appointment/CreateDefaultAppointmentEntity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Associate": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Contact": {
    "ContactId": 123,
    "Name": "<string>",
    "OrgNr": "<string>",
    "Department": "<string>",
    "URL": "<string>",
    "City": "<string>",
    "DirectPhone": "<string>",
    "AssociateId": 123,
    "CountryId": 123,
    "EmailAddress": "<string>",
    "Kananame": "<string>",
    "EmailAddressName": "<string>",
    "URLName": "<string>",
    "AssociateFullName": "<string>",
    "BusinessName": "<string>",
    "CategoryName": "<string>",
    "CountryName": "<string>",
    "Address": {
      "Wgs84Latitude": 123,
      "Wgs84Longitude": 123,
      "LocalizedAddress": [
        [
          {
            "Name": "<string>",
            "Value": "<string>",
            "Tooltip": "<string>",
            "Label": "<string>",
            "ValueLength": 123,
            "AddressType": "<string>",
            "TableRight": {
              "Mask": "<string>",
              "Reason": "<string>"
            },
            "FieldProperties": {}
          }
        ]
      ],
      "Street": {
        "AtypeIdx": "Unknown",
        "Address1": "<string>",
        "Address2": "<string>",
        "Address3": "<string>",
        "City": "<string>",
        "County": "<string>",
        "State": "<string>",
        "Zipcode": "<string>",
        "Formatted": "<string>"
      },
      "Postal": {
        "AtypeIdx": "Unknown",
        "Address1": "<string>",
        "Address2": "<string>",
        "Address3": "<string>",
        "City": "<string>",
        "County": "<string>",
        "State": "<string>",
        "Zipcode": "<string>",
        "Formatted": "<string>"
      },
      "Formatted": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    },
    "FormattedAddress": "<string>",
    "FullName": "<string>",
    "IsOwnerContact": true,
    "ActiveErpLinks": 123,
    "Number1": "<string>",
    "Number2": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "CreatedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "UpdatedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "CreatedDate": "2023-11-07T05:31:56Z",
  "AppointmentId": 123,
  "Description": "<string>",
  "Title": "<string>",
  "Agenda": "<string>",
  "InternalNotes": "<string>",
  "StartDate": "2023-11-07T05:31:56Z",
  "EndDate": "2023-11-07T05:31:56Z",
  "InvitedPerson": {
    "Position": "<string>",
    "PersonId": 123,
    "Mrmrs": "<string>",
    "Firstname": "<string>",
    "Lastname": "<string>",
    "MiddleName": "<string>",
    "Title": "<string>",
    "Description": "<string>",
    "Email": "<string>",
    "FullName": "<string>",
    "DirectPhone": "<string>",
    "FormalName": "<string>",
    "CountryId": 123,
    "ContactId": 123,
    "ContactName": "<string>",
    "Retired": 123,
    "Rank": 123,
    "ActiveInterests": 123,
    "ContactDepartment": "<string>",
    "ContactCountryId": 123,
    "ContactOrgNr": "<string>",
    "FaxPhone": "<string>",
    "MobilePhone": "<string>",
    "ContactPhone": "<string>",
    "AssociateName": "<string>",
    "AssociateId": 123,
    "UsePersonAddress": true,
    "ContactFax": "<string>",
    "Kanafname": "<string>",
    "Kanalname": "<string>",
    "Post1": "<string>",
    "Post2": "<string>",
    "Post3": "<string>",
    "EmailName": "<string>",
    "ContactFullName": "<string>",
    "ActiveErpLinks": 123,
    "TicketPriorityId": 123,
    "SupportLanguageId": 123,
    "SupportAssociateId": 123,
    "CategoryName": "<string>",
    "PersonNumber": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Person": {
    "Position": "<string>",
    "PersonId": 123,
    "Mrmrs": "<string>",
    "Firstname": "<string>",
    "Lastname": "<string>",
    "MiddleName": "<string>",
    "Title": "<string>",
    "Description": "<string>",
    "Email": "<string>",
    "FullName": "<string>",
    "DirectPhone": "<string>",
    "FormalName": "<string>",
    "CountryId": 123,
    "ContactId": 123,
    "ContactName": "<string>",
    "Retired": 123,
    "Rank": 123,
    "ActiveInterests": 123,
    "ContactDepartment": "<string>",
    "ContactCountryId": 123,
    "ContactOrgNr": "<string>",
    "FaxPhone": "<string>",
    "MobilePhone": "<string>",
    "ContactPhone": "<string>",
    "AssociateName": "<string>",
    "AssociateId": 123,
    "UsePersonAddress": true,
    "ContactFax": "<string>",
    "Kanafname": "<string>",
    "Kanalname": "<string>",
    "Post1": "<string>",
    "Post2": "<string>",
    "Post3": "<string>",
    "EmailName": "<string>",
    "ContactFullName": "<string>",
    "ActiveErpLinks": 123,
    "TicketPriorityId": 123,
    "SupportLanguageId": 123,
    "SupportAssociateId": 123,
    "CategoryName": "<string>",
    "PersonNumber": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "MotherId": 123,
  "Priority": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Private": "Public",
  "Project": {
    "ProjectId": 123,
    "Name": "<string>",
    "Description": "<string>",
    "URL": "<string>",
    "Type": "<string>",
    "AssociateId": 123,
    "AssociateFullName": "<string>",
    "TypeId": 123,
    "Updated": "2023-11-07T05:31:56Z",
    "StatusId": 123,
    "Status": "<string>",
    "TextId": 123,
    "PublishTo": "2023-11-07T05:31:56Z",
    "PublishFrom": "2023-11-07T05:31:56Z",
    "IsPublished": true,
    "URLName": "<string>",
    "ProjectNumber": "<string>",
    "ActiveErpLinks": 123,
    "EventId": 123,
    "StartDate": "2023-11-07T05:31:56Z",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Type": "Unknown",
  "UpdatedDate": "2023-11-07T05:31:56Z",
  "Completed": "Unknown",
  "ActiveLinks": 123,
  "Links": [
    {
      "EntityName": "<string>",
      "Id": 123,
      "Description": "<string>",
      "ExtraInfo": "<string>",
      "LinkId": 123,
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "AlarmLeadTime": "<string>",
  "HasAlarm": true,
  "ColorIndex": 123,
  "IsFree": true,
  "IsAlldayEvent": true,
  "LagTime": "<string>",
  "LeadTime": "<string>",
  "Location": "<string>",
  "RejectCounter": 123,
  "RejectReason": "<string>",
  "Recurrence": {
    "RecurrenceId": 123,
    "StartDate": "2023-11-07T05:31:56Z",
    "EndDate": "2023-11-07T05:31:56Z",
    "RecurrenceCounter": 123,
    "RecurrenceEndType": "Unknown",
    "Pattern": "Unknown",
    "DayPattern": {
      "Pattern": "Unknown",
      "Cycle": 123
    },
    "WeekPattern": {
      "Weekdays": "Unknown",
      "Cycle": 123
    },
    "MonthPattern": {
      "Pattern": "Unknown",
      "Cycle": 123,
      "Day": 123,
      "Weekday": "Unknown",
      "WeekOfMonth": "Unknown"
    },
    "YearPattern": {
      "Pattern": "Unknown",
      "Cycle": 123,
      "Day": 123,
      "Weekday": "Unknown",
      "WeekOfMonth": "Unknown"
    },
    "Dates": [
      {
        "Date": "2023-11-07T05:31:56Z",
        "IsConflict": true,
        "Description": "<string>",
        "DescriptionStyleHint": "<string>",
        "Tooltip": "<string>"
      }
    ],
    "IsRecurrence": true
  },
  "Participants": [
    {
      "AssociateId": 123,
      "PersonId": 123,
      "ContactId": 123,
      "EmailId": 123,
      "SendEmail": true,
      "InvitationStatus": "Unknown",
      "EmailAddress": "<string>",
      "Description": "<string>",
      "ExternallyOwnedType": "Unknown",
      "ExternallyOwnedStatus": "Unknown"
    }
  ],
  "AssignmentStatus": "Unknown",
  "InvitationStatus": "Unknown",
  "BookingType": "Unknown",
  "ActiveDate": "2023-11-07T05:31:56Z",
  "HasConflict": true,
  "AssignedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "MotherAssociate": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Task": {
    "TaskListItemId": 123,
    "Value": "<string>",
    "Direction": "Unknown",
    "Type": "Unknown",
    "Tooltip": "<string>",
    "Deleted": true,
    "IntentId": 123,
    "Rank": 123,
    "IsDefaultAlldayEvent": true,
    "IsDefaultFree": true,
    "IsDefaultPublished": true,
    "ColorIndex": "LightBlue",
    "DefaultVideomeetingStatus": "NoChange",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "PreferredTZLocation": 123,
  "PreferredTZLocationData": {
    "TZLocationID": 123,
    "Name": "<string>",
    "TZLocationCode": "<string>",
    "TZLocationCities": "<string>",
    "IsoNumber": 123,
    "TimeZoneSTDRules": {},
    "TimeZoneDSTRules": {}
  },
  "Sale": {
    "ContactName": "<string>",
    "SaleDate": "2023-11-07T05:31:56Z",
    "SaleId": 123,
    "Probability": 123,
    "Title": "<string>",
    "Amount": 123,
    "Currency": "<string>",
    "ProjectName": "<string>",
    "AssociateFullName": "<string>",
    "Description": "<string>",
    "Status": "Unknown",
    "WeightedAmount": 123,
    "ProjectId": 123,
    "EarningPercent": 123,
    "Earning": 123,
    "ContactId": 123,
    "AssociateId": 123,
    "PersonId": 123,
    "SaleTypeId": 123,
    "SaleTypeName": "<string>",
    "PersonFullName": "<string>",
    "Completed": "Unknown",
    "ActiveErpLinks": 123,
    "NextDueDate": "2023-11-07T05:31:56Z",
    "Number": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "SuggestedAppointmentId": 123,
  "IsMileStone": true,
  "CautionWarning": "OK",
  "OwnedExternally": "None",
  "JoinVideomeetUrl": "<string>",
  "CentralserviceVideomeetId": "<string>",
  "UserDefinedFields": {},
  "ExtraFields": {},
  "CustomFields": {},
  "PublishEventDate": "2023-11-07T05:31:56Z",
  "PublishTo": "2023-11-07T05:31:56Z",
  "PublishFrom": "2023-11-07T05:31:56Z",
  "IsPublished": true,
  "VisibleFor": [
    {
      "VisibleId": 123,
      "Visibility": "All",
      "DisplayValue": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Create Default Appointment Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Appointment/CreateDefaultAppointmentEntity");
var client = new RestClient(options);
var request = new RestRequest("");
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'POST'};

fetch('http://localhost:56350/api/v1/Agents/Appointment/CreateDefaultAppointmentEntity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Appointment/CreateDefaultAppointmentEntity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

const options = {method: 'POST'};

fetch('http://localhost:56350/api/v1/Agents/Appointment/CreateDefaultAppointmentEntity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Associate": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Contact": {
    "ContactId": 123,
    "Name": "<string>",
    "OrgNr": "<string>",
    "Department": "<string>",
    "URL": "<string>",
    "City": "<string>",
    "DirectPhone": "<string>",
    "AssociateId": 123,
    "CountryId": 123,
    "EmailAddress": "<string>",
    "Kananame": "<string>",
    "EmailAddressName": "<string>",
    "URLName": "<string>",
    "AssociateFullName": "<string>",
    "BusinessName": "<string>",
    "CategoryName": "<string>",
    "CountryName": "<string>",
    "Address": {
      "Wgs84Latitude": 123,
      "Wgs84Longitude": 123,
      "LocalizedAddress": [
        [
          {
            "Name": "<string>",
            "Value": "<string>",
            "Tooltip": "<string>",
            "Label": "<string>",
            "ValueLength": 123,
            "AddressType": "<string>",
            "TableRight": {
              "Mask": "<string>",
              "Reason": "<string>"
            },
            "FieldProperties": {}
          }
        ]
      ],
      "Street": {
        "AtypeIdx": "Unknown",
        "Address1": "<string>",
        "Address2": "<string>",
        "Address3": "<string>",
        "City": "<string>",
        "County": "<string>",
        "State": "<string>",
        "Zipcode": "<string>",
        "Formatted": "<string>"
      },
      "Postal": {
        "AtypeIdx": "Unknown",
        "Address1": "<string>",
        "Address2": "<string>",
        "Address3": "<string>",
        "City": "<string>",
        "County": "<string>",
        "State": "<string>",
        "Zipcode": "<string>",
        "Formatted": "<string>"
      },
      "Formatted": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    },
    "FormattedAddress": "<string>",
    "FullName": "<string>",
    "IsOwnerContact": true,
    "ActiveErpLinks": 123,
    "Number1": "<string>",
    "Number2": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "CreatedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "UpdatedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "CreatedDate": "2023-11-07T05:31:56Z",
  "AppointmentId": 123,
  "Description": "<string>",
  "Title": "<string>",
  "Agenda": "<string>",
  "InternalNotes": "<string>",
  "StartDate": "2023-11-07T05:31:56Z",
  "EndDate": "2023-11-07T05:31:56Z",
  "InvitedPerson": {
    "Position": "<string>",
    "PersonId": 123,
    "Mrmrs": "<string>",
    "Firstname": "<string>",
    "Lastname": "<string>",
    "MiddleName": "<string>",
    "Title": "<string>",
    "Description": "<string>",
    "Email": "<string>",
    "FullName": "<string>",
    "DirectPhone": "<string>",
    "FormalName": "<string>",
    "CountryId": 123,
    "ContactId": 123,
    "ContactName": "<string>",
    "Retired": 123,
    "Rank": 123,
    "ActiveInterests": 123,
    "ContactDepartment": "<string>",
    "ContactCountryId": 123,
    "ContactOrgNr": "<string>",
    "FaxPhone": "<string>",
    "MobilePhone": "<string>",
    "ContactPhone": "<string>",
    "AssociateName": "<string>",
    "AssociateId": 123,
    "UsePersonAddress": true,
    "ContactFax": "<string>",
    "Kanafname": "<string>",
    "Kanalname": "<string>",
    "Post1": "<string>",
    "Post2": "<string>",
    "Post3": "<string>",
    "EmailName": "<string>",
    "ContactFullName": "<string>",
    "ActiveErpLinks": 123,
    "TicketPriorityId": 123,
    "SupportLanguageId": 123,
    "SupportAssociateId": 123,
    "CategoryName": "<string>",
    "PersonNumber": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Person": {
    "Position": "<string>",
    "PersonId": 123,
    "Mrmrs": "<string>",
    "Firstname": "<string>",
    "Lastname": "<string>",
    "MiddleName": "<string>",
    "Title": "<string>",
    "Description": "<string>",
    "Email": "<string>",
    "FullName": "<string>",
    "DirectPhone": "<string>",
    "FormalName": "<string>",
    "CountryId": 123,
    "ContactId": 123,
    "ContactName": "<string>",
    "Retired": 123,
    "Rank": 123,
    "ActiveInterests": 123,
    "ContactDepartment": "<string>",
    "ContactCountryId": 123,
    "ContactOrgNr": "<string>",
    "FaxPhone": "<string>",
    "MobilePhone": "<string>",
    "ContactPhone": "<string>",
    "AssociateName": "<string>",
    "AssociateId": 123,
    "UsePersonAddress": true,
    "ContactFax": "<string>",
    "Kanafname": "<string>",
    "Kanalname": "<string>",
    "Post1": "<string>",
    "Post2": "<string>",
    "Post3": "<string>",
    "EmailName": "<string>",
    "ContactFullName": "<string>",
    "ActiveErpLinks": 123,
    "TicketPriorityId": 123,
    "SupportLanguageId": 123,
    "SupportAssociateId": 123,
    "CategoryName": "<string>",
    "PersonNumber": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "MotherId": 123,
  "Priority": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Private": "Public",
  "Project": {
    "ProjectId": 123,
    "Name": "<string>",
    "Description": "<string>",
    "URL": "<string>",
    "Type": "<string>",
    "AssociateId": 123,
    "AssociateFullName": "<string>",
    "TypeId": 123,
    "Updated": "2023-11-07T05:31:56Z",
    "StatusId": 123,
    "Status": "<string>",
    "TextId": 123,
    "PublishTo": "2023-11-07T05:31:56Z",
    "PublishFrom": "2023-11-07T05:31:56Z",
    "IsPublished": true,
    "URLName": "<string>",
    "ProjectNumber": "<string>",
    "ActiveErpLinks": 123,
    "EventId": 123,
    "StartDate": "2023-11-07T05:31:56Z",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Type": "Unknown",
  "UpdatedDate": "2023-11-07T05:31:56Z",
  "Completed": "Unknown",
  "ActiveLinks": 123,
  "Links": [
    {
      "EntityName": "<string>",
      "Id": 123,
      "Description": "<string>",
      "ExtraInfo": "<string>",
      "LinkId": 123,
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "AlarmLeadTime": "<string>",
  "HasAlarm": true,
  "ColorIndex": 123,
  "IsFree": true,
  "IsAlldayEvent": true,
  "LagTime": "<string>",
  "LeadTime": "<string>",
  "Location": "<string>",
  "RejectCounter": 123,
  "RejectReason": "<string>",
  "Recurrence": {
    "RecurrenceId": 123,
    "StartDate": "2023-11-07T05:31:56Z",
    "EndDate": "2023-11-07T05:31:56Z",
    "RecurrenceCounter": 123,
    "RecurrenceEndType": "Unknown",
    "Pattern": "Unknown",
    "DayPattern": {
      "Pattern": "Unknown",
      "Cycle": 123
    },
    "WeekPattern": {
      "Weekdays": "Unknown",
      "Cycle": 123
    },
    "MonthPattern": {
      "Pattern": "Unknown",
      "Cycle": 123,
      "Day": 123,
      "Weekday": "Unknown",
      "WeekOfMonth": "Unknown"
    },
    "YearPattern": {
      "Pattern": "Unknown",
      "Cycle": 123,
      "Day": 123,
      "Weekday": "Unknown",
      "WeekOfMonth": "Unknown"
    },
    "Dates": [
      {
        "Date": "2023-11-07T05:31:56Z",
        "IsConflict": true,
        "Description": "<string>",
        "DescriptionStyleHint": "<string>",
        "Tooltip": "<string>"
      }
    ],
    "IsRecurrence": true
  },
  "Participants": [
    {
      "AssociateId": 123,
      "PersonId": 123,
      "ContactId": 123,
      "EmailId": 123,
      "SendEmail": true,
      "InvitationStatus": "Unknown",
      "EmailAddress": "<string>",
      "Description": "<string>",
      "ExternallyOwnedType": "Unknown",
      "ExternallyOwnedStatus": "Unknown"
    }
  ],
  "AssignmentStatus": "Unknown",
  "InvitationStatus": "Unknown",
  "BookingType": "Unknown",
  "ActiveDate": "2023-11-07T05:31:56Z",
  "HasConflict": true,
  "AssignedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "MotherAssociate": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Task": {
    "TaskListItemId": 123,
    "Value": "<string>",
    "Direction": "Unknown",
    "Type": "Unknown",
    "Tooltip": "<string>",
    "Deleted": true,
    "IntentId": 123,
    "Rank": 123,
    "IsDefaultAlldayEvent": true,
    "IsDefaultFree": true,
    "IsDefaultPublished": true,
    "ColorIndex": "LightBlue",
    "DefaultVideomeetingStatus": "NoChange",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "PreferredTZLocation": 123,
  "PreferredTZLocationData": {
    "TZLocationID": 123,
    "Name": "<string>",
    "TZLocationCode": "<string>",
    "TZLocationCities": "<string>",
    "IsoNumber": 123,
    "TimeZoneSTDRules": {},
    "TimeZoneDSTRules": {}
  },
  "Sale": {
    "ContactName": "<string>",
    "SaleDate": "2023-11-07T05:31:56Z",
    "SaleId": 123,
    "Probability": 123,
    "Title": "<string>",
    "Amount": 123,
    "Currency": "<string>",
    "ProjectName": "<string>",
    "AssociateFullName": "<string>",
    "Description": "<string>",
    "Status": "Unknown",
    "WeightedAmount": 123,
    "ProjectId": 123,
    "EarningPercent": 123,
    "Earning": 123,
    "ContactId": 123,
    "AssociateId": 123,
    "PersonId": 123,
    "SaleTypeId": 123,
    "SaleTypeName": "<string>",
    "PersonFullName": "<string>",
    "Completed": "Unknown",
    "ActiveErpLinks": 123,
    "NextDueDate": "2023-11-07T05:31:56Z",
    "Number": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "SuggestedAppointmentId": 123,
  "IsMileStone": true,
  "CautionWarning": "OK",
  "OwnedExternally": "None",
  "JoinVideomeetUrl": "<string>",
  "CentralserviceVideomeetId": "<string>",
  "UserDefinedFields": {},
  "ExtraFields": {},
  "CustomFields": {},
  "PublishEventDate": "2023-11-07T05:31:56Z",
  "PublishTo": "2023-11-07T05:31:56Z",
  "PublishFrom": "2023-11-07T05:31:56Z",
  "IsPublished": true,
  "VisibleFor": [
    {
      "VisibleId": 123,
      "Visibility": "All",
      "DisplayValue": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response

Partial AppointmentEntity class associating the generated AppointmentEntity with an interface.

Associate

object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Show child attributes

Contact

object

Carrier object for Contact. Services for the Contact Carrier is available from the Contact Agent.

Show child attributes

CreatedBy

object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Show child attributes

UpdatedBy

object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Show child attributes

CreatedDate

string<date-time>

Registered date in UTC.

AppointmentId

integer<int32>

Primary key

Description

string

Description of the appointment.

Title

string

The title of the appointment.

Agenda

string

The agenda of the appointment.

InternalNotes

string

Internal notes for the appointment.

StartDate

string<date-time>

date + start time planned

EndDate

string<date-time>

Date + end time planned

InvitedPerson

object

Carrier object for Person. Services for the Person Carrier is available from the Person Agent.

Show child attributes

Person

object

Carrier object for Person. Services for the Person Carrier is available from the Person Agent.

Show child attributes

MotherId

integer<int32>

ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment. However, if 0 and assoc_id != reg_id then this is an assigned appointment, indicated vt type = kBooking

Priority

object

Carrier object for Priority. Services for the Priority Carrier is available from the List Agent.

Show child attributes

Private

enum<string>

The confidentiality of appointments is shown as different types of “private” on the appointment. For an updated list of “private” types, see the database manual.

Available options:

Public,

PrivateUser,

PrivateGroup

Project

object

Carrier object for Project. Services for the Project Carrier is available from the Project Agent.

Show child attributes

Type

enum<string>

The different types of appointment, if the appointment is supposed to be shown in the diary or checklist, or if it's a document. See the different types of appointments in the database manual.

Available options:

Unknown,

inDiary,

inChecklist,

Note,

Document,

SavedReport,

BookingForDiary,

BookingForChecklist,

MergeDraft,

MergeFinal

UpdatedDate

string<date-time>

Updated date in UTC.

Completed

enum<string>

Appointment Completed state. This property is the part of the Status property that is the completed state. Could be three state if the three state user preference is set.

Available options:

Unknown,

NotStarted,

Started,

Completed

ActiveLinks

integer<int32>

Number of active links to sale, document, appointment.

Links

object[]

List of all elements linked to the appointment.

Show child attributes

AlarmLeadTime

string

Alarm lead time.

HasAlarm

boolean

Does this appointment have an alarm

ColorIndex

integer<int32>

Appointment colour, used only in Japanese versions. Western versions take colour from Task

IsFree

boolean

True if free, false if busy

IsAlldayEvent

boolean

True if all day event

LagTime

string

as leadtime, but after the end - time blocked for travel etc.

LeadTime

string

Time blocked (minutes) BEFORE starttime

Location

string

Location for appointment, defaulted from invited resource of type place and other rules, but you can write anything you want here

RejectCounter

integer<int32>

How many invitees have rejected this appointment

RejectReason

string

Why was this booking or assignment rejected, the RejectReason list is a source of suggestions but you can write anything here Use MDO List name "rejectReason" to get list items.

Recurrence

object

Class representing the recurrence of an appointment booking

Show child attributes

Participants

object[]

List of id's of the participants to this appointment.

Show child attributes

AssignmentStatus

enum<string>

Status if this appointment is in the process of being assigned to someone else

Available options:

Unknown,

None,

Assigning,

Seen,

Declined

InvitationStatus

enum<string>

Status if this appointment represents an invitation

Available options:

Unknown,

None,

Accepted,

Hidden,

Invitation,

Moved,

Seen,

MovedSeen,

Declined,

Cancelled

BookingType

enum<string>

The type of booking the appointment represents

Available options:

Unknown,

None,

Owner,

Participant

ActiveDate

string<date-time>

The date to be used for searching & showing

HasConflict

boolean

Does the appointment overlap with another appointment in the user's diary?

AssignedBy

object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Show child attributes

MotherAssociate

object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Show child attributes

Task

object

Carrier object for TaskListItem. Services for the TaskListItem Carrier is available from the Appointment Agent.

Show child attributes

PreferredTZLocation

integer<int32>

Appointments preferred timezone location.

PreferredTZLocationData

object

Show child attributes

Sale

object

Carrier object for Sale. Services for the Sale Carrier is available from the Sale Agent.

Show child attributes

SuggestedAppointmentId

integer<int32>

Suggested guide item that this appointment is an instance of (Note: NOT VALID for document-type appointments, they have their own link)

IsMileStone

boolean

Is this appointment a milestone?

CautionWarning

enum<string>

Status field to indicate appointments that have some sort of problem

Available options:

OK,

NotInSync,

NotNotifiedByEmail,

RecurrencePatternNotSupported,

IncomingRecurrenceChangeNotSupported,

ExternalParticipantsDateTimeMismatch

OwnedExternally

enum<string>

Set if an external system owns this appointment.

Available options:

None,

Other,

Outlook,

Google

JoinVideomeetUrl

string

Blank when not a video meeting. Filled with Join Meeting URL when created.

CentralserviceVideomeetId

string

GUID for video meeting in central services – this is set when we create meetings from SuperOffice. It is blank for incoming meetings created from inbox.

UserDefinedFields

object

Deprecated: Use {SuperOffice.CRM.Services.AppointmentEntity.CustomFields} instead. Dictionary of user defined field data. The key string is the ProgId of the UdefField, or if the ProgId is empty it is a string of the format "SuperOffice:[UdefFieldIdentity]", e.g. "SuperOffice:1234"

Show child attributes

ExtraFields

object

Deprecated: Use {SuperOffice.CRM.Services.AppointmentEntity.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

Show child attributes

CustomFields

object

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual {SuperOffice.CRM.Services.AppointmentEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.

Show child attributes

PublishEventDate

string<date-time>

Publish event date

PublishTo

string<date-time>

Publication valid to (inclusive)

PublishFrom

string<date-time>

Publication valid from (inclusive)

IsPublished

boolean

Publication is published

VisibleFor

object[]

The set of users or groups the record is visible for

Show child attributes

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes