Platform API

UpdateRoleGroupStatus

Archives or Restores a Role Group record.

The following routes are available for this service:
PUT	/api/contactrolegroup/{ContactRoleGroupId}/archive
PUT	/api/contactrolegroup/{ContactRoleGroupId}/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 Role Group record.
    ///</summary>
    [<Api(Description="Archives or Restores a Role Group record.")>]
    [<AllowNullLiteral>]
    type UpdateRoleGroupStatus() = 
        ///<summary>
        ///Id of the Contact Role Group record to be Archived or Restored.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Id of the Contact Role Group record to be Archived or Restored.", IsRequired=true, Name="ContactRoleGroupId", ParameterType="query")>]
        member val ContactRoleGroupId:Guid = new Guid() with get,set

        ///<summary>
        ///True if the action is Archive, False for Restore.
        ///</summary>
        [<ApiMember(DataType="bool", Description="True if the action is Archive, False for Restore.", IsRequired=true, Name="IsActionArchive", ParameterType="query")>]
        member val IsActionArchive:Nullable<Boolean> = new Nullable<Boolean>() with get,set

F# UpdateRoleGroupStatus DTOs

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

HTTP + XML

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

PUT /api/contactrolegroup/{ContactRoleGroupId}/archive HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateRoleGroupStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactRoleGroupId>00000000-0000-0000-0000-000000000000</ContactRoleGroupId>
  <IsActionArchive>false</IsActionArchive>
</UpdateRoleGroupStatus>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>