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
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Archives or Restores a Dimension Value record.
    ///</summary>
    [<Api(Description="Archives or Restores a Dimension Value record.")>]
    [<AllowNullLiteral>]
    type UpdateDimensionValueStatus() = 
        ///<summary>
        ///DimensionValueId of the dimension value to have its status changed
        ///</summary>
        [<ApiMember(Description="DimensionValueId of the dimension value to have its status changed", Name="DimensionValueId")>]
        member val DimensionValueId:Guid = new Guid() with get,set

F# UpdateDimensionValueStatus 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/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
	}
}