| PUT | /api/roles |
|---|
import Foundation
import ServiceStack
/**
* Updates a Role record, and updates Sharing.
*/
// @Api(Description="Updates a Role record, and updates Sharing.")
public class UpdateRoleWithSharing : Codable
{
/**
* Details of the Contact Role to be Updated.
*/
// @ApiMember(DataType="RoleDetailsModel", Description="Details of the Contact Role to be Updated.", IsRequired=true, Name="RoleDetails", ParameterType="query")
public var roleDetails:RoleDetailsModel
/**
*
*/
// @ApiMember(DataType="FormCollection", Description="", Name="Form", ParameterType="query")
public var form:FormCollection
/**
* List of Object Share details.
*/
// @ApiMember(DataType="List<ObjectShareModel>", Description="List of Object Share details.", Name="ShareList", ParameterType="query")
public var shareList:[ObjectShareModel]
required public init(){}
}
public class RoleDetailsModel : Codable
{
/**
* Role Id
*/
// @ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
public var roleId:String
/**
* Role Name
*/
// @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
public var roleName:String
/**
* Role Connection Definition Id
*/
// @ApiMember(DataType="Guid", Description="Role Connection Definition Id", Name="RoleConnectionDefinitionId")
public var roleConnectionDefinitionId:String
/**
* Contact Types the Role applies to
*/
// @ApiMember(DataType="List", Description="Contact Types the Role applies to", Name="ContactTypes")
public var contactTypes:[String]
/**
* Does the role require contacts to accept it?
*/
// @ApiMember(DataType="bool", Description="Does the role require contacts to accept it?", Name="RequireContactsToAccept")
public var requireContactsToAccept:Bool
/**
* Filters linked to the custom role.
*/
// @ApiMember(DataType="List", Description="Filters linked to the custom role.", Name="ListItemFilters")
public var listItemFilters:[ListItemFilterModel]
required public init(){}
}
public class ListItemFilterModel : Codable
{
public var listItemFilterId:String
public var filterName:String
public var listId:String
public var listItemId:String
public var listItemIsInFilter:Bool
required public init(){}
}
public class ObjectShareModel : Codable
{
public var objectShareId:String
public var objectId:String
public var objectName:String
public var name:String
public var Description:String
public var reference:String
public var contactId:String
public var contactName:String
public var contactType:String
public var contactImageUrlPrimary:String
public var contactImageUrlPrimaryThmbnail:String
public var shareStatusId:String
public var shareStatusName:String
required public init(){}
}
Swift UpdateRoleWithSharing 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/roles HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
RoleDetails:
{
RoleName: String,
ContactTypes:
[
00000000-0000-0000-0000-000000000000
],
RequireContactsToAccept: False,
ListItemFilters:
[
{
FilterName: String,
ListItemIsInFilter: False
}
]
},
Form: [],
ShareList:
[
{
ObjectName: String,
Name: String,
Description: String,
Reference: String,
ContactName: String,
ContactType: String,
ContactImageUrlPrimary: String,
ContactImageUrlPrimaryThmbnail: String,
ShareStatusName: String
}
]
}
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
}
}