Class GetPersonBasicOutput

constructor

• new GetPersonBasicOutput(data): GetPersonBasicOutput

• Parameters

  • data: {
        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

  Returns GetPersonBasicOutput

byuId

byuInternalEmailAddress

createdByByuId

Optional createdByName

createdDatetime

deceased

firstName

Optional homeCountry

homeCountryCode

Optional homeState

homeStateCode

homeTown

mergeInProcess

middleName

nameFnf

nameLnf

netId

personId

personalEmailAddress

preferredFirstName

preferredName

preferredSurname

primaryPhoneNumber

restOfName

restricted

sex

studentEmailAddress

suffix

surname

updatedByByuId

Optional updatedByName

updatedDatetime

Static validResponse

Static from

• from(data): GetPersonBasicOutput

• Parameters

  • data: unknown

  Returns GetPersonBasicOutput