Field Squared API Services

<back to all web services

PortalNews

The following routes are available for this service:
GET/{Workspace}/CustomerPortal/News
GET, PUT, POST, DELETE/{Workspace}/PortalNews
GET, PUT, POST, DELETE/{Workspace}/PortalNews/{ObjectId}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PortalNews:
    object_id: Optional[str] = None
    workspace: Optional[str] = None
    content: Optional[str] = None
    title: Optional[str] = None
    created_by: Optional[str] = None
    post_date: Optional[str] = None
    teams: Optional[List[str]] = None
    enabled: Optional[bool] = None
    image_url: Optional[str] = None

Python PortalNews DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Workspace}/PortalNews HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ObjectId: String,
	Workspace: String,
	Content: String,
	Title: String,
	CreatedBy: String,
	PostDate: String,
	Teams: 
	[
		String
	],
	Enabled: False,
	ImageUrl: String
}