Platform API

<back to all web services

AddContactRoleGroup

Create new contact role group

Requires Authentication
The following routes are available for this service:
POST/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

    [<ApiResponse(Description="Create contact role group")>]
    [<AllowNullLiteral>]
    type AddContactRoleGroupResponse() = 
        member val ContactRoleGroupId:Guid = new Guid() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<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>
    ///Create new contact role group
    ///</summary>
    [<Api(Description="Create new contact role group")>]
    [<AllowNullLiteral>]
    type AddContactRoleGroup() = 
        ///<summary>
        ///Contact role group name to be created
        ///</summary>
        [<ApiMember(Description="Contact role group name to be created", Name="Name")>]
        member val Name:String = null with get,set

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

F# AddContactRoleGroup DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"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: application/json
Content-Length: length

{"ContactRoleGroupId":"00000000-0000-0000-0000-000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}