Platform API

GetSuiteDataForLicensee

Gets the suite data for a particular licensee

The following routes are available for this service:
All Verbs	/api/suitedata

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

Namespace Global

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Gets the suite data for a particular licensee
        '''</Summary>
        <Api(Description:="Gets the suite data for a particular licensee")>
        Public Partial Class GetSuiteDataForLicensee
            '''<Summary>
            '''The suite id
            '''</Summary>
            <ApiMember(Description:="The suite id", Name:="Suite Id")>
            Public Overridable Property SuiteId As Guid

            '''<Summary>
            '''The id of the licensee
            '''</Summary>
            <ApiMember(Description:="The id of the licensee", Name:="LicenseeId")>
            Public Overridable Property LicenseeId As Guid
        End Class

        <ApiResponse(Description:="Suite Appliance Data")>
        Public Partial Class GetSuiteDataResponse
            Public Overridable Property SuiteApplianceLicenseeId As Guid
            Public Overridable Property DomainName As String
            Public Overridable Property SkinName As String
            Public Overridable Property LicenseeConnectionId As Guid
            Public Overridable Property LicenseeContactId As Guid
            Public Overridable Property LicenseeContactName As String
            Public Overridable Property IsBrandedURL As Boolean
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET GetSuiteDataForLicensee 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.

POST /api/suitedata HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"SuiteId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"SuiteApplianceLicenseeId":"00000000-0000-0000-0000-000000000000","DomainName":"String","SkinName":"String","LicenseeConnectionId":"00000000-0000-0000-0000-000000000000","LicenseeContactId":"00000000-0000-0000-0000-000000000000","LicenseeContactName":"String","IsBrandedURL":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}