SupplierConnect Gateway API

<back to all web services

ScheduleRequest

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
PUT/api/schedules/{RequestId}
ScheduleRequest Parameters:
NameParameterData TypeRequiredDescription
RequestIdpathGuidYesId of the schedule request to be recreated
ScheduleDateTimebodyDateTimeYesDate/Time of the activity
RequesterbodyContactInfoNo
SupplierbodyContactInfoNo
ProjectbodyProjectInfoNo
PurchaseOrderbodyPurchaseOrderInfoNo
ActivitybodyActivityReferenceNo
ParamsbodyList<ScheduleParams>No
AttachmentsbodyList<EmailAttachment>No
ContactInfo Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
EmailformstringNo
PhoneformstringNo
ContactReferenceformObjectReferenceNo
ObjectReference Parameters:
NameParameterData TypeRequiredDescription
RmsTableContextIdformGuidNo
AlternateKeyformstringNo
DataSourceInstanceIdformGuidNo
ProjectInfo Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
ReferenceformstringNo
DescriptionformstringNo
AddressformstringNo
HouseTypeformstringNo
ElevationformstringNo
CustomerNameformstringNo
SupervisorformContactInfoNo
ProjectReferenceformObjectReferenceNo
PurchaseOrderInfo Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
ReferenceformstringNo
PurchaseOrderReferenceformObjectReferenceNo
ActivityReference Parameters:
NameParameterData TypeRequiredDescription
NameformstringYesName/details of the activity
NotesformstringNo
ScheduleParams Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
EmailAttachment Parameters:
NameParameterData TypeRequiredDescription
FileNameformstringNo
ContentTypeformstringNo
PathformstringNo
UrlformstringNo
LengthformlongNo
StreamContentformstringNo
AttachmentTypeformAttachmentTypeNo
ProcessedAndUploadedAsBlobformboolNo
ScheduleResponse Parameters:
NameParameterData TypeRequiredDescription
ReferenceIdformGuidNo
CommunicationIdformGuidNo
SuccessformboolNo
MessageformstringNo
PayloadformstringNo

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 HTTP/1.1 
Host: production-eros-gateway-api-supplierconnect.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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>