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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @Api(Description="Archives or Restores a Dimension record.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateDimensionStatus:
    """
    Archives or Restores a Dimension record.
    """

    # @ApiMember(Description="DimensionId of the dimension to have its status changed", Name="DimensionId")
    dimension_id: Optional[str] = None
    """
    DimensionId of the dimension to have its status changed
    """

Python UpdateDimensionStatus 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/dimensions/{DimensionId}/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
	}
}