Retrieving configuration for accessible lists¶
GET /integrations/inxmail-professional/accessible-customers/{customerName}/configuration/accessible-lists
Request Parameters¶
Parameter | Required | In | Description |
---|---|---|---|
customerName | yes | path | The name of accessible customer |
Response Structure¶
Path | Type | Description |
---|---|---|
creationDate | String | The date and time when the configuration for accessible lists was created |
modificationDate | String | The date and time when the configuration for accessible lists was last modified |
permitAll | Boolean | true if the space is permitted to access all Inxmail Professional lists |
permittedLists | Array<Number> | List of Inxmail Professional lists which the space is permitted |
_links | Object | The links currently available for this resource. |
Basic example¶
Request:
$ curl 'https://myka-1.my-api.inxmail.de/integrations/inxmail-professional/accessible-customers/myka/configuration/accessible-lists' -i -X GET \
-H 'Authorization: Basic <base64Encoded user:password>' \
Response:
HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: ...
{
"creationDate": "2021-10-18T16:19:38.070Z",
"modificationDate": "2021-10-18T16:19:38.070Z",
"permitAll": false,
"permittedLists": [
3,
5,
8,
1,
2
],
"_links": {
"self": {
"href": "http://myka-1.my-api.inxdev.de:9000/inxmail-professional-adapter/api/integrations/inxmail-professional/accessible-customers/myka/configuration/accessible-lists"
}
}
}