DX STF Client API

<back to all web services

UpdateReceivingAdviceClientProcessed

Receiving Advice Requests

Receiving Advice

Requires Authentication
The following routes are available for this service:
PUT/api/receivingAdvice/{ReceivingAdviceId}/processedUpdate ReceivingAdvice as customer processed, will also acknowledge ReceivingAdvice if not yet set.
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Receiving Advice
*/
@Api(Description="Receiving Advice")
@ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType=TokenDto::class, StatusCode=202)
open class UpdateReceivingAdviceClientProcessed
{
    /**
    * ReceivingAdvice ID or Token
    */
    @ApiMember(Description="ReceivingAdvice ID or Token", ExcludeInSchema=true, ParameterType="path")
    open var receivingAdviceId:UUID? = null

    /**
    * Customer ReceivingAdvice reference in destination system
    */
    @ApiMember(Description="Customer ReceivingAdvice reference in destination system")
    open var customerReference:String? = null

    /**
    * Date and Time ReceivingAdvice was processed in destination system
    */
    @ApiMember(Description="Date and Time ReceivingAdvice was processed in destination system")
    open var customerProcessedDate:Date? = null
}

open class TokenDto : ICommandResponse
{
    open var token:UUID? = null
}

Kotlin UpdateReceivingAdviceClientProcessed DTOs

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

HTTP + OTHER

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

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

{"customerReference":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{}