DX STF Client API

AcknowledgeOrderResponse

Order Response Requests

Order Response

The following routes are available for this service:
PUT	/api/orderResponse/{OrderResponseId}/acknowledge	Acknowledge OrderResponse as received

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')


# @Api(Description="Order Response")
# @ApiResponse(Description="Updated", IsDefaultResponse=true, StatusCode=204)
# @ApiResponse(Description="GLN does not have required access", StatusCode=403)
# @ApiResponse(Description="Document not found", StatusCode=404)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AcknowledgeOrderResponse:
    """
    Order Response
    """

    # @ApiMember(ExcludeInSchema=true, ParameterType="path")
    order_response_id: Optional[str] = None

Python AcknowledgeOrderResponse DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /api/orderResponse/{OrderResponseId}/acknowledge HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: application/json
Content-Type: application/json
Content-Length: length

{}