DX STF Client API

UpdatePurchaseConditionClientProcessed

Purchase Conditions Requests

Purchase Conditions

The following routes are available for this service:
PUT	/api/purchaseCondition/{PurchaseConditionId}/processed	Update Purchase Condition as customer processed, will also acknowledge Purchase Condition if not yet set.

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Purchase Conditions
    */
    @Api(Description="Purchase Conditions")
    @ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType=TokenDto.class, StatusCode=202)
    public static class UpdatePurchaseConditionClientProcessed
    {
        /**
        * PurchaseCondition ID or Token
        */
        @ApiMember(Description="PurchaseCondition ID or Token", ExcludeInSchema=true, ParameterType="path")
        public UUID purchaseConditionId = null;

        /**
        * Customer Purchase Condition reference in destination system
        */
        @ApiMember(Description="Customer Purchase Condition reference in destination system")
        public String customerReference = null;

        /**
        * Date and Time Purchase Condition was processed in destination system
        */
        @ApiMember(Description="Date and Time Purchase Condition was processed in destination system")
        public Date customerProcessedDate = null;
        
        public UUID getPurchaseConditionId() { return purchaseConditionId; }
        public UpdatePurchaseConditionClientProcessed setPurchaseConditionId(UUID value) { this.purchaseConditionId = value; return this; }
        public String getCustomerReference() { return customerReference; }
        public UpdatePurchaseConditionClientProcessed setCustomerReference(String value) { this.customerReference = value; return this; }
        public Date getCustomerProcessedDate() { return customerProcessedDate; }
        public UpdatePurchaseConditionClientProcessed setCustomerProcessedDate(Date value) { this.customerProcessedDate = value; return this; }
    }

    public static class TokenDto implements ICommandResponse
    {
        public UUID token = null;
        
        public UUID getToken() { return token; }
        public TokenDto setToken(UUID value) { this.token = value; return this; }
    }

}

Java UpdatePurchaseConditionClientProcessed DTOs

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

HTTP + CSV

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

PUT /api/purchaseCondition/{PurchaseConditionId}/processed HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"customerReference":"String"}

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

{}