POST api/org/list
Request Information
URI Parameters
None.
Body Parameters
OrganisationListRequestExt| Name | Description | Type | Additional information |
|---|---|---|---|
| Keyword | 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",
"page": 2,
"size": 3,
"totalItems": 4,
"sortOrder": "sample string 5",
"sortField": "sample string 6"
}
application/octet-stream
Sample:
{"keyword":"sample string 1","page":2,"size":3,"totalItems":4,"sortOrder":"sample string 5","sortField":"sample string 6"}
application/xml, text/xml
Sample:
<OrganisationListRequestExt xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bond.Mx.Api.MRM.Organisations.Requests"> <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> <Keyword xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Organisation.Request">sample string 1</Keyword> </OrganisationListRequestExt>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseResultOfOrganisationListResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | OrganisationListResponse |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"data": {
"organisations": [
{
"id": "073d5939-a2c1-4fce-9e9e-46fce5b40bd1",
"name": "sample string 1",
"orgNumber": "sample string 2",
"tradingName": "sample string 3",
"abn": "sample string 4",
"acn": "sample string 5",
"address1": "sample string 6",
"address2": "sample string 7",
"address3": "sample string 8",
"suburb": "sample string 9",
"state": "sample string 10",
"postcode": "sample string 11",
"country": "sample string 12",
"location": "sample string 13",
"website": "sample string 14",
"imageUrl": "sample string 15",
"fields": [
{
"id": "3b09f409-2b25-4e82-9142-1b262a509b46",
"label": "sample string 2",
"value": {},
"toolTip": "sample string 4",
"type": "sample string 5",
"isRequired": true,
"dataCallbackRelativeUrl": "sample string 7"
},
{
"id": "3b09f409-2b25-4e82-9142-1b262a509b46",
"label": "sample string 2",
"value": {},
"toolTip": "sample string 4",
"type": "sample string 5",
"isRequired": true,
"dataCallbackRelativeUrl": "sample string 7"
}
]
},
{
"id": "073d5939-a2c1-4fce-9e9e-46fce5b40bd1",
"name": "sample string 1",
"orgNumber": "sample string 2",
"tradingName": "sample string 3",
"abn": "sample string 4",
"acn": "sample string 5",
"address1": "sample string 6",
"address2": "sample string 7",
"address3": "sample string 8",
"suburb": "sample string 9",
"state": "sample string 10",
"postcode": "sample string 11",
"country": "sample string 12",
"location": "sample string 13",
"website": "sample string 14",
"imageUrl": "sample string 15",
"fields": [
{
"id": "3b09f409-2b25-4e82-9142-1b262a509b46",
"label": "sample string 2",
"value": {},
"toolTip": "sample string 4",
"type": "sample string 5",
"isRequired": true,
"dataCallbackRelativeUrl": "sample string 7"
},
{
"id": "3b09f409-2b25-4e82-9142-1b262a509b46",
"label": "sample string 2",
"value": {},
"toolTip": "sample string 4",
"type": "sample string 5",
"isRequired": true,
"dataCallbackRelativeUrl": "sample string 7"
}
]
}
],
"page": 1,
"size": 2,
"totalItems": 3,
"sortOrder": "sample string 4",
"sortField": "sample string 5"
},
"message": "sample string 1"
}
application/octet-stream
Sample:
{"data":{"organisations":[{"id":"073d5939-a2c1-4fce-9e9e-46fce5b40bd1","name":"sample string 1","orgNumber":"sample string 2","tradingName":"sample string 3","abn":"sample string 4","acn":"sample string 5","address1":"sample string 6","address2":"sample string 7","address3":"sample string 8","suburb":"sample string 9","state":"sample string 10","postcode":"sample string 11","country":"sample string 12","location":"sample string 13","website":"sample string 14","imageUrl":"sample string 15","fields":[{"id":"3b09f409-2b25-4e82-9142-1b262a509b46","label":"sample string 2","value":{},"toolTip":"sample string 4","type":"sample string 5","isRequired":true,"dataCallbackRelativeUrl":"sample string 7"},{"id":"3b09f409-2b25-4e82-9142-1b262a509b46","label":"sample string 2","value":{},"toolTip":"sample string 4","type":"sample string 5","isRequired":true,"dataCallbackRelativeUrl":"sample string 7"}]},{"id":"073d5939-a2c1-4fce-9e9e-46fce5b40bd1","name":"sample string 1","orgNumber":"sample string 2","tradingName":"sample string 3","abn":"sample string 4","acn":"sample string 5","address1":"sample string 6","address2":"sample string 7","address3":"sample string 8","suburb":"sample string 9","state":"sample string 10","postcode":"sample string 11","country":"sample string 12","location":"sample string 13","website":"sample string 14","imageUrl":"sample string 15","fields":[{"id":"3b09f409-2b25-4e82-9142-1b262a509b46","label":"sample string 2","value":{},"toolTip":"sample string 4","type":"sample string 5","isRequired":true,"dataCallbackRelativeUrl":"sample string 7"},{"id":"3b09f409-2b25-4e82-9142-1b262a509b46","label":"sample string 2","value":{},"toolTip":"sample string 4","type":"sample string 5","isRequired":true,"dataCallbackRelativeUrl":"sample string 7"}]}],"page":1,"size":2,"totalItems":3,"sortOrder":"sample string 4","sortField":"sample string 5"},"message":"sample string 1"}
application/xml, text/xml
Sample:
<ResponseResultOfOrganisationListResponseTTPb4p0m 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.Organisation.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:Organisations>
<d2p1:OrganisationResponse>
<d2p1:ABN>sample string 4</d2p1:ABN>
<d2p1:ACN>sample string 5</d2p1:ACN>
<d2p1:Address1>sample string 6</d2p1:Address1>
<d2p1:Address2>sample string 7</d2p1:Address2>
<d2p1:Address3>sample string 8</d2p1:Address3>
<d2p1:Country>sample string 12</d2p1:Country>
<d2p1:Fields xmlns:d5p1="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Custom">
<d5p1:FormField>
<d5p1:DataCallbackRelativeUrl>sample string 7</d5p1:DataCallbackRelativeUrl>
<d5p1:Id>3b09f409-2b25-4e82-9142-1b262a509b46</d5p1:Id>
<d5p1:IsRequired>true</d5p1:IsRequired>
<d5p1:Label>sample string 2</d5p1:Label>
<d5p1:ToolTip>sample string 4</d5p1:ToolTip>
<d5p1:Type>sample string 5</d5p1:Type>
<d5p1:Value />
</d5p1:FormField>
<d5p1:FormField>
<d5p1:DataCallbackRelativeUrl>sample string 7</d5p1:DataCallbackRelativeUrl>
<d5p1:Id>3b09f409-2b25-4e82-9142-1b262a509b46</d5p1:Id>
<d5p1:IsRequired>true</d5p1:IsRequired>
<d5p1:Label>sample string 2</d5p1:Label>
<d5p1:ToolTip>sample string 4</d5p1:ToolTip>
<d5p1:Type>sample string 5</d5p1:Type>
<d5p1:Value />
</d5p1:FormField>
</d2p1:Fields>
<d2p1:Id>073d5939-a2c1-4fce-9e9e-46fce5b40bd1</d2p1:Id>
<d2p1:ImageUrl>sample string 15</d2p1:ImageUrl>
<d2p1:Location>sample string 13</d2p1:Location>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:OrgNumber>sample string 2</d2p1:OrgNumber>
<d2p1:Postcode>sample string 11</d2p1:Postcode>
<d2p1:State>sample string 10</d2p1:State>
<d2p1:Suburb>sample string 9</d2p1:Suburb>
<d2p1:TradingName>sample string 3</d2p1:TradingName>
<d2p1:Website>sample string 14</d2p1:Website>
</d2p1:OrganisationResponse>
<d2p1:OrganisationResponse>
<d2p1:ABN>sample string 4</d2p1:ABN>
<d2p1:ACN>sample string 5</d2p1:ACN>
<d2p1:Address1>sample string 6</d2p1:Address1>
<d2p1:Address2>sample string 7</d2p1:Address2>
<d2p1:Address3>sample string 8</d2p1:Address3>
<d2p1:Country>sample string 12</d2p1:Country>
<d2p1:Fields xmlns:d5p1="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Custom">
<d5p1:FormField>
<d5p1:DataCallbackRelativeUrl>sample string 7</d5p1:DataCallbackRelativeUrl>
<d5p1:Id>3b09f409-2b25-4e82-9142-1b262a509b46</d5p1:Id>
<d5p1:IsRequired>true</d5p1:IsRequired>
<d5p1:Label>sample string 2</d5p1:Label>
<d5p1:ToolTip>sample string 4</d5p1:ToolTip>
<d5p1:Type>sample string 5</d5p1:Type>
<d5p1:Value />
</d5p1:FormField>
<d5p1:FormField>
<d5p1:DataCallbackRelativeUrl>sample string 7</d5p1:DataCallbackRelativeUrl>
<d5p1:Id>3b09f409-2b25-4e82-9142-1b262a509b46</d5p1:Id>
<d5p1:IsRequired>true</d5p1:IsRequired>
<d5p1:Label>sample string 2</d5p1:Label>
<d5p1:ToolTip>sample string 4</d5p1:ToolTip>
<d5p1:Type>sample string 5</d5p1:Type>
<d5p1:Value />
</d5p1:FormField>
</d2p1:Fields>
<d2p1:Id>073d5939-a2c1-4fce-9e9e-46fce5b40bd1</d2p1:Id>
<d2p1:ImageUrl>sample string 15</d2p1:ImageUrl>
<d2p1:Location>sample string 13</d2p1:Location>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:OrgNumber>sample string 2</d2p1:OrgNumber>
<d2p1:Postcode>sample string 11</d2p1:Postcode>
<d2p1:State>sample string 10</d2p1:State>
<d2p1:Suburb>sample string 9</d2p1:Suburb>
<d2p1:TradingName>sample string 3</d2p1:TradingName>
<d2p1:Website>sample string 14</d2p1:Website>
</d2p1:OrganisationResponse>
</d2p1:Organisations>
</Data>
<Message>sample string 1</Message>
</ResponseResultOfOrganisationListResponseTTPb4p0m>