Person Documents

No description given.

Endpoints

get /api/v3/iam/person_documents post /api/v3/iam/person_documents delete /api/v3/iam/person_documents/:resource_id get /api/v3/iam/person_documents/:resource_id patch /api/v3/iam/person_documents/:resource_id

get/api/v3/iam/person_documents

Return a paginated list of iam/person_documents

Input Schema

object
page?:
object
The page number, default to 1
number?: integer
The number of items per page, default to 1000
size?: integer
The sort order, comma separated list of fields. See sorting section for more details
sort?: string
Set to true to return the total number of items in the collection
count?: boolean
filter?:
object
id?: unknown
person_id?: unknown
document_type?: unknown
name?: unknown
url?: unknown
number?: unknown
issued_place?: unknown
issued_date?: unknown
expiration_date?: unknown
created_at?: unknown
updated_at?: unknown
person_id?: unknown
name__match?: unknown
created_at__gte?: unknown
created_at__lte?: unknown
url__exists?: unknown
document_type__in?: unknown
The related resources to include in the response. Allowed resources are:
- `person`
included?:
array
Elements: string
The fields to include in the response.
The key is the resource type and the value is an array of fields.
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  page?: {
    // The page number, default to 1
    number?: number;
    // The number of items per page, default to 1000
    size?: number;
  };
  // The sort order, comma separated list of fields. See sorting section for more details
  sort?: string;
  // Set to true to return the total number of items in the collection
  count?: boolean;
  filter?: {
    id?: any;
    person_id?: any;
    document_type?: any;
    name?: any;
    url?: any;
    number?: any;
    issued_place?: any;
    issued_date?: any;
    expiration_date?: any;
    created_at?: any;
    updated_at?: any;
    person_id?: any;
    name__match?: any;
    created_at__gte?: any;
    created_at__lte?: any;
    url__exists?: any;
    document_type__in?: any;
  };
  // The related resources to include in the response. Allowed resources are:
  // - `person`
  included?: Array<string>;
  // The fields to include in the response.
  // The key is the resource type and the value is an array of fields.
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
array
Elements:
object
type: string
id?: string
attributes?:
object
id?: integer
document_type?: string
name?: string or null
url?: string or null
number?: string or null
issued_place?: string or null
issued_date?: date or null
expiration_date?: date or null
created_at?: datetime
updated_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      document_type?: string;
      name?: string | null;
      url?: string | null;
      number?: string | null;
      issued_place?: string | null;
      issued_date?: Date | null;
      expiration_date?: Date | null;
      created_at?: Date;
      updated_at?: Date;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/iam/person_documents

Create a new iam/person_documents

Input Schema

object
data:
object
type: string
attributes:
object
id?: integer
document_type?: string
name?: string or null
url?: string or null
number?: string or null
issued_place?: string or null
issued_date?: date or null
expiration_date?: date or null
created_at?: datetime
updated_at?: datetime
relationships?:
object
person:
object
data:
object
type: string
id?: string

Typescript

type InputSchema = {
  data: {
    type: string;
    attributes: {
      id?: number;
      document_type?: string;
      name?: string | null;
      url?: string | null;
      number?: string | null;
      issued_place?: string | null;
      issued_date?: Date | null;
      expiration_date?: Date | null;
      created_at?: Date;
      updated_at?: Date;
    };
    relationships?: { person: { data: { type: string; id?: string } } };
  };
};

delete/api/v3/iam/person_documents/:resource_id

Delete the iam/person_documents

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

get/api/v3/iam/person_documents/:resource_id

Show a specific iam/person_documents

Input Schema

object
resource_id: integer
included?:
array
Elements: string
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  resource_id: number;
  included?: Array<string>;
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
object
type: string
id?: string
attributes?:
object
id?: integer
document_type?: string
name?: string or null
url?: string or null
number?: string or null
issued_place?: string or null
issued_date?: date or null
expiration_date?: date or null
created_at?: datetime
updated_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      document_type?: string;
      name?: string | null;
      url?: string | null;
      number?: string | null;
      issued_place?: string | null;
      issued_date?: Date | null;
      expiration_date?: Date | null;
      created_at?: Date;
      updated_at?: Date;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/iam/person_documents/:resource_id

Update a iam/person_documents

Input Schema

object
resource_id: integer
data:
object
type: string
attributes:
object
id?: integer
document_type?: string
name?: string or null
url?: string or null
number?: string or null
issued_place?: string or null
issued_date?: date or null
expiration_date?: date or null
updated_at?: datetime

Typescript

type InputSchema = {
  resource_id: number;
  data: {
    type: string;
    attributes: {
      id?: number;
      document_type?: string;
      name?: string | null;
      url?: string | null;
      number?: string | null;
      issued_place?: string | null;
      issued_date?: Date | null;
      expiration_date?: Date | null;
      updated_at?: Date;
    };
  };
};