Trendsic Platform Service

<back to all web services

SecuritiesListingsRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Securities/DateRange/{ParamStartDate}/{ParamEndDate}/{AgentID}
GET,OPTIONS/v1/Securities/DateRange/{ParamStartDate}/{ParamEndDate}
SecuritiesListingsRequest Parameters:
NameParameterData TypeRequiredDescription
ListingsqueryList<Listing>No
AgentIDpathintNo
ParamStartDatepathDateTimeNo
ParamEndDatepathDateTimeNo
Listing Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
LISTINGDATEformDateTimeNo
LISTINGTDATEformDateTimeNo
POLICYformstringNo
OAGENTformstringNo
INSUREDformstringNo
PREMIUMformstringNo
PARTformstringNo
AMOUNTformdecimalNo
AGENTNMformstringNo
LISTINGCTYPEformstringNo
COMPANYformstringNo
APPROVEDformstringNo
CARDCREDITformstringNo
REGIONformstringNo
FPAYOUTformstringNo
PROMOPTSformstringNo
APPCNTformstringNo
PARTPERCENTformstringNo
GROSSformdecimalNo
CITYformstringNo
STATEformstringNo
AGENTNOformstringNo
TYPEformstringNo
COMMRATEformstringNo
AgentIDformintNo
OAgentIDformintNo
FIELDPAYOUTformdecimalNo
ListingsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ListingsformList<Listing>No

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/Securities/DateRange/{ParamStartDate}/{ParamEndDate}/{AgentID} 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
		}
	},
	Listings: 
	[
		{
			ID: 0,
			LISTINGDATE: 0001-01-01,
			LISTINGTDATE: 0001-01-01,
			POLICY: String,
			OAGENT: String,
			INSURED: String,
			PREMIUM: String,
			PART: String,
			AMOUNT: 0,
			AGENTNM: String,
			LISTINGCTYPE: String,
			COMPANY: String,
			APPROVED: String,
			CARDCREDIT: String,
			REGION: String,
			FPAYOUT: String,
			PROMOPTS: String,
			APPCNT: String,
			PARTPERCENT: String,
			GROSS: 0,
			CITY: String,
			STATE: String,
			AGENTNO: String,
			TYPE: String,
			COMMRATE: String,
			AgentID: 0,
			OAgentID: 0,
			FIELDPAYOUT: 0
		}
	]
}