Antel API

<back to all web services

UpliftAction

Requires Authentication
The following routes are available for this service:
POST/uplift/action

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

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

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

    public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}

export enum UpliftScheduleAction
{
    Confirm = 0,
    Cancel = 1,
}

export class UpliftAction extends ApiServiceRequest
{
    public id: number;
    public action: UpliftScheduleAction;

    public constructor(init?: Partial<UpliftAction>) { super(init); (Object as any).assign(this, init); }
}

TypeScript UpliftAction 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/action HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpliftAction 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>
  <Action>Confirm</Action>
  <Id>0</Id>
</UpliftAction>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ApiServiceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">
  <ApiKey>String</ApiKey>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
</ApiServiceRequest>