GET api/v1/Persons/GetByExternalPersonIds?externalPersonIds[0]={externalPersonIds[0]}&externalPersonIds[1]={externalPersonIds[1]}
Gets persons by their external person ids
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
externalPersonIds | Collection of string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of PersonName | Description | Type | Additional information |
---|---|---|---|
Person_ID |
Person ID |
globally unique identifier |
None. |
PersonCode |
Code identifying user. For example social security number. |
string |
None. |
Address |
Street address |
string |
None. |
CompanyName |
Company where person works |
string |
None. |
ContactInfo |
General contact info field |
string |
None. |
Country |
Country where person lives |
string |
None. |
Description |
Description |
string |
None. |
Email address |
string |
None. |
|
EmploymentEndDate |
Optional date when user's work contract ends. |
date (nullable) |
None. |
ExternalCanEdit |
Is person editable |
boolean |
None. |
ExternalPersonId |
Person's identifier if person is imported to iLOQ from external system. |
string |
None. |
FirstName |
First names |
string |
None. |
LastName |
Last name |
string |
None. |
Phone1 |
Phone number 1 |
string |
None. |
Phone2 |
Phone number 2 |
string |
None. |
Phone3 |
Phone number 3 |
string |
None. |
PostOffice |
City or post office info |
string |
None. |
State |
State. Is person in use or not in use. |
pniPersonState |
None. |
WorkTitle |
Work title in the company. |
string |
None. |
ZipCode |
Zip code |
string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Person_ID": "79dbc8ae-95bc-464e-9d70-564921fa80d1", "PersonCode": "sample string 2", "Address": "sample string 3", "CompanyName": "sample string 4", "ContactInfo": "sample string 5", "Country": "sample string 6", "Description": "sample string 7", "eMail": "sample string 8", "EmploymentEndDate": "2025-05-20T13:41:11.6184178+03:00", "ExternalCanEdit": true, "ExternalPersonId": "sample string 10", "FirstName": "sample string 11", "LastName": "sample string 12", "Phone1": "sample string 13", "Phone2": "sample string 14", "Phone3": "sample string 15", "PostOffice": "sample string 16", "State": 0, "WorkTitle": "sample string 17", "ZipCode": "sample string 18" }, { "Person_ID": "79dbc8ae-95bc-464e-9d70-564921fa80d1", "PersonCode": "sample string 2", "Address": "sample string 3", "CompanyName": "sample string 4", "ContactInfo": "sample string 5", "Country": "sample string 6", "Description": "sample string 7", "eMail": "sample string 8", "EmploymentEndDate": "2025-05-20T13:41:11.6184178+03:00", "ExternalCanEdit": true, "ExternalPersonId": "sample string 10", "FirstName": "sample string 11", "LastName": "sample string 12", "Phone1": "sample string 13", "Phone2": "sample string 14", "Phone3": "sample string 15", "PostOffice": "sample string 16", "State": 0, "WorkTitle": "sample string 17", "ZipCode": "sample string 18" } ]
application/xml, text/xml
Sample:
<ArrayOfPerson xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iloq.manager.server.bus"> <Person> <Address>sample string 3</Address> <CompanyName>sample string 4</CompanyName> <ContactInfo>sample string 5</ContactInfo> <Country>sample string 6</Country> <Description>sample string 7</Description> <EmploymentEndDate>2025-05-20T13:41:11.6184178+03:00</EmploymentEndDate> <ExternalCanEdit>true</ExternalCanEdit> <ExternalPersonId>sample string 10</ExternalPersonId> <FirstName>sample string 11</FirstName> <LastName>sample string 12</LastName> <PersonCode>sample string 2</PersonCode> <Person_ID>79dbc8ae-95bc-464e-9d70-564921fa80d1</Person_ID> <Phone1>sample string 13</Phone1> <Phone2>sample string 14</Phone2> <Phone3>sample string 15</Phone3> <PostOffice>sample string 16</PostOffice> <State>eniActive</State> <WorkTitle>sample string 17</WorkTitle> <ZipCode>sample string 18</ZipCode> <eMail>sample string 8</eMail> </Person> <Person> <Address>sample string 3</Address> <CompanyName>sample string 4</CompanyName> <ContactInfo>sample string 5</ContactInfo> <Country>sample string 6</Country> <Description>sample string 7</Description> <EmploymentEndDate>2025-05-20T13:41:11.6184178+03:00</EmploymentEndDate> <ExternalCanEdit>true</ExternalCanEdit> <ExternalPersonId>sample string 10</ExternalPersonId> <FirstName>sample string 11</FirstName> <LastName>sample string 12</LastName> <PersonCode>sample string 2</PersonCode> <Person_ID>79dbc8ae-95bc-464e-9d70-564921fa80d1</Person_ID> <Phone1>sample string 13</Phone1> <Phone2>sample string 14</Phone2> <Phone3>sample string 15</Phone3> <PostOffice>sample string 16</PostOffice> <State>eniActive</State> <WorkTitle>sample string 17</WorkTitle> <ZipCode>sample string 18</ZipCode> <eMail>sample string 8</eMail> </Person> </ArrayOfPerson>