Platform API

<back to all web services

UpdateRoleGroupStatus

Archives or Restores a Role Group record.

Requires Authentication
The following routes are available for this service:
PUT/api/contactrolegroup/{ContactRoleGroupId}/archive
PUT/api/contactrolegroup/{ContactRoleGroupId}/restore
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel

Namespace Global

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Archives or Restores a Role Group record.
        '''</Summary>
        <Api(Description:="Archives or Restores a Role Group record.")>
        Public Partial Class 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")>
            Public Overridable Property ContactRoleGroupId As Guid

            '''<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")>
            Public Overridable Property IsActionArchive As Boolean?
        End Class
    End Namespace
End Namespace

VB.NET UpdateRoleGroupStatus 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/contactrolegroup/{ContactRoleGroupId}/archive HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ContactRoleGroupId":"00000000-0000-0000-0000-000000000000","IsActionArchive":false}

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"}}