Foundry API

<back to all web services

UploadViewpointPhotoRequest

Requires Authentication
The following routes are available for this service:
POST/machines/{MachineId}/viewpoint
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class UploadViewpointPhotoRequest extends PostOperationTenanted<UploadViewpointPhotoResponse>
    {
        public String machineId = null;
        public Date uploadedAt = null;
        
        public String getMachineId() { return machineId; }
        public UploadViewpointPhotoRequest setMachineId(String value) { this.machineId = value; return this; }
        public Date getUploadedAt() { return uploadedAt; }
        public UploadViewpointPhotoRequest setUploadedAt(Date value) { this.uploadedAt = value; return this; }
    }

    public static class PostOperationTenanted<TResponse> extends PostOperationUnTenanted<TResponse> implements ITenantedRequest
    {
        public String organisationId = null;
        
        public String getOrganisationId() { return organisationId; }
        public PostOperationTenanted<TResponse> setOrganisationId(String value) { this.organisationId = value; return this; }
    }

    public static class PostOperationUnTenanted<TResponse> implements IPost
    {
        
    }

    public static class UploadViewpointPhotoResponse
    {
        public ResponseStatus responseStatus = null;
        public Photo photo = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public UploadViewpointPhotoResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Photo getPhoto() { return photo; }
        public UploadViewpointPhotoResponse setPhoto(Photo value) { this.photo = value; return this; }
    }

    public static class Photo implements IIdentifiableResource
    {
        public Date uploadedAt = null;
        public String imageUrl = null;
        public String thumbnailUrl = null;
        public String id = null;
        
        public Date getUploadedAt() { return uploadedAt; }
        public Photo setUploadedAt(Date value) { this.uploadedAt = value; return this; }
        public String getImageUrl() { return imageUrl; }
        public Photo setImageUrl(String value) { this.imageUrl = value; return this; }
        public String getThumbnailUrl() { return thumbnailUrl; }
        public Photo setThumbnailUrl(String value) { this.thumbnailUrl = value; return this; }
        public String getId() { return id; }
        public Photo setId(String value) { this.id = value; return this; }
    }

}

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

<UploadViewpointPhotoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Photos">
  <OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
  <MachineId>String</MachineId>
  <UploadedAt>0001-01-01T00:00:00</UploadedAt>
</UploadViewpointPhotoRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UploadViewpointPhotoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Photos">
  <Photo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:Id>String</d2p1:Id>
    <d2p1:ImageUrl>String</d2p1:ImageUrl>
    <d2p1:ThumbnailUrl>String</d2p1:ThumbnailUrl>
    <d2p1:UploadedAt>0001-01-01T00:00:00</d2p1:UploadedAt>
  </Photo>
  <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>
</UploadViewpointPhotoResponse>