Cochrane+ App API

<back to all web services

TemplateApprovalList

Requires Authentication
The following routes are available for this service:
GET/template-approval/list
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.ServiceModel
Imports WebService.ServiceModel.Base
Imports CommonService.Api.Models.Base
Imports ServiceProvider.CochranePresentation.Models

Namespace Global

    Namespace CommonService.Api.Models.Base

        Public Partial Class ApiServiceResponse
            Implements IServiceResponse
            Public Overridable Property Description As String
            Public Overridable Property Heading As String
            Public Overridable Property WasSuccessful As Boolean
            Public Overridable Property ModelState As Object
        End Class
    End Namespace

    Namespace ServiceProvider.CochranePresentation.Models

        Public Enum TemplateApprovalStatus
            AwaitingApproval = 0
            Rejected = 1
            Approved = 2
        End Enum

        Public Enum TemplateType
            Introductory = 0
            Refresher = 1
        End Enum
    End Namespace

    Namespace WebService.ServiceModel

        Public Partial Class SectionSummary
            Public Overridable Property Title As SectionTitle
            Public Overridable Property TitleString As String
            Public Overridable Property SectionId As Integer
            Public Overridable Property SectionName As String
        End Class

        Public Enum SectionTitle
            Welcome = 0
            Cochrane = 1
            Iconic = 2
            OurBestWork = 3
            RealityOfRisk = 4
            ProductRange = 5
            ProductDeployments = 6
            Industries = 7
            ClearVu = 8
            CaseStudies = 9
            Expertise = 10
            Media = 11
            ThankYou = 12
            ClearVuRange = 13
            Presentations = 14
            LegacyVideos = 15
        End Enum

        Public Partial Class TemplateApprovalList
            Inherits ApiServiceRequest
        End Class

        Public Partial Class TemplateApprovalListItem
            Public Sub New()
                TemplateChangeDetail = New List(Of SectionSummary)
                TemplateDetail = New List(Of SectionSummary)
            End Sub

            Public Overridable Property UserCrmId As Guid
            Public Overridable Property ApprovalDate As String
            Public Overridable Property TemplateApprovalId As Integer
            Public Overridable Property ApprovalStatus As TemplateApprovalStatus
            Public Overridable Property ApprovalStatusString As String
            Public Overridable Property TemplateType As TemplateType
            Public Overridable Property TemplateTypeString As String
            Public Overridable Property TemplateName As String
            Public Overridable Property SystemUserName As String
            Public Overridable Property TemplateChangeDetail As List(Of SectionSummary)
            Public Overridable Property TemplateDetail As List(Of SectionSummary)
            Public Overridable Property Content As String
        End Class

        Public Partial Class TemplateApprovalListResponse
            Inherits ApiServiceResponse
            Public Sub New()
                Templates = New List(Of TemplateApprovalListItem)
            End Sub

            Public Overridable Property Templates As List(Of TemplateApprovalListItem)
        End Class
    End Namespace

    Namespace WebService.ServiceModel.Base

        Public Partial Class ApiServiceRequest
            Implements IServiceRequest
            Implements IHasApiKey
            Implements IHasDeviceInfo
            '''<Summary>
            '''The API Key required for authentication
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The API Key required for authentication", IsRequired:=true)>
            Public Overridable Property ApiKey As String

            '''<Summary>
            '''Latitude of the user making this request
            '''</Summary>
            <ApiMember(DataType:="double", Description:="Latitude of the user making this request")>
            Public Overridable Property Latitude As Double

            '''<Summary>
            '''Longitude of the user making this request
            '''</Summary>
            <ApiMember(DataType:="double", Description:="Longitude of the user making this request")>
            Public Overridable Property Longitude As Double
        End Class
    End Namespace
End Namespace

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

GET /template-approval/list HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"templates":[{}],"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}