| PUT | /api/contactgroup/{ContactGroupId}/archive | ||
|---|---|---|---|
| PUT | /api/contactgroup/{ContactGroupId}/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 Contact Group record.
///</summary>
[<Api(Description="Archives or Restores a Contact Group record.")>]
[<AllowNullLiteral>]
type UpdateContactGroupStatus() =
///<summary>
///ContactGroupId of the Contact group to be deleted
///</summary>
[<ApiMember(Description="ContactGroupId of the Contact group to be deleted", Name="ContactGroupId")>]
member val ContactGroupId: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# 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
}
}