Platform API

<back to all web services

GetContactNotifications

Get notifications for the specified contact

Requires Authentication
The following routes are available for this service:
All Verbs/api/contact/{ContactId}/notifications
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 InputSwitch() = 
        member val Id:String = null with get,set
        member val Name:String = null with get,set
        member val IsDisabled:Boolean = new Boolean() with get,set
        member val IsChecked:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type NotificationDetails() = 
        member val NotificationId:Guid = new Guid() with get,set
        member val NotificationGroupName:String = null with get,set
        member val NotificationValueId:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val IsMandatory:Boolean = new Boolean() with get,set
        member val IsCardinality:Boolean = new Boolean() with get,set
        member val IsSystem:Boolean = new Boolean() with get,set
        member val IsVisibleToRecipients:Boolean = new Boolean() with get,set
        member val Index:Int32 = new Int32() with get,set
        member val Email:InputSwitch = null with get,set
        member val SMS:InputSwitch = null with get,set
        member val UpdateNotification:InputSwitch = null with get,set
        member val Push:InputSwitch = null with get,set
        member val Phone:InputSwitch = null with get,set

    [<AllowNullLiteral>]
    type NotificationGroup() = 
        member val GroupName:String = null with get,set
        member val Notifications:ResizeArray<NotificationDetails> = null with get,set

    [<ApiResponse(Description="List of contact notifications")>]
    [<AllowNullLiteral>]
    type GetContactNotificationsResponse() = 
        member val Notifications:ResizeArray<NotificationGroup> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get notifications for the specified contact
    ///</summary>
    [<Api(Description="Get notifications for the specified contact")>]
    [<AllowNullLiteral>]
    type GetContactNotifications() = 
        ///<summary>
        ///Id of contact to get notifications for
        ///</summary>
        [<ApiMember(Description="Id of contact to get notifications for", IsRequired=true, Name="ContactId")>]
        member val ContactId:Guid = new Guid() with get,set

        ///<summary>
        ///Id of licensee to get notifications for
        ///</summary>
        [<ApiMember(Description="Id of licensee to get notifications for", IsRequired=true, Name="LicenseeId")>]
        member val LicenseeId:Guid = new Guid() with get,set

        ///<summary>
        ///Id of suite to get notifications for
        ///</summary>
        [<ApiMember(Description="Id of suite to get notifications for", IsRequired=true, Name="Suite")>]
        member val SuiteId:Guid = new Guid() with get,set

F# GetContactNotifications 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/contact/{ContactId}/notifications HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetContactNotifications xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactId>00000000-0000-0000-0000-000000000000</ContactId>
  <LicenseeId>00000000-0000-0000-0000-000000000000</LicenseeId>
  <SuiteId>00000000-0000-0000-0000-000000000000</SuiteId>
</GetContactNotifications>

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

<GetContactNotificationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Notifications xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
    <d2p1:NotificationGroup>
      <d2p1:GroupName>String</d2p1:GroupName>
      <d2p1:Notifications>
        <d2p1:NotificationDetails>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:Email>
            <d2p1:Id>String</d2p1:Id>
            <d2p1:IsChecked>false</d2p1:IsChecked>
            <d2p1:IsDisabled>false</d2p1:IsDisabled>
            <d2p1:Name>String</d2p1:Name>
          </d2p1:Email>
          <d2p1:Index>0</d2p1:Index>
          <d2p1:IsCardinality>false</d2p1:IsCardinality>
          <d2p1:IsMandatory>false</d2p1:IsMandatory>
          <d2p1:IsSystem>false</d2p1:IsSystem>
          <d2p1:IsVisibleToRecipients>false</d2p1:IsVisibleToRecipients>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:NotificationGroupName>String</d2p1:NotificationGroupName>
          <d2p1:NotificationId>00000000-0000-0000-0000-000000000000</d2p1:NotificationId>
          <d2p1:NotificationValueId>00000000-0000-0000-0000-000000000000</d2p1:NotificationValueId>
          <d2p1:Phone>
            <d2p1:Id>String</d2p1:Id>
            <d2p1:IsChecked>false</d2p1:IsChecked>
            <d2p1:IsDisabled>false</d2p1:IsDisabled>
            <d2p1:Name>String</d2p1:Name>
          </d2p1:Phone>
          <d2p1:Push>
            <d2p1:Id>String</d2p1:Id>
            <d2p1:IsChecked>false</d2p1:IsChecked>
            <d2p1:IsDisabled>false</d2p1:IsDisabled>
            <d2p1:Name>String</d2p1:Name>
          </d2p1:Push>
          <d2p1:SMS>
            <d2p1:Id>String</d2p1:Id>
            <d2p1:IsChecked>false</d2p1:IsChecked>
            <d2p1:IsDisabled>false</d2p1:IsDisabled>
            <d2p1:Name>String</d2p1:Name>
          </d2p1:SMS>
          <d2p1:UpdateNotification>
            <d2p1:Id>String</d2p1:Id>
            <d2p1:IsChecked>false</d2p1:IsChecked>
            <d2p1:IsDisabled>false</d2p1:IsDisabled>
            <d2p1:Name>String</d2p1:Name>
          </d2p1:UpdateNotification>
        </d2p1:NotificationDetails>
      </d2p1:Notifications>
    </d2p1:NotificationGroup>
  </Notifications>
  <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>
</GetContactNotificationsResponse>