Get My Sync Appointments

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/Appointment/GetMySyncAppointments");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"StartTime\": \"2023-11-07T05:31:56Z\",\n  \"EndTime\": \"2023-11-07T05:31:56Z\"\n}", false);
var response = await client.PostAsync(request);

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

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({StartTime: '2023-11-07T05:31:56Z', EndTime: '2023-11-07T05:31:56Z'})
};

fetch('http://localhost:53294/api/v1/Agents/Appointment/GetMySyncAppointments', 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 => "53294",
  CURLOPT_URL => "http://localhost:53294/api/v1/Agents/Appointment/GetMySyncAppointments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'StartTime' => '2023-11-07T05:31:56Z',
    'EndTime' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

import requests

url = "http://localhost:53294/api/v1/Agents/Appointment/GetMySyncAppointments"

payload = {
    "StartTime": "2023-11-07T05:31:56Z",
    "EndTime": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({StartTime: '2023-11-07T05:31:56Z', EndTime: '2023-11-07T05:31:56Z'})
};

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

[
  {
    "AlarmTime": "2023-11-07T05:31:56Z",
    "AppointmentId": 123,
    "AppointmentText": "<string>",
    "ContactDepartment": "<string>",
    "ContactFullName": "<string>",
    "ContactName": "<string>",
    "ContactId": 123,
    "EndDate": "2023-11-07T05:31:56Z",
    "HasAlarm": true,
    "IsAllDay": true,
    "IsAssignment": true,
    "IsBusy": true,
    "IsCompleted": true,
    "IsInvitation": true,
    "IsTentative": true,
    "Location": "<string>",
    "Participants": [
      {
        "PersonId": 123,
        "PersonFirstName": "<string>",
        "PersonMiddleName": "<string>",
        "PersonLastname": "<string>",
        "PersonMrmrs": "<string>",
        "PersonTitle": "<string>",
        "PersonPosition": "<string>",
        "PersonAcademicTitle": "<string>",
        "PersonFormalName": "<string>",
        "PersonFullName": "<string>",
        "ContactId": 123,
        "ContactName": "<string>",
        "ContactDepartment": "<string>",
        "ContactBusiness": "<string>",
        "ContactCountry": "<string>",
        "ContactCategory": "<string>",
        "ContactFullName": "<string>",
        "EMail": [
          "<string>"
        ],
        "PhonePrivate": [
          "<string>"
        ],
        "PhoneFax": [
          "<string>"
        ],
        "PhoneMobile": [
          "<string>"
        ],
        "PhoneDirect": [
          "<string>"
        ],
        "PhoneContact": [
          "<string>"
        ],
        "Messenger": [
          "<string>"
        ],
        "Voip": [
          "<string>"
        ],
        "ContactUrl": [
          "<string>"
        ],
        "Url": [
          "<string>"
        ],
        "StreetAddress": {
          "AddressId": 123,
          "AddressType": "Unknown",
          "Address1": "<string>",
          "Address2": "<string>",
          "Address3": "<string>",
          "City": "<string>",
          "County": "<string>",
          "ZipCode": "<string>",
          "State": "<string>",
          "Latitude": 123,
          "Longitude": 123,
          "FormattedAddress": "<string>",
          "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
          },
          "FieldProperties": {}
        },
        "PostalAddress": {
          "AddressId": 123,
          "AddressType": "Unknown",
          "Address1": "<string>",
          "Address2": "<string>",
          "Address3": "<string>",
          "City": "<string>",
          "County": "<string>",
          "ZipCode": "<string>",
          "State": "<string>",
          "Latitude": 123,
          "Longitude": 123,
          "FormattedAddress": "<string>",
          "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
          },
          "FieldProperties": {}
        },
        "Country": "<string>",
        "PersonAddress": {
          "AddressId": 123,
          "AddressType": "Unknown",
          "Address1": "<string>",
          "Address2": "<string>",
          "Address3": "<string>",
          "City": "<string>",
          "County": "<string>",
          "ZipCode": "<string>",
          "State": "<string>",
          "Latitude": 123,
          "Longitude": 123,
          "FormattedAddress": "<string>",
          "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
          },
          "FieldProperties": {}
        },
        "PersonCountry": "<string>",
        "ParticipantStatus": "UnknownOrPostIt",
        "TableRight": {
          "Mask": "<string>",
          "Reason": "<string>"
        },
        "FieldProperties": {}
      }
    ],
    "PersonFormalName": "<string>",
    "PersonFullName": "<string>",
    "PersonId": 123,
    "ProjectId": 123,
    "ProjectName": "<string>",
    "SaleId": 123,
    "SaleName": "<string>",
    "StartDate": "2023-11-07T05:31:56Z",
    "TaskName": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  }
]

Get My Sync Appointments

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/Appointment/GetMySyncAppointments");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"StartTime\": \"2023-11-07T05:31:56Z\",\n  \"EndTime\": \"2023-11-07T05:31:56Z\"\n}", false);
var response = await client.PostAsync(request);

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

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({StartTime: '2023-11-07T05:31:56Z', EndTime: '2023-11-07T05:31:56Z'})
};

fetch('http://localhost:53294/api/v1/Agents/Appointment/GetMySyncAppointments', 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 => "53294",
  CURLOPT_URL => "http://localhost:53294/api/v1/Agents/Appointment/GetMySyncAppointments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'StartTime' => '2023-11-07T05:31:56Z',
    'EndTime' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

import requests

url = "http://localhost:53294/api/v1/Agents/Appointment/GetMySyncAppointments"

payload = {
    "StartTime": "2023-11-07T05:31:56Z",
    "EndTime": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({StartTime: '2023-11-07T05:31:56Z', EndTime: '2023-11-07T05:31:56Z'})
};

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

[
  {
    "AlarmTime": "2023-11-07T05:31:56Z",
    "AppointmentId": 123,
    "AppointmentText": "<string>",
    "ContactDepartment": "<string>",
    "ContactFullName": "<string>",
    "ContactName": "<string>",
    "ContactId": 123,
    "EndDate": "2023-11-07T05:31:56Z",
    "HasAlarm": true,
    "IsAllDay": true,
    "IsAssignment": true,
    "IsBusy": true,
    "IsCompleted": true,
    "IsInvitation": true,
    "IsTentative": true,
    "Location": "<string>",
    "Participants": [
      {
        "PersonId": 123,
        "PersonFirstName": "<string>",
        "PersonMiddleName": "<string>",
        "PersonLastname": "<string>",
        "PersonMrmrs": "<string>",
        "PersonTitle": "<string>",
        "PersonPosition": "<string>",
        "PersonAcademicTitle": "<string>",
        "PersonFormalName": "<string>",
        "PersonFullName": "<string>",
        "ContactId": 123,
        "ContactName": "<string>",
        "ContactDepartment": "<string>",
        "ContactBusiness": "<string>",
        "ContactCountry": "<string>",
        "ContactCategory": "<string>",
        "ContactFullName": "<string>",
        "EMail": [
          "<string>"
        ],
        "PhonePrivate": [
          "<string>"
        ],
        "PhoneFax": [
          "<string>"
        ],
        "PhoneMobile": [
          "<string>"
        ],
        "PhoneDirect": [
          "<string>"
        ],
        "PhoneContact": [
          "<string>"
        ],
        "Messenger": [
          "<string>"
        ],
        "Voip": [
          "<string>"
        ],
        "ContactUrl": [
          "<string>"
        ],
        "Url": [
          "<string>"
        ],
        "StreetAddress": {
          "AddressId": 123,
          "AddressType": "Unknown",
          "Address1": "<string>",
          "Address2": "<string>",
          "Address3": "<string>",
          "City": "<string>",
          "County": "<string>",
          "ZipCode": "<string>",
          "State": "<string>",
          "Latitude": 123,
          "Longitude": 123,
          "FormattedAddress": "<string>",
          "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
          },
          "FieldProperties": {}
        },
        "PostalAddress": {
          "AddressId": 123,
          "AddressType": "Unknown",
          "Address1": "<string>",
          "Address2": "<string>",
          "Address3": "<string>",
          "City": "<string>",
          "County": "<string>",
          "ZipCode": "<string>",
          "State": "<string>",
          "Latitude": 123,
          "Longitude": 123,
          "FormattedAddress": "<string>",
          "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
          },
          "FieldProperties": {}
        },
        "Country": "<string>",
        "PersonAddress": {
          "AddressId": 123,
          "AddressType": "Unknown",
          "Address1": "<string>",
          "Address2": "<string>",
          "Address3": "<string>",
          "City": "<string>",
          "County": "<string>",
          "ZipCode": "<string>",
          "State": "<string>",
          "Latitude": 123,
          "Longitude": 123,
          "FormattedAddress": "<string>",
          "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
          },
          "FieldProperties": {}
        },
        "PersonCountry": "<string>",
        "ParticipantStatus": "UnknownOrPostIt",
        "TableRight": {
          "Mask": "<string>",
          "Reason": "<string>"
        },
        "FieldProperties": {}
      }
    ],
    "PersonFormalName": "<string>",
    "PersonFullName": "<string>",
    "PersonId": 123,
    "ProjectId": 123,
    "ProjectName": "<string>",
    "SaleId": 123,
    "SaleName": "<string>",
    "StartDate": "2023-11-07T05:31:56Z",
    "TaskName": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  }
]

Authorizations

Authorization

string

header

required

SuperOffice username:password are passed in Base64-encoded.

You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.

Authorization

string

header

required

SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/

passing in the application id and redirect URL.

SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)

https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f

You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.

FlowImplicit

Authorization URL: https://online.superoffice.com/login/common/oauth/authorize

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.

Query Parameters

$select

string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

StartTime, EndTime

GetMySyncAppointments: Method that returns a specified number of appointments within a time range. The appointments belong to the currently logged on user.

StartTime

string<date-time>

EndTime

string<date-time>

Response

AlarmTime

string<date-time>

Date and time at which to show alarm

AppointmentId

integer<int32>

Primary key

AppointmentText

string

The appointment's textbox; holds a descriptive text about the appointment. Filled out by the user.

ContactDepartment

string

The department of the contact connected to the appointment

ContactFullName

string

The entire name of the contact, including department name

ContactName

string

The contact associated with the appointment.

ContactId

integer<int32>

The contacts identifier

EndDate

string<date-time>

Date + end time planned

HasAlarm

boolean

Does this appointment have an alarm

IsAllDay

boolean

IsAssignment

boolean

IsBusy

boolean

IsCompleted

boolean

IsInvitation

boolean

IsTentative

boolean

Location

string

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

Participants

object[]

Show child attributes

PersonFormalName

string

PersonFullName

string

The full name of the person this appointment belongs to.

PersonId

integer<int32>

Person ID of person the appointment is with, may be 0

ProjectId

integer<int32>

ID of project referred to, may be 0

ProjectName

string

Project name

SaleId

integer<int32>

Owning sale, if any (may be 0)

SaleName

string

Sale heading (short description?)

StartDate

string<date-time>

date + start time planned

TaskName

string

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