| All Verbs | /api/contacts/{UserProfileId}/notmanagingorgprofile |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserProfileId | query | Guid | Yes | Id of the Organisation Profile record being managed. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactsNotManagingOrgProfile | form | List<UserProfileSummaryModel> | No | A list of contacts eligible, but not yet managing the passed in Organisation Profile. |
| TotalContactsNotManagingOrgProfile | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | Service Stack Response Status. |
| 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/contacts/{UserProfileId}/notmanagingorgprofile HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"UserProfileId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ContactsNotManagingOrgProfile":[{"UserProfileId":"00000000-0000-0000-0000-000000000000","UserId":"00000000-0000-0000-0000-000000000000","ContactId":"00000000-0000-0000-0000-000000000000","UserName":"String","ProfileName":"String","ContactFullName":"String","EmailAddress":"String","EmailSignature":"String","MobileNumber":"String","PhoneNumber":"String","ContactTypeId":"00000000-0000-0000-0000-000000000000","ContactTypeName":"String","FirstName":"String","Surname":"String","Title":"String","LegalName":"String","TradingName":"String","Abn":"String","Acn":"String","Arbn":"String","GstRegistered":false,"ESL":false,"Language":"String","InterpreterRequired":false,"LicenseeNotes":"String","ProfilePhotoUrl":"String","ProfilePhotoThumbnailUrl":"String","ProfileImageId":"00000000-0000-0000-0000-000000000000","Description":"String","EmploymentIndustry":"String","EmploymentRole":"String","EmploymentGeographicArea":"String","Timezone":"00000000-0000-0000-0000-000000000000","TimezoneName":"String","PrimaryAddress":"String","IsActiveContact":false}],"TotalContactsNotManagingOrgProfile":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}