GET api/contacts/{id}/contactcontactnumbers?contactNumberCountryCode={contactNumberCountryCode}&contactNumberCountryCodeContains={contactNumberCountryCodeContains}
Get all ContactNumbers associated to a parent Contact record optionally filtered by any of the arguments specified in the query string.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The primary key of the parent Contact record in the Hobsons database. |
integer |
Required |
contactNumberCountryCode |
Optional case-insensitive filter on ContactNumbers with a country dialling code that matches the provided value. |
string |
None. |
contactNumberCountryCodeContains |
Optional case-insensitive filter on ContactNumberss with a country dialling code containing the provided value. |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
ContactContactNumberDtoName | Description | Type | Additional information |
---|---|---|---|
CrmNumber |
The primary key of the parent contact record in the Hobsons database. Ignored for PUT and POST requests sent to the API. |
integer |
Required Range: inclusive between 1 and 2147483647 |
ContactNumberTypeId |
The type of ContactNumber. Valid values are: [1 - Home Phone], [2 - Work Phone], [3 - Home Fax], [4 - Work Fax], [5 - Mobile] Ignored for PUT requests sent to the API. |
integer |
Required Range: inclusive between 1 and 5 |
ContactNumberTypeName |
The name of the ContactNumberType record that is binded to the ContactNumber. Ignored for PUT and POST requests sent to the API. |
string |
None. |
CountryCode |
The country calling code of the country the ContactNumber is associated to. |
string |
Max length: 7 |
AreaCode |
The area code of the location the ContactNumber is associated to. |
string |
Max length: 6 |
Number |
The local number of the ContactNumber record. |
string |
Required Max length: 15 |
Response Formats
application/json, text/json
{ "CrmNumber": 1, "ContactNumberTypeId": 2, "ContactNumberTypeName": "sample string 3", "CountryCode": "sample string 4", "AreaCode": "sample string 5", "Number": "sample string 6" }