GET api/entity/person/GetPersons

Request Information

URI Parameters

Name	Description	Type	Additional information
PersonIDs	Gets or sets the person ids.	Collection of integer	None.
Since	The timestamp to use. This should always be UTC.	date	None.

Body Parameters

None.

Response Information

Resource Description

WebMethodResultOfListOfPerson

Name	Type	Additional information
Result	Collection of Person	None.
Success	boolean	None.
ErrorText	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": [
    {
      "ID": 1,
      "Name": {
        "LastName": "sample string 1",
        "FirstName": "sample string 2",
        "NickName": "sample string 3",
        "MaidenName": "sample string 4",
        "MiddleName": "sample string 5",
        "TitleID": 0,
        "SuffixID": 0,
        "FullName": "sample string 2 sample string 1",
        "FullNameWithNickName": "sample string 2 (sample string 3) sample string 1",
        "FullNameUPR": "sample string 10",
        "FullNameUPRShort": "sample string 11",
        "FullNameUPRShortNoMaiden": "sample string 12"
      },
      "Gender": 0,
      "DOB": "2024-05-07T03:30:32.7597803-06:00",
      "Occupation": "sample string 2",
      "MaritalStatus": {
        "<ID>k__BackingField": 1,
        "<Name>k__BackingField": "sample string 2"
      },
      "SSN": "sample string 3",
      "HasAvatar": true,
      "PhoneNumbers": [
        {
          "LocationFlagID": 0,
          "TypeID": 0,
          "Type": 0,
          "Label": 0,
          "Number": "sample string 3"
        },
        {
          "LocationFlagID": 0,
          "TypeID": 0,
          "Type": 0,
          "Label": 0,
          "Number": "sample string 3"
        }
      ],
      "EmailAddresses": [
        {
          "Label": 0,
          "Email": "sample string 3",
          "IsLoginEmail": true
        },
        {
          "Label": 0,
          "Email": "sample string 3",
          "IsLoginEmail": true
        }
      ]
    },
    {
      "ID": 1,
      "Name": {
        "LastName": "sample string 1",
        "FirstName": "sample string 2",
        "NickName": "sample string 3",
        "MaidenName": "sample string 4",
        "MiddleName": "sample string 5",
        "TitleID": 0,
        "SuffixID": 0,
        "FullName": "sample string 2 sample string 1",
        "FullNameWithNickName": "sample string 2 (sample string 3) sample string 1",
        "FullNameUPR": "sample string 10",
        "FullNameUPRShort": "sample string 11",
        "FullNameUPRShortNoMaiden": "sample string 12"
      },
      "Gender": 0,
      "DOB": "2024-05-07T03:30:32.7597803-06:00",
      "Occupation": "sample string 2",
      "MaritalStatus": {
        "<ID>k__BackingField": 1,
        "<Name>k__BackingField": "sample string 2"
      },
      "SSN": "sample string 3",
      "HasAvatar": true,
      "PhoneNumbers": [
        {
          "LocationFlagID": 0,
          "TypeID": 0,
          "Type": 0,
          "Label": 0,
          "Number": "sample string 3"
        },
        {
          "LocationFlagID": 0,
          "TypeID": 0,
          "Type": 0,
          "Label": 0,
          "Number": "sample string 3"
        }
      ],
      "EmailAddresses": [
        {
          "Label": 0,
          "Email": "sample string 3",
          "IsLoginEmail": true
        },
        {
          "Label": 0,
          "Email": "sample string 3",
          "IsLoginEmail": true
        }
      ]
    }
  ],
  "Success": true,
  "ErrorText": "sample string 2"
}

application/javascript

Sample:

{"Result":[{"ID":1,"Name":{"LastName":"sample string 1","FirstName":"sample string 2","NickName":"sample string 3","MaidenName":"sample string 4","MiddleName":"sample string 5","TitleID":0,"SuffixID":0,"FullName":"sample string 2 sample string 1","FullNameWithNickName":"sample string 2 (sample string 3) sample string 1","FullNameUPR":"sample string 10","FullNameUPRShort":"sample string 11","FullNameUPRShortNoMaiden":"sample string 12"},"Gender":0,"DOB":"2024-05-07T03:30:32.7597803-06:00","Occupation":"sample string 2","MaritalStatus":{"<ID>k__BackingField":1,"<Name>k__BackingField":"sample string 2"},"SSN":"sample string 3","HasAvatar":true,"PhoneNumbers":[{"LocationFlagID":0,"TypeID":0,"Type":0,"Label":0,"Number":"sample string 3"},{"LocationFlagID":0,"TypeID":0,"Type":0,"Label":0,"Number":"sample string 3"}],"EmailAddresses":[{"Label":0,"Email":"sample string 3","IsLoginEmail":true},{"Label":0,"Email":"sample string 3","IsLoginEmail":true}]},{"ID":1,"Name":{"LastName":"sample string 1","FirstName":"sample string 2","NickName":"sample string 3","MaidenName":"sample string 4","MiddleName":"sample string 5","TitleID":0,"SuffixID":0,"FullName":"sample string 2 sample string 1","FullNameWithNickName":"sample string 2 (sample string 3) sample string 1","FullNameUPR":"sample string 10","FullNameUPRShort":"sample string 11","FullNameUPRShortNoMaiden":"sample string 12"},"Gender":0,"DOB":"2024-05-07T03:30:32.7597803-06:00","Occupation":"sample string 2","MaritalStatus":{"<ID>k__BackingField":1,"<Name>k__BackingField":"sample string 2"},"SSN":"sample string 3","HasAvatar":true,"PhoneNumbers":[{"LocationFlagID":0,"TypeID":0,"Type":0,"Label":0,"Number":"sample string 3"},{"LocationFlagID":0,"TypeID":0,"Type":0,"Label":0,"Number":"sample string 3"}],"EmailAddresses":[{"Label":0,"Email":"sample string 3","IsLoginEmail":true},{"Label":0,"Email":"sample string 3","IsLoginEmail":true}]}],"Success":true,"ErrorText":"sample string 2"}

application/xml, text/xml

Sample:

<WebMethodResultOfListOfPerson xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <ErrorText>sample string 2</ErrorText>
  <Result>
    <Person>
      <ID>1</ID>
      <Name>
        <LastName>sample string 1</LastName>
        <FirstName>sample string 2</FirstName>
        <NickName>sample string 3</NickName>
        <MaidenName>sample string 4</MaidenName>
        <MiddleName>sample string 5</MiddleName>
        <TitleID>0</TitleID>
        <Title>Undefined</Title>
        <SuffixID>0</SuffixID>
        <Suffix>Undefined</Suffix>
        <FullName>sample string 2 sample string 1</FullName>
        <FullNameWithNickName>sample string 2 (sample string 3) sample string 1</FullNameWithNickName>
        <FullNameUPR>sample string 10</FullNameUPR>
        <FullNameUPRShort>sample string 11</FullNameUPRShort>
        <FullNameUPRShortNoMaiden>sample string 12</FullNameUPRShortNoMaiden>
      </Name>
      <Gender>Female</Gender>
      <DOB>2024-05-07T03:30:32.7597803-06:00</DOB>
      <Occupation>sample string 2</Occupation>
      <MaritalStatus>
        <ID>1</ID>
        <Name>sample string 2</Name>
      </MaritalStatus>
      <SSN>sample string 3</SSN>
      <HasAvatar>true</HasAvatar>
      <PhoneNumbers>
        <PhoneNumber>
          <LocationFlagID>0</LocationFlagID>
          <LocationFlag>Undefined</LocationFlag>
          <TypeID>0</TypeID>
          <Type>Undefined</Type>
          <Label>Undefined</Label>
          <Number>sample string 3</Number>
        </PhoneNumber>
        <PhoneNumber>
          <LocationFlagID>0</LocationFlagID>
          <LocationFlag>Undefined</LocationFlag>
          <TypeID>0</TypeID>
          <Type>Undefined</Type>
          <Label>Undefined</Label>
          <Number>sample string 3</Number>
        </PhoneNumber>
      </PhoneNumbers>
      <EmailAddresses>
        <EmailAddress>
          <ID>1</ID>
          <Label>Undefined</Label>
          <OtherLabel>sample string 2</OtherLabel>
          <Email>sample string 3</Email>
          <IsLoginEmail>true</IsLoginEmail>
        </EmailAddress>
        <EmailAddress>
          <ID>1</ID>
          <Label>Undefined</Label>
          <OtherLabel>sample string 2</OtherLabel>
          <Email>sample string 3</Email>
          <IsLoginEmail>true</IsLoginEmail>
        </EmailAddress>
      </EmailAddresses>
    </Person>
    <Person>
      <ID>1</ID>
      <Name>
        <LastName>sample string 1</LastName>
        <FirstName>sample string 2</FirstName>
        <NickName>sample string 3</NickName>
        <MaidenName>sample string 4</MaidenName>
        <MiddleName>sample string 5</MiddleName>
        <TitleID>0</TitleID>
        <Title>Undefined</Title>
        <SuffixID>0</SuffixID>
        <Suffix>Undefined</Suffix>
        <FullName>sample string 2 sample string 1</FullName>
        <FullNameWithNickName>sample string 2 (sample string 3) sample string 1</FullNameWithNickName>
        <FullNameUPR>sample string 10</FullNameUPR>
        <FullNameUPRShort>sample string 11</FullNameUPRShort>
        <FullNameUPRShortNoMaiden>sample string 12</FullNameUPRShortNoMaiden>
      </Name>
      <Gender>Female</Gender>
      <DOB>2024-05-07T03:30:32.7597803-06:00</DOB>
      <Occupation>sample string 2</Occupation>
      <MaritalStatus>
        <ID>1</ID>
        <Name>sample string 2</Name>
      </MaritalStatus>
      <SSN>sample string 3</SSN>
      <HasAvatar>true</HasAvatar>
      <PhoneNumbers>
        <PhoneNumber>
          <LocationFlagID>0</LocationFlagID>
          <LocationFlag>Undefined</LocationFlag>
          <TypeID>0</TypeID>
          <Type>Undefined</Type>
          <Label>Undefined</Label>
          <Number>sample string 3</Number>
        </PhoneNumber>
        <PhoneNumber>
          <LocationFlagID>0</LocationFlagID>
          <LocationFlag>Undefined</LocationFlag>
          <TypeID>0</TypeID>
          <Type>Undefined</Type>
          <Label>Undefined</Label>
          <Number>sample string 3</Number>
        </PhoneNumber>
      </PhoneNumbers>
      <EmailAddresses>
        <EmailAddress>
          <ID>1</ID>
          <Label>Undefined</Label>
          <OtherLabel>sample string 2</OtherLabel>
          <Email>sample string 3</Email>
          <IsLoginEmail>true</IsLoginEmail>
        </EmailAddress>
        <EmailAddress>
          <ID>1</ID>
          <Label>Undefined</Label>
          <OtherLabel>sample string 2</OtherLabel>
          <Email>sample string 3</Email>
          <IsLoginEmail>true</IsLoginEmail>
        </EmailAddress>
      </EmailAddresses>
    </Person>
  </Result>
</WebMethodResultOfListOfPerson>