Antel API

<back to all web services

SaveUpliftImage

Requires Authentication
The following routes are available for this service:
POST/uplift/image
"use strict";
export class ApiServiceRequest {
    /** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API Key required for authentication */
    apiKey;
    /**
     * @type {number}
     * @description Latitude of the user making this request */
    latitude;
    /**
     * @type {number}
     * @description Longitude of the user making this request */
    longitude;
}
export class ApiServiceResponse {
    /** @param {{description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Information about the response. */
    description;
    /**
     * @type {string}
     * @description Heading or summary of the response. */
    heading;
    /**
     * @type {boolean}
     * @description Did the intended operation for this response complete successfully? */
    wasSuccessful;
    /** @type {ResponseStatus} */
    responseStatus;
}
/** @typedef {number} */
export var UpliftImageType;
(function (UpliftImageType) {
    UpliftImageType[UpliftImageType["ClaimDoc"] = 0] = "ClaimDoc"
    UpliftImageType[UpliftImageType["DamagedOk"] = 1] = "DamagedOk"
    UpliftImageType[UpliftImageType["DamagedBad"] = 2] = "DamagedBad"
    UpliftImageType[UpliftImageType["Expired"] = 3] = "Expired"
    UpliftImageType[UpliftImageType["Recall"] = 4] = "Recall"
    UpliftImageType[UpliftImageType["Product"] = 5] = "Product"
    UpliftImageType[UpliftImageType["OperatorSignature"] = 6] = "OperatorSignature"
    UpliftImageType[UpliftImageType["OperatorRegistration"] = 7] = "OperatorRegistration"
    UpliftImageType[UpliftImageType["OutletSignature"] = 8] = "OutletSignature"
    UpliftImageType[UpliftImageType["GoodStock"] = 9] = "GoodStock"
    UpliftImageType[UpliftImageType["Deranged"] = 10] = "Deranged"
    UpliftImageType[UpliftImageType["Overstocked"] = 11] = "Overstocked"
    UpliftImageType[UpliftImageType["FactoryFault"] = 12] = "FactoryFault"
    UpliftImageType[UpliftImageType["Status"] = 13] = "Status"
})(UpliftImageType || (UpliftImageType = {}));
export class SaveUpliftImage extends ApiServiceRequest {
    /** @param {{type?:UpliftImageType,upliftId?:number,stockStatusId?:number,imageId?:string,apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {UpliftImageType} */
    type;
    /** @type {number} */
    upliftId;
    /** @type {number} */
    stockStatusId;
    /** @type {string} */
    imageId;
}

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