DX STF Client API

SearchSenderPurchaseCondition

Purchase Conditions Requests

Purchase Conditions

The following routes are available for this service:
POST	/api/purchaseCondition/search/sender	Search purchase condition based on search parameters

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using DX.STF.Application.ClientApi.Messages.PurchaseCondition;
using DX.STF.Models.Queries.PurchaseCondition;
using DX.STF.Contracts.Enums;
using DX.STF.Models.Queries.QueryResult;
using DX.Framework.Core.Querying;

namespace DX.Framework.Core.Querying
{
    public partial class PagedQueryResult<T>
    {
        public virtual long StartIndex { get; set; }
        public virtual long EndIndex { get; set; }
        public virtual int NumberOfRecordsReturned { get; set; }
        public virtual int TotalNumberOfPages { get; set; }
        public virtual long TotalNumberOfRecords { get; set; }
        public virtual List<ResultItem<ClaimMessage>> Results { get; set; } = [];
    }

}

namespace DX.STF.Application.ClientApi.Messages.PurchaseCondition
{
    ///<summary>
    ///Purchase Conditions
    ///</summary>
    [Api(Description="Purchase Conditions")]
    [ApiResponse(Description="Paged Purchase data", IsDefaultResponse=true, ResponseType=typeof(DX.STF.Models.Queries.QueryResult.PagedQueryResponseWithToken`1[[DX.Framework.Core.Querying.ResultItem`1[[DX.STF.Models.Dto.GS1.PurchaseConditionsMessage, DX.STF.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], DX.Framework.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]), StatusCode=200)]
    public partial class SearchSenderPurchaseCondition
    {
        ///<summary>
        ///Search query
        ///</summary>
        [ApiMember(Description="Search query", ParameterType="model")]
        public virtual SearchPurchaseConditionByDateFilter Query { get; set; }
    }

}

namespace DX.STF.Contracts.Enums
{
    public enum ORDER
    {
        ASC,
        DESC,
    }

}

namespace DX.STF.Models.Queries.PurchaseCondition
{
    public partial class SearchPurchaseConditionByDateFilter
        : ISearchPurchaseConditionByDateFilter
    {
        public virtual DateTime FromDate { get; set; }
        public virtual DateTime ToDate { get; set; }
        public virtual string ContinuationToken { get; set; }
        public virtual int RequestedPage { get; set; }
        public virtual int NumberOfRecordsPerPage { get; set; }
        public virtual string OrderBy { get; set; }
        public virtual ORDER Order { get; set; }
    }

}

namespace DX.STF.Models.Queries.QueryResult
{
    public partial class PagedQueryResponseWithToken<T>
        : PagedQueryResult<ResultItem<InvoiceMessage>>
    {
        public virtual string ContinuationToken { get; set; }
    }

}

C# SearchSenderPurchaseCondition 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.

POST /api/purchaseCondition/search/sender HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"query":{"continuationToken":"String","requestedPage":0,"numberOfRecordsPerPage":0,"orderBy":"String","order":"ASC"}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"continuationToken":"String","startIndex":0,"endIndex":0,"numberOfRecordsReturned":0,"totalNumberOfPages":0,"totalNumberOfRecords":0,"results":[{}]}