Platform API

<back to all web services

UpdateRoleStatus

Archives or Restores a Role record.

Requires Authentication
The following routes are available for this service:
PUT/api/role/{ContactRoleId}/archive
PUT/api/role/{ContactRoleId}/restore
import Foundation
import ServiceStack

/**
* Archives or Restores a Role record.
*/
// @Api(Description="Archives or Restores a Role record.")
public class UpdateRoleStatus : Codable
{
    /**
    * Id of the Contact Role record to be Archived or Restored.
    */
    // @ApiMember(DataType="Guid", Description="Id of the Contact Role record to be Archived or Restored.", IsRequired=true, Name="ContactRoleId", ParameterType="query")
    public var contactRoleId:String

    required public init(){}
}

Swift UpdateRoleStatus DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ContactRoleId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}