Skip to content

Institution

Available Actions

HTTP Action Endpoint Request Parameters Request Model Response Model
GET /v2/institution/{id} id – institution id ~ Institution
GET /v2/institution ~ ~ Institution[]
POST /v2/institution ~ CreateInstitution Institution
PATCH /v2/institution/{id} id – institution id UpdateInstitution Institution

Models

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
export interface Institution {
    id: number;
    type: InstitutionType;
    name: string;
    codeName: string;
    description?: string;
    isActive: boolean;
    isTest: boolean;
    country: string;
    abbreviation?: string;
    uuid: string;
    createdBy: string;
    updatedBy: string;
    createdAt: Date;
    updatedAt: Date;
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
export interface CreateInstitution {
    type: InstitutionType;
    name: string;
    codeName: string;
    description?: string;
    isActive?: boolean;
    isTest?: boolean;
    country: string;
    abbreviation?: string;
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
export interface UpdateInstitution {
    id: number;
    name?: string;
    codeName?: string;
    description?: string;
    isActive?: boolean;
    isTest?: boolean;
    country?: string;
    abbreviation?: string;
}

Enums

1
2
3
4
export enum InstitutionType {
    CARDLYTICS = 'Cardlytics',
    PUBLISHER = 'Publisher',
}