Trendsic Platform Service

PolicyRequiredDocumentRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator

The following routes are available for this service:
PUT,DELETE,OPTIONS	/v1/PolicyRequiredDocument/{Id}
POST,OPTIONS	/v1/PolicyRequiredDocument
GET	/v1/PolicyRequiredDocument/GetAllByPolicyAssociateId/{PolicyAssociateId}

import Foundation
import ServiceStack

public class PolicyRequiredDocumentRequest : Codable
{
    public var policyRequiredDocument:PolicyRequiredDocumentExtended
    public var policyAssociateId:String?
    public var id:Int?

    required public init(){}
}

public class PolicyRequiredDocumentExtended : PolicyRequiredDocument
{
    public var reminders:[PolicyDocumentReminder] = []
    public var agentReminders:[ReminderExtended] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case reminders
        case agentReminders
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        reminders = try container.decodeIfPresent([PolicyDocumentReminder].self, forKey: .reminders) ?? []
        agentReminders = try container.decodeIfPresent([ReminderExtended].self, forKey: .agentReminders) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if reminders.count > 0 { try container.encode(reminders, forKey: .reminders) }
        if agentReminders.count > 0 { try container.encode(agentReminders, forKey: .agentReminders) }
    }
}

public class PolicyRequiredDocument : Codable
{
    public var id:Int
    public var policyAssociateId:String
    public var policyDocumentId:Int
    public var nbcStatusId:Int
    public var agentStatusId:Int
    public var statusOptions:[PolicyDocumentStatus] = []

    required public init(){}
}

public class PolicyDocumentStatus : Codable
{
    public var id:Int
    public var name:String
    public var isNBCStatus:Bool
    public var isAgentStatus:Bool

    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 ReminderExtended : Reminder
{
    public var agentName:String
    public var recordAgentName:String
    public var recordAgentID:Int
    public var isAdmin:Bool
    public var agentID:Int

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case agentName
        case recordAgentName
        case recordAgentID
        case isAdmin
        case agentID
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        agentName = try container.decodeIfPresent(String.self, forKey: .agentName)
        recordAgentName = try container.decodeIfPresent(String.self, forKey: .recordAgentName)
        recordAgentID = try container.decodeIfPresent(Int.self, forKey: .recordAgentID)
        isAdmin = try container.decodeIfPresent(Bool.self, forKey: .isAdmin)
        agentID = try container.decodeIfPresent(Int.self, forKey: .agentID)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if agentName != nil { try container.encode(agentName, forKey: .agentName) }
        if recordAgentName != nil { try container.encode(recordAgentName, forKey: .recordAgentName) }
        if recordAgentID != nil { try container.encode(recordAgentID, forKey: .recordAgentID) }
        if isAdmin != nil { try container.encode(isAdmin, forKey: .isAdmin) }
        if agentID != nil { try container.encode(agentID, forKey: .agentID) }
    }
}

public class Reminder : Codable
{
    public var reminderId:String
    public var tableName:String
    public var fieldName:String
    public var recordId:Int
    public var reminderDate:Date
    public var reminderNote:String
    public var createdDate:Date
    public var createdBy:String
    public var completedDate:Date

    required public init(){}
}

public class PolicyRequiredDocumentResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var policyRequiredDocuments:[PolicyRequiredDocumentExtended] = []

    required public init(){}
}

Swift PolicyRequiredDocumentRequest 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/PolicyRequiredDocument HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	PolicyRequiredDocument: 
	{
		Reminders: 
		[
			{
				Id: 0,
				PolicyDocumentId: 0,
				ReminderFor: String,
				ReminderLeadTime: 0,
				ReminderMessage: String,
				AdminAgentId: 0,
				NeedsPrompt: False
			}
		],
		AgentReminders: 
		[
			{
				AgentName: String,
				RecordAgentName: String,
				RecordAgentID: 0,
				IsAdmin: False,
				AgentID: 0,
				ReminderId: 00000000000000000000000000000000,
				TableName: String,
				FieldName: String,
				RecordId: 0,
				ReminderDate: 0001-01-01,
				ReminderNote: String,
				CreatedDate: 0001-01-01,
				CreatedBy: String,
				CompletedDate: 0001-01-01
			}
		],
		Id: 0,
		PolicyAssociateId: 00000000000000000000000000000000,
		PolicyDocumentId: 0,
		NBCStatusId: 0,
		AgentStatusId: 0,
		StatusOptions: 
		[
			{
				Id: 0,
				Name: String,
				IsNBCStatus: False,
				IsAgentStatus: False
			}
		]
	},
	PolicyAssociateId: 00000000000000000000000000000000,
	Id: 0
}

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
		}
	},
	PolicyRequiredDocuments: 
	[
		{
			Reminders: 
			[
				{
					Id: 0,
					PolicyDocumentId: 0,
					ReminderFor: String,
					ReminderLeadTime: 0,
					ReminderMessage: String,
					AdminAgentId: 0,
					NeedsPrompt: False
				}
			],
			AgentReminders: 
			[
				{
					AgentName: String,
					RecordAgentName: String,
					RecordAgentID: 0,
					IsAdmin: False,
					AgentID: 0,
					ReminderId: 00000000000000000000000000000000,
					TableName: String,
					FieldName: String,
					RecordId: 0,
					ReminderDate: 0001-01-01,
					ReminderNote: String,
					CreatedDate: 0001-01-01,
					CreatedBy: String,
					CompletedDate: 0001-01-01
				}
			],
			Id: 0,
			PolicyAssociateId: 00000000000000000000000000000000,
			PolicyDocumentId: 0,
			NBCStatusId: 0,
			AgentStatusId: 0,
			StatusOptions: 
			[
				{
					Id: 0,
					Name: String,
					IsNBCStatus: False,
					IsAgentStatus: False
				}
			]
		}
	]
}