| GET | /api/objects/{ObjectId}/contactconnections | ||
|---|---|---|---|
| GET | /api/projects/{ObjectId}/myteam |
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Get contact connections for the specified object.
*/
@Api(Description="Get contact connections for the specified object.")
open class GetObjectContactConnections
{
/**
* Object Id to get contact connections for
*/
@ApiMember(DataType="Guid", Description="Object Id to get contact connections for", IsRequired=true, Name="ObjectId")
open var ObjectId:UUID? = null
}
@ApiResponse(Description="Returns the contact connections for the specified object.")
open class GetObjectContactConnectionsResponse
{
open var ContactConnections:ArrayList<ObjectContactConnectionModel>? = null
open var ResponseStatus:ResponseStatus? = null
}
open class ObjectContactConnectionModel
{
open var ObjectContactConnectionId:UUID? = null
open var ContactRoleConnectionId:UUID? = null
open var ObjectId:UUID? = null
open var Contact:ContactSummaryModel? = null
open var RoleId:UUID? = null
open var RoleName:String? = null
open var Created:Date? = null
}
open class ContactSummaryModel
{
/**
* Contact linked to the profile
*/
@ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
open var ContactId:UUID? = null
/**
* Full name of the contact linked to the profile
*/
@ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")
open var ContactFullName:String? = null
/**
* Email Address of the contact linked to the profile
*/
@ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")
open var EmailAddress:String? = null
/**
* Mobile Number of the contact linked to the profile
*/
@ApiMember(DataType="string", Description="Mobile Number of the contact linked to the profile", Name="MobileNumber")
open var MobileNumber:String? = null
/**
* Primary Phone Number of the contact linked to the profile
*/
@ApiMember(DataType="string", Description="Primary Phone Number of the contact linked to the profile", Name="PhoneNumber")
open var PhoneNumber:String? = null
/**
* Type of contact (person, organisation etc.) linked to the profile
*/
@ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeId")
open var ContactTypeId:UUID? = null
/**
* Profile photo of contact linked to the profile
*/
@ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")
open var ProfilePhotoUrl:String? = null
/**
* Thumbnail photo of contact linked to the profile
*/
@ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
open var ProfilePhotoThumbnailUrl:String? = null
/**
* Profile description
*/
@ApiMember(DataType="string", Description="Profile description", Name="Description")
open var Description:String? = null
/**
* Employment Industry
*/
@ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
open var EmploymentIndustry:String? = null
/**
* Employment Role
*/
@ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
open var EmploymentRole:String? = null
/**
* Areas of Work
*/
@ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
open var EmploymentGeographicArea:String? = null
/**
* Timezone Name
*/
@ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
open var TimezoneName:String? = null
/**
* The primary address of the contact
*/
@ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
open var PrimaryAddress:String? = null
/**
* Have all connections to the contact been removed?
*/
@ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")
open var IsRemovedContact:Boolean? = null
}
Kotlin GetObjectContactConnections 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.
GET /api/objects/{ObjectId}/contactconnections HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ContactConnections":[{"ObjectContactConnectionId":"00000000-0000-0000-0000-000000000000","ContactRoleConnectionId":"00000000-0000-0000-0000-000000000000","ObjectId":"00000000-0000-0000-0000-000000000000","Contact":{"ContactId":"00000000-0000-0000-0000-000000000000","ContactFullName":"String","EmailAddress":"String","MobileNumber":"String","PhoneNumber":"String","ContactTypeId":"00000000-0000-0000-0000-000000000000","ProfilePhotoUrl":"String","ProfilePhotoThumbnailUrl":"String","Description":"String","EmploymentIndustry":"String","EmploymentRole":"String","EmploymentGeographicArea":"String","TimezoneName":"String","PrimaryAddress":"String","IsRemovedContact":false},"RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String","Created":"0001-01-01T00:00:00.0000000"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}