Trendsic Platform Service

<back to all web services

BluebeamCommitRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/projects/{ProjectID}/bluebeam/import/commit

export class BluebeamRow
{
    public RowNo: number;
    public Subject: string;
    public PageLabel: string;
    public PageIndex?: number;
    public Author: string;
    public Date: string;
    public Status: string;
    public Color: string;
    public Comments: string;
    public Label: string;
    public Layer: string;
    public Space: string;
    public Length?: number;
    public Area?: number;
    public Count?: number;
    public Volume?: number;
    public Measurement: string;
    public X?: number;
    public Y?: number;
    public Width?: number;
    public Height?: number;
    public Extras: { [index:string]: string; } = {};

    public constructor(init?: Partial<BluebeamRow>) { (Object as any).assign(this, init); }
}

export class BluebeamMappedRow
{
    public RowNo: number;
    public Target: string;
    public Title: string;
    public Description: string;
    public Area: string;
    public Trade: string;
    public AssignedSub: string;
    public Priority: string;
    public Quantity?: number;
    public QuantityKind: string;
    public Unit: string;
    public TaskSeq?: number;
    public Reason: string;
    public Source: BluebeamRow;

    public constructor(init?: Partial<BluebeamMappedRow>) { (Object as any).assign(this, init); }
}

export class BluebeamCommitResult
{
    public PunchCreated: number;
    public RfisCreated: number;
    public Skipped: number;
    public Created: string[] = [];
    public Quantities: BluebeamMappedRow[] = [];
    public Errors: string[] = [];

    public constructor(init?: Partial<BluebeamCommitResult>) { (Object as any).assign(this, init); }
}

export class BluebeamCommitResponse
{
    public ResponseStatus: ResponseStatus;
    public Result: BluebeamCommitResult;
    public QuantitiesCsv: string;
    public QuantitiesWritten: number;

    public constructor(init?: Partial<BluebeamCommitResponse>) { (Object as any).assign(this, init); }
}

export class BluebeamCommitRequest
{
    public ProjectID: number;
    public FileName: string;
    public Rows: BluebeamMappedRow[] = [];
    public RfpDocumentUID?: string;

    public constructor(init?: Partial<BluebeamCommitRequest>) { (Object as any).assign(this, init); }
}

TypeScript BluebeamCommitRequest DTOs

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.

POST /v1/projects/{ProjectID}/bluebeam/import/commit HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BluebeamCommitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FileName>String</FileName>
  <ProjectID>0</ProjectID>
  <RfpDocumentUID>00000000-0000-0000-0000-000000000000</RfpDocumentUID>
  <Rows>
    <BluebeamMappedRow>
      <Area>String</Area>
      <AssignedSub>String</AssignedSub>
      <Description>String</Description>
      <Priority>String</Priority>
      <Quantity>0</Quantity>
      <QuantityKind>String</QuantityKind>
      <Reason>String</Reason>
      <RowNo>0</RowNo>
      <Source>
        <Area>0</Area>
        <Author>String</Author>
        <Color>String</Color>
        <Comments>String</Comments>
        <Count>0</Count>
        <Date>String</Date>
        <Extras xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Extras>
        <Height>0</Height>
        <Label>String</Label>
        <Layer>String</Layer>
        <Length>0</Length>
        <Measurement>String</Measurement>
        <PageIndex>0</PageIndex>
        <PageLabel>String</PageLabel>
        <RowNo>0</RowNo>
        <Space>String</Space>
        <Status>String</Status>
        <Subject>String</Subject>
        <Volume>0</Volume>
        <Width>0</Width>
        <X>0</X>
        <Y>0</Y>
      </Source>
      <Target>String</Target>
      <TaskSeq>0</TaskSeq>
      <Title>String</Title>
      <Trade>String</Trade>
      <Unit>String</Unit>
    </BluebeamMappedRow>
  </Rows>
</BluebeamCommitRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BluebeamCommitResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <QuantitiesCsv>String</QuantitiesCsv>
  <QuantitiesWritten>0</QuantitiesWritten>
  <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>
  <Result>
    <Created xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Created>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Errors>
    <PunchCreated>0</PunchCreated>
    <Quantities>
      <BluebeamMappedRow>
        <Area>String</Area>
        <AssignedSub>String</AssignedSub>
        <Description>String</Description>
        <Priority>String</Priority>
        <Quantity>0</Quantity>
        <QuantityKind>String</QuantityKind>
        <Reason>String</Reason>
        <RowNo>0</RowNo>
        <Source>
          <Area>0</Area>
          <Author>String</Author>
          <Color>String</Color>
          <Comments>String</Comments>
          <Count>0</Count>
          <Date>String</Date>
          <Extras xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </Extras>
          <Height>0</Height>
          <Label>String</Label>
          <Layer>String</Layer>
          <Length>0</Length>
          <Measurement>String</Measurement>
          <PageIndex>0</PageIndex>
          <PageLabel>String</PageLabel>
          <RowNo>0</RowNo>
          <Space>String</Space>
          <Status>String</Status>
          <Subject>String</Subject>
          <Volume>0</Volume>
          <Width>0</Width>
          <X>0</X>
          <Y>0</Y>
        </Source>
        <Target>String</Target>
        <TaskSeq>0</TaskSeq>
        <Title>String</Title>
        <Trade>String</Trade>
        <Unit>String</Unit>
      </BluebeamMappedRow>
    </Quantities>
    <RfisCreated>0</RfisCreated>
    <Skipped>0</Skipped>
  </Result>
</BluebeamCommitResponse>