|
WARNING: This section is intended for advanced users and "Super users" of PRIM Logix.
The configuration items presented in this section may indeed have an impact on your operations.
If in doubt, consult your system administrator.
Please note that only users in the appropriate security groups can access the software configuration windows. |
Get the list of contact phone numbers
Returns the list of all contacts with their phone numbers (except for the phone types excluded)
URL: api/GetContactPhone
Attributes to pass to actionParameters
FilterTypeExclude
string
Optional
Comma , separated list of phone type identifiers to exclude from the list
We don't put a comma after the last type
Default value: 2,4
The list of phone number types below is from PRIM Logix basic configuration. The types and codes might be different in your agency. Please refer to pane Contact details type (CFG043) in the configuration window.
List of phone number types
Type |
Description |
1 |
Home |
2 |
Work |
3 |
Cell phone |
4 |
Fax |
5 |
Pager |
Note
The above list may vary depending on the agency
Complete example of a request
i.e.. To eliminate the phone numbers with type Fax or Pager
{
"actionParameters": {
"FilterTypeExclude": "4,5"
}
}
Response returned by Web service
{
"status": "success",
"data": [
{
"rownumber": 1,
"ContactId": 504,
"ContactName": "Arnaud H. Tachel",
"PhoneNumber": "1049870293",
"PhoneExtension": null
},
{
"rownumber": 2,
"ContactId": 504,
"ContactName": "Arnaud H. Tachel",
"PhoneNumber": "1234567894",
"PhoneExtension": null
}
]
}
Here is what each of the fields returned in each section of the data property corresponds to
rownumber
integer
Rank of the phone number in the JSON
Possible values: 1 or higher
ContactId
integer
Contact ID (concod)
Possible values: 1 or higher
ContactName
string
Contact name
PhoneNumber
string
Non-formatted phone number (numbers only)
PhoneExtension
string
Extension if applicable
Possible values: null (no extension) or value of the extension
