Get News Items For User

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/NewsFeed/GetNewsItemsForUser");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"AssociateId\": 123,\n  \"FromDate\": \"2023-11-07T05:31:56Z\",\n  \"ToDate\": \"2023-11-07T05:31:56Z\",\n  \"Top\": 123,\n  \"Skip\": 123\n}", false);
var response = await client.PostAsync(request);

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

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    AssociateId: 123,
    FromDate: '2023-11-07T05:31:56Z',
    ToDate: '2023-11-07T05:31:56Z',
    Top: 123,
    Skip: 123
  })
};

fetch('http://localhost:56350/api/v1/Agents/NewsFeed/GetNewsItemsForUser', 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/NewsFeed/GetNewsItemsForUser",
  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([
    'AssociateId' => 123,
    'FromDate' => '2023-11-07T05:31:56Z',
    'ToDate' => '2023-11-07T05:31:56Z',
    'Top' => 123,
    'Skip' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "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:56350/api/v1/Agents/NewsFeed/GetNewsItemsForUser"

payload = {
    "AssociateId": 123,
    "FromDate": "2023-11-07T05:31:56Z",
    "ToDate": "2023-11-07T05:31:56Z",
    "Top": 123,
    "Skip": 123
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    AssociateId: 123,
    FromDate: '2023-11-07T05:31:56Z',
    ToDate: '2023-11-07T05:31:56Z',
    Top: 123,
    Skip: 123
  })
};

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

[
  {
    "NewsFeedItemId": 123,
    "Title": "<string>",
    "Summary": "<string>",
    "Description": {},
    "Actions": [
      {
        "Identifier": "<string>",
        "Title": "<string>",
        "CtaType": "Unknown",
        "CtaFlavor": "Normal"
      }
    ],
    "ImageLink": "<string>",
    "SourceLink": "<string>",
    "PreviewHint": "<string>",
    "FromName": "<string>",
    "FromCategoryName": "<string>",
    "Priority": "NoPriority",
    "Registered": "2023-11-07T05:31:56Z",
    "Updated": "2023-11-07T05:31:56Z",
    "ExpiresAt": "2023-11-07T05:31:56Z",
    "Status": "Normal",
    "IsRead": true,
    "ReadAt": "2023-11-07T05:31:56Z",
    "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": {}
    },
    "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": {}
    },
    "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": {}
    },
    "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": {}
    },
    "ApplicationId": "<string>",
    "Location": "<string>",
    "RatingPercent": 123
  }
]

Get News Items For User

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/NewsFeed/GetNewsItemsForUser");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"AssociateId\": 123,\n  \"FromDate\": \"2023-11-07T05:31:56Z\",\n  \"ToDate\": \"2023-11-07T05:31:56Z\",\n  \"Top\": 123,\n  \"Skip\": 123\n}", false);
var response = await client.PostAsync(request);

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

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    AssociateId: 123,
    FromDate: '2023-11-07T05:31:56Z',
    ToDate: '2023-11-07T05:31:56Z',
    Top: 123,
    Skip: 123
  })
};

fetch('http://localhost:56350/api/v1/Agents/NewsFeed/GetNewsItemsForUser', 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/NewsFeed/GetNewsItemsForUser",
  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([
    'AssociateId' => 123,
    'FromDate' => '2023-11-07T05:31:56Z',
    'ToDate' => '2023-11-07T05:31:56Z',
    'Top' => 123,
    'Skip' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "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:56350/api/v1/Agents/NewsFeed/GetNewsItemsForUser"

payload = {
    "AssociateId": 123,
    "FromDate": "2023-11-07T05:31:56Z",
    "ToDate": "2023-11-07T05:31:56Z",
    "Top": 123,
    "Skip": 123
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    AssociateId: 123,
    FromDate: '2023-11-07T05:31:56Z',
    ToDate: '2023-11-07T05:31:56Z',
    Top: 123,
    Skip: 123
  })
};

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

[
  {
    "NewsFeedItemId": 123,
    "Title": "<string>",
    "Summary": "<string>",
    "Description": {},
    "Actions": [
      {
        "Identifier": "<string>",
        "Title": "<string>",
        "CtaType": "Unknown",
        "CtaFlavor": "Normal"
      }
    ],
    "ImageLink": "<string>",
    "SourceLink": "<string>",
    "PreviewHint": "<string>",
    "FromName": "<string>",
    "FromCategoryName": "<string>",
    "Priority": "NoPriority",
    "Registered": "2023-11-07T05:31:56Z",
    "Updated": "2023-11-07T05:31:56Z",
    "ExpiresAt": "2023-11-07T05:31:56Z",
    "Status": "Normal",
    "IsRead": true,
    "ReadAt": "2023-11-07T05:31:56Z",
    "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": {}
    },
    "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": {}
    },
    "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": {}
    },
    "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": {}
    },
    "ApplicationId": "<string>",
    "Location": "<string>",
    "RatingPercent": 123
  }
]

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

AssociateId, FromDate, ToDate, Top, Skip

GetNewsItemsForUser: Get a list of newsfeed items for a particular user between two dates. If the current user cannot access a particular item, it will be excluded from the results.

AssociateId

integer<int32>

FromDate

string<date-time>

ToDate

string<date-time>

Top

integer<int32>

Skip

integer<int32>

Response

NewsFeedItemId

integer<int32>

Primary key

Title

string

Short, descriptive headline. Plain text title. Multi-language string supported: 'US:"english";NO:"norsk"'.

Summary

string

Short, descriptive summary. Plain text summary. Multi-language string supported: 'US:"english";NO:"norsk"'.

Description

object

Multi-language descriptions for the news feed item, where the key is an ISO 2 letter language code (e.g. 'en', 'no', 'de') and the value is the description in that language. Styling via pre-defined CSS classes. No SCRIPT or STYLE tags allowed. The 'current' value is set based on the Accept-Language/SO-Language header.

Show child attributes

Actions

object[]

Call to action items for the news feed item. Each item contains a title, an identifier, a type and flavor.

Show child attributes

ImageLink

string

URL Link to an image associated with the news item.

SourceLink

string

URL Link to the source of the news item, or an SOProtocol link to a SuperOffice item

PreviewHint

string

Preview hint for the news item. e.g. {contact_id=123}

FromName

string

Name of the instance that published this item. e.g. Pete the prospector

FromCategoryName

string

Type of the instance that published this item. e.g. Prospector Agent

Priority

enum<string>

Importance of the news item. Low to High. Higher priority items may be shown more prominently in the feed.

Available options:

NoPriority,

Highest,

High,

Normal,

Low,

Lowest

Registered

string<date-time>

Registered when in UTC.

Updated

string<date-time>

Last updated when in UTC.

ExpiresAt

string<date-time>

When the news item expires and should no longer be shown in feeds (UTC) in UTC.

Status

enum<string>

Indicates if the item is being handled by a CTA. (normal, processing, processed)

Available options:

Normal,

Handling,

Handled

IsRead

boolean

Set to true when the recipient user has read the news feed item.

ReadAt

string<date-time>

When the recipient user read the news feed item (UTC) in UTC.

Contact

object

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

Show child attributes

Person

object

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

Show child attributes

Project

object

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

Show child attributes

Sale

object

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

Show child attributes

ApplicationId

string

The id of the application that registered this news item. Used to resolve where any CTA should be posted when clicked.

Location

string

Place related to news item (city or city + country) (optional)

RatingPercent

integer<int32>

Rating as percentage (0-100). 0 = undefined. 1-9 = No stars, 10-30 = One star, Two stars = 31-50, 90-100 = Five stars. Client can render rating as stars, pie chart, thumbs up or down, however they want. Default 0 indicates no rating.