| PUT | /api/receivingAdvice/{ReceivingAdviceId}/processed | Update 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.*;
public class dtos
{
/**
* Receiving Advice
*/
@Api(Description="Receiving Advice")
@ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType=TokenDto.class, StatusCode=202)
public static class UpdateReceivingAdviceClientProcessed
{
/**
* ReceivingAdvice ID or Token
*/
@ApiMember(Description="ReceivingAdvice ID or Token", ExcludeInSchema=true, ParameterType="path")
public UUID receivingAdviceId = null;
/**
* Customer ReceivingAdvice reference in destination system
*/
@ApiMember(Description="Customer ReceivingAdvice reference in destination system")
public String customerReference = null;
/**
* Date and Time ReceivingAdvice was processed in destination system
*/
@ApiMember(Description="Date and Time ReceivingAdvice was processed in destination system")
public Date customerProcessedDate = null;
public UUID getReceivingAdviceId() { return receivingAdviceId; }
public UpdateReceivingAdviceClientProcessed setReceivingAdviceId(UUID value) { this.receivingAdviceId = value; return this; }
public String getCustomerReference() { return customerReference; }
public UpdateReceivingAdviceClientProcessed setCustomerReference(String value) { this.customerReference = value; return this; }
public Date getCustomerProcessedDate() { return customerProcessedDate; }
public UpdateReceivingAdviceClientProcessed 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 UpdateReceivingAdviceClientProcessed DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
customerReference: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
}