| GET | /api/schedules | ||
|---|---|---|---|
| GET | /api/schedules/{Ids} |
<?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 SupplierConnectObjectReference implements JsonSerializable
{
public function __construct(
/** @var string */
public string $RmsTableContextId='',
/** @var string|null */
public ?string $AlternateKey=null,
/** @var string */
public string $DataSourceInstanceId=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['RmsTableContextId'])) $this->RmsTableContextId = $o['RmsTableContextId'];
if (isset($o['AlternateKey'])) $this->AlternateKey = $o['AlternateKey'];
if (isset($o['DataSourceInstanceId'])) $this->DataSourceInstanceId = $o['DataSourceInstanceId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->RmsTableContextId)) $o['RmsTableContextId'] = $this->RmsTableContextId;
if (isset($this->AlternateKey)) $o['AlternateKey'] = $this->AlternateKey;
if (isset($this->DataSourceInstanceId)) $o['DataSourceInstanceId'] = $this->DataSourceInstanceId;
return empty($o) ? new class(){} : $o;
}
}
class SupplierConnectContactInfo implements JsonSerializable
{
public function __construct(
/** @var string */
public string $Id='',
/** @var string|null */
public ?string $Name=null,
/** @var string|null */
public ?string $Email=null,
/** @var string|null */
public ?string $Phone=null,
/** @var SupplierConnectObjectReference|null */
public ?SupplierConnectObjectReference $ContactReference=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Email'])) $this->Email = $o['Email'];
if (isset($o['Phone'])) $this->Phone = $o['Phone'];
if (isset($o['ContactReference'])) $this->ContactReference = JsonConverters::from('SupplierConnectObjectReference', $o['ContactReference']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Email)) $o['Email'] = $this->Email;
if (isset($this->Phone)) $o['Phone'] = $this->Phone;
if (isset($this->ContactReference)) $o['ContactReference'] = JsonConverters::to('SupplierConnectObjectReference', $this->ContactReference);
return empty($o) ? new class(){} : $o;
}
}
class SupplierConnectProjectInfo implements JsonSerializable
{
public function __construct(
/** @var string */
public string $Id='',
/** @var string|null */
public ?string $Name=null,
/** @var string|null */
public ?string $Reference=null,
/** @var string|null */
public ?string $Description=null,
/** @var string|null */
public ?string $Address=null,
/** @var string|null */
public ?string $HouseType=null,
/** @var string|null */
public ?string $Elevation=null,
/** @var SupplierConnectContactInfo|null */
public ?SupplierConnectContactInfo $Supervisor=null,
/** @var string|null */
public ?string $CustomerName=null,
/** @var SupplierConnectObjectReference|null */
public ?SupplierConnectObjectReference $ProjectReference=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Reference'])) $this->Reference = $o['Reference'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['Address'])) $this->Address = $o['Address'];
if (isset($o['HouseType'])) $this->HouseType = $o['HouseType'];
if (isset($o['Elevation'])) $this->Elevation = $o['Elevation'];
if (isset($o['Supervisor'])) $this->Supervisor = JsonConverters::from('SupplierConnectContactInfo', $o['Supervisor']);
if (isset($o['CustomerName'])) $this->CustomerName = $o['CustomerName'];
if (isset($o['ProjectReference'])) $this->ProjectReference = JsonConverters::from('SupplierConnectObjectReference', $o['ProjectReference']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Reference)) $o['Reference'] = $this->Reference;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->Address)) $o['Address'] = $this->Address;
if (isset($this->HouseType)) $o['HouseType'] = $this->HouseType;
if (isset($this->Elevation)) $o['Elevation'] = $this->Elevation;
if (isset($this->Supervisor)) $o['Supervisor'] = JsonConverters::to('SupplierConnectContactInfo', $this->Supervisor);
if (isset($this->CustomerName)) $o['CustomerName'] = $this->CustomerName;
if (isset($this->ProjectReference)) $o['ProjectReference'] = JsonConverters::to('SupplierConnectObjectReference', $this->ProjectReference);
return empty($o) ? new class(){} : $o;
}
}
class SupplierConnectPurchaseOrderInfo implements JsonSerializable
{
public function __construct(
/** @var string */
public string $Id='',
/** @var string|null */
public ?string $Reference=null,
/** @var string|null */
public ?string $Description=null,
/** @var string */
public string $ProjectId='',
/** @var SupplierConnectObjectReference|null */
public ?SupplierConnectObjectReference $PurchaseOrderReference=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Reference'])) $this->Reference = $o['Reference'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['ProjectId'])) $this->ProjectId = $o['ProjectId'];
if (isset($o['PurchaseOrderReference'])) $this->PurchaseOrderReference = JsonConverters::from('SupplierConnectObjectReference', $o['PurchaseOrderReference']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Reference)) $o['Reference'] = $this->Reference;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->ProjectId)) $o['ProjectId'] = $this->ProjectId;
if (isset($this->PurchaseOrderReference)) $o['PurchaseOrderReference'] = JsonConverters::to('SupplierConnectObjectReference', $this->PurchaseOrderReference);
return empty($o) ? new class(){} : $o;
}
}
class SupplierConnectActivityReference implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Name=null,
/** @var string|null */
public ?string $Notes=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Notes'])) $this->Notes = $o['Notes'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Notes)) $o['Notes'] = $this->Notes;
return empty($o) ? new class(){} : $o;
}
}
class SupplierConnectScheduleParams implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $Name=null,
/** @var string|null */
public ?string $Value=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Value'])) $this->Value = $o['Value'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Value)) $o['Value'] = $this->Value;
return empty($o) ? new class(){} : $o;
}
}
enum AttachmentType : string
{
case Url = 'Url';
case FileStream = 'FileStream';
}
class EmailAttachment implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $FileName=null,
/** @var string|null */
public ?string $ContentType=null,
/** @var string|null */
public ?string $Path=null,
/** @var string|null */
public ?string $Url=null,
/** @var int */
public int $Length=0,
/** @var ByteArray|null */
public ?ByteArray $FileStream=null,
/** @var string|null */
public ?string $StreamContent=null,
/** @var AttachmentType|null */
public ?AttachmentType $AttachmentType=null,
/** @var bool|null */
public ?bool $ProcessedAndUploadedAsBlob=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['FileName'])) $this->FileName = $o['FileName'];
if (isset($o['ContentType'])) $this->ContentType = $o['ContentType'];
if (isset($o['Path'])) $this->Path = $o['Path'];
if (isset($o['Url'])) $this->Url = $o['Url'];
if (isset($o['Length'])) $this->Length = $o['Length'];
if (isset($o['FileStream'])) $this->FileStream = JsonConverters::from('ByteArray', $o['FileStream']);
if (isset($o['StreamContent'])) $this->StreamContent = $o['StreamContent'];
if (isset($o['AttachmentType'])) $this->AttachmentType = JsonConverters::from('AttachmentType', $o['AttachmentType']);
if (isset($o['ProcessedAndUploadedAsBlob'])) $this->ProcessedAndUploadedAsBlob = $o['ProcessedAndUploadedAsBlob'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->FileName)) $o['FileName'] = $this->FileName;
if (isset($this->ContentType)) $o['ContentType'] = $this->ContentType;
if (isset($this->Path)) $o['Path'] = $this->Path;
if (isset($this->Url)) $o['Url'] = $this->Url;
if (isset($this->Length)) $o['Length'] = $this->Length;
if (isset($this->FileStream)) $o['FileStream'] = JsonConverters::to('ByteArray', $this->FileStream);
if (isset($this->StreamContent)) $o['StreamContent'] = $this->StreamContent;
if (isset($this->AttachmentType)) $o['AttachmentType'] = JsonConverters::to('AttachmentType', $this->AttachmentType);
if (isset($this->ProcessedAndUploadedAsBlob)) $o['ProcessedAndUploadedAsBlob'] = $this->ProcessedAndUploadedAsBlob;
return empty($o) ? new class(){} : $o;
}
}
class SupplierConnectSchedule implements JsonSerializable
{
public function __construct(
/** @var string */
public string $RequestId='',
/** @var string */
public string $PreviousRequestId='',
/** @var string */
public string $LicenseeId='',
/** @var string|null */
public ?string $LicenseeName=null,
/** @var DateTime */
public DateTime $ScheduleDateTime=new DateTime(),
/** @var SupplierConnectContactInfo|null */
public ?SupplierConnectContactInfo $Requester=null,
/** @var SupplierConnectContactInfo|null */
public ?SupplierConnectContactInfo $Supplier=null,
/** @var SupplierConnectProjectInfo|null */
public ?SupplierConnectProjectInfo $Project=null,
/** @var SupplierConnectPurchaseOrderInfo|null */
public ?SupplierConnectPurchaseOrderInfo $PurchaseOrder=null,
/** @var SupplierConnectActivityReference|null */
public ?SupplierConnectActivityReference $Activity=null,
/** @var array<SupplierConnectScheduleParams>|null */
public ?array $Params=null,
/** @var array<EmailAttachment>|null */
public ?array $Attachments=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['RequestId'])) $this->RequestId = $o['RequestId'];
if (isset($o['PreviousRequestId'])) $this->PreviousRequestId = $o['PreviousRequestId'];
if (isset($o['LicenseeId'])) $this->LicenseeId = $o['LicenseeId'];
if (isset($o['LicenseeName'])) $this->LicenseeName = $o['LicenseeName'];
if (isset($o['ScheduleDateTime'])) $this->ScheduleDateTime = JsonConverters::from('DateTime', $o['ScheduleDateTime']);
if (isset($o['Requester'])) $this->Requester = JsonConverters::from('SupplierConnectContactInfo', $o['Requester']);
if (isset($o['Supplier'])) $this->Supplier = JsonConverters::from('SupplierConnectContactInfo', $o['Supplier']);
if (isset($o['Project'])) $this->Project = JsonConverters::from('SupplierConnectProjectInfo', $o['Project']);
if (isset($o['PurchaseOrder'])) $this->PurchaseOrder = JsonConverters::from('SupplierConnectPurchaseOrderInfo', $o['PurchaseOrder']);
if (isset($o['Activity'])) $this->Activity = JsonConverters::from('SupplierConnectActivityReference', $o['Activity']);
if (isset($o['Params'])) $this->Params = JsonConverters::fromArray('SupplierConnectScheduleParams', $o['Params']);
if (isset($o['Attachments'])) $this->Attachments = JsonConverters::fromArray('EmailAttachment', $o['Attachments']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->RequestId)) $o['RequestId'] = $this->RequestId;
if (isset($this->PreviousRequestId)) $o['PreviousRequestId'] = $this->PreviousRequestId;
if (isset($this->LicenseeId)) $o['LicenseeId'] = $this->LicenseeId;
if (isset($this->LicenseeName)) $o['LicenseeName'] = $this->LicenseeName;
if (isset($this->ScheduleDateTime)) $o['ScheduleDateTime'] = JsonConverters::to('DateTime', $this->ScheduleDateTime);
if (isset($this->Requester)) $o['Requester'] = JsonConverters::to('SupplierConnectContactInfo', $this->Requester);
if (isset($this->Supplier)) $o['Supplier'] = JsonConverters::to('SupplierConnectContactInfo', $this->Supplier);
if (isset($this->Project)) $o['Project'] = JsonConverters::to('SupplierConnectProjectInfo', $this->Project);
if (isset($this->PurchaseOrder)) $o['PurchaseOrder'] = JsonConverters::to('SupplierConnectPurchaseOrderInfo', $this->PurchaseOrder);
if (isset($this->Activity)) $o['Activity'] = JsonConverters::to('SupplierConnectActivityReference', $this->Activity);
if (isset($this->Params)) $o['Params'] = JsonConverters::toArray('SupplierConnectScheduleParams', $this->Params);
if (isset($this->Attachments)) $o['Attachments'] = JsonConverters::toArray('EmailAttachment', $this->Attachments);
return empty($o) ? new class(){} : $o;
}
}
class ScheduleDetails extends SupplierConnectSchedule implements JsonSerializable
{
/**
* @param string $RequestId
* @param string $PreviousRequestId
* @param string $LicenseeId
* @param string|null $LicenseeName
* @param DateTime $ScheduleDateTime
* @param SupplierConnectContactInfo|null $Requester
* @param SupplierConnectContactInfo|null $Supplier
* @param SupplierConnectProjectInfo|null $Project
* @param SupplierConnectPurchaseOrderInfo|null $PurchaseOrder
* @param SupplierConnectActivityReference|null $Activity
* @param array<SupplierConnectScheduleParams>|null $Params
* @param array<EmailAttachment>|null $Attachments
*/
public function __construct(
string $RequestId='',
string $PreviousRequestId='',
string $LicenseeId='',
?string $LicenseeName=null,
DateTime $ScheduleDateTime=new DateTime(),
?SupplierConnectContactInfo $Requester=null,
?SupplierConnectContactInfo $Supplier=null,
?SupplierConnectProjectInfo $Project=null,
?SupplierConnectPurchaseOrderInfo $PurchaseOrder=null,
?SupplierConnectActivityReference $Activity=null,
?array $Params=null,
?array $Attachments=null,
/** @var string */
public string $ReferenceId='',
/** @var int */
public int $Index=0,
/** @var string */
public string $StatusId='',
/** @var string|null */
public ?string $Status=null,
/** @var string|null */
public ?string $StatusMessage=null,
/** @var string|null */
public ?string $RequestedBy=null,
/** @var DateTime|null */
public ?DateTime $RequestedDate=null,
/** @var string */
public string $CommunicationId=''
) {
parent::__construct($RequestId,$PreviousRequestId,$LicenseeId,$LicenseeName,$ScheduleDateTime,$Requester,$Supplier,$Project,$PurchaseOrder,$Activity,$Params,$Attachments);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['ReferenceId'])) $this->ReferenceId = $o['ReferenceId'];
if (isset($o['Index'])) $this->Index = $o['Index'];
if (isset($o['StatusId'])) $this->StatusId = $o['StatusId'];
if (isset($o['Status'])) $this->Status = $o['Status'];
if (isset($o['StatusMessage'])) $this->StatusMessage = $o['StatusMessage'];
if (isset($o['RequestedBy'])) $this->RequestedBy = $o['RequestedBy'];
if (isset($o['RequestedDate'])) $this->RequestedDate = JsonConverters::from('DateTime', $o['RequestedDate']);
if (isset($o['CommunicationId'])) $this->CommunicationId = $o['CommunicationId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->ReferenceId)) $o['ReferenceId'] = $this->ReferenceId;
if (isset($this->Index)) $o['Index'] = $this->Index;
if (isset($this->StatusId)) $o['StatusId'] = $this->StatusId;
if (isset($this->Status)) $o['Status'] = $this->Status;
if (isset($this->StatusMessage)) $o['StatusMessage'] = $this->StatusMessage;
if (isset($this->RequestedBy)) $o['RequestedBy'] = $this->RequestedBy;
if (isset($this->RequestedDate)) $o['RequestedDate'] = JsonConverters::to('DateTime', $this->RequestedDate);
if (isset($this->CommunicationId)) $o['CommunicationId'] = $this->CommunicationId;
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="Returns the list of the schedule requests for the given list of Ids")
class GetSchedulesResponse implements JsonSerializable
{
public function __construct(
/** @var bool|null */
public ?bool $Success=null,
/** @var string|null */
public ?string $Message=null,
/** @var array<ScheduleDetails>|null */
public ?array $ScheduleRequests=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var string|null */
public ?string $LastRowVersion=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Success'])) $this->Success = $o['Success'];
if (isset($o['Message'])) $this->Message = $o['Message'];
if (isset($o['ScheduleRequests'])) $this->ScheduleRequests = JsonConverters::fromArray('ScheduleDetails', $o['ScheduleRequests']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['LastRowVersion'])) $this->LastRowVersion = $o['LastRowVersion'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Success)) $o['Success'] = $this->Success;
if (isset($this->Message)) $o['Message'] = $this->Message;
if (isset($this->ScheduleRequests)) $o['ScheduleRequests'] = JsonConverters::toArray('ScheduleDetails', $this->ScheduleRequests);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->LastRowVersion)) $o['LastRowVersion'] = $this->LastRowVersion;
return empty($o) ? new class(){} : $o;
}
}
/** @description Retrieve SupplierConnect schedule(s) by given ids. This will return SupplierConnect schedule request(s), and the associated other details such as statuses */
// @Api(Description="Retrieve SupplierConnect schedule(s) by given ids. This will return SupplierConnect schedule request(s), and the associated other details such as statuses")
class GetSchedules implements JsonSerializable
{
public function __construct(
/** @description Id or list of Ids of the schedule request(s) to be retrieved */
// @DataMember(Name="id")
// @ApiMember(Description="Id or list of Ids of the schedule request(s) to be retrieved", IsRequired=true, Name="id")
/** @var array<string>|null */
public ?array $id=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = JsonConverters::fromArray('Guid', $o['id']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = JsonConverters::toArray('Guid', $this->id);
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/schedules HTTP/1.1 Host: production-eros-gateway-api-supplierconnect.azurewebsites.net Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Success":false,"Message":"String","ScheduleRequests":[{"Index":0,"Status":"String","StatusMessage":"String","RequestedBy":"String","RequestedDate":"0001-01-01T00:00:00.0000000","LicenseeName":"String","ScheduleDateTime":"0001-01-01T00:00:00.0000000","Requester":{"Name":"String","Email":"String","Phone":"String","ContactReference":{"AlternateKey":"String"}},"Supplier":{"Name":"String","Email":"String","Phone":"String","ContactReference":{"AlternateKey":"String"}},"Project":{"Name":"String","Reference":"String","Description":"String","Address":"String","HouseType":"String","Elevation":"String","Supervisor":{"Name":"String","Email":"String","Phone":"String","ContactReference":{"AlternateKey":"String"}},"CustomerName":"String","ProjectReference":{"AlternateKey":"String"}},"PurchaseOrder":{"Reference":"String","Description":"String","PurchaseOrderReference":{"AlternateKey":"String"}},"Activity":{"Name":"String","Notes":"String"},"Params":[{"Name":"String","Value":"String"}],"Attachments":[{"FileName":"String","ContentType":"String","Path":"String","Url":"String","Length":0,"StreamContent":"String","AttachmentType":"Url","ProcessedAndUploadedAsBlob":false}]}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"LastRowVersion":"String"}