Platform API

AddContactRoleGroup

Create new contact role group

The following routes are available for this service:
POST	/api/contactrolegroups

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Create new contact role group
*/
@Api(Description="Create new contact role group")
open class AddContactRoleGroup
{
    /**
    * Contact role group name to be created
    */
    @ApiMember(Description="Contact role group name to be created", Name="Name")
    open var Name:String? = null

    open var Roles:ArrayList<ListItemModel>? = null
}

open class ListItemModel
{
    open var ListItemId:UUID? = null
    open var Name:String? = null
    open var Description:String? = null
    open var ShortName:String? = null
    open var IsDefault:Boolean? = null
    open var Order:Int? = null
    open var ListItemTrafficLightId:UUID? = null
    open var PrimaryListItemImageId:UUID? = null
    open var PrimaryListItemImageUrl:String? = null
    open var PrimaryImageThumbnailUrl:String? = null
    open var OwnerContactId:UUID? = null
    open var RecordStatus:String? = null
}

@ApiResponse(Description="Create contact role group")
open class AddContactRoleGroupResponse
{
    open var ContactRoleGroupId:UUID? = null
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin AddContactRoleGroup DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/contactrolegroups HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Name: String,
	Roles: 
	[
		{
			Name: String,
			Description: String,
			ShortName: String,
			IsDefault: False,
			Order: 0,
			PrimaryListItemImageUrl: String,
			PrimaryImageThumbnailUrl: String,
			RecordStatus: String
		}
	]
}

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

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