Class GetPersonOutput

Constructors

constructor

Properties

basic? emailAddresses? validResponse

Methods

from

Constructors

constructor

  • new GetPersonOutput(data): GetPersonOutput

  • Parameters

    • data: {
          basic?: {
              byu_id: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              byu_internal_email: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              created_by_byu_id: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              created_datetime: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              deceased: {
                  api_type: string;
                  description?: string;
                  value: boolean;
              };
              first_name: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              home_country_code: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              home_state_code: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              home_town: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              merge_in_process: {
                  api_type: string;
                  description?: string;
                  value: boolean;
              };
              metadata: {
                  restricted: boolean;
                  validation_response: {
                      code: number;
                      message: string;
                  };
              };
              middle_name: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              name_fnf: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              name_lnf: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              net_id: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              person_id: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              personal_email_address: {
                  api_type: string;
                  description?: string;
                  value: null | string;
              };
              preferred_first_name: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              preferred_name: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              preferred_surname: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              primary_phone_number: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              rest_of_name: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              sex: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              student_email_address: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              suffix: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              surname: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              updated_by_byu_id: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              updated_datetime: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
          };
          email_addresses?: {
              values: {
                  byu_id: {
                      api_type: string;
                      description?: string;
                      value: string;
                  };
                  created_by_byu_id: {
                      api_type: string;
                      description?: string;
                      value: string;
                  };
                  created_datetime: {
                      api_type: string;
                      description?: string;
                      value: string;
                  };
                  email_address: {
                      api_type: string;
                      description?: string;
                      value: string;
                  };
                  email_address_type: {
                      api_type: string;
                      description?: string;
                      value: string;
                  };
                  metadata: {
                      restricted: boolean;
                      validation_response: {
                          code: number;
                          message: string;
                      };
                  };
                  unlisted: {
                      api_type: string;
                      description?: string;
                      value: boolean;
                  };
                  updated_by_byu_id: {
                      api_type: string;
                      description?: string;
                      value: string;
                  };
                  updated_datetime: {
                      api_type: string;
                      description?: string;
                      value: string;
                  };
                  verified_flag: {
                      api_type: string;
                      description?: string;
                      value: boolean;
                  };
              }[];
          };
      }
      • Optional basic?: {
            byu_id: {
                api_type: string;
                description?: string;
                value: string;
            };
            byu_internal_email: {
                api_type: string;
                description?: string;
                value: string;
            };
            created_by_byu_id: {
                api_type: string;
                description?: string;
                value: string;
            };
            created_datetime: {
                api_type: string;
                description?: string;
                value: string;
            };
            deceased: {
                api_type: string;
                description?: string;
                value: boolean;
            };
            first_name: {
                api_type: string;
                description?: string;
                value: string;
            };
            home_country_code: {
                api_type: string;
                description?: string;
                value: string;
            };
            home_state_code: {
                api_type: string;
                description?: string;
                value: string;
            };
            home_town: {
                api_type: string;
                description?: string;
                value: string;
            };
            merge_in_process: {
                api_type: string;
                description?: string;
                value: boolean;
            };
            metadata: {
                restricted: boolean;
                validation_response: {
                    code: number;
                    message: string;
                };
            };
            middle_name: {
                api_type: string;
                description?: string;
                value: string;
            };
            name_fnf: {
                api_type: string;
                description?: string;
                value: string;
            };
            name_lnf: {
                api_type: string;
                description?: string;
                value: string;
            };
            net_id: {
                api_type: string;
                description?: string;
                value: string;
            };
            person_id: {
                api_type: string;
                description?: string;
                value: string;
            };
            personal_email_address: {
                api_type: string;
                description?: string;
                value: null | string;
            };
            preferred_first_name: {
                api_type: string;
                description?: string;
                value: string;
            };
            preferred_name: {
                api_type: string;
                description?: string;
                value: string;
            };
            preferred_surname: {
                api_type: string;
                description?: string;
                value: string;
            };
            primary_phone_number: {
                api_type: string;
                description?: string;
                value: string;
            };
            rest_of_name: {
                api_type: string;
                description?: string;
                value: string;
            };
            sex: {
                api_type: string;
                description?: string;
                value: string;
            };
            student_email_address: {
                api_type: string;
                description?: string;
                value: string;
            };
            suffix: {
                api_type: string;
                description?: string;
                value: string;
            };
            surname: {
                api_type: string;
                description?: string;
                value: string;
            };
            updated_by_byu_id: {
                api_type: string;
                description?: string;
                value: string;
            };
            updated_datetime: {
                api_type: string;
                description?: string;
                value: string;
            };
        }
        • byu_id: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • byu_internal_email: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • created_by_byu_id: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • created_datetime: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • deceased: {
              api_type: string;
              description?: string;
              value: boolean;
          }
          • api_type: string
          • Optional description?: string
          • value: boolean
        • first_name: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • home_country_code: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • home_state_code: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • home_town: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • merge_in_process: {
              api_type: string;
              description?: string;
              value: boolean;
          }
          • api_type: string
          • Optional description?: string
          • value: boolean
        • metadata: {
              restricted: boolean;
              validation_response: {
                  code: number;
                  message: string;
              };
          }
          • restricted: boolean
          • validation_response: {
                code: number;
                message: string;
            }
            • code: number
            • message: string
        • middle_name: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • name_fnf: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • name_lnf: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • net_id: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • person_id: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • personal_email_address: {
              api_type: string;
              description?: string;
              value: null | string;
          }
          • api_type: string
          • Optional description?: string
          • value: null | string
        • preferred_first_name: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • preferred_name: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • preferred_surname: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • primary_phone_number: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • rest_of_name: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • sex: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • student_email_address: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • suffix: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • surname: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • updated_by_byu_id: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • updated_datetime: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
      • Optional email_addresses?: {
            values: {
                byu_id: {
                    api_type: string;
                    description?: string;
                    value: string;
                };
                created_by_byu_id: {
                    api_type: string;
                    description?: string;
                    value: string;
                };
                created_datetime: {
                    api_type: string;
                    description?: string;
                    value: string;
                };
                email_address: {
                    api_type: string;
                    description?: string;
                    value: string;
                };
                email_address_type: {
                    api_type: string;
                    description?: string;
                    value: string;
                };
                metadata: {
                    restricted: boolean;
                    validation_response: {
                        code: number;
                        message: string;
                    };
                };
                unlisted: {
                    api_type: string;
                    description?: string;
                    value: boolean;
                };
                updated_by_byu_id: {
                    api_type: string;
                    description?: string;
                    value: string;
                };
                updated_datetime: {
                    api_type: string;
                    description?: string;
                    value: string;
                };
                verified_flag: {
                    api_type: string;
                    description?: string;
                    value: boolean;
                };
            }[];
        }
        • values: {
              byu_id: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              created_by_byu_id: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              created_datetime: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              email_address: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              email_address_type: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              metadata: {
                  restricted: boolean;
                  validation_response: {
                      code: number;
                      message: string;
                  };
              };
              unlisted: {
                  api_type: string;
                  description?: string;
                  value: boolean;
              };
              updated_by_byu_id: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              updated_datetime: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              verified_flag: {
                  api_type: string;
                  description?: string;
                  value: boolean;
              };
          }[]

    Returns GetPersonOutput

Properties

Optional basic

basic?: GetPersonBasicOutput

Optional emailAddresses

emailAddresses?: GetEmailAddressesOutput

Static validResponse

validResponse: TypeCheck<TObject<{
    basic: TOptional<TObject<{
        byu_id: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        byu_internal_email: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        created_by_byu_id: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        created_datetime: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        deceased: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TBoolean;
        }>;
        first_name: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        home_country_code: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        home_state_code: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        home_town: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        merge_in_process: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TBoolean;
        }>;
        metadata: TObject<{
            restricted: TBoolean;
            validation_response: TObject<{
                code: TNumber;
                message: TString;
            }>;
        }>;
        middle_name: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        name_fnf: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        name_lnf: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        net_id: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        person_id: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        personal_email_address: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TUnion<[TString, TNull]>;
        }>;
        preferred_first_name: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        preferred_name: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        preferred_surname: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        primary_phone_number: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        rest_of_name: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        sex: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        student_email_address: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        suffix: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        surname: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        updated_by_byu_id: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        updated_datetime: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
    }>>;
    email_addresses: TOptional<TObject<{
        values: TArray<TObject<{
            byu_id: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
            created_by_byu_id: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
            created_datetime: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
            email_address: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
            email_address_type: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
            metadata: TObject<{
                restricted: ...;
                validation_response: ...;
            }>;
            unlisted: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
            updated_by_byu_id: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
            updated_datetime: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
            verified_flag: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
        }>>;
    }>>;
}>> = ...

Methods

Static from

Settings

Member Visibility

Theme

On This Page

constructorbasicemailAddressesvalidResponsefrom