Trendsic Platform Service

<back to all web services

PayAppG702Request

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/projects/{ProjectID}/pay-apps/{PeriodNumber}/g702
"use strict";
export class DocField {
    /** @param {{Label?:string,Value?:string,Ref?:string,Emphasis?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Label;
    /** @type {string} */
    Value;
    /** @type {string} */
    Ref;
    /** @type {boolean} */
    Emphasis;
}
export class DocColumn {
    /** @param {{Key?:string,Label?:string,Align?:string,Width?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Label;
    /** @type {string} */
    Align;
    /** @type {number} */
    Width;
}
export class DocTable {
    /** @param {{Caption?:string,Columns?:DocColumn[],Rows?:string[][],Footer?:string[][]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Caption;
    /** @type {DocColumn[]} */
    Columns = [];
    /** @type {string[][]} */
    Rows = [];
    /** @type {string[][]} */
    Footer = [];
}
export class DocBlock {
    /** @param {{Type?:string,Text?:string,Level?:number,Fields?:DocField[],Columns?:number,Table?:DocTable,Signatures?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Type;
    /** @type {string} */
    Text;
    /** @type {number} */
    Level;
    /** @type {DocField[]} */
    Fields = [];
    /** @type {number} */
    Columns;
    /** @type {DocTable} */
    Table;
    /** @type {string[]} */
    Signatures = [];
}
export class DocIssue {
    /** @param {{Severity?:string,Code?:string,Message?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Severity;
    /** @type {string} */
    Code;
    /** @type {string} */
    Message;
}
export class PrintDocument {
    /** @param {{Kind?:string,Title?:string,Subtitle?:string,FileName?:string,Landscape?:boolean,GeneratedAtUtc?:string,GeneratedBy?:string,Meta?:DocField[],Blocks?:DocBlock[],Issues?:DocIssue[],CanPrint?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Kind;
    /** @type {string} */
    Title;
    /** @type {string} */
    Subtitle;
    /** @type {string} */
    FileName;
    /** @type {boolean} */
    Landscape;
    /** @type {string} */
    GeneratedAtUtc;
    /** @type {string} */
    GeneratedBy;
    /** @type {DocField[]} */
    Meta = [];
    /** @type {DocBlock[]} */
    Blocks = [];
    /** @type {DocIssue[]} */
    Issues = [];
    /** @type {boolean} */
    CanPrint;
}
export class PrintableResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Document?:PrintDocument}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {PrintDocument} */
    Document;
}
export class PayAppG702Request {
    /** @param {{ProjectID?:number,PeriodNumber?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
    /** @type {number} */
    PeriodNumber;
}

JavaScript PayAppG702Request 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}/pay-apps/{PeriodNumber}/g702 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
		}
	},
	Document: 
	{
		Kind: String,
		Title: String,
		Subtitle: String,
		FileName: String,
		Landscape: False,
		GeneratedAtUtc: 0001-01-01,
		GeneratedBy: String,
		Meta: 
		[
			{
				Label: String,
				Value: String,
				Ref: String,
				Emphasis: False
			}
		],
		Blocks: 
		[
			{
				Type: String,
				Text: String,
				Level: 0,
				Fields: 
				[
					{
						Label: String,
						Value: String,
						Ref: String,
						Emphasis: False
					}
				],
				Columns: 0,
				Table: 
				{
					Caption: String,
					Columns: 
					[
						{
							Key: String,
							Label: String,
							Align: String,
							Width: 0
						}
					],
					Rows: 
					[
						[
							String
						]
					],
					Footer: 
					[
						[
							String
						]
					]
				},
				Signatures: 
				[
					String
				]
			}
		],
		Issues: 
		[
			{
				Severity: String,
				Code: String,
				Message: String
			}
		],
		CanPrint: True
	}
}