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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type BluebeamRow() = 
        member val RowNo:Int32 = new Int32() with get,set
        member val Subject:String = null with get,set
        member val PageLabel:String = null with get,set
        member val PageIndex:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Author:String = null with get,set
        member val Date:String = null with get,set
        member val Status:String = null with get,set
        member val Color:String = null with get,set
        member val Comments:String = null with get,set
        member val Label:String = null with get,set
        member val Layer:String = null with get,set
        member val Space:String = null with get,set
        member val Length:Nullable<Double> = new Nullable<Double>() with get,set
        member val Area:Nullable<Double> = new Nullable<Double>() with get,set
        member val Count:Nullable<Double> = new Nullable<Double>() with get,set
        member val Volume:Nullable<Double> = new Nullable<Double>() with get,set
        member val Measurement:String = null with get,set
        member val X:Nullable<Double> = new Nullable<Double>() with get,set
        member val Y:Nullable<Double> = new Nullable<Double>() with get,set
        member val Width:Nullable<Double> = new Nullable<Double>() with get,set
        member val Height:Nullable<Double> = new Nullable<Double>() with get,set
        member val Extras:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type BluebeamMappedRow() = 
        member val RowNo:Int32 = new Int32() with get,set
        member val Target:String = null with get,set
        member val Title:String = null with get,set
        member val Description:String = null with get,set
        member val Area:String = null with get,set
        member val Trade:String = null with get,set
        member val AssignedSub:String = null with get,set
        member val Priority:String = null with get,set
        member val Quantity:Nullable<Double> = new Nullable<Double>() with get,set
        member val QuantityKind:String = null with get,set
        member val Unit:String = null with get,set
        member val TaskSeq:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Reason:String = null with get,set
        member val Source:BluebeamRow = null with get,set

    [<AllowNullLiteral>]
    type BluebeamCommitResult() = 
        member val PunchCreated:Int32 = new Int32() with get,set
        member val RfisCreated:Int32 = new Int32() with get,set
        member val Skipped:Int32 = new Int32() with get,set
        member val Created:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Quantities:ResizeArray<BluebeamMappedRow> = new ResizeArray<BluebeamMappedRow>() with get,set
        member val Errors:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type BluebeamCommitResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Result:BluebeamCommitResult = null with get,set
        member val QuantitiesCsv:String = null with get,set
        member val QuantitiesWritten:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type BluebeamCommitRequest() = 
        member val ProjectID:Int32 = new Int32() with get,set
        member val FileName:String = null with get,set
        member val Rows:ResizeArray<BluebeamMappedRow> = new ResizeArray<BluebeamMappedRow>() with get,set
        member val RfpDocumentUID:Nullable<Guid> = new Nullable<Guid>() with get,set

F# BluebeamCommitRequest 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.

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

{
	ProjectID: 0,
	FileName: String,
	Rows: 
	[
		{
			RowNo: 0,
			Target: String,
			Title: String,
			Description: String,
			Area: String,
			Trade: String,
			AssignedSub: String,
			Priority: String,
			Quantity: 0,
			QuantityKind: String,
			Unit: String,
			TaskSeq: 0,
			Reason: String,
			Source: 
			{
				RowNo: 0,
				Subject: String,
				PageLabel: String,
				PageIndex: 0,
				Author: String,
				Date: String,
				Status: String,
				Color: String,
				Comments: String,
				Label: String,
				Layer: String,
				Space: String,
				Length: 0,
				Area: 0,
				Count: 0,
				Volume: 0,
				Measurement: String,
				X: 0,
				Y: 0,
				Width: 0,
				Height: 0,
				Extras: 
				{
					String: String
				}
			}
		}
	],
	RfpDocumentUID: 00000000000000000000000000000000
}
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
		}
	},
	Result: 
	{
		PunchCreated: 0,
		RfisCreated: 0,
		Skipped: 0,
		Created: 
		[
			String
		],
		Quantities: 
		[
			{
				RowNo: 0,
				Target: String,
				Title: String,
				Description: String,
				Area: String,
				Trade: String,
				AssignedSub: String,
				Priority: String,
				Quantity: 0,
				QuantityKind: String,
				Unit: String,
				TaskSeq: 0,
				Reason: String,
				Source: 
				{
					RowNo: 0,
					Subject: String,
					PageLabel: String,
					PageIndex: 0,
					Author: String,
					Date: String,
					Status: String,
					Color: String,
					Comments: String,
					Label: String,
					Layer: String,
					Space: String,
					Length: 0,
					Area: 0,
					Count: 0,
					Volume: 0,
					Measurement: String,
					X: 0,
					Y: 0,
					Width: 0,
					Height: 0,
					Extras: 
					{
						String: String
					}
				}
			}
		],
		Errors: 
		[
			String
		]
	},
	QuantitiesCsv: String,
	QuantitiesWritten: 0
}