Platform API

UpdateContactRoleGroup

Update contact role group

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

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


/**
* Update contact role group
*/
@Api(Description="Update contact role group")
open class UpdateContactRoleGroup
{
    /**
    * Guid of the Contact Role Group to be updated.
    */
    @ApiMember(DataType="Guid", Description="Guid of the Contact Role Group to be updated.", IsRequired=true, Name="RoleGroupId", ParameterType="query")
    open var RoleGroupId:UUID? = null

    /**
    * Contact role group name to be updated
    */
    @ApiMember(DataType="string", Description="Contact role group name to be updated", IsRequired=true, Name="Name", ParameterType="query")
    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
}

Kotlin UpdateContactRoleGroup DTOs

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

HTTP + CSV

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

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

{"RoleGroupId":"00000000-0000-0000-0000-000000000000","Name":"String","Roles":[{"ListItemId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","IsDefault":false,"Order":0,"ListItemTrafficLightId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageUrl":"String","PrimaryImageThumbnailUrl":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"}]}

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

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