DX STF Client API

<back to all web services

AcknowledgeReceivingAdvice

Receiving Advice Requests

Receiving Advice

Requires Authentication
The following routes are available for this service:
PUT/api/receivingAdvice/{ReceivingAdviceId}/acknowledgeAcknowledge ReceivingAdvice as received
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


/** @description Receiving Advice */
// @Api(Description="Receiving Advice")
// @ApiResponse(Description="Updated", IsDefaultResponse=true, StatusCode=204)
// @ApiResponse(Description="GLN does not have required access", StatusCode=403)
// @ApiResponse(Description="Document not found", StatusCode=404)
class AcknowledgeReceivingAdvice implements JsonSerializable
{
    public function __construct(
        // @ApiMember(ExcludeInSchema=true, ParameterType="path")
        /** @var string */
        public string $receivingAdviceId=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['receivingAdviceId'])) $this->receivingAdviceId = $o['receivingAdviceId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->receivingAdviceId)) $o['receivingAdviceId'] = $this->receivingAdviceId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP AcknowledgeReceivingAdvice 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}/acknowledge HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{}