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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"provider":"None","providerImageId":"String","attributes":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"status":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}