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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports DX.STF.Application.ClientApi.Messages.Order

Namespace Global

    Namespace DX.STF.Application.ClientApi.Messages.Order

        '''<Summary>
        '''Order
        '''</Summary>
        <Api(Description:="Order")>
        <ApiResponse(Description:="Order exported flag reset", StatusCode:=204)>
        Public Partial Class ResetExported
            '''<Summary>
            '''Order ID or Token
            '''</Summary>
            <ApiMember(Description:="Order ID or Token", ExcludeInSchema:=true, ParameterType:="path")>
            Public Overridable Property OrderId As Guid
        End Class
    End Namespace
End Namespace

VB.NET 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>