GET api/Contacts/Tagged

Retrieves a list of contacts with the specified tag.

Request

Parameters

Name	Description	Default
`tag`	The tag to match.

Response

Body

Content Type: application/xml or application/json
Data set containing the contacts, or an error message.

XML JSON
<Response> <Result> <!--Array of 'Item'--> <Item> <ContactID>long</ContactID> <!--Contact number (unique ID)--> <ContactCode>string</ContactCode> <!--Historical code--> <Name>string</Name> <!--File-as name--> <Location>string</Location> <!--General location (based on physical address)--> <Email>string</Email> <!--E-mail address--> <PhoneNo>string</PhoneNo> <!--Telephone number--> <Industry>string</Industry> <!--Industry group--> <AdmissionDate>datetime</AdmissionDate> <!--Date of admission (lawyer contacts)--> <JobTitle>string</JobTitle> <!--Position--> <ProspectiveWorkgroup>string</ProspectiveWorkgroup> <!--Prospective workgroup--> <ReferralSource>string</ReferralSource> <!--Referral method--> <AssociatedWithID>long</AssociatedWithID> <!--Contact number (unique ID) of associated entity or head office--> <AssociatedWith>string</AssociatedWith> <!--Name of associated entity or head office--> </Item> </Result> <Message>string</Message> <!--Error message--> </Response>
{ "Result": [{ "ContactID": "long", // Contact number (unique ID) "ContactCode": "string", // Historical code "Name": "string", // File-as name "Location": "string", // General location (based on physical address) "Email": "string", // E-mail address "PhoneNo": "string", // Telephone number "Industry": "string", // Industry group "AdmissionDate": "datetime", // Date of admission (lawyer contacts) "JobTitle": "string", // Position "ProspectiveWorkgroup": "string", // Prospective workgroup "ReferralSource": "string", // Referral method "AssociatedWithID": "long", // Contact number (unique ID) of associated entity or head office "AssociatedWith": "string" // Name of associated entity or head office }], "Message": "string" // Error message }

XML JSON

<Response>                                                   
  <Result>                                                   <!--Array of 'Item'--> 
    <Item>                                                   
      <ContactID>long</ContactID>                            <!--Contact number (unique ID)--> 
      <ContactCode>string</ContactCode>                      <!--Historical code--> 
      <Name>string</Name>                                    <!--File-as name--> 
      <Location>string</Location>                            <!--General location (based on physical address)--> 
      <Email>string</Email>                                  <!--E-mail address--> 
      <PhoneNo>string</PhoneNo>                              <!--Telephone number--> 
      <Industry>string</Industry>                            <!--Industry group--> 
      <AdmissionDate>datetime</AdmissionDate>                <!--Date of admission (lawyer contacts)--> 
      <JobTitle>string</JobTitle>                            <!--Position--> 
      <ProspectiveWorkgroup>string</ProspectiveWorkgroup>    <!--Prospective workgroup--> 
      <ReferralSource>string</ReferralSource>                <!--Referral method--> 
      <AssociatedWithID>long</AssociatedWithID>              <!--Contact number (unique ID) of associated entity or head office--> 
      <AssociatedWith>string</AssociatedWith>                <!--Name of associated entity or head office--> 
    </Item>                                                  
  </Result>                                                  
  <Message>string</Message>                                  <!--Error message--> 
</Response>

{                                          
   "Result": [{                            
      "ContactID": "long",                 // Contact number (unique ID)
      "ContactCode": "string",             // Historical code
      "Name": "string",                    // File-as name
      "Location": "string",                // General location (based on physical address)
      "Email": "string",                   // E-mail address
      "PhoneNo": "string",                 // Telephone number
      "Industry": "string",                // Industry group
      "AdmissionDate": "datetime",         // Date of admission (lawyer contacts)
      "JobTitle": "string",                // Position
      "ProspectiveWorkgroup": "string",    // Prospective workgroup
      "ReferralSource": "string",          // Referral method
      "AssociatedWithID": "long",          // Contact number (unique ID) of associated entity or head office
      "AssociatedWith": "string"           // Name of associated entity or head office
   }],                                     
   "Message": "string"                     // Error message
}

Status Codes

Code	Condition
200 OK	The operation completed successfully.
400 Bad Request	Invalid tag.
401 Unauthorized	Access token is invalid, expired or not specified.
406 Not Acceptable	Content type specified in the Accept header isn't supported.
500 Internal Server Error	An internal error occurred.