ImageServiceAPI

<back to all web services

PostImageRequest

Requires Authentication
The following routes are available for this service:
POST/v4/images

// @DataContract
export class V4BaseRequest
{

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

// @DataContract
export class V4BaseResponse
{
    // @DataMember(Name="status")
    public status: ResponseStatus;

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

// @DataContract
export class PostImageResponse extends V4BaseResponse implements IPostImageResponse
{

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

export enum ImageProvider
{
    None = 'None',
    Cloudinary = 'Cloudinary',
}

// @DataContract
export class PostImageRequest extends V4BaseRequest implements IPostImageRequest
{
    // @DataMember(Name="provider")
    public provider: ImageProvider;

    // @DataMember(Name="providerImageId")
    public providerImageId: string;

    // @DataMember(Name="attributes")
    public attributes: { [index: string]: string; };

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

TypeScript PostImageRequest 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 /v4/images HTTP/1.1 
Host: image-service-api.qa.platform.georiot.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostImageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ImageServiceAPI.ServiceModel.V4.Requests">
  <attributes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </attributes>
  <provider>None</provider>
  <providerImageId>String</providerImageId>
</PostImageRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PostImageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ImageServiceAPI.ServiceModel.V4.Responses">
  <status 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>
  </status>
  <data i:nil="true" />
</PostImageResponse>