Trendsic Platform Service

<back to all web services

ProjectLocationSiteDetailRequest

Requires Authentication
The following routes are available for this service:
POST,PUT/v1/projectlocationsitedetail
DELETE/v1/projectlocationsitedetail/{ProjectLocationSiteDetailID}
import Foundation
import ServiceStack

public class ProjectLocationSiteDetailRequest : Codable
{
    public var projectLocationSiteDetailID:Int
    public var siteDetails:[ProjectLocationSiteDetail] = []

    required public init(){}
}

public class ProjectLocationSiteDetail : Codable
{
    public var projectLocationSiteDetailID:Int
    public var projectLocationID:Int
    public var detailType:String
    public var label:String
    public var value:String
    public var isSensitive:Bool
    public var encVersion:Int
    public var hasValue:Bool
    public var notes:String
    public var displayOrder:Int
    public var active:Bool
    public var createdBy:String
    public var createdAt:Date?
    public var updatedAt:Date?

    required public init(){}
}

public class ProjectLocationResponse : Codable
{
    public var locations:[ProjectLocation] = []
    public var areas:[ProjectLocationArea] = []
    public var equipment:[ProjectLocationEquipment] = []
    public var siteDetails:[ProjectLocationSiteDetail] = []
    public var attachments:[ProjectLocationAttachment] = []
    public var siteDetail:ProjectLocationSiteDetail
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ProjectLocation : Codable
{
    public var projectLocationID:Int
    public var projectID:Int
    public var name:String
    public var address1:String
    public var address2:String
    public var city:String
    public var state:String
    public var zip:String
    public var latitude:Double?
    public var longitude:Double?
    public var totalArea:Double?
    public var areaUnit:String
    public var accessInstructions:String
    public var isPrimary:Bool
    public var displayOrder:Int
    public var active:Bool
    public var createdBy:String
    public var createdAt:Date?
    public var updatedAt:Date?
    public var areas:[ProjectLocationArea] = []
    public var equipment:[ProjectLocationEquipment] = []
    public var siteDetails:[ProjectLocationSiteDetail] = []
    public var attachments:[ProjectLocationAttachment] = []

    required public init(){}
}

public class ProjectLocationArea : Codable
{
    public var projectLocationAreaID:Int
    public var projectLocationID:Int
    public var name:String
    public var measurement:Double?
    public var measurementUnit:String
    public var notes:String
    public var displayOrder:Int
    public var active:Bool
    public var createdBy:String
    public var createdAt:Date?
    public var updatedAt:Date?

    required public init(){}
}

public class ProjectLocationEquipment : Codable
{
    public var projectLocationEquipmentID:Int
    public var projectLocationID:Int
    public var name:String
    public var Description:String
    public var manufacturer:String
    public var model:String
    public var serialNumber:String
    public var assetTag:String
    public var notes:String
    public var active:Bool
    public var createdBy:String
    public var createdAt:Date?
    public var updatedAt:Date?

    required public init(){}
}

public class ProjectLocationAttachment : Codable
{
    public var projectLocationAttachmentID:Int
    public var projectLocationID:Int
    public var projectLocationAreaID:Int?
    public var kind:String
    public var docTitle:String
    public var fileName:String
    public var url:String
    public var mimeType:String
    public var uploadDate:Date?
    public var uploadedBy:String
    public var active:Bool

    required public init(){}
}


Swift ProjectLocationSiteDetailRequest 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/projectlocationsitedetail HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProjectLocationSiteDetailID: 0,
	SiteDetails: 
	[
		{
			ProjectLocationSiteDetailID: 0,
			ProjectLocationID: 0,
			DetailType: String,
			Label: String,
			Value: String,
			IsSensitive: False,
			EncVersion: 0,
			HasValue: False,
			Notes: String,
			DisplayOrder: 0,
			Active: False,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Locations: 
	[
		{
			ProjectLocationID: 0,
			ProjectID: 0,
			Name: String,
			Address1: String,
			Address2: String,
			City: String,
			State: String,
			Zip: String,
			Latitude: 0,
			Longitude: 0,
			TotalArea: 0,
			AreaUnit: String,
			AccessInstructions: String,
			IsPrimary: False,
			DisplayOrder: 0,
			Active: False,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01,
			Areas: 
			[
				{
					ProjectLocationAreaID: 0,
					ProjectLocationID: 0,
					Name: String,
					Measurement: 0,
					MeasurementUnit: String,
					Notes: String,
					DisplayOrder: 0,
					Active: False,
					CreatedBy: String,
					CreatedAt: 0001-01-01,
					UpdatedAt: 0001-01-01
				}
			],
			Equipment: 
			[
				{
					ProjectLocationEquipmentID: 0,
					ProjectLocationID: 0,
					Name: String,
					Description: String,
					Manufacturer: String,
					Model: String,
					SerialNumber: String,
					AssetTag: String,
					Notes: String,
					Active: False,
					CreatedBy: String,
					CreatedAt: 0001-01-01,
					UpdatedAt: 0001-01-01
				}
			],
			SiteDetails: 
			[
				{
					ProjectLocationSiteDetailID: 0,
					ProjectLocationID: 0,
					DetailType: String,
					Label: String,
					Value: String,
					IsSensitive: False,
					EncVersion: 0,
					HasValue: False,
					Notes: String,
					DisplayOrder: 0,
					Active: False,
					CreatedBy: String,
					CreatedAt: 0001-01-01,
					UpdatedAt: 0001-01-01
				}
			],
			Attachments: 
			[
				{
					ProjectLocationAttachmentID: 0,
					ProjectLocationID: 0,
					ProjectLocationAreaID: 0,
					Kind: String,
					DocTitle: String,
					FileName: String,
					Url: String,
					MimeType: String,
					UploadDate: 0001-01-01,
					UploadedBy: String,
					Active: False
				}
			]
		}
	],
	Areas: 
	[
		{
			ProjectLocationAreaID: 0,
			ProjectLocationID: 0,
			Name: String,
			Measurement: 0,
			MeasurementUnit: String,
			Notes: String,
			DisplayOrder: 0,
			Active: False,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01
		}
	],
	Equipment: 
	[
		{
			ProjectLocationEquipmentID: 0,
			ProjectLocationID: 0,
			Name: String,
			Description: String,
			Manufacturer: String,
			Model: String,
			SerialNumber: String,
			AssetTag: String,
			Notes: String,
			Active: False,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01
		}
	],
	SiteDetails: 
	[
		{
			ProjectLocationSiteDetailID: 0,
			ProjectLocationID: 0,
			DetailType: String,
			Label: String,
			Value: String,
			IsSensitive: False,
			EncVersion: 0,
			HasValue: False,
			Notes: String,
			DisplayOrder: 0,
			Active: False,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01
		}
	],
	Attachments: 
	[
		{
			ProjectLocationAttachmentID: 0,
			ProjectLocationID: 0,
			ProjectLocationAreaID: 0,
			Kind: String,
			DocTitle: String,
			FileName: String,
			Url: String,
			MimeType: String,
			UploadDate: 0001-01-01,
			UploadedBy: String,
			Active: False
		}
	],
	SiteDetail: 
	{
		ProjectLocationSiteDetailID: 0,
		ProjectLocationID: 0,
		DetailType: String,
		Label: String,
		Value: String,
		IsSensitive: False,
		EncVersion: 0,
		HasValue: False,
		Notes: String,
		DisplayOrder: 0,
		Active: False,
		CreatedBy: String,
		CreatedAt: 0001-01-01,
		UpdatedAt: 0001-01-01
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}