ImageServiceAPI

<back to all web services

PostImageRequest

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

// @DataContract
public class PostImageRequest : V4BaseRequest, IPostImageRequest
{
    // @DataMember(Name="provider")
    public var provider:ImageProvider

    // @DataMember(Name="providerImageId")
    public var providerImageId:String

    // @DataMember(Name="attributes")
    public var attributes:[String:String] = [:]

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case provider
        case providerImageId
        case attributes
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        provider = try container.decodeIfPresent(ImageProvider.self, forKey: .provider)
        providerImageId = try container.decodeIfPresent(String.self, forKey: .providerImageId)
        attributes = try container.decodeIfPresent([String:String].self, forKey: .attributes) ?? [:]
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if provider != nil { try container.encode(provider, forKey: .provider) }
        if providerImageId != nil { try container.encode(providerImageId, forKey: .providerImageId) }
        if attributes.count > 0 { try container.encode(attributes, forKey: .attributes) }
    }
}

// @DataContract
public class V4BaseRequest : Codable
{
    required public init(){}
}

public enum ImageProvider : String, Codable
{
    case None
    case Cloudinary
}

// @DataContract
public class PostImageResponse : V4BaseResponse, IPostImageResponse
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

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

    required public init(){}
}


Swift 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>