| All Verbs | /api/suitedata |
|---|
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
# @ApiResponse(Description="Suite Appliance Data")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSuiteDataResponse:
suite_appliance_licensee_id: Optional[str] = None
domain_name: Optional[str] = None
skin_name: Optional[str] = None
licensee_connection_id: Optional[str] = None
licensee_contact_id: Optional[str] = None
licensee_contact_name: Optional[str] = None
is_branded_u_r_l: bool = False
response_status: Optional[ResponseStatus] = None
# @Api(Description="Gets the suite data for a particular licensee")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSuiteDataForLicensee:
"""
Gets the suite data for a particular licensee
"""
# @ApiMember(Description="The suite id", Name="Suite Id")
suite_id: Optional[str] = None
"""
The suite id
"""
# @ApiMember(Description="The id of the licensee", Name="LicenseeId")
licensee_id: Optional[str] = None
"""
The id of the licensee
"""
Python GetSuiteDataForLicensee DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/suitedata HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"SuiteId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"SuiteApplianceLicenseeId":"00000000-0000-0000-0000-000000000000","DomainName":"String","SkinName":"String","LicenseeConnectionId":"00000000-0000-0000-0000-000000000000","LicenseeContactId":"00000000-0000-0000-0000-000000000000","LicenseeContactName":"String","IsBrandedURL":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}