Trendsic Platform Service

<back to all web services

BroadcastRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Broadcast/{BroadcastId}
GET,OPTIONS/v1/Broadcast
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 Broadcast() = 
        member val BroadcastId:Int32 = new Int32() with get,set
        member val BroadcastTitle:String = null with get,set
        member val BroadcastDescription:String = null with get,set
        member val BroadcastBegin:DateTime = new DateTime() with get,set
        member val BroadcastBeginTime:String = null with get,set
        member val BroadcastEnd:DateTime = new DateTime() with get,set
        member val BroadcastEndTime:String = null with get,set

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

    [<AllowNullLiteral>]
    type BroadcastRequest() = 
        member val Broadcast:ResizeArray<Broadcast> = new ResizeArray<Broadcast>() with get,set

F# BroadcastRequest 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.

GET /v1/Broadcast/{BroadcastId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Broadcast: 
	[
		{
			BroadcastId: 0,
			BroadcastTitle: String,
			BroadcastDescription: String,
			BroadcastBegin: 0001-01-01,
			BroadcastBeginTime: String,
			BroadcastEnd: 0001-01-01,
			BroadcastEndTime: String
		}
	]
}