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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PrintableResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Document>
    <Blocks>
      <DocBlock>
        <Columns>0</Columns>
        <Fields>
          <DocField>
            <Emphasis>false</Emphasis>
            <Label>String</Label>
            <Ref>String</Ref>
            <Value>String</Value>
          </DocField>
        </Fields>
        <Level>0</Level>
        <Signatures xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </Signatures>
        <Table>
          <Caption>String</Caption>
          <Columns>
            <DocColumn>
              <Align>String</Align>
              <Key>String</Key>
              <Label>String</Label>
              <Width>0</Width>
            </DocColumn>
          </Columns>
          <Footer xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:ArrayOfstring>
              <d6p1:string>String</d6p1:string>
            </d6p1:ArrayOfstring>
          </Footer>
          <Rows xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:ArrayOfstring>
              <d6p1:string>String</d6p1:string>
            </d6p1:ArrayOfstring>
          </Rows>
        </Table>
        <Text>String</Text>
        <Type>String</Type>
      </DocBlock>
    </Blocks>
    <FileName>String</FileName>
    <GeneratedAtUtc>0001-01-01T00:00:00</GeneratedAtUtc>
    <GeneratedBy>String</GeneratedBy>
    <Issues>
      <DocIssue>
        <Code>String</Code>
        <Message>String</Message>
        <Severity>String</Severity>
      </DocIssue>
    </Issues>
    <Kind>String</Kind>
    <Landscape>false</Landscape>
    <Meta>
      <DocField>
        <Emphasis>false</Emphasis>
        <Label>String</Label>
        <Ref>String</Ref>
        <Value>String</Value>
      </DocField>
    </Meta>
    <Subtitle>String</Subtitle>
    <Title>String</Title>
  </Document>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</PrintableResponse>