Trendsic Platform Service

<back to all web services

NoticeRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,POST,OPTIONS/v1/Notice/{NoticeId}
GET,OPTIONS/v1/Notice
GET,OPTIONS/v1/Notice/History/{DateAsOf}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Notice() = 
        member val NoticeId:Int32 = new Int32() with get,set
        member val BeginDate:DateTime = new DateTime() with get,set
        member val ExpireDate:DateTime = new DateTime() with get,set
        member val NoticeTitle:String = null with get,set
        member val NoticeDescription:String = null with get,set
        member val NoticeFullText:String = null with get,set
        member val OrderIndex:Int32 = new Int32() with get,set
        member val IsActive:Boolean = new Boolean() with get,set
        member val IsUrgent:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type NoticeResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Notice:ResizeArray<Notice> = new ResizeArray<Notice>() with get,set

    [<AllowNullLiteral>]
    type NoticeRequest() = 
        member val DateAsOf:DateTime = new DateTime() with get,set
        member val Notice:ResizeArray<Notice> = new ResizeArray<Notice>() with get,set

F# NoticeRequest DTOs

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

HTTP + CSV

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

POST /v1/Notice/{NoticeId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DateAsOf":"0001-01-01T00:00:00.0000000","Notice":[{"NoticeId":0,"BeginDate":"0001-01-01T00:00:00.0000000","ExpireDate":"0001-01-01T00:00:00.0000000","NoticeTitle":"String","NoticeDescription":"String","NoticeFullText":"String","OrderIndex":0,"IsActive":false,"IsUrgent":false}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Notice":[{"NoticeId":0,"BeginDate":"0001-01-01T00:00:00.0000000","ExpireDate":"0001-01-01T00:00:00.0000000","NoticeTitle":"String","NoticeDescription":"String","NoticeFullText":"String","OrderIndex":0,"IsActive":false,"IsUrgent":false}]}