SupplierConnect Gateway API

<back to all web services

CancelScheduleRequest

Creates or Reschedules a SupplierConnect schedule. This will return the id of the schedule request created and the communication id of the notification sent.

Requires Authentication
The following routes are available for this service:
POST/api/schedules/{RequestId}/cancel
import Foundation
import ServiceStack

/**
* Creates or Reschedules a SupplierConnect schedule. This will return the id of the schedule request created and the communication id of the notification sent.
*/
// @Api(Description="Creates or Reschedules a SupplierConnect schedule. This will return the id of the schedule request created and the communication id of the notification sent.")
// @DataContract
public class CancelScheduleRequest : Codable
{
    /**
    * Id of the schedule request to be recreated
    */
    // @DataMember(Name="RequestId")
    // @ApiMember(Description="Id of the schedule request to be recreated", IsRequired=true, Name="RequestId")
    public var RequestId:String

    /**
    * Date/Time of the activity
    */
    // @DataMember(Name="ScheduleDateTime")
    // @ApiMember(Description="Date/Time of the activity", IsRequired=true, Name="ScheduleDateTime")
    // @Required()
    public var ScheduleDateTime:Date?

    // @DataMember(Name="Requester")
    public var Requester:ContactInfo

    // @DataMember(Name="Supplier")
    public var Supplier:ContactInfo

    // @DataMember(Name="Project")
    public var Project:ProjectInfo

    // @DataMember(Name="PurchaseOrder")
    public var PurchaseOrder:PurchaseOrderInfo

    // @DataMember(Name="Activity")
    public var Activity:ActivityReference

    // @DataMember(Name="Params")
    public var Params:[ScheduleParams]

    // @DataMember(Name="Attachments")
    public var Attachments:[EmailAttachment]

    required public init(){}
}

// @DataContract
public class ContactInfo : Codable
{
    // @DataMember(Name="Id")
    public var Id:String

    // @DataMember(Name="Name")
    public var Name:String

    // @DataMember(Name="Email")
    public var Email:String

    // @DataMember(Name="Phone")
    public var Phone:String

    // @DataMember(Name="ContactReference")
    public var ContactReference:ObjectReference

    required public init(){}
}

// @DataContract
public class ObjectReference : Codable
{
    // @DataMember(Name="RmsTableContextId")
    public var RmsTableContextId:String

    // @DataMember(Name="AlternateKey")
    public var AlternateKey:String

    // @DataMember(Name="DataSourceInstanceId")
    public var DataSourceInstanceId:String

    required public init(){}
}

// @DataContract
public class ProjectInfo : Codable
{
    // @DataMember(Name="Id")
    public var Id:String

    // @DataMember(Name="Name")
    public var Name:String

    // @DataMember(Name="Reference")
    public var Reference:String

    // @DataMember(Name="Description")
    public var Description:String

    // @DataMember(Name="Address")
    public var Address:String

    // @DataMember(Name="HouseType")
    public var HouseType:String

    // @DataMember(Name="Elevation")
    public var Elevation:String

    // @DataMember(Name="CustomerName")
    public var CustomerName:String

    // @DataMember(Name="Supervisor")
    public var Supervisor:ContactInfo

    // @DataMember(Name="ProjectReference")
    public var ProjectReference:ObjectReference

    required public init(){}
}

// @DataContract
public class PurchaseOrderInfo : Codable
{
    // @DataMember(Name="Id")
    public var Id:String

    // @DataMember(Name="Reference")
    public var Reference:String

    // @DataMember(Name="Description")
    public var Description:String

    // @DataMember(Name="PurchaseOrderReference")
    public var PurchaseOrderReference:ObjectReference

    required public init(){}
}

// @DataContract
public class ActivityReference : Codable
{
    /**
    * Name/details of the activity
    */
    // @DataMember(Name="name")
    // @ApiMember(Description="Name/details of the activity", IsRequired=true, Name="Name")
    public var name:String

    // @DataMember(Name="notes")
    public var notes:String

    required public init(){}
}

// @DataContract
public class ScheduleParams : Codable
{
    // @DataMember(Name="Name")
    public var Name:String

    // @DataMember(Name="Value")
    public var Value:String

    required public init(){}
}

public class EmailAttachment : Codable
{
    public var fileName:String
    public var contentType:String
    public var path:String
    public var url:String
    public var length:Int
    public var fileStream:Data
    public var streamContent:String
    public var attachmentType:AttachmentType
    public var processedAndUploadedAsBlob:Bool

    required public init(){}
}

public enum AttachmentType : String, Codable
{
    case Url
    case FileStream
}

public class ScheduleResponse : Codable
{
    public var referenceId:String
    public var communicationId:String
    public var success:Bool
    public var message:String
    public var payload:String

    required public init(){}
}

Swift CancelScheduleRequest 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/{RequestId}/cancel HTTP/1.1 
Host: production-eros-gateway-api-supplierconnect.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ScheduleDateTime: 0001-01-01,
	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,
		CustomerName: String,
		Supervisor: 
		{
			Name: String,
			Email: String,
			Phone: String,
			ContactReference: 
			{
				AlternateKey: 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
		}
	]
}

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

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