| PUT | /api/role/{ContactRoleId}/archive | ||
|---|---|---|---|
| PUT | /api/role/{ContactRoleId}/restore |
/** @description Archives or Restores a Role record. */
// @Api(Description="Archives or Restores a Role record.")
export class UpdateRoleStatus
{
/** @description 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 ContactRoleId: string;
public constructor(init?: Partial<UpdateRoleStatus>) { (Object as any).assign(this, init); }
}
TypeScript UpdateRoleStatus 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/role/{ContactRoleId}/archive HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
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
}
}