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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Saguna.Common.WebAPIModel.Models

Namespace Global

    Namespace Eros.Saguna.Common.WebAPIModel.Models

        Public Partial Class ListItemModel
            Public Overridable Property ListItemId As Guid
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property ShortName As String
            Public Overridable Property IsDefault As Boolean
            Public Overridable Property Order As Integer
            Public Overridable Property ListItemTrafficLightId As Guid
            Public Overridable Property PrimaryListItemImageId As Guid
            Public Overridable Property PrimaryListItemImageUrl As String
            Public Overridable Property PrimaryImageThumbnailUrl As String
            Public Overridable Property OwnerContactId As Guid
            Public Overridable Property RecordStatus As String
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Update contact role group
        '''</Summary>
        <Api(Description:="Update contact role group")>
        Public Partial Class 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")>
            Public Overridable Property RoleGroupId As Guid

            '''<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")>
            Public Overridable Property Name As String

            Public Overridable Property Roles As List(Of ListItemModel)
        End Class
    End Namespace
End Namespace

VB.NET UpdateContactRoleGroup DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
Content-Length: length

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