| All Verbs | /api/connections/{ContactId}/role/{RoleId} |
|---|
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
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GuidLookup:
lookup_id: Optional[str] = None
value: Optional[str] = None
# @Api(Description="Connect two contacts in the specified roles")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddConnectionsInRole:
"""
Connect two contacts in the specified roles
"""
# @ApiMember(DataType="Guid", Description="Create a connection from this contact to the specified list of contacts in the specified role.", IsRequired=true, Name="ContactId")
contact_id: Optional[str] = None
"""
Create a connection from this contact to the specified list of contacts in the specified role.
"""
# @ApiMember(DataType="List<GuidLookup>", Description="List of contacts to add to the role, including the type of contact", IsRequired=true, Name="ToContacts")
to_contacts: List[GuidLookup] = field(default_factory=list)
"""
List of contacts to add to the role, including the type of contact
"""
# @ApiMember(DataType="Guid", Description="Create a connection between contacts in the specified role.", IsRequired=true, Name="RoleId")
role_id: Optional[str] = None
"""
Create a connection between contacts in the specified role.
"""
# @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 AddConnectionsInRole DTOs
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/connections/{ContactId}/role/{RoleId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AddConnectionsInRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactId>00000000-0000-0000-0000-000000000000</ContactId>
<RoleId>00000000-0000-0000-0000-000000000000</RoleId>
<SendConnectionEmails>false</SendConnectionEmails>
<ToContacts xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
<d2p1:GuidLookup>
<d2p1:LookupId>00000000-0000-0000-0000-000000000000</d2p1:LookupId>
<d2p1:Value>00000000-0000-0000-0000-000000000000</d2p1:Value>
</d2p1:GuidLookup>
</ToContacts>
</AddConnectionsInRole>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ConnectContactsInRolesResponse 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>
</ConnectContactsInRolesResponse>