SupplierConnect Gateway API

<back to all web services

ResendScheduleNotification

Resends the notification to supplier for a given SupplierConnect schedule by id. (This will return the same information returned on a create schedule request with only change being the communication id which will be the id of the new notification.)

Requires Authentication
The following routes are available for this service:
POST/api/schedules/{id}/resend
<?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};


class ScheduleResponse implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ReferenceId='',
        /** @var string */
        public string $CommunicationId='',
        /** @var bool|null */
        public ?bool $Success=null,
        /** @var string|null */
        public ?string $Message=null,
        /** @var string|null */
        public ?string $Payload=null
    ) {
    }

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

/** @description Resends the notification to supplier for a given SupplierConnect schedule by id. (This will return the same information returned on a create schedule request with only change being the communication id which will be the id of the new notification.) */
// @Api(Description="Resends the notification to supplier for a given SupplierConnect schedule by id. (This will return the same information returned on a create schedule request with only change being the communication id which will be the id of the new notification.)")
class ResendScheduleNotification implements JsonSerializable
{
    public function __construct(
        /** @description Id of the schedule request to resend the notification for */
        // @DataMember(Name="id")
        // @ApiMember(Description="Id of the schedule request to resend the notification for", IsRequired=true, Name="id")
        /** @var string */
        public string $id=''
    ) {
    }

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

PHP ResendScheduleNotification DTOs

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

HTTP + JSV

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

POST /api/schedules/{id}/resend HTTP/1.1 
Host: production-eros-gateway-api-supplierconnect.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	Message: String,
	Payload: String
}