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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocField:
    label: Optional[str] = None
    value: Optional[str] = None
    ref: Optional[str] = None
    emphasis: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocColumn:
    key: Optional[str] = None
    label: Optional[str] = None
    align: Optional[str] = None
    width: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocTable:
    caption: Optional[str] = None
    columns: List[DocColumn] = field(default_factory=list)
    rows: List[List[str]] = field(default_factory=list)
    footer: List[List[str]] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocBlock:
    type: Optional[str] = None
    text: Optional[str] = None
    level: int = 0
    fields: List[DocField] = field(default_factory=list)
    columns: int = 0
    table: Optional[DocTable] = None
    signatures: List[str] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocIssue:
    severity: Optional[str] = None
    code: Optional[str] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PrintDocument:
    kind: Optional[str] = None
    title: Optional[str] = None
    subtitle: Optional[str] = None
    file_name: Optional[str] = None
    landscape: bool = False
    generated_at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    generated_by: Optional[str] = None
    meta: List[DocField] = field(default_factory=list)
    blocks: List[DocBlock] = field(default_factory=list)
    issues: List[DocIssue] = field(default_factory=list)
    can_print: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PrintableResponse:
    response_status: Optional[ResponseStatus] = None
    document: Optional[PrintDocument] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PayAppG702Request:
    project_i_d: int = 0
    period_number: int = 0

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