POST api/organisations
Request Information
URI Parameters
None.
Body Parameters
OrganisationDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| CreationDate | date |
None. |
|
| CreatorUserId | globally unique identifier |
None. |
|
| TenantId | globally unique identifier |
None. |
|
| ParentId | globally unique identifier |
None. |
|
| StaffSecurityGroupId | globally unique identifier |
None. |
|
| ManagerSecurityGroupId | globally unique identifier |
None. |
|
| BusinessNumber | string |
None. |
|
| VatNumber | string |
None. |
|
| OrganisationAddressId | globally unique identifier |
None. |
|
| BillingAddressId | globally unique identifier |
None. |
|
| DeliveryAddressId | globally unique identifier |
None. |
|
| BusinessAreaName | string |
None. |
|
| BusinessAreaId | globally unique identifier |
None. |
|
| IsDeleted | boolean |
None. |
|
| LogoId | globally unique identifier |
None. |
|
| IsFranchise | boolean |
None. |
|
| Negotiator1ImageId | globally unique identifier |
None. |
|
| Negotiator1RBId | string |
None. |
|
| Negotiator1Name | string |
None. |
|
| Negotiator1Email | string |
None. |
|
| Negotiator1Tel | string |
None. |
|
| Negotiator2ImageId | globally unique identifier |
None. |
|
| Negotiator2RBId | string |
None. |
|
| Negotiator2Name | string |
None. |
|
| Negotiator2Email | string |
None. |
|
| Negotiator2Tel | string |
None. |
|
| TotalCode | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "da64d235-2537-497d-98c6-ee40c68d9088",
"Name": "sample string 2",
"CreationDate": "2025-12-06T04:48:56.7958878+00:00",
"CreatorUserId": "a60e2506-6517-4eb6-a1d7-d3836adee13f",
"TenantId": "01910867-d814-4d50-b10f-ccc900968b5b",
"ParentId": "cef00901-1060-4cd9-9a0a-a081e300e584",
"StaffSecurityGroupId": "f41bfd03-feae-4ec6-a3b1-540bfe17afc6",
"ManagerSecurityGroupId": "0ce5efe3-1804-4a9c-8189-086d1095c168",
"BusinessNumber": "sample string 6",
"VatNumber": "sample string 7",
"OrganisationAddressId": "3e62d460-4790-4d98-9b86-f1883b9122b5",
"BillingAddressId": "335ad735-92e3-46b6-842f-75e615890798",
"DeliveryAddressId": "968c1167-5925-45bb-ab62-bf45e71ccee7",
"BusinessAreaName": "sample string 8",
"BusinessAreaId": "c9580628-36ef-4617-97cf-1c273e247b6f",
"IsDeleted": true,
"LogoId": "69e079cf-911e-436c-9c6d-69c1c4d876e4",
"IsFranchise": true,
"Negotiator1ImageId": "b72259f9-aeef-4cf6-a05c-309ea321599b",
"Negotiator1RBId": "sample string 11",
"Negotiator1Name": "sample string 12",
"Negotiator1Email": "sample string 13",
"Negotiator1Tel": "sample string 14",
"Negotiator2ImageId": "117d003c-2be3-40a2-bce4-e9e7e6fc900e",
"Negotiator2RBId": "sample string 15",
"Negotiator2Name": "sample string 16",
"Negotiator2Email": "sample string 17",
"Negotiator2Tel": "sample string 18",
"TotalCode": "sample string 19"
}
application/xml, text/xml
Sample:
<OrganisationDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Profile.Models"> <BillingAddressId>335ad735-92e3-46b6-842f-75e615890798</BillingAddressId> <BusinessAreaId>c9580628-36ef-4617-97cf-1c273e247b6f</BusinessAreaId> <BusinessAreaName>sample string 8</BusinessAreaName> <BusinessNumber>sample string 6</BusinessNumber> <CreationDate>2025-12-06T04:48:56.7958878+00:00</CreationDate> <CreatorUserId>a60e2506-6517-4eb6-a1d7-d3836adee13f</CreatorUserId> <DeliveryAddressId>968c1167-5925-45bb-ab62-bf45e71ccee7</DeliveryAddressId> <Id>da64d235-2537-497d-98c6-ee40c68d9088</Id> <IsDeleted>true</IsDeleted> <IsFranchise>true</IsFranchise> <LogoId>69e079cf-911e-436c-9c6d-69c1c4d876e4</LogoId> <ManagerSecurityGroupId>0ce5efe3-1804-4a9c-8189-086d1095c168</ManagerSecurityGroupId> <Name>sample string 2</Name> <Negotiator1Email>sample string 13</Negotiator1Email> <Negotiator1ImageId>b72259f9-aeef-4cf6-a05c-309ea321599b</Negotiator1ImageId> <Negotiator1Name>sample string 12</Negotiator1Name> <Negotiator1RBId>sample string 11</Negotiator1RBId> <Negotiator1Tel>sample string 14</Negotiator1Tel> <Negotiator2Email>sample string 17</Negotiator2Email> <Negotiator2ImageId>117d003c-2be3-40a2-bce4-e9e7e6fc900e</Negotiator2ImageId> <Negotiator2Name>sample string 16</Negotiator2Name> <Negotiator2RBId>sample string 15</Negotiator2RBId> <Negotiator2Tel>sample string 18</Negotiator2Tel> <OrganisationAddressId>3e62d460-4790-4d98-9b86-f1883b9122b5</OrganisationAddressId> <ParentId>cef00901-1060-4cd9-9a0a-a081e300e584</ParentId> <StaffSecurityGroupId>f41bfd03-feae-4ec6-a3b1-540bfe17afc6</StaffSecurityGroupId> <TenantId>01910867-d814-4d50-b10f-ccc900968b5b</TenantId> <TotalCode>sample string 19</TotalCode> <VatNumber>sample string 7</VatNumber> </OrganisationDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.