| PUT | /api/contactrolegroup/{ContactRoleGroupId}/archive | ||
|---|---|---|---|
| PUT | /api/contactrolegroup/{ContactRoleGroupId}/restore |
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
# @Api(Description="Archives or Restores a Role Group record.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateRoleGroupStatus:
"""
Archives or Restores a Role Group record.
"""
# @ApiMember(DataType="Guid", Description="Id of the Contact Role Group record to be Archived or Restored.", IsRequired=true, Name="ContactRoleGroupId", ParameterType="query")
contact_role_group_id: Optional[str] = None
"""
Id of the Contact Role Group record to be Archived or Restored.
"""
# @ApiMember(DataType="bool", Description="True if the action is Archive, False for Restore.", IsRequired=true, Name="IsActionArchive", ParameterType="query")
is_action_archive: Optional[bool] = None
"""
True if the action is Archive, False for Restore.
"""
Python UpdateRoleGroupStatus DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /api/contactrolegroup/{ContactRoleGroupId}/archive HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ContactRoleGroupId":"00000000-0000-0000-0000-000000000000","IsActionArchive":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}