Platform API

<back to all web services

UpdateContactRoleGroup

Update contact role group

Requires Authentication
The following routes are available for this service:
PUT/api/contactrolegroups
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ListItemModel() = 
        member val ListItemId:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val ShortName:String = null with get,set
        member val IsDefault:Boolean = new Boolean() with get,set
        member val Order:Int32 = new Int32() with get,set
        member val ListItemTrafficLightId:Guid = new Guid() with get,set
        member val PrimaryListItemImageId:Guid = new Guid() with get,set
        member val PrimaryListItemImageUrl:String = null with get,set
        member val PrimaryImageThumbnailUrl:String = null with get,set
        member val OwnerContactId:Guid = new Guid() with get,set
        member val RecordStatus:String = null with get,set

    ///<summary>
    ///Update contact role group
    ///</summary>
    [<Api(Description="Update contact role group")>]
    [<AllowNullLiteral>]
    type UpdateContactRoleGroup() = 
        ///<summary>
        ///Guid of the Contact Role Group to be updated.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Guid of the Contact Role Group to be updated.", IsRequired=true, Name="RoleGroupId", ParameterType="query")>]
        member val RoleGroupId:Guid = new Guid() with get,set

        ///<summary>
        ///Contact role group name to be updated
        ///</summary>
        [<ApiMember(DataType="string", Description="Contact role group name to be updated", IsRequired=true, Name="Name", ParameterType="query")>]
        member val Name:String = null with get,set

        member val Roles:ResizeArray<ListItemModel> = null with get,set

F# UpdateContactRoleGroup 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.

PUT /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

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