| GET | /api/safetycommitment | ||
|---|---|---|---|
| GET | /api/terms |
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 GetTermsDetailsResponse:
# @ApiMember(Description="Should Commitment to Safety be displayed?", Name="DisplaySafetyCommitment")
display_safety_commitment: bool = False
"""
Should Commitment to Safety be displayed?
"""
# @ApiMember(Description="Commitment to Safety HTML content.", Name="SafetyCommitmentContent")
safety_commitment_content: Optional[str] = None
"""
Commitment to Safety HTML content.
"""
response_status: Optional[ResponseStatus] = None
# @Api(Description="Retrieve details of the specified terms for the specified licensee and contact.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetTermsDetails:
"""
Retrieve details of the specified terms for the specified licensee and contact.
"""
# @ApiMember(DataType="Guid", Description="Accept terms for the specified licensee contact id.", IsRequired=true, Name="LicenseeContactId")
licensee_contact_id: Optional[str] = None
"""
Accept terms for the specified licensee contact id.
"""
# @ApiMember(DataType="Guid", Description="Terms are being accepted by the specified contact id.", IsRequired=true, Name="ContactId")
contact_id: Optional[str] = None
"""
Terms are being accepted by the specified contact id.
"""
# @ApiMember(DataType="Guid", Description="Contact Type e.g Real Person or Real Organisation. Defaults to real person.", IsRequired=true, Name="ContactTypeId")
contact_type_id: Optional[str] = None
"""
Contact Type e.g Real Person or Real Organisation. Defaults to real person.
"""
# @ApiMember(DataType="Guid", Description="Accept terms for the specified appliance id. This is not required for Safety Commitment.", Name="ApplianceId")
appliance_id: Optional[str] = None
"""
Accept terms for the specified appliance id. This is not required for Safety Commitment.
"""
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/safetycommitment HTTP/1.1 Host: pfapi.pstpf.com.au Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"DisplaySafetyCommitment":false,"SafetyCommitmentContent":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}