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
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

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CancelScheduleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Dvaravartman.SupplierConnect.Model.APIModels">
  <Activity>
    <name>String</name>
    <notes>String</notes>
  </Activity>
  <Attachments xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.Library">
    <d2p1:EmailAttachment>
      <d2p1:AttachmentType>Url</d2p1:AttachmentType>
      <d2p1:ContentType>String</d2p1:ContentType>
      <d2p1:FileName>String</d2p1:FileName>
      <d2p1:FileStream xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
      <d2p1:Length>0</d2p1:Length>
      <d2p1:Path>String</d2p1:Path>
      <d2p1:ProcessedAndUploadedAsBlob>false</d2p1:ProcessedAndUploadedAsBlob>
      <d2p1:StreamContent>String</d2p1:StreamContent>
      <d2p1:Url>String</d2p1:Url>
    </d2p1:EmailAttachment>
  </Attachments>
  <Params>
    <ScheduleParams>
      <Name>String</Name>
      <Value>String</Value>
    </ScheduleParams>
  </Params>
  <Project>
    <Address>String</Address>
    <CustomerName>String</CustomerName>
    <Description>String</Description>
    <Elevation>String</Elevation>
    <HouseType>String</HouseType>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <Name>String</Name>
    <ProjectReference>
      <AlternateKey>String</AlternateKey>
      <DataSourceInstanceId>00000000-0000-0000-0000-000000000000</DataSourceInstanceId>
      <RmsTableContextId>00000000-0000-0000-0000-000000000000</RmsTableContextId>
    </ProjectReference>
    <Reference>String</Reference>
    <Supervisor>
      <ContactReference>
        <AlternateKey>String</AlternateKey>
        <DataSourceInstanceId>00000000-0000-0000-0000-000000000000</DataSourceInstanceId>
        <RmsTableContextId>00000000-0000-0000-0000-000000000000</RmsTableContextId>
      </ContactReference>
      <Email>String</Email>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <Name>String</Name>
      <Phone>String</Phone>
    </Supervisor>
  </Project>
  <PurchaseOrder>
    <Description>String</Description>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <PurchaseOrderReference>
      <AlternateKey>String</AlternateKey>
      <DataSourceInstanceId>00000000-0000-0000-0000-000000000000</DataSourceInstanceId>
      <RmsTableContextId>00000000-0000-0000-0000-000000000000</RmsTableContextId>
    </PurchaseOrderReference>
    <Reference>String</Reference>
  </PurchaseOrder>
  <RequestId>00000000-0000-0000-0000-000000000000</RequestId>
  <Requester>
    <ContactReference>
      <AlternateKey>String</AlternateKey>
      <DataSourceInstanceId>00000000-0000-0000-0000-000000000000</DataSourceInstanceId>
      <RmsTableContextId>00000000-0000-0000-0000-000000000000</RmsTableContextId>
    </ContactReference>
    <Email>String</Email>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <Name>String</Name>
    <Phone>String</Phone>
  </Requester>
  <ScheduleDateTime>0001-01-01T00:00:00</ScheduleDateTime>
  <Supplier>
    <ContactReference>
      <AlternateKey>String</AlternateKey>
      <DataSourceInstanceId>00000000-0000-0000-0000-000000000000</DataSourceInstanceId>
      <RmsTableContextId>00000000-0000-0000-0000-000000000000</RmsTableContextId>
    </ContactReference>
    <Email>String</Email>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <Name>String</Name>
    <Phone>String</Phone>
  </Supplier>
</CancelScheduleRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ScheduleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Dvaravartman.SupplierConnect.Model.APIModels">
  <CommunicationId>00000000-0000-0000-0000-000000000000</CommunicationId>
  <Message>String</Message>
  <Payload>String</Payload>
  <ReferenceId>00000000-0000-0000-0000-000000000000</ReferenceId>
  <Success>false</Success>
</ScheduleResponse>