Platform API

<back to all web services

UpdateDimensionValueStatus

Archives or Restores a Dimension Value record.

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

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

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

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

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

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

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

Dart UpdateDimensionValueStatus DTOs

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

HTTP + CSV

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

PUT /api/dimensionvalues/{DimensionValueId}/archive HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

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