Antel API

<back to all web services

UpliftHistory

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 class ApiServiceResponse implements IServiceResponse
{
    /** @description Information about the response. */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    public description: string;

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

    /** @description 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 wasSuccessful: boolean;

    public responseStatus: ResponseStatus;

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

export class UpliftHistoryItem
{
    public principleLogo: string;
    public principleName: string;
    public outletName: string;
    public appointmentDate: string;
    public appointmentDateFormatted: string;
    public submittedDate: string;
    public submittedDateFormatted: string;
    public upliftNumber: string;
    public submissionDocument: string;

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

export class UpliftHistoryResponse extends ApiServiceResponse
{
    public upliftHistoryItems: UpliftHistoryItem[];

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

export class UpliftHistory extends ApiServiceRequest
{

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

TypeScript UpliftHistory DTOs

GET /uplift/history HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"upliftHistoryItems":[{}],"description":"String","heading":"String","wasSuccessful":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}