Foundry API

<back to all web services

UploadViewpointPhotoRequest

Requires Authentication
The following routes are available for this service:
POST/machines/{MachineId}/viewpoint
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Infrastructure.Api.Interfaces.ServiceOperations.Photos
Imports Infrastructure.Api.Interfaces.ServiceOperations
Imports Application.Interfaces.Resources

Namespace Global

    Namespace Application.Interfaces.Resources

        Public Partial Class Photo
            Implements IIdentifiableResource
            Public Overridable Property UploadedAt As Date
            Public Overridable Property ImageUrl As String
            Public Overridable Property ThumbnailUrl As String
            Public Overridable Property Id As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations

        Public Partial Class PostOperationTenanted(Of TResponse)
            Inherits PostOperationUnTenanted(Of TResponse)
            Implements ITenantedRequest
            Public Overridable Property OrganisationId As String
        End Class

        Public Partial Class PostOperationUnTenanted(Of TResponse)
            Implements IPost
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.Photos

        Public Partial Class UploadViewpointPhotoRequest
            Inherits PostOperationTenanted(Of UploadViewpointPhotoResponse)
            Public Overridable Property MachineId As String
            Public Overridable Property UploadedAt As Date
        End Class

        Public Partial Class UploadViewpointPhotoResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Photo As Photo
        End Class
    End Namespace
End Namespace

VB.NET UploadViewpointPhotoRequest 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 /machines/{MachineId}/viewpoint HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	machineId: String,
	organisationId: String
}
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
		}
	},
	photo: 
	{
		imageUrl: String,
		thumbnailUrl: String,
		id: String
	}
}