Trendsic Platform Service

<back to all web services

RatesResolveRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/Rfp/{RfpDocumentUID}/Rates/Resolve
"use strict";
export class RateQuote {
    /** @param {{Tier?:string,Confidence?:string,Value?:number,Unit?:string,Provenance?:string,Url?:string,FetchedAtUtc?:string,Vendor?:string,Location?:string,RateDay?:number,RateWeek?:number,RateMonth?:number,AdjustmentPct?:number,ListValue?:number,Note?:string,ChipShort?:string,Status?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Tier;
    /** @type {string} */
    Confidence;
    /** @type {?number} */
    Value;
    /** @type {string} */
    Unit;
    /** @type {string} */
    Provenance;
    /** @type {string} */
    Url;
    /** @type {?string} */
    FetchedAtUtc;
    /** @type {string} */
    Vendor;
    /** @type {string} */
    Location;
    /** @type {?number} */
    RateDay;
    /** @type {?number} */
    RateWeek;
    /** @type {?number} */
    RateMonth;
    /** @type {?number} */
    AdjustmentPct;
    /** @type {?number} */
    ListValue;
    /** @type {string} */
    Note;
    /** @type {string} */
    ChipShort;
    /** @type {string} */
    Status;
}
export class RatesResolveResponse {
    /** @param {{ResponseStatus?:ResponseStatus,RateKey?:string,Name?:string,Kind?:string,Unit?:string,Quotes?:RateQuote[],RetailRequestId?:string,CurrentRate?:number,CurrentChip?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {string} */
    RateKey;
    /** @type {string} */
    Name;
    /** @type {string} */
    Kind;
    /** @type {string} */
    Unit;
    /** @type {RateQuote[]} */
    Quotes = [];
    /** @type {string} */
    RetailRequestId;
    /** @type {?number} */
    CurrentRate;
    /** @type {string} */
    CurrentChip;
}
export class RatesResolveRequest {
    /** @param {{RfpDocumentUID?:string,RateKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RfpDocumentUID;
    /** @type {string} */
    RateKey;
}

JavaScript RatesResolveRequest 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/Rfp/{RfpDocumentUID}/Rates/Resolve HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RfpDocumentUID: 00000000000000000000000000000000,
	RateKey: 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
		}
	},
	RateKey: String,
	Name: String,
	Kind: String,
	Unit: String,
	Quotes: 
	[
		{
			Tier: String,
			Confidence: String,
			Value: 0,
			Unit: String,
			Provenance: String,
			Url: String,
			FetchedAtUtc: 0001-01-01,
			Vendor: String,
			Location: String,
			RateDay: 0,
			RateWeek: 0,
			RateMonth: 0,
			AdjustmentPct: 0,
			ListValue: 0,
			Note: String,
			ChipShort: String,
			Status: String
		}
	],
	RetailRequestId: String,
	CurrentRate: 0,
	CurrentChip: String
}