POST Agents/EMail/CreateDefaultEMailAppointment

• 2 minutes to read
 • 2 minutes to read 
POST /api/v1/Agents/EMail/CreateDefaultEMailAppointment

Set default values into a new EMailAppointment.

NetServer calculates default values on the entity, which is required when creating/storing a new instance

Online Restricted: ## The EMail agent is not available in Online by default. Access must be requested specifically when app is registered.

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

OK

Response Description
200 OK

Response body: EMailAppointment

Property Name Type Description
Appointment Appointment Appointment information
CalMethod string Method field stored in ICS file.
Participants array List of participants in the iCal file - first one being the organizer
Comment string Comment attached to the calendar event (accept / reject reason etc.)
Sequence int32 Sequence number in ICS file.
DtStart date-time Start date/time in ICS file.
DtEnd date-time End date/time in ICS file.
Superseded bool A newer invitation exists
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/EMail/CreateDefaultEMailAppointment
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "Appointment": null,
  "CalMethod": "Add",
  "Participants": [
    "similique",
    "iusto"
  ],
  "Comment": "occaecati",
  "Sequence": 641,
  "DtStart": "2004-12-23T17:54:03.0858331+01:00",
  "DtEnd": "2022-05-06T17:54:03.0858331+02:00",
  "Superseded": true,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 466
    }
  }
}