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
PayAppG702Request Parameters:
NameParameterData TypeRequiredDescription
ProjectIDpathintNo
PeriodNumberpathintNo
PrintableResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
DocumentformPrintDocumentNo
PrintDocument Parameters:
NameParameterData TypeRequiredDescription
KindformstringNo
TitleformstringNo
SubtitleformstringNo
FileNameformstringNo
LandscapeformboolNo
GeneratedAtUtcformDateTimeNo
GeneratedByformstringNo
MetaformList<DocField>No
BlocksformList<DocBlock>No
IssuesformList<DocIssue>No
CanPrintformboolNo
DocField Parameters:
NameParameterData TypeRequiredDescription
LabelformstringNo
ValueformstringNo
RefformstringNo
EmphasisformboolNo
DocBlock Parameters:
NameParameterData TypeRequiredDescription
TypeformstringNo
TextformstringNo
LevelformintNo
FieldsformList<DocField>No
ColumnsformintNo
TableformDocTableNo
SignaturesformList<string>No
DocTable Parameters:
NameParameterData TypeRequiredDescription
CaptionformstringNo
ColumnsformList<DocColumn>No
RowsformList<List<String>>No
FooterformList<List<String>>No
DocColumn Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
LabelformstringNo
AlignformstringNo
WidthformintNo
DocIssue Parameters:
NameParameterData TypeRequiredDescription
SeverityformstringNo
CodeformstringNo
MessageformstringNo

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
	}
}