digitaluapi

<back to all web services

SchedulesEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/schedules/{Id}
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 SchedulesEditResponse:
    id: int = 0
    tenants_id: int = 0
    intervals_id: int = 0
    run_at: Optional[datetime.datetime] = None
    monday: Optional[bool] = None
    tuesday: Optional[bool] = None
    wednesday: Optional[bool] = None
    thursday: Optional[bool] = None
    friday: Optional[bool] = None
    saturday: Optional[bool] = None
    sunday: Optional[bool] = None
    day_of_month: Optional[int] = None
    month_of_year: Optional[int] = None
    start_date: datetime.datetime = datetime.datetime(1, 1, 1)
    end_date: datetime.datetime = datetime.datetime(1, 1, 1)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SchedulesEdit:
    # @Validate(Validator="NotNull")
    id: int = 0

    # @Validate(Validator="NotNull")
    tenants_id: int = 0

    # @Validate(Validator="NotNull")
    intervals_id: int = 0

    run_at: Optional[datetime.datetime] = None
    monday: Optional[bool] = None
    tuesday: Optional[bool] = None
    wednesday: Optional[bool] = None
    thursday: Optional[bool] = None
    friday: Optional[bool] = None
    saturday: Optional[bool] = None
    sunday: Optional[bool] = None
    day_of_month: Optional[int] = None
    month_of_year: Optional[int] = None
    start_date: datetime.datetime = datetime.datetime(1, 1, 1)
    end_date: datetime.datetime = datetime.datetime(1, 1, 1)

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

PUT /schedules/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SchedulesEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <TenantsId>0</TenantsId>
  <IntervalsId>0</IntervalsId>
  <RunAt>0001-01-01T00:00:00</RunAt>
  <Monday>false</Monday>
  <Tuesday>false</Tuesday>
  <Wednesday>false</Wednesday>
  <Thursday>false</Thursday>
  <Friday>false</Friday>
  <Saturday>false</Saturday>
  <Sunday>false</Sunday>
  <DayOfMonth>0</DayOfMonth>
  <MonthOfYear>0</MonthOfYear>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <EndDate>0001-01-01T00:00:00</EndDate>
</SchedulesEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SchedulesEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <DayOfMonth>0</DayOfMonth>
  <EndDate>0001-01-01T00:00:00</EndDate>
  <Friday>false</Friday>
  <Id>0</Id>
  <IntervalsId>0</IntervalsId>
  <Monday>false</Monday>
  <MonthOfYear>0</MonthOfYear>
  <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>
  <RunAt>0001-01-01T00:00:00</RunAt>
  <Saturday>false</Saturday>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <Sunday>false</Sunday>
  <TenantsId>0</TenantsId>
  <Thursday>false</Thursday>
  <Tuesday>false</Tuesday>
  <Wednesday>false</Wednesday>
</SchedulesEditResponse>