Platform API

UpdateRoleStatus

Archives or Restores a Role record.

The following routes are available for this service:
PUT	/api/role/{ContactRoleId}/archive
PUT	/api/role/{ContactRoleId}/restore

import 'package:servicestack/servicestack.dart';

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

    UpdateRoleStatus({this.ContactRoleId});
    UpdateRoleStatus.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

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

Dart UpdateRoleStatus DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

{
	
}

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
	}
}