Platform API

<back to all web services

UpdateRoleGroupStatus

Archives or Restores a Role Group record.

Requires Authentication
The following routes are available for this service:
PUT/api/contactrolegroup/{ContactRoleGroupId}/archive
PUT/api/contactrolegroup/{ContactRoleGroupId}/restore
import 'package:servicestack/servicestack.dart';

/**
* Archives or Restores a Role Group record.
*/
// @Api(Description="Archives or Restores a Role Group record.")
class UpdateRoleGroupStatus implements IConvertible
{
    /**
    * Id of the Contact Role Group record to be Archived or Restored.
    */
    // @ApiMember(DataType="Guid", Description="Id of the Contact Role Group record to be Archived or Restored.", IsRequired=true, Name="ContactRoleGroupId", ParameterType="query")
    String? ContactRoleGroupId;

    /**
    * True if the action is Archive, False for Restore.
    */
    // @ApiMember(DataType="bool", Description="True if the action is Archive, False for Restore.", IsRequired=true, Name="IsActionArchive", ParameterType="query")
    bool? IsActionArchive;

    UpdateRoleGroupStatus({this.ContactRoleGroupId,this.IsActionArchive});
    UpdateRoleGroupStatus.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ContactRoleGroupId = json['ContactRoleGroupId'];
        IsActionArchive = json['IsActionArchive'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ContactRoleGroupId': ContactRoleGroupId,
        'IsActionArchive': IsActionArchive
    };

    getTypeName() => "UpdateRoleGroupStatus";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'UpdateRoleGroupStatus': TypeInfo(TypeOf.Class, create:() => UpdateRoleGroupStatus()),
});

Dart UpdateRoleGroupStatus DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ContactRoleGroupId":"00000000-0000-0000-0000-000000000000","IsActionArchive":false}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}