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

export class ScheduleResponse
{
    public ReferenceId: string;
    public CommunicationId: string;
    public Success: boolean;
    public Message: string;
    public Payload: string;

    public constructor(init?: Partial<ScheduleResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ObjectReference
{
    // @DataMember(Name="RmsTableContextId")
    public RmsTableContextId: string;

    // @DataMember(Name="AlternateKey")
    public AlternateKey: string;

    // @DataMember(Name="DataSourceInstanceId")
    public DataSourceInstanceId: string;

    public constructor(init?: Partial<ObjectReference>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ContactInfo
{
    // @DataMember(Name="Id")
    public Id: string;

    // @DataMember(Name="Name")
    public Name: string;

    // @DataMember(Name="Email")
    public Email: string;

    // @DataMember(Name="Phone")
    public Phone: string;

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

    public constructor(init?: Partial<ContactInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ProjectInfo
{
    // @DataMember(Name="Id")
    public Id: string;

    // @DataMember(Name="Name")
    public Name: string;

    // @DataMember(Name="Reference")
    public Reference: string;

    // @DataMember(Name="Description")
    public Description: string;

    // @DataMember(Name="Address")
    public Address: string;

    // @DataMember(Name="HouseType")
    public HouseType: string;

    // @DataMember(Name="Elevation")
    public Elevation: string;

    // @DataMember(Name="CustomerName")
    public CustomerName: string;

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

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

    public constructor(init?: Partial<ProjectInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PurchaseOrderInfo
{
    // @DataMember(Name="Id")
    public Id: string;

    // @DataMember(Name="Reference")
    public Reference: string;

    // @DataMember(Name="Description")
    public Description: string;

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

    public constructor(init?: Partial<PurchaseOrderInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ActivityReference
{
    /** @description Name/details of the activity */
    // @DataMember(Name="name")
    // @ApiMember(Description="Name/details of the activity", IsRequired=true, Name="Name")
    public name: string;

    // @DataMember(Name="notes")
    public notes: string;

    public constructor(init?: Partial<ActivityReference>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ScheduleParams
{
    // @DataMember(Name="Name")
    public Name: string;

    // @DataMember(Name="Value")
    public Value: string;

    public constructor(init?: Partial<ScheduleParams>) { (Object as any).assign(this, init); }
}

export enum AttachmentType
{
    Url = 'Url',
    FileStream = 'FileStream',
}

export class EmailAttachment
{
    public FileName: string;
    public ContentType: string;
    public Path: string;
    public Url: string;
    public Length: number;
    public FileStream: string;
    public StreamContent: string;
    public AttachmentType: AttachmentType;
    public ProcessedAndUploadedAsBlob: boolean;

    public constructor(init?: Partial<EmailAttachment>) { (Object as any).assign(this, init); }
}

/** @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. */
// @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
export class CancelScheduleRequest
{
    /** @description 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 RequestId: string;

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

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

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

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

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

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

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

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

    public constructor(init?: Partial<CancelScheduleRequest>) { (Object as any).assign(this, init); }
}

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