Class GetPersonOutput

constructor

• new GetPersonOutput(
      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: string | null;
              };
              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;
                  };
              }[];
          };
      },
  ): 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: string | null;
            };
            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 };
            }[];
        };
    }

  Returns GetPersonOutput

Optionalbasic

OptionalemailAddresses

StaticvalidResponse

Staticfrom

• from(data: unknown): GetPersonOutput

  Parameters

  • data: unknown

  Returns GetPersonOutput