Trendsic Platform Service

<back to all web services

NoticeAgreementRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,OPTIONS/v1/noticeAgreement/{AgentId}
PUT,OPTIONS/v1/noticeAgreement/{AgentId}/{Status}
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 NoticeAgreement() = 
        member val Id:Int32 = new Int32() with get,set
        member val AgentId:Int32 = new Int32() with get,set
        member val AgentName:String = null with get,set
        member val Status:String = null with get,set
        member val SignedDate:DateTime = new DateTime() with get,set
        member val FirstViewed:DateTime = new DateTime() with get,set
        member val SnoozedDate:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type NoticeAgreementResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val AgentAgreement:NoticeAgreement = null with get,set

    [<AllowNullLiteral>]
    type NoticeAgreementRequest() = 
        member val AgentId:Int32 = new Int32() with get,set
        member val Status:String = null with get,set

F# NoticeAgreementRequest 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/noticeAgreement/{AgentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"AgentId":0,"Status":"String"}
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"}},"AgentAgreement":{"Id":0,"AgentId":0,"AgentName":"String","Status":"String","SignedDate":"0001-01-01T00:00:00.0000000","FirstViewed":"0001-01-01T00:00:00.0000000","SnoozedDate":"0001-01-01T00:00:00.0000000"}}