Retrieves a summary of the contact's details that is suitable for display purposes.
| Name | Description | Default |
|---|---|---|
id
|
Contact number (unique ID). | |
parts
|
Components included in the response. |
All
|
Content Type:
application/xml
or
application/json
Summary details or an error message.
| XML JSON |
|---|
<Response>
<Result>
<ID>long</ID> <!--Unique contact ID-->
<ContactTypes> <!--Array of 'Item'-->
<Item>string</Item> <!--'Individual' or 'Entity' at minimum-->
</ContactTypes>
<ClientTypes> <!--Array of 'Item'-->
<Item>string</Item>
</ClientTypes>
<Created>
<Date>datetime</Date>
<MemberCode>string</MemberCode>
</Created>
<LastModified>
<Date>datetime</Date>
<MemberCode>string</MemberCode>
<ModificationTypes> <!--Array of 'Item'-->
<Item>string</Item>
</ModificationTypes>
</LastModified>
<Contact>
<ContactHeading>string</ContactHeading> <!--Overall type of contact-->
<DisplayName>string</DisplayName>
<EntityName>string</EntityName> <!--Entity contacts only-->
<Gender>string</Gender> <!--'Male', 'Female' or 'Unknown'-->
<PositionAndIndustry>string</PositionAndIndustry>
<AssociatedEntity>
<ID>long</ID>
<FileAs>string</FileAs>
</AssociatedEntity>
<Trustee>
<ID>long</ID>
<FileAs>string</FileAs>
</Trustee>
<Spouse>
<ID>long</ID>
<FileAs>string</FileAs>
</Spouse>
<EntityCategory>string</EntityCategory> <!--Entity contacts only-->
<ABN>string</ABN> <!--Entity contacts only-->
<ACN>string</ACN> <!--Entity contacts only-->
<AdmissionDate>datetime</AdmissionDate> <!--Lawyer contacts only-->
<ReferredBy>
<ID>long</ID>
<FileAs>string</FileAs>
</ReferredBy>
<HistoricalCode>string</HistoricalCode> <!--Legacy identifier-->
</Contact>
<Correspondence>
<Greeting>string</Greeting>
<Closing>string</Closing>
<Addresses> <!--Array of 'Item'-->
<Item>
<ID>long</ID>
<Type>string</Type> <!--'Address', 'MailTo', 'RegisteredOffice', 'Location' or 'None'-->
<Description>string</Description>
<Address>string</Address>
</Item>
</Addresses>
</Correspondence>
<Communications>
<PreferredMethod>string</PreferredMethod> <!--'None', 'Post', 'Facsimile' or 'Email'-->
<Items> <!--Array of 'Item'-->
<Item>
<ID>long</ID>
<Type>string</Type> <!--'Telephone', 'Facsimile', 'Email' or 'Website'-->
<Description>string</Description>
<Communication>string</Communication>
<IsPreferred>bool</IsPreferred>
</Item>
</Items>
</Communications>
<Notes>string</Notes> <!--Free-form notes (RTF)-->
<RelatedContacts>
<Total>int</Total>
<Additional>int</Additional>
<Contacts> <!--Array of 'Item'-->
<Item>
<ID>long</ID>
<FileAs>string</FileAs>
<Relationship>string</Relationship> <!--Relative to the outer contact-->
</Item>
</Contacts>
</RelatedContacts>
<RecentFiles>
<Files> <!--Array of 'Item'-->
<Item>
<ID>long</ID> <!--Unique matter ID-->
<FileNumber>string</FileNumber> <!--Human-readable file number-->
<Matter>string</Matter>
<CompanyID>long</CompanyID> <!--Company (unique ID)-->
<PrimaryClientID>long</PrimaryClientID> <!--Contact number (unique ID) of primary client-->
</Item>
</Files>
<ActiveTotal>int</ActiveTotal> <!--Total number of active matters-->
<ArchivedTotal>int</ArchivedTotal> <!--Total number of archived matters-->
</RecentFiles>
<Identification>
<TotalPoints>int</TotalPoints>
<Items> <!--Array of 'Item'-->
<Item>
<ID>long</ID>
<Description>string</Description>
<Detail>string</Detail>
<IsExpired>bool</IsExpired>
<Points>int</Points>
<DocumentID>long</DocumentID> <!--Related document-->
<Password>string</Password> <!--Password entries only-->
</Item>
</Items>
</Identification>
<Financial>
<EFTDetails>
<BankCode>string</BankCode>
<BSB>string</BSB>
<AccountNo>string</AccountNo>
</EFTDetails>
<HasCreditCardDetails>bool</HasCreditCardDetails>
<BPayDetails>
<BillerCode>string</BillerCode>
<Reference>string</Reference>
</BPayDetails>
<CreditTerms>string</CreditTerms> <!--Creditor contacts only-->
<CreditTermsDays>int</CreditTermsDays> <!--Creditor contacts only-->
<CreditLimit>decimal</CreditLimit>
</Financial>
<Tags> <!--Array of 'Item'-->
<Item>string</Item>
</Tags>
</Result>
<Message>string</Message> <!--Error message-->
</Response>
|
{
"Result": {
"ID": "long", // Unique contact ID
"ContactTypes": [ "string" ], // 'Individual' or 'Entity' at minimum
"ClientTypes": [ "string" ],
"Created": {
"Date": "datetime",
"MemberCode": "string"
},
"LastModified": {
"Date": "datetime",
"MemberCode": "string",
"ModificationTypes": [ "string" ]
},
"Contact": {
"ContactHeading": "string", // Overall type of contact
"DisplayName": "string",
"EntityName": "string", // Entity contacts only
"Gender": "string", // 'Male', 'Female' or 'Unknown'
"PositionAndIndustry": "string",
"AssociatedEntity": {
"ID": "long",
"FileAs": "string"
},
"Trustee": {
"ID": "long",
"FileAs": "string"
},
"Spouse": {
"ID": "long",
"FileAs": "string"
},
"EntityCategory": "string", // Entity contacts only
"ABN": "string", // Entity contacts only
"ACN": "string", // Entity contacts only
"AdmissionDate": "datetime", // Lawyer contacts only
"ReferredBy": {
"ID": "long",
"FileAs": "string"
},
"HistoricalCode": "string" // Legacy identifier
},
"Correspondence": {
"Greeting": "string",
"Closing": "string",
"Addresses": [{
"ID": "long",
"Type": "string", // 'Address', 'MailTo', 'RegisteredOffice', 'Location' or 'None'
"Description": "string",
"Address": "string"
}]
},
"Communications": {
"PreferredMethod": "string", // 'None', 'Post', 'Facsimile' or 'Email'
"Items": [{
"ID": "long",
"Type": "string", // 'Telephone', 'Facsimile', 'Email' or 'Website'
"Description": "string",
"Communication": "string",
"IsPreferred": "bool"
}]
},
"Notes": "string", // Free-form notes (RTF)
"RelatedContacts": {
"Total": "int",
"Additional": "int",
"Contacts": [{
"ID": "long",
"FileAs": "string",
"Relationship": "string" // Relative to the outer contact
}]
},
"RecentFiles": {
"Files": [{
"ID": "long", // Unique matter ID
"FileNumber": "string", // Human-readable file number
"Matter": "string",
"CompanyID": "long", // Company (unique ID)
"PrimaryClientID": "long" // Contact number (unique ID) of primary client
}],
"ActiveTotal": "int", // Total number of active matters
"ArchivedTotal": "int" // Total number of archived matters
},
"Identification": {
"TotalPoints": "int",
"Items": [{
"ID": "long",
"Description": "string",
"Detail": "string",
"IsExpired": "bool",
"Points": "int",
"DocumentID": "long", // Related document
"Password": "string" // Password entries only
}]
},
"Financial": {
"EFTDetails": {
"BankCode": "string",
"BSB": "string",
"AccountNo": "string"
},
"HasCreditCardDetails": "bool",
"BPayDetails": {
"BillerCode": "string",
"Reference": "string"
},
"CreditTerms": "string", // Creditor contacts only
"CreditTermsDays": "int", // Creditor contacts only
"CreditLimit": "decimal"
},
"Tags": [ "string" ]
},
"Message": "string" // Error message
}
|
| Code | Condition |
|---|---|
| 200 OK | The operation completed successfully. |
| 400 Bad Request | Invalid contact number. |
| 401 Unauthorized | Access token is invalid, expired or not specified. |
| 404 Not Found | Contact not found. |
| 406 Not Acceptable | Content type specified in the Accept header isn't supported. |
| 500 Internal Server Error | An internal error occurred. |
parts parameter can be one (or more, separated by commas) of the following values:
| Value | Description |
|---|---|
None | Response will contain only the most basic details about the contact. |
Contact | Name and key information. |
Correspondence | Correspondence preferences and addresses. |
Communications | Communication details (phone, fax, e-mail, etc). |
Notes | Contact notes (Rich Text Format). |
RelatedContacts | Related contacts. |
RecentFiles | For client contacts, a list of recent files. |
Identification | Identification entries and totals. |
Financial | Financial details. |
Tags | Tags. |
All | All parts. |
Regardless of the parts parameter, parts which are not defined for the contact will not appear in the response.