SupplierConnect Gateway API

GetRequestActivity

Retrieves a list of activities of SupplierConnect schedule(s) for a given time window. This will return SupplierConnect schedule request(s), and the associated other details such as statuses

The following routes are available for this service:
GET	/api/activity
GET	/api/activity/{lastrowversion}

namespace Eros.Causal.Common.Entity

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

    [<AllowNullLiteral>]
    type SupplierConnectObjectReference() = 
        member val RmsTableContextId:Guid = new Guid() with get,set
        member val AlternateKey:String = null with get,set
        member val DataSourceInstanceId:Guid = new Guid() with get,set

    [<AllowNullLiteral>]
    type SupplierConnectContactInfo() = 
        member val Id:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Email:String = null with get,set
        member val Phone:String = null with get,set
        member val ContactReference:SupplierConnectObjectReference = null with get,set

    [<AllowNullLiteral>]
    type SupplierConnectProjectInfo() = 
        member val Id:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Reference:String = null with get,set
        member val Description:String = null with get,set
        member val Address:String = null with get,set
        member val HouseType:String = null with get,set
        member val Elevation:String = null with get,set
        member val Supervisor:SupplierConnectContactInfo = null with get,set
        member val CustomerName:String = null with get,set
        member val ProjectReference:SupplierConnectObjectReference = null with get,set

    [<AllowNullLiteral>]
    type SupplierConnectPurchaseOrderInfo() = 
        member val Id:Guid = new Guid() with get,set
        member val Reference:String = null with get,set
        member val Description:String = null with get,set
        member val ProjectId:Guid = new Guid() with get,set
        member val PurchaseOrderReference:SupplierConnectObjectReference = null with get,set

    [<AllowNullLiteral>]
    type SupplierConnectActivityReference() = 
        member val Name:String = null with get,set
        member val Notes:String = null with get,set

    [<AllowNullLiteral>]
    type SupplierConnectScheduleParams() = 
        member val Name:String = null with get,set
        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

    [<AllowNullLiteral>]
    type SupplierConnectSchedule() = 
        member val RequestId:Guid = new Guid() with get,set
        member val PreviousRequestId:Guid = new Guid() with get,set
        member val LicenseeId:Guid = new Guid() with get,set
        member val LicenseeName:String = null with get,set
        member val ScheduleDateTime:DateTime = new DateTime() with get,set
        member val Requester:SupplierConnectContactInfo = null with get,set
        member val Supplier:SupplierConnectContactInfo = null with get,set
        member val Project:SupplierConnectProjectInfo = null with get,set
        member val PurchaseOrder:SupplierConnectPurchaseOrderInfo = null with get,set
        member val Activity:SupplierConnectActivityReference = null with get,set
        member val Params:ResizeArray<SupplierConnectScheduleParams> = null with get,set
        member val Attachments:ResizeArray<EmailAttachment> = null with get,set

    [<AllowNullLiteral>]
    type ScheduleDetails() = 
        inherit SupplierConnectSchedule()
        member val ReferenceId:Guid = new Guid() with get,set
        member val Index:Int32 = new Int32() with get,set
        member val StatusId:Guid = new Guid() with get,set
        member val Status:String = null with get,set
        member val StatusMessage:String = null with get,set
        member val RequestedBy:String = null with get,set
        member val RequestedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CommunicationId:Guid = new Guid() with get,set

    [<ApiResponse(Description="Returns the list of the schedule requests for the given list of Ids")>]
    [<AllowNullLiteral>]
    type GetSchedulesResponse() = 
        member val Success:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set
        member val ScheduleRequests:ResizeArray<ScheduleDetails> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set
        member val LastRowVersion:String = null with get,set

    ///<summary>
    ///Retrieves a list of activities of SupplierConnect schedule(s) for a given time window. This will return SupplierConnect schedule request(s), and the associated other details such as statuses
    ///</summary>
    [<Api(Description="Retrieves a list of activities of SupplierConnect schedule(s) for a given time window. This will return SupplierConnect schedule request(s), and the associated other details such as statuses")>]
    [<AllowNullLiteral>]
    type GetRequestActivity() = 
        ///<summary>
        ///Row version of the last/latest record processed/returned in the previous request
        ///</summary>
        [<DataMember(Name="LastRowVersion")>]
        [<ApiMember(Description="Row version of the last/latest record processed/returned in the previous request", IsRequired=true, Name="LastRowVersion")>]
        member val LastRowVersion:String = null with get,set

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

GET /api/activity HTTP/1.1 
Host: production-eros-gateway-api-supplierconnect.azurewebsites.net 
Accept: application/xml

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

<GetSchedulesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Dvaravartman.SupplierConnect.Model.APIModels">
  <LastRowVersion>String</LastRowVersion>
  <Message>String</Message>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <ScheduleRequests>
    <ScheduleDetails>
      <Activity xmlns="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
        <Name>String</Name>
        <Notes>String</Notes>
      </Activity>
      <Attachments xmlns:d4p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.Library" xmlns="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
        <d4p1:EmailAttachment>
          <d4p1:AttachmentType>Url</d4p1:AttachmentType>
          <d4p1:ContentType>String</d4p1:ContentType>
          <d4p1:FileName>String</d4p1:FileName>
          <d4p1:FileStream xmlns:d6p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
          <d4p1:Length>0</d4p1:Length>
          <d4p1:Path>String</d4p1:Path>
          <d4p1:ProcessedAndUploadedAsBlob>false</d4p1:ProcessedAndUploadedAsBlob>
          <d4p1:StreamContent>String</d4p1:StreamContent>
          <d4p1:Url>String</d4p1:Url>
        </d4p1:EmailAttachment>
      </Attachments>
      <LicenseeId xmlns="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">00000000-0000-0000-0000-000000000000</LicenseeId>
      <LicenseeName xmlns="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">String</LicenseeName>
      <Params xmlns="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
        <SupplierConnectScheduleParams>
          <Name>String</Name>
          <Value>String</Value>
        </SupplierConnectScheduleParams>
      </Params>
      <PreviousRequestId xmlns="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">00000000-0000-0000-0000-000000000000</PreviousRequestId>
      <Project xmlns="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
        <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 xmlns="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
        <Description>String</Description>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <ProjectId>00000000-0000-0000-0000-000000000000</ProjectId>
        <PurchaseOrderReference>
          <AlternateKey>String</AlternateKey>
          <DataSourceInstanceId>00000000-0000-0000-0000-000000000000</DataSourceInstanceId>
          <RmsTableContextId>00000000-0000-0000-0000-000000000000</RmsTableContextId>
        </PurchaseOrderReference>
        <Reference>String</Reference>
      </PurchaseOrder>
      <RequestId xmlns="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">00000000-0000-0000-0000-000000000000</RequestId>
      <Requester xmlns="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
        <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 xmlns="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">0001-01-01T00:00:00</ScheduleDateTime>
      <Supplier xmlns="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
        <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>
      <CommunicationId>00000000-0000-0000-0000-000000000000</CommunicationId>
      <Index>0</Index>
      <ReferenceId>00000000-0000-0000-0000-000000000000</ReferenceId>
      <RequestedBy>String</RequestedBy>
      <RequestedDate>0001-01-01T00:00:00</RequestedDate>
      <Status>String</Status>
      <StatusId>00000000-0000-0000-0000-000000000000</StatusId>
      <StatusMessage>String</StatusMessage>
    </ScheduleDetails>
  </ScheduleRequests>
  <Success>false</Success>
</GetSchedulesResponse>