Trendsic Platform Service

<back to all web services

ProjectLocationRequest

Requires Authentication
The following routes are available for this service:
POST,PUT/v1/projectlocation
GET,DELETE/v1/projectlocation/{ProjectLocationID}

export class ProjectLocationArea
{
    public ProjectLocationAreaID: number;
    public ProjectLocationID: number;
    public Name: string;
    public Measurement?: number;
    public MeasurementUnit: string;
    public Notes: string;
    public DisplayOrder: number;
    public Active: boolean;
    public CreatedBy: string;
    public CreatedAt?: string;
    public UpdatedAt?: string;

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

export class ProjectLocationEquipment
{
    public ProjectLocationEquipmentID: number;
    public ProjectLocationID: number;
    public Name: string;
    public Description: string;
    public Manufacturer: string;
    public Model: string;
    public SerialNumber: string;
    public AssetTag: string;
    public Notes: string;
    public Active: boolean;
    public CreatedBy: string;
    public CreatedAt?: string;
    public UpdatedAt?: string;

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

export class ProjectLocationSiteDetail
{
    public ProjectLocationSiteDetailID: number;
    public ProjectLocationID: number;
    public DetailType: string;
    public Label: string;
    public Value: string;
    public IsSensitive: boolean;
    public EncVersion: number;
    public HasValue: boolean;
    public Notes: string;
    public DisplayOrder: number;
    public Active: boolean;
    public CreatedBy: string;
    public CreatedAt?: string;
    public UpdatedAt?: string;

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

export class ProjectLocationAttachment
{
    public ProjectLocationAttachmentID: number;
    public ProjectLocationID: number;
    public ProjectLocationAreaID?: number;
    public Kind: string;
    public DocTitle: string;
    public FileName: string;
    public Url: string;
    public MimeType: string;
    public UploadDate?: string;
    public UploadedBy: string;
    public Active: boolean;

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

export class ProjectLocation
{
    public ProjectLocationID: number;
    public ProjectID: number;
    public Name: string;
    public Address1: string;
    public Address2: string;
    public City: string;
    public State: string;
    public Zip: string;
    public Latitude?: number;
    public Longitude?: number;
    public TotalArea?: number;
    public AreaUnit: string;
    public AccessInstructions: string;
    public IsPrimary: boolean;
    public DisplayOrder: number;
    public Active: boolean;
    public CreatedBy: string;
    public CreatedAt?: string;
    public UpdatedAt?: string;
    public Areas: ProjectLocationArea[] = [];
    public Equipment: ProjectLocationEquipment[] = [];
    public SiteDetails: ProjectLocationSiteDetail[] = [];
    public Attachments: ProjectLocationAttachment[] = [];

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

export class ProjectLocationResponse
{
    public Locations: ProjectLocation[] = [];
    public Areas: ProjectLocationArea[] = [];
    public Equipment: ProjectLocationEquipment[] = [];
    public SiteDetails: ProjectLocationSiteDetail[] = [];
    public Attachments: ProjectLocationAttachment[] = [];
    public SiteDetail: ProjectLocationSiteDetail;
    public ResponseStatus: ResponseStatus;

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

export class ProjectLocationRequest
{
    public ProjectLocationID: number;
    public Locations: ProjectLocation[] = [];

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

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

{
	ProjectLocationID: 0,
	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
				}
			]
		}
	]
}
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
		}
	}
}