Trendsic Platform Service

<back to all web services

RfpAddendaListRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Rfp/{RfpDocumentUID}/Addenda
"use strict";
export class AddendaChange {
    /** @param {{ChangeId?:string,ChangeType?:string,TargetSeq?:number,ItemNumber?:string,ItemName?:string,Field?:string,OldValue?:string,NewValue?:string,Description?:string,Status?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ChangeId;
    /** @type {string} */
    ChangeType;
    /** @type {?number} */
    TargetSeq;
    /** @type {string} */
    ItemNumber;
    /** @type {string} */
    ItemName;
    /** @type {string} */
    Field;
    /** @type {string} */
    OldValue;
    /** @type {string} */
    NewValue;
    /** @type {string} */
    Description;
    /** @type {string} */
    Status;
}
export class AddendaChangeSet {
    /** @param {{ChangeSetId?:string,SourceRfpDocumentID?:number,SourceFileName?:string,DocumentType?:string,ExtractedAtUtc?:string,Summary?:string,Changes?:AddendaChange[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ChangeSetId;
    /** @type {number} */
    SourceRfpDocumentID;
    /** @type {string} */
    SourceFileName;
    /** @type {string} */
    DocumentType;
    /** @type {?string} */
    ExtractedAtUtc;
    /** @type {string} */
    Summary;
    /** @type {AddendaChange[]} */
    Changes = [];
}
export class WageClassification {
    /** @param {{Title?:string,BaseRate?:number,FringeRate?:number,ParishNote?:string,SourceLine?:string,BenchmarkFringeRate?:number,FringeCompareNote?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Title;
    /** @type {?number} */
    BaseRate;
    /** @type {?number} */
    FringeRate;
    /** @type {string} */
    ParishNote;
    /** @type {string} */
    SourceLine;
    /** @type {?number} */
    BenchmarkFringeRate;
    /** @type {string} */
    FringeCompareNote;
}
export class WageDeterminationResult {
    /** @param {{SourceRfpDocumentID?:number,SourceFileName?:string,WdNumber?:string,ExtractedAtUtc?:string,Classifications?:WageClassification[],Source?:string,IsTrustworthy?:boolean,ExecutiveOrderFloor?:number,PublishedDate?:string,ProjectParish?:string,Warnings?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    SourceRfpDocumentID;
    /** @type {string} */
    SourceFileName;
    /** @type {string} */
    WdNumber;
    /** @type {?string} */
    ExtractedAtUtc;
    /** @type {WageClassification[]} */
    Classifications = [];
    /** @type {string} */
    Source;
    /** @type {boolean} */
    IsTrustworthy;
    /** @type {?number} */
    ExecutiveOrderFloor;
    /** @type {string} */
    PublishedDate;
    /** @type {string} */
    ProjectParish;
    /** @type {string[]} */
    Warnings = [];
}
export class RfpAddendaResponse {
    /** @param {{ResponseStatus?:ResponseStatus,RfpDocumentID?:number,Diffs?:AddendaChangeSet[],WageDeterminations?:WageDeterminationResult[],Message?:string,Reflowed?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {number} */
    RfpDocumentID;
    /** @type {AddendaChangeSet[]} */
    Diffs = [];
    /** @type {WageDeterminationResult[]} */
    WageDeterminations = [];
    /** @type {string} */
    Message;
    /** @type {boolean} */
    Reflowed;
}
export class RfpAddendaListRequest {
    /** @param {{RfpDocumentUID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RfpDocumentUID;
}

JavaScript RfpAddendaListRequest 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.

GET /v1/Rfp/{RfpDocumentUID}/Addenda 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
		}
	},
	RfpDocumentID: 0,
	Diffs: 
	[
		{
			ChangeSetId: String,
			SourceRfpDocumentID: 0,
			SourceFileName: String,
			DocumentType: String,
			ExtractedAtUtc: 0001-01-01,
			Summary: String,
			Changes: 
			[
				{
					ChangeId: String,
					ChangeType: String,
					TargetSeq: 0,
					ItemNumber: String,
					ItemName: String,
					Field: String,
					OldValue: String,
					NewValue: String,
					Description: String,
					Status: String
				}
			]
		}
	],
	WageDeterminations: 
	[
		{
			SourceRfpDocumentID: 0,
			SourceFileName: String,
			WdNumber: String,
			ExtractedAtUtc: 0001-01-01,
			Classifications: 
			[
				{
					Title: String,
					BaseRate: 0,
					FringeRate: 0,
					ParishNote: String,
					SourceLine: String,
					BenchmarkFringeRate: 0,
					FringeCompareNote: String
				}
			],
			Source: String,
			IsTrustworthy: False,
			ExecutiveOrderFloor: 0,
			PublishedDate: String,
			ProjectParish: String,
			Warnings: 
			[
				String
			]
		}
	],
	Message: String,
	Reflowed: False
}