Platform API

UpdateRoleStatus

Archives or Restores a Role record.

The following routes are available for this service:
PUT	/api/role/{ContactRoleId}/archive
PUT	/api/role/{ContactRoleId}/restore

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Archives or Restores a Role record.
    ///</summary>
    [Api(Description="Archives or Restores a Role record.")]
    public partial class UpdateRoleStatus
    {
        ///<summary>
        ///Id of the Contact Role record to be Archived or Restored.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Id of the Contact Role record to be Archived or Restored.", IsRequired=true, Name="ContactRoleId", ParameterType="query")]
        public virtual Guid ContactRoleId { get; set; }
    }

}

C# UpdateRoleStatus 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/role/{ContactRoleId}/archive HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ContactRoleId":"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"}}