Antel API

<back to all web services

FinishSubmitCompletedUplifts

Requires Authentication
The following routes are available for this service:
POST/sync/finishsubmit
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class FinishSubmitCompletedUplifts extends ApiServiceRequest
    {
        public Integer success = null;
        public ArrayList<UpliftSubmissionResult> failed = null;
        public Integer remaining = null;
        public String extra = null;
        
        public Integer getSuccess() { return success; }
        public FinishSubmitCompletedUplifts setSuccess(Integer value) { this.success = value; return this; }
        public ArrayList<UpliftSubmissionResult> getFailed() { return failed; }
        public FinishSubmitCompletedUplifts setFailed(ArrayList<UpliftSubmissionResult> value) { this.failed = value; return this; }
        public Integer getRemaining() { return remaining; }
        public FinishSubmitCompletedUplifts setRemaining(Integer value) { this.remaining = value; return this; }
        public String getExtra() { return extra; }
        public FinishSubmitCompletedUplifts setExtra(String value) { this.extra = value; return this; }
    }

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

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

        /**
        * Longitude of the user making this request
        */
        @ApiMember(DataType="double", Description="Longitude of the user making this request")
        public Double longitude = null;
        
        public String getApiKey() { return apiKey; }
        public ApiServiceRequest setApiKey(String value) { this.apiKey = value; return this; }
        public Double getLatitude() { return latitude; }
        public ApiServiceRequest setLatitude(Double value) { this.latitude = value; return this; }
        public Double getLongitude() { return longitude; }
        public ApiServiceRequest setLongitude(Double value) { this.longitude = value; return this; }
    }

    public static class UpliftSubmissionResult
    {
        public Boolean wasSuccessful = null;
        public String description = null;
        public String step = null;
        public Long upliftId = null;
        
        public Boolean isWasSuccessful() { return wasSuccessful; }
        public UpliftSubmissionResult setWasSuccessful(Boolean value) { this.wasSuccessful = value; return this; }
        public String getDescription() { return description; }
        public UpliftSubmissionResult setDescription(String value) { this.description = value; return this; }
        public String getStep() { return step; }
        public UpliftSubmissionResult setStep(String value) { this.step = value; return this; }
        public Long getUpliftId() { return upliftId; }
        public UpliftSubmissionResult setUpliftId(Long value) { this.upliftId = value; return this; }
    }

    public static class ApiServiceResponse implements IServiceResponse
    {
        /**
        * Information about the response.
        */
        @ApiMember(Description="Information about the response.", IsRequired=true)
        public String description = null;

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

        /**
        * 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 Boolean wasSuccessful = null;

        public ResponseStatus responseStatus = null;
        
        public String getDescription() { return description; }
        public ApiServiceResponse setDescription(String value) { this.description = value; return this; }
        public String getHeading() { return heading; }
        public ApiServiceResponse setHeading(String value) { this.heading = value; return this; }
        public Boolean isWasSuccessful() { return wasSuccessful; }
        public ApiServiceResponse setWasSuccessful(Boolean value) { this.wasSuccessful = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public ApiServiceResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java FinishSubmitCompletedUplifts 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 /sync/finishsubmit HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FinishSubmitCompletedUplifts 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>
  <Extra>String</Extra>
  <Failed>
    <UpliftSubmissionResult>
      <Description>String</Description>
      <Step>String</Step>
      <UpliftId>0</UpliftId>
      <WasSuccessful>false</WasSuccessful>
    </UpliftSubmissionResult>
  </Failed>
  <Remaining>0</Remaining>
  <Success>0</Success>
</FinishSubmitCompletedUplifts>
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>