Entity API / get

Operation Information

Application Reference: com.hornbill.core
Scope: Entity - Contact
Class: Entity
Required Privilege Level: basic
Required Rights: none

Description

For internal use only - Get Contact by ID

Request Parameters

The get API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.

Name	Type	Required	Description
`id`	`xs:string`	Yes	Contact ID we want to retrieve
`getOrgData`	`xs:boolean`	No	Set true to get Organization Data in a JSON Object with Id and Name

Response Parameters

Name	Type	Description
`id`	`xs:string`	Contact Id
`firstname`	`xs:string`	Contact First Name
`lastname`	`xs:string`	Contact Last Name
`email1`	`xs:string`	Contact Email
`email2`	`xs:string`	Contact Second Email
`email3`	`xs:string`	Contact Third Email
`tel1`	`xs:string`	Contact Telephone
`tel2`	`xs:string`	Contact Second Telephone
`tel3`	`xs:string`	Contact Third Telephone
`organization`	`xs:string`	Organization JSON Object - id and Name
`jobtitle`	`xs:string`	Contact Job Title
`description`	`xs:string`	Contact Description
`company`	`xs:string`	Contact Company
`notes`	`xs:string`	Contact place to add long text
`country`	`xs:string`	The ISO 3166 alpha 2 country code that the contact is located in. If not set, the country set for the portal account is assumed
`region`	`xs:string`	Logical location of the contact
`language`	`xs:string`	The RFC3066 language code defined for this contact
`timezone`	`xs:string`	The timezone that the Contact is located in If not set, the timezone set the portal account is assumed
`status`	`xs:int`	Contact Status: 0 = active, 1 = suspended, 2 = archived/deleted - XMLMC accountStatusType
`owner`	`xs:string`	Contact Owner
`createdOn`	`xs:string`	Contact Created On
`createdBy`	`xs:string`	Contact Created By
`modifiedOn`	`xs:string`	Contact Last Date Modified On
`validatedOn`	`xs:string`	Contact Validated On
`lastAccessed`	`xs:string`	Contact Last Accessed
`type`	`xs:int`	Contact Type: 0 (or null) = Contact, 1 = visitor
`private`	`xs:int`	If 1 then this contact should only be visible to the h_owner. If h_owner is not set then is visible to everyone regardless
`rights`	`xs:int`	If 1 then this contact should be allowed to view requests for other organisations
`logonId`	`xs:string`	Contact Logon Id
`activityStreamId`	`xs:string`	The field used to store the activity stream id for the organization
`custom_1`	`xs:string`	Contact Custom 1
`custom_2`	`xs:string`	Contact Custom 2
`custom_3`	`xs:string`	Contact Custom 3
`custom_4`	`xs:string`	Contact Custom 4
`custom_5`	`xs:string`	Contact Custom 5
`custom_6`	`xs:string`	Contact Custom 6
`relatedData`	`xs:string`	Contact Custom 6

Code Examples

      curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.core/Contact' \
   -H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
   -H 'Content-Type: application/json' \
   -d '{"@service":"apps/com.hornbill.core/Contact","@method":"get","params":{"id":"xs:string","getOrgData":false}}'

      package main
import (
    "fmt"
    apiLib "github.com/hornbill/goApiLib"
)
func main() {
	hornbillAPI := apiLib.NewXmlmcInstance("yourinstanceid")
	hornbillAPI.SetAPIKey("yourHornbillAPIKey")
	hornbillAPI.SetJSONResponse(true)
	hornbillAPI.SetParam("id", "xs:string")
	hornbillAPI.SetParam("getOrgData", "xs:boolean")
	responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.core/Contact", "get")
	if apiError != nil {
		fmt.Println(apiError)
		return
	}
	fmt.Println(responseBody)
}

      const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.core/Contact";
const payload = {
  "@service": "apps/com.hornbill.core/Contact",
  "@method": "get",
  "params": {
    "id": "xs:string",
    "getOrgData": false
  }
};
fetch(endpoint, {
  method: 'POST',
  headers: {
    "Authorization": "ESP-APIKEY yourHornbillAPIKey"
  },
  body: JSON.stringify(payload)
}).then(res => res.json())
  .then(res => console.log(res));

      const axios = require('axios');
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.core/Contact";
const payload = {
  "@service": "apps/com.hornbill.core/Contact",
  "@method": "get",
  "params": {
    "id": "xs:string",
    "getOrgData": false
  }
};
const axiosConfig = {
  headers: {
    "Authorization": "ESP-APIKEY yourHornbillAPIKey"
  }
};
axios.post(endpoint, payload, axiosConfig)
.then((res) => {
    console.log("RESPONSE RECEIVED: ", res);
})
.catch((err) => {
    console.log("AXIOS ERROR: ", err);
})

      $endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.core/Contact";
$payload = (object) [
    '@service' => 'apps/com.hornbill.core/Contact',
    '@method' => 'get',
    'params' => (object) [
        'id' => 'xs:string',
        'getOrgData' => 'xs:boolean',
    ]
];
$headers = [
    'Authorization: ESP-APIKEY yourHornbillAPIKey',
    'Content-Type: application/json'
];
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $endpoint);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$resp = curl_exec($curl);
curl_close($curl);
echo $resp;

      $Endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.core/Contact"
$Body = @{
	"@service" = "apps/com.hornbill.core/Contact"
	"@method" = "get"
	params = @{
		id = "xs:string"
		getOrgData = "xs:boolean"
	}
}
$Header = @{
	"Authorization" = "ESP-APIKEY yourHornbillAPIKey"
}
$Parameters = @{
	Method      = "POST"
	Uri         = $Endpoint
	Headers     = $Header
	Body        = ($Body | ConvertTo-Json)
	ContentType = "application/json"
}
Invoke-RestMethod @Parameters

      import requests
import json
endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.core/Contact"
headers = {   
    "Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
        "@service":"apps/com.hornbill.core/Contact",
        "@method":"get",
        "params":{
            "id":"xs:string",
            "getOrgData":"xs:boolean",
        },
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)

{{docApp.title}}

{{docApp.description}}

How can we help?

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

{{resultItem.title}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{group.title || group.id}}

{{group.title}}

Entity API / get

Operation Information

Description

Request Parameters

Response Parameters

Code Examples

{{docApp.title}}

{{docApp.description}}

How can we help?

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}} Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

{{resultItem.title}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{group.title || group.id}}

{{group.title}}

Entity API / get

Operation Information

Description

Request Parameters

Response Parameters

Code Examples

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.