| 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 .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.
POST /api/connections/{ContactId}/role/{RoleId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"ContactId":"00000000-0000-0000-0000-000000000000","ToContacts":[{"LookupId":"00000000-0000-0000-0000-000000000000","Value":"00000000-0000-0000-0000-000000000000"}],"RoleId":"00000000-0000-0000-0000-000000000000","SendConnectionEmails":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}