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.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Dvaravartman.SupplierConnect.Model.APIModels;
using Eros.Saguna.Common.Library;

namespace Eros.Saguna.Common.Library
{
    public enum AttachmentType
    {
        Url,
        FileStream,
    }

    public partial class EmailAttachment
    {
        public virtual string FileName { get; set; }
        public virtual string ContentType { get; set; }
        public virtual string Path { get; set; }
        public virtual string Url { get; set; }
        public virtual long Length { get; set; }
        public virtual Stream FileStream { get; set; }
        public virtual string StreamContent { get; set; }
        public virtual AttachmentType AttachmentType { get; set; }
        public virtual bool ProcessedAndUploadedAsBlob { get; set; }
    }

}

namespace Eros.Subtle.Dvaravartman.SupplierConnect.Model.APIModels
{
    [DataContract]
    public partial class ActivityReference
    {
        ///<summary>
        ///Name/details of the activity
        ///</summary>
        [DataMember(Name="name")]
        [ApiMember(Description="Name/details of the activity", IsRequired=true, Name="Name")]
        public virtual string Name { get; set; }

        [DataMember(Name="notes")]
        public virtual string Notes { get; set; }
    }

    ///<summary>
    ///Creates or Reschedules a SupplierConnect schedule. This will return the id of the schedule request created and the communication id of the notification sent.
    ///</summary>
    [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 partial class CancelScheduleRequest
    {
        ///<summary>
        ///Id of the schedule request to be recreated
        ///</summary>
        [DataMember(Name="RequestId")]
        [ApiMember(Description="Id of the schedule request to be recreated", IsRequired=true, Name="RequestId")]
        public virtual Guid RequestId { get; set; }

        ///<summary>
        ///Date/Time of the activity
        ///</summary>
        [DataMember(Name="ScheduleDateTime")]
        [ApiMember(Description="Date/Time of the activity", IsRequired=true, Name="ScheduleDateTime")]
        [Required]
        public virtual DateTime ScheduleDateTime { get; set; }

        [DataMember(Name="Requester")]
        public virtual ContactInfo Requester { get; set; }

        [DataMember(Name="Supplier")]
        public virtual ContactInfo Supplier { get; set; }

        [DataMember(Name="Project")]
        public virtual ProjectInfo Project { get; set; }

        [DataMember(Name="PurchaseOrder")]
        public virtual PurchaseOrderInfo PurchaseOrder { get; set; }

        [DataMember(Name="Activity")]
        public virtual ActivityReference Activity { get; set; }

        [DataMember(Name="Params")]
        public virtual List<ScheduleParams> Params { get; set; }

        [DataMember(Name="Attachments")]
        public virtual List<EmailAttachment> Attachments { get; set; }
    }

    [DataContract]
    public partial class ContactInfo
    {
        [DataMember(Name="Id")]
        public virtual Guid Id { get; set; }

        [DataMember(Name="Name")]
        public virtual string Name { get; set; }

        [DataMember(Name="Email")]
        public virtual string Email { get; set; }

        [DataMember(Name="Phone")]
        public virtual string Phone { get; set; }

        [DataMember(Name="ContactReference")]
        public virtual ObjectReference ContactReference { get; set; }
    }

    [DataContract]
    public partial class ObjectReference
    {
        [DataMember(Name="RmsTableContextId")]
        public virtual Guid RmsTableContextId { get; set; }

        [DataMember(Name="AlternateKey")]
        public virtual string AlternateKey { get; set; }

        [DataMember(Name="DataSourceInstanceId")]
        public virtual Guid DataSourceInstanceId { get; set; }
    }

    [DataContract]
    public partial class ProjectInfo
    {
        [DataMember(Name="Id")]
        public virtual Guid Id { get; set; }

        [DataMember(Name="Name")]
        public virtual string Name { get; set; }

        [DataMember(Name="Reference")]
        public virtual string Reference { get; set; }

        [DataMember(Name="Description")]
        public virtual string Description { get; set; }

        [DataMember(Name="Address")]
        public virtual string Address { get; set; }

        [DataMember(Name="HouseType")]
        public virtual string HouseType { get; set; }

        [DataMember(Name="Elevation")]
        public virtual string Elevation { get; set; }

        [DataMember(Name="CustomerName")]
        public virtual string CustomerName { get; set; }

        [DataMember(Name="Supervisor")]
        public virtual ContactInfo Supervisor { get; set; }

        [DataMember(Name="ProjectReference")]
        public virtual ObjectReference ProjectReference { get; set; }
    }

    [DataContract]
    public partial class PurchaseOrderInfo
    {
        [DataMember(Name="Id")]
        public virtual Guid Id { get; set; }

        [DataMember(Name="Reference")]
        public virtual string Reference { get; set; }

        [DataMember(Name="Description")]
        public virtual string Description { get; set; }

        [DataMember(Name="PurchaseOrderReference")]
        public virtual ObjectReference PurchaseOrderReference { get; set; }
    }

    [DataContract]
    public partial class ScheduleParams
    {
        [DataMember(Name="Name")]
        public virtual string Name { get; set; }

        [DataMember(Name="Value")]
        public virtual string Value { get; set; }
    }

    public partial class ScheduleResponse
    {
        public virtual Guid ReferenceId { get; set; }
        public virtual Guid CommunicationId { get; set; }
        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
        public virtual string Payload { get; set; }
    }

}

C# CancelScheduleRequest DTOs

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
}