| All Verbs | /api/connections/{ContactId}/to/{ToContactId} |
|---|
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="List of roles available for connection from the specified contact for specified contact types")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConnectContactsInRolesResponse:
response_status: Optional[ResponseStatus] = None
# @Api(Description="Connect two contacts in the specified roles")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConnectContactsInRoles:
"""
Connect two contacts in the specified roles
"""
# @ApiMember(DataType="Guid", Description="Create a connection from this contact to the specified to contact in the specified roles.", IsRequired=true, Name="ContactId")
contact_id: Optional[str] = None
"""
Create a connection from this contact to the specified to contact in the specified roles.
"""
# @ApiMember(DataType="Guid", Description="Create a connection to this contact from the specified to contact in the specified roles.", IsRequired=true, Name="ToContactId")
to_contact_id: Optional[str] = None
"""
Create a connection to this contact from the specified to contact in the specified roles.
"""
# @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(DataType="List<Guid>", Description="List of roles to connect contacts in", IsRequired=true, Name="Roles")
roles: List[str] = field(default_factory=list)
"""
List of roles to connect contacts in
"""
# @ApiMember(DataType="boolean", Description="Send connection emails for auto - accept roles that are being assigned? Note: emails will always be sent if the role requires user acceptance", IsRequired=true, Name="SendConnectionEmails")
send_connection_emails: bool = False
"""
Send connection emails for auto - accept roles that are being assigned? Note: emails will always be sent if the role requires user acceptance
"""
Python ConnectContactsInRoles DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/connections/{ContactId}/to/{ToContactId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Roles:
[
00000000-0000-0000-0000-000000000000
],
SendConnectionEmails: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}