POST api/user/organisation/list
Request Information
URI Parameters
None.
Body Parameters
UserListRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Keyword | string |
None. |
|
| UserIds | Collection of string |
None. |
|
| Emails | Collection of string |
None. |
|
| ContactTypes | Collection of string |
None. |
|
| Page | integer |
None. |
|
| Size | integer |
None. |
|
| TotalItems | integer |
None. |
|
| SortOrder | string |
None. |
|
| SortField | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"keyword": "sample string 1",
"userIds": [
"sample string 1",
"sample string 2"
],
"emails": [
"sample string 1",
"sample string 2"
],
"contactTypes": [
"sample string 1",
"sample string 2"
],
"page": 2,
"size": 3,
"totalItems": 4,
"sortOrder": "sample string 5",
"sortField": "sample string 6"
}
application/octet-stream
Sample:
{"keyword":"sample string 1","userIds":["sample string 1","sample string 2"],"emails":["sample string 1","sample string 2"],"contactTypes":["sample string 1","sample string 2"],"page":2,"size":3,"totalItems":4,"sortOrder":"sample string 5","sortField":"sample string 6"}
application/xml, text/xml
Sample:
<UserListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.User.Request">
<Page xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">2</Page>
<Size xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">3</Size>
<SortField xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">sample string 6</SortField>
<SortOrder xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">sample string 5</SortOrder>
<TotalItems xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">4</TotalItems>
<ContactTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ContactTypes>
<Emails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Emails>
<Keyword>sample string 1</Keyword>
<UserIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</UserIds>
</UserListRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseResultOfUserWorkplaceListResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | UserWorkplaceListResponse |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"data": {
"workplaces": [
{
"userId": "sample string 1",
"memberNum": "sample string 2",
"title": "sample string 3",
"firstName": "sample string 4",
"lastName": "sample string 5",
"prefName": "sample string 6",
"email": "sample string 7",
"gender": "sample string 8",
"pronoun": "sample string 9",
"orgId": "d659950f-138b-4f72-a069-51c4311f1fa9",
"orgName": "sample string 10",
"location": "sample string 11",
"jobTitle": "sample string 12",
"startDate": "2025-12-11T04:19:10.1148712+11:00"
},
{
"userId": "sample string 1",
"memberNum": "sample string 2",
"title": "sample string 3",
"firstName": "sample string 4",
"lastName": "sample string 5",
"prefName": "sample string 6",
"email": "sample string 7",
"gender": "sample string 8",
"pronoun": "sample string 9",
"orgId": "d659950f-138b-4f72-a069-51c4311f1fa9",
"orgName": "sample string 10",
"location": "sample string 11",
"jobTitle": "sample string 12",
"startDate": "2025-12-11T04:19:10.1148712+11:00"
}
],
"page": 1,
"size": 2,
"totalItems": 3,
"sortOrder": "sample string 4",
"sortField": "sample string 5"
},
"message": "sample string 1"
}
application/octet-stream
Sample:
{"data":{"workplaces":[{"userId":"sample string 1","memberNum":"sample string 2","title":"sample string 3","firstName":"sample string 4","lastName":"sample string 5","prefName":"sample string 6","email":"sample string 7","gender":"sample string 8","pronoun":"sample string 9","orgId":"d659950f-138b-4f72-a069-51c4311f1fa9","orgName":"sample string 10","location":"sample string 11","jobTitle":"sample string 12","startDate":"2025-12-11T04:19:10.1148712+11:00"},{"userId":"sample string 1","memberNum":"sample string 2","title":"sample string 3","firstName":"sample string 4","lastName":"sample string 5","prefName":"sample string 6","email":"sample string 7","gender":"sample string 8","pronoun":"sample string 9","orgId":"d659950f-138b-4f72-a069-51c4311f1fa9","orgName":"sample string 10","location":"sample string 11","jobTitle":"sample string 12","startDate":"2025-12-11T04:19:10.1148712+11:00"}],"page":1,"size":2,"totalItems":3,"sortOrder":"sample string 4","sortField":"sample string 5"},"message":"sample string 1"}
application/xml, text/xml
Sample:
<ResponseResultOfUserWorkplaceListResponseBtYhHhLc xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Response">
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.User.Response">
<Page xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">1</Page>
<Size xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">2</Size>
<SortField xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">sample string 5</SortField>
<SortOrder xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">sample string 4</SortOrder>
<TotalItems xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">3</TotalItems>
<d2p1:Workplaces>
<d2p1:UserWorkplaceResponse>
<d2p1:Email>sample string 7</d2p1:Email>
<d2p1:FirstName>sample string 4</d2p1:FirstName>
<d2p1:Gender>sample string 8</d2p1:Gender>
<d2p1:JobTitle>sample string 12</d2p1:JobTitle>
<d2p1:LastName>sample string 5</d2p1:LastName>
<d2p1:Location>sample string 11</d2p1:Location>
<d2p1:MemberNum>sample string 2</d2p1:MemberNum>
<d2p1:OrgId>d659950f-138b-4f72-a069-51c4311f1fa9</d2p1:OrgId>
<d2p1:OrgName>sample string 10</d2p1:OrgName>
<d2p1:PrefName>sample string 6</d2p1:PrefName>
<d2p1:Pronoun>sample string 9</d2p1:Pronoun>
<d2p1:StartDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-10T17:19:10.1148712Z</d5p1:DateTime>
<d5p1:OffsetMinutes>660</d5p1:OffsetMinutes>
</d2p1:StartDate>
<d2p1:Title>sample string 3</d2p1:Title>
<d2p1:UserId>sample string 1</d2p1:UserId>
</d2p1:UserWorkplaceResponse>
<d2p1:UserWorkplaceResponse>
<d2p1:Email>sample string 7</d2p1:Email>
<d2p1:FirstName>sample string 4</d2p1:FirstName>
<d2p1:Gender>sample string 8</d2p1:Gender>
<d2p1:JobTitle>sample string 12</d2p1:JobTitle>
<d2p1:LastName>sample string 5</d2p1:LastName>
<d2p1:Location>sample string 11</d2p1:Location>
<d2p1:MemberNum>sample string 2</d2p1:MemberNum>
<d2p1:OrgId>d659950f-138b-4f72-a069-51c4311f1fa9</d2p1:OrgId>
<d2p1:OrgName>sample string 10</d2p1:OrgName>
<d2p1:PrefName>sample string 6</d2p1:PrefName>
<d2p1:Pronoun>sample string 9</d2p1:Pronoun>
<d2p1:StartDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-10T17:19:10.1148712Z</d5p1:DateTime>
<d5p1:OffsetMinutes>660</d5p1:OffsetMinutes>
</d2p1:StartDate>
<d2p1:Title>sample string 3</d2p1:Title>
<d2p1:UserId>sample string 1</d2p1:UserId>
</d2p1:UserWorkplaceResponse>
</d2p1:Workplaces>
</Data>
<Message>sample string 1</Message>
</ResponseResultOfUserWorkplaceListResponseBtYhHhLc>