Platform API

AddContactRoleGroup

Create new contact role group

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

import Foundation
import ServiceStack

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

    public var roles:[ListItemModel]

    required public init(){}
}

public class ListItemModel : Codable
{
    public var listItemId:String
    public var name:String
    public var Description:String
    public var shortName:String
    public var isDefault:Bool
    public var order:Int
    public var listItemTrafficLightId:String
    public var primaryListItemImageId:String
    public var primaryListItemImageUrl:String
    public var primaryImageThumbnailUrl:String
    public var ownerContactId:String
    public var recordStatus:String

    required public init(){}
}

// @ApiResponse(Description="Create contact role group")
public class AddContactRoleGroupResponse : Codable
{
    public var contactRoleGroupId:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift AddContactRoleGroup 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.

POST /api/contactrolegroups HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
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: text/csv
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"}}}