| PUT | /api/contactgroup/{ContactGroupId}/archive | ||
|---|---|---|---|
| PUT | /api/contactgroup/{ContactGroupId}/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 Contact Group record.
'''</Summary>
<Api(Description:="Archives or Restores a Contact Group record.")>
Public Partial Class UpdateContactGroupStatus
'''<Summary>
'''ContactGroupId of the Contact group to be deleted
'''</Summary>
<ApiMember(Description:="ContactGroupId of the Contact group to be deleted", Name:="ContactGroupId")>
Public Overridable Property ContactGroupId 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 UpdateContactGroupStatus DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /api/contactgroup/{ContactGroupId}/archive HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
IsActionArchive: False
}
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
}
}