Platform API

<back to all web services

UpdateRoleGroupStatus

Archives or Restores a Role Group record.

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

PUT /api/contactrolegroup/{ContactRoleGroupId}/archive HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	IsActionArchive: False
}

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

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