| POST | /api/roles |
|---|
import Foundation
import ServiceStack
/**
* Add a custom role for the licensee
*/
// @Api(Description="Add a custom role for the licensee")
public class AddContactRole : Codable
{
/**
* Details of the Contact Role to be Added.
*/
// @ApiMember(DataType="RoleDetailsModel", Description="Details of the Contact Role to be Added.", IsRequired=true, Name="RoleDetails", ParameterType="query")
public var roleDetails:RoleDetailsModel
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(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/roles HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"RoleDetails":{"RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String","RoleConnectionDefinitionId":"00000000-0000-0000-0000-000000000000","ContactTypes":["00000000-0000-0000-0000-000000000000"],"RequireContactsToAccept":false,"ListItemFilters":[{"ListItemFilterId":"00000000-0000-0000-0000-000000000000","FilterName":"String","ListId":"00000000-0000-0000-0000-000000000000","ListItemId":"00000000-0000-0000-0000-000000000000","ListItemIsInFilter":false}]}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}