Publish And Retrieve Ui Events

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/ViewState/PublishAndRetrieveUiEvents");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"LatestKnownEventId\": 123,\n  \"PublishEvents\": [\n    {\n      \"EventId\": 123,\n      \"EventName\": \"<string>\",\n      \"EntityType\": \"<string>\",\n      \"EntityKey\": 123,\n      \"AssociateId\": 123,\n      \"AssociateName\": \"<string>\",\n      \"EventDateTime\": \"2023-11-07T05:31:56Z\",\n      \"TableRight\": {\n        \"Mask\": \"<string>\",\n        \"Reason\": \"<string>\"\n      },\n      \"FieldProperties\": {}\n    }\n  ],\n  \"Metrics\": [\n    {\n      \"Name\": \"<string>\",\n      \"Value\": 123\n    }\n  ]\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({
    LatestKnownEventId: 123,
    PublishEvents: [
      {
        EventId: 123,
        EventName: '<string>',
        EntityType: '<string>',
        EntityKey: 123,
        AssociateId: 123,
        AssociateName: '<string>',
        EventDateTime: '2023-11-07T05:31:56Z',
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      }
    ],
    Metrics: [{Name: '<string>', Value: 123}]
  })
};

fetch('http://localhost:53294/api/v1/Agents/ViewState/PublishAndRetrieveUiEvents', 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/ViewState/PublishAndRetrieveUiEvents",
  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([
    'LatestKnownEventId' => 123,
    'PublishEvents' => [
        [
                'EventId' => 123,
                'EventName' => '<string>',
                'EntityType' => '<string>',
                'EntityKey' => 123,
                'AssociateId' => 123,
                'AssociateName' => '<string>',
                'EventDateTime' => '2023-11-07T05:31:56Z',
                'TableRight' => [
                                'Mask' => '<string>',
                                'Reason' => '<string>'
                ],
                'FieldProperties' => [
                                
                ]
        ]
    ],
    'Metrics' => [
        [
                'Name' => '<string>',
                'Value' => 123
        ]
    ]
  ]),
  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/ViewState/PublishAndRetrieveUiEvents"

payload = {
    "LatestKnownEventId": 123,
    "PublishEvents": [
        {
            "EventId": 123,
            "EventName": "<string>",
            "EntityType": "<string>",
            "EntityKey": 123,
            "AssociateId": 123,
            "AssociateName": "<string>",
            "EventDateTime": "2023-11-07T05:31:56Z",
            "TableRight": {
                "Mask": "<string>",
                "Reason": "<string>"
            },
            "FieldProperties": {}
        }
    ],
    "Metrics": [
        {
            "Name": "<string>",
            "Value": 123
        }
    ]
}
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({
    LatestKnownEventId: 123,
    PublishEvents: [
      {
        EventId: 123,
        EventName: '<string>',
        EntityType: '<string>',
        EntityKey: 123,
        AssociateId: 123,
        AssociateName: '<string>',
        EventDateTime: '2023-11-07T05:31:56Z',
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      }
    ],
    Metrics: [{Name: '<string>', Value: 123}]
  })
};

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

[
  {
    "EventId": 123,
    "EventName": "<string>",
    "EntityType": "<string>",
    "EntityKey": 123,
    "AssociateId": 123,
    "AssociateName": "<string>",
    "EventDateTime": "2023-11-07T05:31:56Z",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  }
]

Publish And Retrieve Ui Events

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/ViewState/PublishAndRetrieveUiEvents");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"LatestKnownEventId\": 123,\n  \"PublishEvents\": [\n    {\n      \"EventId\": 123,\n      \"EventName\": \"<string>\",\n      \"EntityType\": \"<string>\",\n      \"EntityKey\": 123,\n      \"AssociateId\": 123,\n      \"AssociateName\": \"<string>\",\n      \"EventDateTime\": \"2023-11-07T05:31:56Z\",\n      \"TableRight\": {\n        \"Mask\": \"<string>\",\n        \"Reason\": \"<string>\"\n      },\n      \"FieldProperties\": {}\n    }\n  ],\n  \"Metrics\": [\n    {\n      \"Name\": \"<string>\",\n      \"Value\": 123\n    }\n  ]\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({
    LatestKnownEventId: 123,
    PublishEvents: [
      {
        EventId: 123,
        EventName: '<string>',
        EntityType: '<string>',
        EntityKey: 123,
        AssociateId: 123,
        AssociateName: '<string>',
        EventDateTime: '2023-11-07T05:31:56Z',
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      }
    ],
    Metrics: [{Name: '<string>', Value: 123}]
  })
};

fetch('http://localhost:53294/api/v1/Agents/ViewState/PublishAndRetrieveUiEvents', 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/ViewState/PublishAndRetrieveUiEvents",
  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([
    'LatestKnownEventId' => 123,
    'PublishEvents' => [
        [
                'EventId' => 123,
                'EventName' => '<string>',
                'EntityType' => '<string>',
                'EntityKey' => 123,
                'AssociateId' => 123,
                'AssociateName' => '<string>',
                'EventDateTime' => '2023-11-07T05:31:56Z',
                'TableRight' => [
                                'Mask' => '<string>',
                                'Reason' => '<string>'
                ],
                'FieldProperties' => [
                                
                ]
        ]
    ],
    'Metrics' => [
        [
                'Name' => '<string>',
                'Value' => 123
        ]
    ]
  ]),
  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/ViewState/PublishAndRetrieveUiEvents"

payload = {
    "LatestKnownEventId": 123,
    "PublishEvents": [
        {
            "EventId": 123,
            "EventName": "<string>",
            "EntityType": "<string>",
            "EntityKey": 123,
            "AssociateId": 123,
            "AssociateName": "<string>",
            "EventDateTime": "2023-11-07T05:31:56Z",
            "TableRight": {
                "Mask": "<string>",
                "Reason": "<string>"
            },
            "FieldProperties": {}
        }
    ],
    "Metrics": [
        {
            "Name": "<string>",
            "Value": 123
        }
    ]
}
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({
    LatestKnownEventId: 123,
    PublishEvents: [
      {
        EventId: 123,
        EventName: '<string>',
        EntityType: '<string>',
        EntityKey: 123,
        AssociateId: 123,
        AssociateName: '<string>',
        EventDateTime: '2023-11-07T05:31:56Z',
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      }
    ],
    Metrics: [{Name: '<string>', Value: 123}]
  })
};

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

[
  {
    "EventId": 123,
    "EventName": "<string>",
    "EntityType": "<string>",
    "EntityKey": 123,
    "AssociateId": 123,
    "AssociateName": "<string>",
    "EventDateTime": "2023-11-07T05:31:56Z",
    "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

LatestKnownEventId, PublishEvents, Metrics

PublishAndRetrieveUiEvents: Publish zero or more events, and return any new events since the given event id. The initial implementation is in-memory only; applies solely to the front-end web server; and anything older than 20 minutes is discarded

LatestKnownEventId

integer<int32>

PublishEvents

object[]

Show child attributes

Metrics

object[]

Show child attributes

Response

EventId

integer<int32>

Id of event, increasing in chronological order, assigned by server

EventName

string

Name of event, for instance 'change' or 'edit'

EntityType

string

Name of entity, for instance 'ticket'

EntityKey

integer<int32>

Primary key of entity the event concerns

AssociateId

integer<int32>

The ID of the associate causing the event

AssociateName

string

The full person name of the associate causing the event

EventDateTime

string<date-time>

When did the event happen

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