Cochrane+ App API

<back to all web services

ReadAllMessages

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 class NotificationMessageAttachment
{
    public isImage: boolean;
    public isPdf: boolean;
    public isWord: boolean;
    public isExcel: boolean;
    public fileName: string;
    public thumbnailUrl: string;
    public fileUrl: string;

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

export class NotificationMessageData
{
    public title: string;
    public content: string;
    public sentBy: string;
    public systemUserMessageId: number;
    public dateSent: string;
    public comment: string;
    public hasComment: boolean;
    public commentDate: string;
    public hasAttachments: boolean;
    public attachmentList: NotificationMessageAttachment[];
    public hasRead: boolean;

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

export class GetNotificationMessageResponse extends ApiServiceResponse
{
    public messages: NotificationMessageData[];
    public unreadCount: number;

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

export class ReadAllMessages extends ApiServiceRequest
{

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

TypeScript ReadAllMessages DTOs

POST /notificationcentre/readall HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"apiKey":"String","latitude":0,"longitude":0}

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

{"messages":[{}],"unreadCount":0,"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}