| POST | /api/roles |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Add a custom role for the licensee
*/
@Api(Description="Add a custom role for the licensee")
open class AddContactRole
{
/**
* 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")
open var RoleDetails:RoleDetailsModel? = null
}
open class RoleDetailsModel
{
/**
* Role Id
*/
@ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
open var RoleId:UUID? = null
/**
* Role Name
*/
@ApiMember(DataType="string", Description="Role Name", Name="RoleName")
open var RoleName:String? = null
/**
* Role Connection Definition Id
*/
@ApiMember(DataType="Guid", Description="Role Connection Definition Id", Name="RoleConnectionDefinitionId")
open var RoleConnectionDefinitionId:UUID? = null
/**
* Contact Types the Role applies to
*/
@ApiMember(DataType="List", Description="Contact Types the Role applies to", Name="ContactTypes")
open var ContactTypes:ArrayList<UUID>? = null
/**
* Does the role require contacts to accept it?
*/
@ApiMember(DataType="bool", Description="Does the role require contacts to accept it?", Name="RequireContactsToAccept")
open var RequireContactsToAccept:Boolean? = null
/**
* Filters linked to the custom role.
*/
@ApiMember(DataType="List", Description="Filters linked to the custom role.", Name="ListItemFilters")
open var ListItemFilters:ArrayList<ListItemFilterModel>? = null
}
open class ListItemFilterModel
{
open var ListItemFilterId:UUID? = null
open var FilterName:String? = null
open var ListId:UUID? = null
open var ListItemId:UUID? = null
open var ListItemIsInFilter:Boolean? = null
}
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.
POST /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
}
]
}
}
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
}
}