| All Verbs | /api/connections/{ConnectionId}/cancel | ||
|---|---|---|---|
| All Verbs | /api/connections/{ConnectionId}/remove |
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 ConnectionStatusUpdateResponse:
response_status: Optional[ResponseStatus] = None
# @Api(Description="Update the status of the specified connection")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConnectionStatusUpdate:
"""
Update the status of the specified connection
"""
# @ApiMember(Description="Connection to be updated", IsRequired=true, Name="ConnectionId")
connection_id: Optional[str] = None
"""
Connection to be updated
"""
# @ApiMember(Description="Id of the contact linked to the connection", IsRequired=true, Name="ContactId")
contact_id: Optional[str] = None
"""
Id of the contact linked to the connection
"""
# @ApiMember(DataType="Guid", Description="Type of contact being connected with. For e.g. Real Person, Virtual Person etc.", IsRequired=true, Name="ContactTypeId")
contact_type_id: Optional[str] = None
"""
Type of contact being connected with. For e.g. Real Person, Virtual Person etc.
"""
# @ApiMember(Description="Role Id linked to the connection request", IsRequired=true, Name="RoleId")
role_id: Optional[str] = None
"""
Role Id linked to the connection request
"""
Python ConnectionStatusUpdate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/connections/{ConnectionId}/cancel HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"ConnectionId":"00000000-0000-0000-0000-000000000000","ContactId":"00000000-0000-0000-0000-000000000000","ContactTypeId":"00000000-0000-0000-0000-000000000000","RoleId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}