SupplierConnect Gateway API

<back to all web services

GetSchedules

Retrieve SupplierConnect schedule(s) by given ids. This will return SupplierConnect schedule request(s), and the associated other details such as statuses

Requires Authentication
The following routes are available for this service:
GET/api/schedules
GET/api/schedules/{Ids}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SupplierConnectObjectReference:
    rms_table_context_id: Optional[str] = None
    alternate_key: Optional[str] = None
    data_source_instance_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SupplierConnectContactInfo:
    id: Optional[str] = None
    name: Optional[str] = None
    email: Optional[str] = None
    phone: Optional[str] = None
    contact_reference: Optional[SupplierConnectObjectReference] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SupplierConnectProjectInfo:
    id: Optional[str] = None
    name: Optional[str] = None
    reference: Optional[str] = None
    description: Optional[str] = None
    address: Optional[str] = None
    house_type: Optional[str] = None
    elevation: Optional[str] = None
    supervisor: Optional[SupplierConnectContactInfo] = None
    customer_name: Optional[str] = None
    project_reference: Optional[SupplierConnectObjectReference] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SupplierConnectPurchaseOrderInfo:
    id: Optional[str] = None
    reference: Optional[str] = None
    description: Optional[str] = None
    project_id: Optional[str] = None
    purchase_order_reference: Optional[SupplierConnectObjectReference] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SupplierConnectActivityReference:
    name: Optional[str] = None
    notes: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SupplierConnectScheduleParams:
    name: Optional[str] = None
    value: Optional[str] = None


class AttachmentType(str, Enum):
    URL = 'Url'
    FILE_STREAM = 'FileStream'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EmailAttachment:
    file_name: Optional[str] = None
    content_type: Optional[str] = None
    path: Optional[str] = None
    url: Optional[str] = None
    length: int = 0
    file_stream: Optional[bytes] = None
    stream_content: Optional[str] = None
    attachment_type: Optional[AttachmentType] = None
    processed_and_uploaded_as_blob: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SupplierConnectSchedule:
    request_id: Optional[str] = None
    previous_request_id: Optional[str] = None
    licensee_id: Optional[str] = None
    licensee_name: Optional[str] = None
    schedule_date_time: datetime.datetime = datetime.datetime(1, 1, 1)
    requester: Optional[SupplierConnectContactInfo] = None
    supplier: Optional[SupplierConnectContactInfo] = None
    project: Optional[SupplierConnectProjectInfo] = None
    purchase_order: Optional[SupplierConnectPurchaseOrderInfo] = None
    activity: Optional[SupplierConnectActivityReference] = None
    params: Optional[List[SupplierConnectScheduleParams]] = None
    attachments: Optional[List[EmailAttachment]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScheduleDetails(SupplierConnectSchedule):
    reference_id: Optional[str] = None
    index: int = 0
    status_id: Optional[str] = None
    status: Optional[str] = None
    status_message: Optional[str] = None
    requested_by: Optional[str] = None
    requested_date: Optional[datetime.datetime] = None
    communication_id: Optional[str] = None


# @ApiResponse(Description="Returns the list of the schedule requests for the given list of Ids")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSchedulesResponse:
    success: bool = False
    message: Optional[str] = None
    schedule_requests: Optional[List[ScheduleDetails]] = None
    response_status: Optional[ResponseStatus] = None
    last_row_version: Optional[str] = None


# @Api(Description="Retrieve SupplierConnect schedule(s) by given ids. This will return SupplierConnect schedule request(s), and the associated other details such as statuses")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSchedules:
    """
    Retrieve SupplierConnect schedule(s) by given ids. This will return SupplierConnect schedule request(s), and the associated other details such as statuses
    """

    # @ApiMember(Description="Id or list of Ids of the schedule request(s) to be retrieved", IsRequired=true, Name="id")
    ids: List[str] = field(default_factory=list)
    """
    Id or list of Ids of the schedule request(s) to be retrieved
    """

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