DX STF Client API

<back to all web services

ResetExported

Order Requests

Order

Requires Authentication
The following routes are available for this service:
PUT/api/order/{OrderId}/resetUpdate order and mark as available
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


/** @description Order */
// @Api(Description="Order")
// @ApiResponse(Description="Order exported flag reset", StatusCode=204)
class ResetExported implements JsonSerializable
{
    public function __construct(
        /** @description Order ID or Token */
        // @ApiMember(Description="Order ID or Token", ExcludeInSchema=true, ParameterType="path")
        /** @var string */
        public string $orderId=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['orderId'])) $this->orderId = $o['orderId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->orderId)) $o['orderId'] = $this->orderId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP ResetExported 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.

PUT /api/order/{OrderId}/reset HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ResetExported xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Application.ClientApi.Messages.Order">
  <OrderId>00000000-0000-0000-0000-000000000000</OrderId>
</ResetExported>