Trendsic Platform Service

<back to all web services

SubmittalListRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/projects/{ProjectID}/submittals
"use strict";
export class Submittal {
    /** @param {{SubmittalID?:number,SubmittalUID?:string,ProjectID?:number,SubmittalNo?:string,SpecSection?:string,Title?:string,SubType?:string,Rev?:number,BallInCourt?:string,Status?:string,DueDate?:string,SubmittedDate?:string,DecidedDate?:string,Notes?:string,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string,IsOverdue?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    SubmittalID;
    /** @type {string} */
    SubmittalUID;
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    SubmittalNo;
    /** @type {string} */
    SpecSection;
    /** @type {string} */
    Title;
    /** @type {string} */
    SubType;
    /** @type {number} */
    Rev;
    /** @type {string} */
    BallInCourt;
    /** @type {string} */
    Status;
    /** @type {?string} */
    DueDate;
    /** @type {?string} */
    SubmittedDate;
    /** @type {?string} */
    DecidedDate;
    /** @type {string} */
    Notes;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
    /** @type {boolean} */
    IsOverdue;
}
export class SubmittalListResponse {
    /** @param {{ResponseStatus?:ResponseStatus,ProjectID?:number,Submittals?:Submittal[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {number} */
    ProjectID;
    /** @type {Submittal[]} */
    Submittals = [];
}
export class SubmittalListRequest {
    /** @param {{ProjectID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
}

JavaScript SubmittalListRequest 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/projects/{ProjectID}/submittals 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
		}
	},
	ProjectID: 0,
	Submittals: 
	[
		{
			SubmittalID: 0,
			SubmittalUID: 00000000000000000000000000000000,
			ProjectID: 0,
			SubmittalNo: String,
			SpecSection: String,
			Title: String,
			SubType: String,
			Rev: 0,
			BallInCourt: String,
			Status: String,
			DueDate: 0001-01-01,
			SubmittedDate: 0001-01-01,
			DecidedDate: 0001-01-01,
			Notes: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01,
			IsOverdue: False
		}
	]
}