| GET | /api/automation/notification/{ObjectId}/roles |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GroupedListItemModel:
list_item_id: Optional[str] = None
name: Optional[str] = None
group_id: Optional[str] = None
group_name: Optional[str] = None
# @ApiResponse(Description="A list of roles that are eligible to be assigned to a notification.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetRolesForAutomationNotificationsResponse:
# @ApiMember(Description="List of all roles (grouped by suite) that can be assigned to a notification.")
all_roles: Optional[List[GroupedListItemModel]] = None
"""
List of all roles (grouped by suite) that can be assigned to a notification.
"""
# @ApiMember(Description="List of roles that are already assigned to an email notification for the object, these should be excluded from being selected again.")
roles_used_email: Optional[List[str]] = None
"""
List of roles that are already assigned to an email notification for the object, these should be excluded from being selected again.
"""
# @ApiMember(Description="List of roles that are already assigned to an sms notification for the object, these should be excluded from being selected again.")
roles_used_s_m_s: Optional[List[str]] = None
"""
List of roles that are already assigned to an sms notification for the object, these should be excluded from being selected again.
"""
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get eligible roles for automation notifications")
# @ApiResponse(Description="A list of roles that are eligible to be assigned to a notification.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetRolesForAutomationNotifications(GetRolesForAutomationNotificationsResponse):
"""
Get eligible roles for automation notifications
"""
# @ApiMember(Description="Object the notification will be for. Used to exclude any currently assigned roles.", ParameterType="path")
object_id: Optional[str] = None
"""
Object the notification will be for. Used to exclude any currently assigned roles.
"""
Python GetRolesForAutomationNotifications DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/automation/notification/{ObjectId}/roles HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"AllRoles":[{"ListItemId":"00000000-0000-0000-0000-000000000000","Name":"String","GroupId":"00000000-0000-0000-0000-000000000000","GroupName":"String"}],"RolesUsedEmail":["00000000-0000-0000-0000-000000000000"],"RolesUsedSMS":["00000000-0000-0000-0000-000000000000"],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}