Platform API

GetContactsManagingOrgProfile

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

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

**GetContactsManagingOrgProfile** Parameters:
Name	Parameter	Data Type	Required	Description
UserProfileId	query	Guid	Yes	Id of the Organisation Profile record being managed.

**GetContactsManagingOrgProfileResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ContactsNotManagingOrgProfile	form	List<UserProfileSummaryModel>	No	A list of contacts eligible, and managing the passed in Organisation Profile.
TotalContactsManagingOrgProfile	form	int	No
ResponseStatus	form	ResponseStatus	No	Service Stack Response Status.

**UserProfileSummaryModel** Parameters:
Name	Parameter	Data Type	Required	Description
UserProfileId	form	Guid	No	User Profile Id
UserId	form	Guid	No	User linked to the profile
ContactId	form	Guid	No	Contact linked to the profile
UserName	form	string	No	User linked to the profile
ProfileName	form	string	No	User Profile Name
ContactFullName	form	string	No	Full name of the contact linked to the profile
EmailAddress	form	string	No	Email Address of the contact linked to the profile
EmailSignature	form	string	No	Email signature of the contact linked to the profile
MobileNumber	form	string	No	Mobile number of the contact linked to the profile
PhoneNumber	form	string	No	Phone number of the contact linked to the profile
ContactTypeId	form	string	No	Type of contact (person, organisation etc.) linked to the profile
ContactTypeName	form	string	No	Type of contact (person, organisation etc.) linked to the profile
FirstName	form	string	No	First name of the contact linked to the profile
Surname	form	string	No	Surname of the contact linked to the profile
Title	form	string	No	Title of contact linked to the profile
LegalName	form	string	No	Legal name of contact linked to the profile
TradingName	form	string	No	Trading name of contact linked to the profile
Abn	query	string	No	Australian Business Number
Acn	query	string	No	Australian Company Number
Arbn	query	string	No	Australian Registered Body Number
GstRegistered	query	bool	No	Indicates if the Contact is registered for GST.
ESL	query	bool	No	True if english is a secondary language for the contact.
Language	query	string	No	Language that is the primary language for the contact.
InterpreterRequired	query	bool	No	True if an interpreter is required.
LicenseeNotes	query	string	No	Licensee specific notes about the contact.
ProfilePhotoUrl	form	string	No	Profile photo of contact linked to the profile
ProfilePhotoThumbnailUrl	form	string	No	Thumbnail photo of contact linked to the profile
ProfileImageId	form	Guid	No	Profile photo id of contact linked to the profile
Description	form	string	No	Profile description
EmploymentIndustry	form	string	No	Employment Industry
EmploymentRole	form	string	No	Employment Role
EmploymentGeographicArea	form	string	No	Areas of Work
Timezone	query	Guid	No	The contacts timezone.
TimezoneName	query	string	No	Timezone Name
PrimaryAddress	query	string	No	The primary address of the contact
IsActiveContact	form	bool	No	Is this an active contact? Or an inactive contact (deleted account)?

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>