Skip to content

Organization

Available Actions

HTTP Action Endpoint Request Parameters Request Model Response Model
GET /v2/institution/{id}/organization id – institution id ~ Organization[]
GET /v2/organization/{id} id – institution id ~ Organization
POST /v2/organization ~ CreateOrganization Organization
PATCH /v2/organization/{id} id – institution id UpdateOrganization Organization

Models

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
export interface Organization {
    id: number;
    sourceOrganizationId: string;
    institutionId: number;
    name: string;
    description?: string;
    operatingCurrencyCode: string;
    url?: string;
    createdBy: string;
    updatedBy: string;
    createdAt: Date;
    updatedAt: Date;
}

1
2
3
4
5
6
7
8
export interface CreateOrganization {
    sourceOrganizationId: string;
    institutionId: number;
    name: string;
    description?: string;
    operatingCurrencyCode: string;
    url?: string;
}

1
2
3
4
5
6
7
export interface UpdateOrganization {
    id: number;
    name?: string;
    description?: string;
    operatingCurrencyCode?: string;
    url?: string;
}