Platform API

<back to all web services

UpdateDimensionValueStatus

Archives or Restores a Dimension Value record.

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


/** @description Archives or Restores a Dimension Value record. */
// @Api(Description="Archives or Restores a Dimension Value record.")
class UpdateDimensionValueStatus implements JsonSerializable
{
    public function __construct(
        /** @description DimensionValueId of the dimension value to have its status changed */
        // @ApiMember(Description="DimensionValueId of the dimension value to have its status changed", Name="DimensionValueId")
        /** @var string */
        public string $DimensionValueId=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['DimensionValueId'])) $this->DimensionValueId = $o['DimensionValueId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->DimensionValueId)) $o['DimensionValueId'] = $this->DimensionValueId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP UpdateDimensionValueStatus DTOs

PUT /api/dimensionvalues/{DimensionValueId}/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
	}
}