Platform API

<back to all web services

UpdateDimensionStatus

Archives or Restores a Dimension record.

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

/**
* Archives or Restores a Dimension record.
*/
// @Api(Description="Archives or Restores a Dimension record.")
class UpdateDimensionStatus implements IConvertible
{
    /**
    * DimensionId of the dimension to have its status changed
    */
    // @ApiMember(Description="DimensionId of the dimension to have its status changed", Name="DimensionId")
    String? DimensionId;

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

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

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

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

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

Dart UpdateDimensionStatus 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

HTTP + JSON

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

PUT /api/dimensions/{DimensionId}/archive HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"DimensionId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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