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}
NoticeAgreementRequest Parameters:
NameParameterData TypeRequiredDescription
AgentIdpathintNo
StatuspathstringNo
NoticeAgreementResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AgentAgreementformNoticeAgreementNo
NoticeAgreement Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
AgentIdformintNo
AgentNameformstringNo
StatusformstringNo
SignedDateformDateTimeNo
FirstViewedformDateTimeNo
SnoozedDateformDateTimeNo

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 /v1/noticeAgreement/{AgentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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