Cochrane+ App API

<back to all web services

TemplateApprovalList

Requires Authentication
The following routes are available for this service:
GET/template-approval/list

export class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /** @description The API Key required for authentication */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public apiKey: string;

    /** @description Latitude of the user making this request */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public latitude: number;

    /** @description Longitude of the user making this request */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public longitude: number;

    public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}

export class ApiServiceResponse implements IServiceResponse
{
    public description: string;
    public heading: string;
    public wasSuccessful: boolean;
    public modelState: Object;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export enum TemplateApprovalStatus
{
    AwaitingApproval = 0,
    Rejected = 1,
    Approved = 2,
}

export enum TemplateType
{
    Introductory = 0,
    Refresher = 1,
}

export 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,
}

export class SectionSummary
{
    public title: SectionTitle;
    public titleString: string;
    public sectionId: number;
    public sectionName: string;

    public constructor(init?: Partial<SectionSummary>) { (Object as any).assign(this, init); }
}

export class TemplateApprovalListItem
{
    public userCrmId: string;
    public approvalDate: string;
    public templateApprovalId: number;
    public approvalStatus: TemplateApprovalStatus;
    public approvalStatusString: string;
    public templateType: TemplateType;
    public templateTypeString: string;
    public templateName: string;
    public systemUserName: string;
    public templateChangeDetail: SectionSummary[];
    public templateDetail: SectionSummary[];
    public content: string;

    public constructor(init?: Partial<TemplateApprovalListItem>) { (Object as any).assign(this, init); }
}

export class TemplateApprovalListResponse extends ApiServiceResponse
{
    public templates: TemplateApprovalListItem[];

    public constructor(init?: Partial<TemplateApprovalListResponse>) { super(init); (Object as any).assign(this, init); }
}

export class TemplateApprovalList extends ApiServiceRequest
{

    public constructor(init?: Partial<TemplateApprovalList>) { super(init); (Object as any).assign(this, init); }
}

TypeScript TemplateApprovalList DTOs

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

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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