Platform API

<back to all web services

GetContactsManagingOrgProfile

Gets a list of contacts that are currently managing the userProfileId supplied.

Requires Authentication
The following routes are available for this service:
All Verbs/api/contacts/{UserProfileId}/managingorgprofile

export class UserProfileSummaryModel
{
    /** @description User Profile Id */
    // @ApiMember(DataType="Guid", Description="User Profile Id", Name="UserProfileId")
    public UserProfileId: string;

    /** @description User linked to the profile */
    // @ApiMember(DataType="Guid", Description="User linked to the profile", Name="UserId")
    public UserId: string;

    /** @description Contact linked to the profile */
    // @ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
    public ContactId: string;

    /** @description User linked to the profile */
    // @ApiMember(DataType="string", Description="User linked to the profile", Name="UserName")
    public UserName: string;

    /** @description User Profile Name */
    // @ApiMember(DataType="string", Description="User Profile Name", Name="ProfileName")
    public ProfileName: string;

    /** @description Full name of the contact linked to the profile */
    // @ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")
    public ContactFullName: string;

    /** @description Email Address of the contact linked to the profile */
    // @ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")
    public EmailAddress: string;

    /** @description Email signature of the contact linked to the profile */
    // @ApiMember(DataType="string", Description="Email signature of the contact linked to the profile", Name="EmailSignature")
    public EmailSignature: string;

    /** @description Mobile number of the contact linked to the profile */
    // @ApiMember(DataType="string", Description="Mobile number of the contact linked to the profile", Name="MobileNumber")
    public MobileNumber: string;

    /** @description Phone number of the contact linked to the profile */
    // @ApiMember(DataType="string", Description="Phone number of the contact linked to the profile", Name="PhoneNumber")
    public PhoneNumber: string;

    /** @description 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")
    public ContactTypeId: string;

    /** @description 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="ContactTypeName")
    public ContactTypeName: string;

    /** @description First name of the contact linked to the profile */
    // @ApiMember(DataType="string", Description="First name of the contact linked to the profile", Name="FirstName")
    public FirstName: string;

    /** @description Surname of the contact linked to the profile */
    // @ApiMember(DataType="string", Description="Surname of the contact linked to the profile", Name="Surname")
    public Surname: string;

    /** @description Title of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Title of contact linked to the profile", Name="Title")
    public Title: string;

    /** @description Legal name of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")
    public LegalName: string;

    /** @description Trading name of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")
    public TradingName: string;

    /** @description Australian Business Number */
    // @ApiMember(DataType="string", Description="Australian Business Number", Name="Abn", ParameterType="query")
    public Abn: string;

    /** @description Australian Company Number */
    // @ApiMember(DataType="string", Description="Australian Company Number", Name="Acn", ParameterType="query")
    public Acn: string;

    /** @description Australian Registered Body Number */
    // @ApiMember(DataType="string", Description="Australian Registered Body Number", Name="Arbn", ParameterType="query")
    public Arbn: string;

    /** @description Indicates if the Contact is registered for GST. */
    // @ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")
    public GstRegistered: boolean;

    /** @description True if english is a secondary language for the contact. */
    // @ApiMember(DataType="bool", Description="True if english is a secondary language for the contact.", Name="ESL", ParameterType="query")
    public ESL: boolean;

    /** @description Language that is the primary language for the contact. */
    // @ApiMember(DataType="string", Description="Language that is the primary language for the contact.", Name="Language", ParameterType="query")
    public Language: string;

    /** @description True if an interpreter is required. */
    // @ApiMember(DataType="bool", Description="True if an interpreter is required.", Name="InterpreterRequired", ParameterType="query")
    public InterpreterRequired: boolean;

    /** @description Licensee specific notes about the contact. */
    // @ApiMember(DataType="string", Description="Licensee specific notes about the contact.", Name="LicenseeNotes", ParameterType="query")
    public LicenseeNotes: string;

    /** @description Profile photo of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")
    public ProfilePhotoUrl: string;

    /** @description Thumbnail photo of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
    public ProfilePhotoThumbnailUrl: string;

    /** @description Profile photo id of contact linked to the profile */
    // @ApiMember(DataType="Guid", Description="Profile photo id of contact linked to the profile", Name="ProfileImageId")
    public ProfileImageId: string;

    /** @description Profile description */
    // @ApiMember(DataType="string", Description="Profile description", Name="Description")
    public Description: string;

    /** @description Employment Industry */
    // @ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
    public EmploymentIndustry: string;

    /** @description Employment Role */
    // @ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
    public EmploymentRole: string;

    /** @description Areas of Work */
    // @ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
    public EmploymentGeographicArea: string;

    /** @description The contacts timezone. */
    // @ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")
    public Timezone: string;

    /** @description Timezone Name */
    // @ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
    public TimezoneName: string;

    /** @description The primary address of the contact */
    // @ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
    public PrimaryAddress: string;

    /** @description Is this an active contact? Or an inactive contact (deleted account)? */
    // @ApiMember(DataType="bool", Description="Is this an active contact? Or an inactive contact (deleted account)?", Name="IsActiveContact")
    public IsActiveContact: boolean;

    public constructor(init?: Partial<UserProfileSummaryModel>) { (Object as any).assign(this, init); }
}

export class GetContactsManagingOrgProfileResponse
{
    /** @description A list of contacts eligible, and managing the passed in Organisation Profile. */
    // @ApiMember(DataType="List<UserProfileSummaryModel>", Description="A list of contacts eligible, and managing the passed in Organisation Profile.", Name="ContactsManagingOrgProfile")
    public ContactsNotManagingOrgProfile: UserProfileSummaryModel[];

    public TotalContactsManagingOrgProfile: number;
    /** @description Service Stack Response Status. */
    // @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus")
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetContactsManagingOrgProfileResponse>) { (Object as any).assign(this, init); }
}

/** @description Gets a list of contacts that are currently managing the userProfileId supplied. */
// @Api(Description="Gets a list of contacts that are currently managing the userProfileId supplied.")
export class GetContactsManagingOrgProfile
{
    /** @description Id of the Organisation Profile record being managed. */
    // @ApiMember(DataType="Guid", Description="Id of the Organisation Profile record being managed.", IsRequired=true, Name="UserProfileId", ParameterType="query")
    public UserProfileId: string;

    public constructor(init?: Partial<GetContactsManagingOrgProfile>) { (Object as any).assign(this, init); }
}

TypeScript GetContactsManagingOrgProfile DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/contacts/{UserProfileId}/managingorgprofile HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetContactsManagingOrgProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <UserProfileId>00000000-0000-0000-0000-000000000000</UserProfileId>
</GetContactsManagingOrgProfile>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetContactsManagingOrgProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactsNotManagingOrgProfile xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:UserProfileSummaryModel>
      <d2p1:Abn>String</d2p1:Abn>
      <d2p1:Acn>String</d2p1:Acn>
      <d2p1:Arbn>String</d2p1:Arbn>
      <d2p1:ContactFullName>String</d2p1:ContactFullName>
      <d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
      <d2p1:ContactTypeId>00000000-0000-0000-0000-000000000000</d2p1:ContactTypeId>
      <d2p1:ContactTypeName>String</d2p1:ContactTypeName>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:ESL>false</d2p1:ESL>
      <d2p1:EmailAddress>String</d2p1:EmailAddress>
      <d2p1:EmailSignature>String</d2p1:EmailSignature>
      <d2p1:EmploymentGeographicArea>String</d2p1:EmploymentGeographicArea>
      <d2p1:EmploymentIndustry>String</d2p1:EmploymentIndustry>
      <d2p1:EmploymentRole>String</d2p1:EmploymentRole>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:GstRegistered>false</d2p1:GstRegistered>
      <d2p1:InterpreterRequired>false</d2p1:InterpreterRequired>
      <d2p1:IsActiveContact>false</d2p1:IsActiveContact>
      <d2p1:Language>String</d2p1:Language>
      <d2p1:LegalName>String</d2p1:LegalName>
      <d2p1:LicenseeNotes>String</d2p1:LicenseeNotes>
      <d2p1:MobileNumber>String</d2p1:MobileNumber>
      <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
      <d2p1:PrimaryAddress>String</d2p1:PrimaryAddress>
      <d2p1:ProfileImageId>00000000-0000-0000-0000-000000000000</d2p1:ProfileImageId>
      <d2p1:ProfileName>String</d2p1:ProfileName>
      <d2p1:ProfilePhotoThumbnailUrl>String</d2p1:ProfilePhotoThumbnailUrl>
      <d2p1:ProfilePhotoUrl>String</d2p1:ProfilePhotoUrl>
      <d2p1:Surname>String</d2p1:Surname>
      <d2p1:Timezone>00000000-0000-0000-0000-000000000000</d2p1:Timezone>
      <d2p1:TimezoneName>String</d2p1:TimezoneName>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:TradingName>String</d2p1:TradingName>
      <d2p1:UserId>00000000-0000-0000-0000-000000000000</d2p1:UserId>
      <d2p1:UserName>String</d2p1:UserName>
      <d2p1:UserProfileId>00000000-0000-0000-0000-000000000000</d2p1:UserProfileId>
    </d2p1:UserProfileSummaryModel>
  </ContactsNotManagingOrgProfile>
  <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>
  <TotalContactsManagingOrgProfile>0</TotalContactsManagingOrgProfile>
</GetContactsManagingOrgProfileResponse>