| GET | /api/objects/{ObjectId}/contactconnections | ||
|---|---|---|---|
| GET | /api/projects/{ObjectId}/myteam |
namespace Eros.Saguna.Common.WebAPIModel.Models
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ContactSummaryModel() =
///<summary>
///Contact linked to the profile
///</summary>
[<ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")>]
member val ContactId:Guid = new Guid() with get,set
///<summary>
///Full name of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")>]
member val ContactFullName:String = null with get,set
///<summary>
///Email Address of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")>]
member val EmailAddress:String = null with get,set
///<summary>
///Mobile Number of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Mobile Number of the contact linked to the profile", Name="MobileNumber")>]
member val MobileNumber:String = null with get,set
///<summary>
///Primary Phone Number of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Primary Phone Number of the contact linked to the profile", Name="PhoneNumber")>]
member val PhoneNumber:String = null with get,set
///<summary>
///Type of contact (person, organisation etc.) linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeId")>]
member val ContactTypeId:Guid = new Guid() with get,set
///<summary>
///Profile photo of contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")>]
member val ProfilePhotoUrl:String = null with get,set
///<summary>
///Thumbnail photo of contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")>]
member val ProfilePhotoThumbnailUrl:String = null with get,set
///<summary>
///Profile description
///</summary>
[<ApiMember(DataType="string", Description="Profile description", Name="Description")>]
member val Description:String = null with get,set
///<summary>
///Employment Industry
///</summary>
[<ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")>]
member val EmploymentIndustry:String = null with get,set
///<summary>
///Employment Role
///</summary>
[<ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")>]
member val EmploymentRole:String = null with get,set
///<summary>
///Areas of Work
///</summary>
[<ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")>]
member val EmploymentGeographicArea:String = null with get,set
///<summary>
///Timezone Name
///</summary>
[<ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")>]
member val TimezoneName:String = null with get,set
///<summary>
///The primary address of the contact
///</summary>
[<ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")>]
member val PrimaryAddress:String = null with get,set
///<summary>
///Have all connections to the contact been removed?
///</summary>
[<ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")>]
member val IsRemovedContact:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type ObjectContactConnectionModel() =
member val ObjectContactConnectionId:Guid = new Guid() with get,set
member val ContactRoleConnectionId:Guid = new Guid() with get,set
member val ObjectId:Guid = new Guid() with get,set
member val Contact:ContactSummaryModel = null with get,set
member val RoleId:Guid = new Guid() with get,set
member val RoleName:String = null with get,set
member val Created:DateTime = new DateTime() with get,set
[<ApiResponse(Description="Returns the contact connections for the specified object.")>]
[<AllowNullLiteral>]
type GetObjectContactConnectionsResponse() =
member val ContactConnections:ResizeArray<ObjectContactConnectionModel> = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Get contact connections for the specified object.
///</summary>
[<Api(Description="Get contact connections for the specified object.")>]
[<AllowNullLiteral>]
type GetObjectContactConnections() =
///<summary>
///Object Id to get contact connections for
///</summary>
[<ApiMember(DataType="Guid", Description="Object Id to get contact connections for", IsRequired=true, Name="ObjectId")>]
member val ObjectId:Guid = new Guid() with get,set
F# GetObjectContactConnections 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.
GET /api/objects/{ObjectId}/contactconnections HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetObjectContactConnectionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
<ContactConnections xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:ObjectContactConnectionModel>
<d2p1:Contact>
<d2p1:ContactFullName>String</d2p1:ContactFullName>
<d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
<d2p1:ContactTypeId>00000000-0000-0000-0000-000000000000</d2p1:ContactTypeId>
<d2p1:Description>String</d2p1:Description>
<d2p1:EmailAddress>String</d2p1:EmailAddress>
<d2p1:EmploymentGeographicArea>String</d2p1:EmploymentGeographicArea>
<d2p1:EmploymentIndustry>String</d2p1:EmploymentIndustry>
<d2p1:EmploymentRole>String</d2p1:EmploymentRole>
<d2p1:IsRemovedContact>false</d2p1:IsRemovedContact>
<d2p1:MobileNumber>String</d2p1:MobileNumber>
<d2p1:PhoneNumber>String</d2p1:PhoneNumber>
<d2p1:PrimaryAddress>String</d2p1:PrimaryAddress>
<d2p1:ProfilePhotoThumbnailUrl>String</d2p1:ProfilePhotoThumbnailUrl>
<d2p1:ProfilePhotoUrl>String</d2p1:ProfilePhotoUrl>
<d2p1:TimezoneName>String</d2p1:TimezoneName>
</d2p1:Contact>
<d2p1:ContactRoleConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ContactRoleConnectionId>
<d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
<d2p1:ObjectContactConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectContactConnectionId>
<d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
<d2p1:RoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleId>
<d2p1:RoleName>String</d2p1:RoleName>
</d2p1:ObjectContactConnectionModel>
</ContactConnections>
<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>
</GetObjectContactConnectionsResponse>