digitaluapi

<back to all web services

ClientInvitesEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/client_invites/{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 ClientInvitesEditResponse:
    id: int = 0
    invite_guid: Optional[str] = None
    date_created: datetime.datetime = datetime.datetime(1, 1, 1)
    date_sent: Optional[datetime.datetime] = None
    recipients: Optional[str] = None
    reference: Optional[str] = None
    retry_count: int = 0
    status_codes_id: int = 0
    tempate_text: Optional[str] = None
    tenants_id: int = 0
    clients_user_auth_id: int = 0
    response_status: Optional[ResponseStatus] = None


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

    # @Validate(Validator="NotNull")
    invite_guid: Optional[str] = None

    # @Validate(Validator="NotNull")
    date_created: datetime.datetime = datetime.datetime(1, 1, 1)

    date_sent: Optional[datetime.datetime] = None
    # @Validate(Validator="NotNull")
    recipients: Optional[str] = None

    reference: Optional[str] = None
    # @Validate(Validator="NotNull")
    retry_count: int = 0

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

    tempate_text: Optional[str] = None
    # @Validate(Validator="NotNull")
    tenants_id: int = 0

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

Python ClientInvitesEdit 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 /client_invites/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ClientInvitesEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <InviteGuid>00000000-0000-0000-0000-000000000000</InviteGuid>
  <DateCreated xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DateCreated>
  <DateSent xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DateSent>
  <Recipients>String</Recipients>
  <Reference>String</Reference>
  <RetryCount>0</RetryCount>
  <StatusCodesId>0</StatusCodesId>
  <TempateText>String</TempateText>
  <TenantsId>0</TenantsId>
  <ClientsUserAuthId>0</ClientsUserAuthId>
</ClientInvitesEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ClientInvitesEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ClientsUserAuthId>0</ClientsUserAuthId>
  <DateCreated xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DateCreated>
  <DateSent xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DateSent>
  <Id>0</Id>
  <InviteGuid>00000000-0000-0000-0000-000000000000</InviteGuid>
  <Recipients>String</Recipients>
  <Reference>String</Reference>
  <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>
  <RetryCount>0</RetryCount>
  <StatusCodesId>0</StatusCodesId>
  <TempateText>String</TempateText>
  <TenantsId>0</TenantsId>
</ClientInvitesEditResponse>