Antel API

<back to all web services

SaveUpliftImage

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

public class SaveUpliftImage : ApiServiceRequest
{
    public var type:UpliftImageType
    public var upliftId:Int
    public var stockStatusId:Int
    public var imageId:String

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

    private enum CodingKeys : String, CodingKey {
        case type
        case upliftId
        case stockStatusId
        case imageId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        type = try container.decodeIfPresent(UpliftImageType.self, forKey: .type)
        upliftId = try container.decodeIfPresent(Int.self, forKey: .upliftId)
        stockStatusId = try container.decodeIfPresent(Int.self, forKey: .stockStatusId)
        imageId = try container.decodeIfPresent(String.self, forKey: .imageId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if type != nil { try container.encode(type, forKey: .type) }
        if upliftId != nil { try container.encode(upliftId, forKey: .upliftId) }
        if stockStatusId != nil { try container.encode(stockStatusId, forKey: .stockStatusId) }
        if imageId != nil { try container.encode(imageId, forKey: .imageId) }
    }
}

public class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo, Codable
{
    /**
    * The API Key required for authentication
    */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public var apiKey:String

    /**
    * Latitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public var latitude:Double

    /**
    * Longitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public var longitude:Double

    required public init(){}
}

public enum UpliftImageType : Int, Codable
{
    case ClaimDoc = 0
    case DamagedOk = 1
    case DamagedBad = 2
    case Expired = 3
    case Recall = 4
    case Product = 5
    case OperatorSignature = 6
    case OperatorRegistration = 7
    case OutletSignature = 8
    case GoodStock = 9
    case Deranged = 10
    case Overstocked = 11
    case FactoryFault = 12
    case Status = 13
}

public class ApiServiceResponse : IServiceResponse, Codable
{
    /**
    * Information about the response.
    */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    public var Description:String

    /**
    * Heading or summary of the response.
    */
    // @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    public var heading:String

    /**
    * Did the intended operation for this response complete successfully?
    */
    // @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    public var wasSuccessful:Bool

    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift SaveUpliftImage 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 /uplift/image HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SaveUpliftImage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ApiKey>
  <Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Latitude>
  <Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Longitude>
  <ImageId>00000000-0000-0000-0000-000000000000</ImageId>
  <StockStatusId>0</StockStatusId>
  <Type>ClaimDoc</Type>
  <UpliftId>0</UpliftId>
</SaveUpliftImage>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ApiServiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">
  <Description>String</Description>
  <Heading>String</Heading>
  <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>
  <WasSuccessful>false</WasSuccessful>
</ApiServiceResponse>