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
namespace Eros.Saguna.Common.Library

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ScheduleResponse() = 
        member val ReferenceId:Guid = new Guid() with get,set
        member val CommunicationId:Guid = new Guid() with get,set
        member val Success:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set
        member val Payload:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ObjectReference() = 
        [<DataMember(Name="RmsTableContextId")>]
        member val RmsTableContextId:Guid = new Guid() with get,set

        [<DataMember(Name="AlternateKey")>]
        member val AlternateKey:String = null with get,set

        [<DataMember(Name="DataSourceInstanceId")>]
        member val DataSourceInstanceId:Guid = new Guid() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ContactInfo() = 
        [<DataMember(Name="Id")>]
        member val Id:Guid = new Guid() with get,set

        [<DataMember(Name="Name")>]
        member val Name:String = null with get,set

        [<DataMember(Name="Email")>]
        member val Email:String = null with get,set

        [<DataMember(Name="Phone")>]
        member val Phone:String = null with get,set

        [<DataMember(Name="ContactReference")>]
        member val ContactReference:ObjectReference = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ProjectInfo() = 
        [<DataMember(Name="Id")>]
        member val Id:Guid = new Guid() with get,set

        [<DataMember(Name="Name")>]
        member val Name:String = null with get,set

        [<DataMember(Name="Reference")>]
        member val Reference:String = null with get,set

        [<DataMember(Name="Description")>]
        member val Description:String = null with get,set

        [<DataMember(Name="Address")>]
        member val Address:String = null with get,set

        [<DataMember(Name="HouseType")>]
        member val HouseType:String = null with get,set

        [<DataMember(Name="Elevation")>]
        member val Elevation:String = null with get,set

        [<DataMember(Name="CustomerName")>]
        member val CustomerName:String = null with get,set

        [<DataMember(Name="Supervisor")>]
        member val Supervisor:ContactInfo = null with get,set

        [<DataMember(Name="ProjectReference")>]
        member val ProjectReference:ObjectReference = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type PurchaseOrderInfo() = 
        [<DataMember(Name="Id")>]
        member val Id:Guid = new Guid() with get,set

        [<DataMember(Name="Reference")>]
        member val Reference:String = null with get,set

        [<DataMember(Name="Description")>]
        member val Description:String = null with get,set

        [<DataMember(Name="PurchaseOrderReference")>]
        member val PurchaseOrderReference:ObjectReference = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ActivityReference() = 
        ///<summary>
        ///Name/details of the activity
        ///</summary>
        [<DataMember(Name="name")>]
        [<ApiMember(Description="Name/details of the activity", IsRequired=true, Name="Name")>]
        member val Name:String = null with get,set

        [<DataMember(Name="notes")>]
        member val Notes:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ScheduleParams() = 
        [<DataMember(Name="Name")>]
        member val Name:String = null with get,set

        [<DataMember(Name="Value")>]
        member val Value:String = null with get,set

    type AttachmentType =
        | Url = 0
        | FileStream = 1

    [<AllowNullLiteral>]
    type EmailAttachment() = 
        member val FileName:String = null with get,set
        member val ContentType:String = null with get,set
        member val Path:String = null with get,set
        member val Url:String = null with get,set
        member val Length:Int64 = new Int64() with get,set
        member val FileStream:Stream = null with get,set
        member val StreamContent:String = null with get,set
        member val AttachmentType:AttachmentType = new AttachmentType() with get,set
        member val ProcessedAndUploadedAsBlob:Boolean = new Boolean() with 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>]
    [<AllowNullLiteral>]
    type 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")>]
        member val RequestId:Guid = new Guid() with get,set

        ///<summary>
        ///Date/Time of the activity
        ///</summary>
        [<DataMember(Name="ScheduleDateTime")>]
        [<ApiMember(Description="Date/Time of the activity", IsRequired=true, Name="ScheduleDateTime")>]
        [<Required>]
        member val ScheduleDateTime:DateTime = new DateTime() with get,set

        [<DataMember(Name="Requester")>]
        member val Requester:ContactInfo = null with get,set

        [<DataMember(Name="Supplier")>]
        member val Supplier:ContactInfo = null with get,set

        [<DataMember(Name="Project")>]
        member val Project:ProjectInfo = null with get,set

        [<DataMember(Name="PurchaseOrder")>]
        member val PurchaseOrder:PurchaseOrderInfo = null with get,set

        [<DataMember(Name="Activity")>]
        member val Activity:ActivityReference = null with get,set

        [<DataMember(Name="Params")>]
        member val Params:ResizeArray<ScheduleParams> = null with get,set

        [<DataMember(Name="Attachments")>]
        member val Attachments:ResizeArray<EmailAttachment> = null with get,set

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