Trendsic Platform Service

<back to all web services

PolicyDocumentReminderRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/PolicyDocumentReminder/{PolicyDocumentId}
DELETE,OPTIONS/v1/PolicyDocumentReminder/{Id}
POST,PUT,OPTIONS/v1/PolicyDocumentReminder/
import Foundation
import ServiceStack

public class PolicyDocumentReminderRequest : Codable
{
    public var id:Int
    public var policyDocumentId:Int
    public var reminder:PolicyDocumentReminder

    required public init(){}
}

public class PolicyDocumentReminder : Codable
{
    public var id:Int
    public var policyDocumentId:Int
    public var reminderFor:String
    public var reminderLeadTime:Int
    public var reminderMessage:String
    public var adminAgentId:Int
    public var needsPrompt:Bool

    required public init(){}
}

public class PolicyDocumentReminderResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var policyDocumentReminder:[PolicyDocumentReminder] = []

    required public init(){}
}


Swift PolicyDocumentReminderRequest 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.

POST /v1/PolicyDocumentReminder/ HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	PolicyDocumentId: 0,
	Reminder: 
	{
		Id: 0,
		PolicyDocumentId: 0,
		ReminderFor: String,
		ReminderLeadTime: 0,
		ReminderMessage: String,
		AdminAgentId: 0,
		NeedsPrompt: False
	}
}
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
		}
	},
	PolicyDocumentReminder: 
	[
		{
			Id: 0,
			PolicyDocumentId: 0,
			ReminderFor: String,
			ReminderLeadTime: 0,
			ReminderMessage: String,
			AdminAgentId: 0,
			NeedsPrompt: False
		}
	]
}