Platform API

AddContactRoleGroup

Create new contact role group

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

"use strict";
export class AddContactRoleGroupResponse {
    /** @param {{ContactRoleGroupId?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ContactRoleGroupId;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class ListItemModel {
    /** @param {{ListItemId?:string,Name?:string,Description?:string,ShortName?:string,IsDefault?:boolean,Order?:number,ListItemTrafficLightId?:string,PrimaryListItemImageId?:string,PrimaryListItemImageUrl?:string,PrimaryImageThumbnailUrl?:string,OwnerContactId?:string,RecordStatus?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ListItemId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {string} */
    ShortName;
    /** @type {boolean} */
    IsDefault;
    /** @type {number} */
    Order;
    /** @type {string} */
    ListItemTrafficLightId;
    /** @type {string} */
    PrimaryListItemImageId;
    /** @type {string} */
    PrimaryListItemImageUrl;
    /** @type {string} */
    PrimaryImageThumbnailUrl;
    /** @type {string} */
    OwnerContactId;
    /** @type {string} */
    RecordStatus;
}
export class AddContactRoleGroup {
    /** @param {{Name?:string,Roles?:ListItemModel[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Contact role group name to be created */
    Name;
    /** @type {ListItemModel[]} */
    Roles;
}

JavaScript AddContactRoleGroup DTOs

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

HTTP + XML

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

<AddContactRoleGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Name>String</Name>
  <Roles xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:ListItemModel>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:IsDefault>false</d2p1:IsDefault>
      <d2p1:ListItemId>00000000-0000-0000-0000-000000000000</d2p1:ListItemId>
      <d2p1:ListItemTrafficLightId>00000000-0000-0000-0000-000000000000</d2p1:ListItemTrafficLightId>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Order>0</d2p1:Order>
      <d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
      <d2p1:PrimaryImageThumbnailUrl>String</d2p1:PrimaryImageThumbnailUrl>
      <d2p1:PrimaryListItemImageId>00000000-0000-0000-0000-000000000000</d2p1:PrimaryListItemImageId>
      <d2p1:PrimaryListItemImageUrl>String</d2p1:PrimaryListItemImageUrl>
      <d2p1:RecordStatus>String</d2p1:RecordStatus>
      <d2p1:ShortName>String</d2p1:ShortName>
    </d2p1:ListItemModel>
  </Roles>
</AddContactRoleGroup>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddContactRoleGroupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactRoleGroupId>00000000-0000-0000-0000-000000000000</ContactRoleGroupId>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</AddContactRoleGroupResponse>