Foundry API

UploadViewpointPhotoRequest

The following routes are available for this service:
POST	/machines/{MachineId}/viewpoint


export class PostOperationUnTenanted<TResponse> implements IPost
{

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

export class PostOperationTenanted<TResponse> extends PostOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

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

export class Photo implements IIdentifiableResource
{
    public uploadedAt: string;
    public imageUrl?: string;
    public thumbnailUrl?: string;
    public id?: string;

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

export class UploadViewpointPhotoResponse
{
    public responseStatus?: ResponseStatus;
    public photo?: Photo;

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

export class UploadViewpointPhotoRequest extends PostOperationTenanted<UploadViewpointPhotoResponse>
{
    public machineId?: string;
    public uploadedAt: string;

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

TypeScript 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: staging-api.foundrylab.com 
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>