SupplierConnect Gateway API

GetSchedules

Retrieve SupplierConnect schedule(s) by given ids. 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/schedules
GET	/api/schedules/{Ids}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Retrieve SupplierConnect schedule(s) by given ids. This will return SupplierConnect schedule request(s), and the associated other details such as statuses
*/
@Api(Description="Retrieve SupplierConnect schedule(s) by given ids. This will return SupplierConnect schedule request(s), and the associated other details such as statuses")
open class GetSchedules
{
    /**
    * Id or list of Ids of the schedule request(s) to be retrieved
    */
    @DataMember(Name="id")
    @SerializedName("id")
    @ApiMember(Description="Id or list of Ids of the schedule request(s) to be retrieved", IsRequired=true, Name="id")
    open var Ids:ArrayList<UUID> = ArrayList<UUID>()
}

@ApiResponse(Description="Returns the list of the schedule requests for the given list of Ids")
open class GetSchedulesResponse
{
    open var Success:Boolean? = null
    open var Message:String? = null
    open var ScheduleRequests:ArrayList<ScheduleDetails>? = null
    open var ResponseStatus:ResponseStatus? = null
    open var LastRowVersion:String? = null
}

open class ScheduleDetails : SupplierConnectSchedule()
{
    open var ReferenceId:UUID? = null
    open var Index:Int? = null
    open var StatusId:UUID? = null
    open var Status:String? = null
    open var StatusMessage:String? = null
    open var RequestedBy:String? = null
    open var RequestedDate:Date? = null
    open var CommunicationId:UUID? = null
}

open class SupplierConnectSchedule
{
    open var RequestId:UUID? = null
    open var PreviousRequestId:UUID? = null
    open var LicenseeId:UUID? = null
    open var LicenseeName:String? = null
    open var ScheduleDateTime:Date? = null
    open var Requester:SupplierConnectContactInfo? = null
    open var Supplier:SupplierConnectContactInfo? = null
    open var Project:SupplierConnectProjectInfo? = null
    open var PurchaseOrder:SupplierConnectPurchaseOrderInfo? = null
    open var Activity:SupplierConnectActivityReference? = null
    open var Params:ArrayList<SupplierConnectScheduleParams>? = null
    open var Attachments:ArrayList<EmailAttachment>? = null
}

open class SupplierConnectContactInfo
{
    open var Id:UUID? = null
    open var Name:String? = null
    open var Email:String? = null
    open var Phone:String? = null
    open var ContactReference:SupplierConnectObjectReference? = null
}

open class SupplierConnectObjectReference
{
    open var RmsTableContextId:UUID? = null
    open var AlternateKey:String? = null
    open var DataSourceInstanceId:UUID? = null
}

open class SupplierConnectProjectInfo
{
    open var Id:UUID? = null
    open var Name:String? = null
    open var Reference:String? = null
    open var Description:String? = null
    open var Address:String? = null
    open var HouseType:String? = null
    open var Elevation:String? = null
    open var Supervisor:SupplierConnectContactInfo? = null
    open var CustomerName:String? = null
    open var ProjectReference:SupplierConnectObjectReference? = null
}

open class SupplierConnectPurchaseOrderInfo
{
    open var Id:UUID? = null
    open var Reference:String? = null
    open var Description:String? = null
    open var ProjectId:UUID? = null
    open var PurchaseOrderReference:SupplierConnectObjectReference? = null
}

open class SupplierConnectActivityReference
{
    open var Name:String? = null
    open var Notes:String? = null
}

open class SupplierConnectScheduleParams
{
    open var Name:String? = null
    open var Value:String? = null
}

open class EmailAttachment
{
    open var FileName:String? = null
    open var ContentType:String? = null
    open var Path:String? = null
    open var Url:String? = null
    open var Length:Long? = null
    open var FileStream:InputStream? = null
    open var StreamContent:String? = null
    open var AttachmentType:AttachmentType? = null
    open var ProcessedAndUploadedAsBlob:Boolean? = null
}

enum class AttachmentType
{
    Url,
    FileStream,
}

Kotlin GetSchedules 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/schedules 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>