| POST | /api/safetycommitment/accept | ||
|---|---|---|---|
| POST | /api/terms/accept |
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="Returns the response status")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TermsActionResponse:
response_status: Optional[ResponseStatus] = None
# @Api(Description="Accept the specified terms for the specified licensee and contact.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AcceptTerms:
"""
Accept 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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/safetycommitment/accept HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AcceptTerms xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ApplianceId>00000000-0000-0000-0000-000000000000</ApplianceId>
<ContactId>00000000-0000-0000-0000-000000000000</ContactId>
<ContactTypeId>00000000-0000-0000-0000-000000000000</ContactTypeId>
<LicenseeContactId>00000000-0000-0000-0000-000000000000</LicenseeContactId>
</AcceptTerms>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<TermsActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<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>
</TermsActionResponse>