PUT api/user/organisation
Request Information
URI Parameters
None.
Body Parameters
UpdateWorkplaceRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Organisation | OrganisationRequest |
None. |
|
| Role | string |
None. |
|
| Rank | string |
None. |
|
| StartDate | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"organisation": {
"id": "5b43ffc6-962b-442f-aa0f-7971561f6d49",
"name": "sample string 1",
"address1": "sample string 2",
"address2": "sample string 3",
"suburb": "sample string 4",
"state": "sample string 5",
"postcode": "sample string 6",
"country": "sample string 7",
"website": "sample string 8",
"imageUrl": "sample string 9"
},
"role": "sample string 1",
"rank": "sample string 2",
"startDate": "2025-12-11T04:20:11.6700531+11:00"
}
application/octet-stream
Sample:
{"organisation":{"id":"5b43ffc6-962b-442f-aa0f-7971561f6d49","name":"sample string 1","address1":"sample string 2","address2":"sample string 3","suburb":"sample string 4","state":"sample string 5","postcode":"sample string 6","country":"sample string 7","website":"sample string 8","imageUrl":"sample string 9"},"role":"sample string 1","rank":"sample string 2","startDate":"2025-12-11T04:20:11.6700531+11:00"}
application/xml, text/xml
Sample:
<UpdateWorkplaceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.User.Request">
<Organisation xmlns:d2p1="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Organisation.Request">
<d2p1:Address1>sample string 2</d2p1:Address1>
<d2p1:Address2>sample string 3</d2p1:Address2>
<d2p1:Country>sample string 7</d2p1:Country>
<d2p1:Id>5b43ffc6-962b-442f-aa0f-7971561f6d49</d2p1:Id>
<d2p1:ImageUrl>sample string 9</d2p1:ImageUrl>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Postcode>sample string 6</d2p1:Postcode>
<d2p1:State>sample string 5</d2p1:State>
<d2p1:Suburb>sample string 4</d2p1:Suburb>
<d2p1:Website>sample string 8</d2p1:Website>
</Organisation>
<Rank>sample string 2</Rank>
<Role>sample string 1</Role>
<StartDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-12-10T17:20:11.6700531Z</d2p1:DateTime>
<d2p1:OffsetMinutes>660</d2p1:OffsetMinutes>
</StartDate>
</UpdateWorkplaceRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseResultOfWorkplaceResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | WorkplaceResponse |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"data": {
"organisation": {
"id": "4657a1c3-c69a-454b-8ea9-772e822ba87f",
"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": "cf6794f3-e248-4cff-bb98-f5d151e733c8",
"label": "sample string 2",
"value": {},
"toolTip": "sample string 4",
"type": "sample string 5",
"isRequired": true,
"dataCallbackRelativeUrl": "sample string 7"
},
{
"id": "cf6794f3-e248-4cff-bb98-f5d151e733c8",
"label": "sample string 2",
"value": {},
"toolTip": "sample string 4",
"type": "sample string 5",
"isRequired": true,
"dataCallbackRelativeUrl": "sample string 7"
}
]
},
"role": "sample string 1",
"rank": "sample string 2",
"startDate": "2025-12-11T04:20:11.6700531+11:00"
},
"message": "sample string 1"
}
application/octet-stream
Sample:
{"data":{"organisation":{"id":"4657a1c3-c69a-454b-8ea9-772e822ba87f","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":"cf6794f3-e248-4cff-bb98-f5d151e733c8","label":"sample string 2","value":{},"toolTip":"sample string 4","type":"sample string 5","isRequired":true,"dataCallbackRelativeUrl":"sample string 7"},{"id":"cf6794f3-e248-4cff-bb98-f5d151e733c8","label":"sample string 2","value":{},"toolTip":"sample string 4","type":"sample string 5","isRequired":true,"dataCallbackRelativeUrl":"sample string 7"}]},"role":"sample string 1","rank":"sample string 2","startDate":"2025-12-11T04:20:11.6700531+11:00"},"message":"sample string 1"}
application/xml, text/xml
Sample:
<ResponseResultOfWorkplaceResponseBtYhHhLc 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">
<d2p1:Organisation xmlns:d3p1="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Organisation.Response">
<d3p1:ABN>sample string 4</d3p1:ABN>
<d3p1:ACN>sample string 5</d3p1:ACN>
<d3p1:Address1>sample string 6</d3p1:Address1>
<d3p1:Address2>sample string 7</d3p1:Address2>
<d3p1:Address3>sample string 8</d3p1:Address3>
<d3p1:Country>sample string 12</d3p1:Country>
<d3p1:Fields xmlns:d4p1="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Custom">
<d4p1:FormField>
<d4p1:DataCallbackRelativeUrl>sample string 7</d4p1:DataCallbackRelativeUrl>
<d4p1:Id>cf6794f3-e248-4cff-bb98-f5d151e733c8</d4p1:Id>
<d4p1:IsRequired>true</d4p1:IsRequired>
<d4p1:Label>sample string 2</d4p1:Label>
<d4p1:ToolTip>sample string 4</d4p1:ToolTip>
<d4p1:Type>sample string 5</d4p1:Type>
<d4p1:Value />
</d4p1:FormField>
<d4p1:FormField>
<d4p1:DataCallbackRelativeUrl>sample string 7</d4p1:DataCallbackRelativeUrl>
<d4p1:Id>cf6794f3-e248-4cff-bb98-f5d151e733c8</d4p1:Id>
<d4p1:IsRequired>true</d4p1:IsRequired>
<d4p1:Label>sample string 2</d4p1:Label>
<d4p1:ToolTip>sample string 4</d4p1:ToolTip>
<d4p1:Type>sample string 5</d4p1:Type>
<d4p1:Value />
</d4p1:FormField>
</d3p1:Fields>
<d3p1:Id>4657a1c3-c69a-454b-8ea9-772e822ba87f</d3p1:Id>
<d3p1:ImageUrl>sample string 15</d3p1:ImageUrl>
<d3p1:Location>sample string 13</d3p1:Location>
<d3p1:Name>sample string 1</d3p1:Name>
<d3p1:OrgNumber>sample string 2</d3p1:OrgNumber>
<d3p1:Postcode>sample string 11</d3p1:Postcode>
<d3p1:State>sample string 10</d3p1:State>
<d3p1:Suburb>sample string 9</d3p1:Suburb>
<d3p1:TradingName>sample string 3</d3p1:TradingName>
<d3p1:Website>sample string 14</d3p1:Website>
</d2p1:Organisation>
<d2p1:Rank>sample string 2</d2p1:Rank>
<d2p1:Role>sample string 1</d2p1:Role>
<d2p1:StartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-10T17:20:11.6700531Z</d3p1:DateTime>
<d3p1:OffsetMinutes>660</d3p1:OffsetMinutes>
</d2p1:StartDate>
</Data>
<Message>sample string 1</Message>
</ResponseResultOfWorkplaceResponseBtYhHhLc>