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}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class Notice
            Public Overridable Property NoticeId As Integer
            Public Overridable Property BeginDate As Date
            Public Overridable Property ExpireDate As Date
            Public Overridable Property NoticeTitle As String
            Public Overridable Property NoticeDescription As String
            Public Overridable Property NoticeFullText As String
            Public Overridable Property OrderIndex As Integer
            Public Overridable Property IsActive As Boolean
            Public Overridable Property IsUrgent As Boolean
        End Class

        Public Partial Class NoticeRequest
            Public Overridable Property DateAsOf As Date
            Public Overridable Property Notice As List(Of Notice) = New List(Of Notice)
        End Class

        Public Partial Class NoticeResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Notice As List(Of Notice) = New List(Of Notice)
        End Class
    End Namespace
End Namespace

VB.NET NoticeRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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}]}