Listing all contact persons¶
Sends a GET request to the endpoint /organization/contacts.
Description¶
The List-Contacts request allows the user to request a list of all contact persons of the organisation.
Requirements¶
Values of the request: none
Objects: none
Request¶
To request a list of all contact persons, no additional information needs to be added to the path of the request.
As a result, the user gets one or more objects OrganizationContactVO with the requested information.
The object provides the following information:
| Attributes | Description | Values |
|---|---|---|
userId |
The id of the user related to the entry, if the contact person is a Myra App user. | integer |
name |
The name of the contact person. | string |
email |
The email address of the contact person. | string |
phone |
The phone number of the contact person. | integer |
receiveSSLReminders |
Shows whether the contact person gets notifications about expiring certificates. |
|
technicalPriority |
The priority of the contact person for technical issues. | integer |
escalationPriority |
The priority of the contact person for escalations. | integer |
id |
The ID of the entry. | integer |
modified |
The last modification date in ISO 8601 format. | string($date-time) |
created |
The creation date in ISO 8601 format. | string($date-time) |
Example¶
Example response:
[
{
"objectType": "string",
"userId": 0,
"name": "string",
"email": "string",
"phone": "string",
"receiveSSLReminders": true,
"technicalPriority": "string",
"escalationPriority": "string",
"id": 0,
"modified": "string",
"created": "string"
}
]
Responses¶
The following responses are available:
| STATUS CODE | DESCRIPTION |
|---|---|
| 200 | A list of OrganizationContactVO elements. |
| 400 | The request was unsuccessful. The request was invalid or information is missing. |
| 401 | The request has not succeeded because the user authentication was incorrect. |
| 403 | The request has not succeeded because the user does not have the right permissions. |