POST api/organisations
Request Information
URI Parameters
None.
Body Parameters
API.Infrastructure.Dto.Organisations.OrganisationDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Name | string |
Required |
|
| OrganisationTypeId | globally unique identifier |
Required |
|
| ExternalReference | string |
None. |
|
| LanguageId | globally unique identifier |
Required |
|
| Timezone | string |
Required |
|
| Address1 | string |
None. |
|
| Address2 | string |
None. |
|
| Address3 | string |
None. |
|
| Address4 | string |
None. |
|
| City | string |
None. |
|
| Country | string |
None. |
|
| County | string |
None. |
|
| Zip | string |
None. |
|
| Image | string |
None. |
|
| ParentId | globally unique identifier |
None. |
|
| Contacts | Collection of API.Infrastructure.Dto.Contacts.ContactDto |
None. |
|
| ReportKey | string |
None. |
|
| DigitalTwinUrl | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"id": "e967b278-a204-4154-9040-7d9e8f28314d",
"name": "sample string 1",
"organisationTypeId": "66858da0-bb1f-454b-900d-fa550f673940",
"externalReference": "sample string 2",
"languageId": "5450bfca-84ef-4a42-b3ac-bc81812c2e97",
"timezone": "sample string 4",
"address1": "sample string 5",
"address2": "sample string 6",
"address3": "sample string 7",
"address4": "sample string 8",
"city": "sample string 9",
"country": "sample string 10",
"county": "sample string 11",
"zip": "sample string 12",
"image": "sample string 13",
"parentId": "453b4e36-7de0-4ba2-b898-68809cb8f7d8",
"contacts": [
{
"id": "c29a2c3c-ddea-43db-9d85-af62baa76379",
"contactTypeId": "16684fdc-4dd9-4ae5-a211-64bc5cfe1168",
"jobTitle": "sample string 2",
"titleId": "39745394-ccd7-4a7b-9fa6-1e61b73d3aa7",
"firstName": "sample string 3",
"lastName": "sample string 4",
"phone": "sample string 5",
"mobile": "sample string 6",
"email": "sample string 7",
"organisationId": "4249cdad-48aa-4868-b9f1-bc9f425bfc67",
"default": true,
"active": true
},
{
"id": "c29a2c3c-ddea-43db-9d85-af62baa76379",
"contactTypeId": "16684fdc-4dd9-4ae5-a211-64bc5cfe1168",
"jobTitle": "sample string 2",
"titleId": "39745394-ccd7-4a7b-9fa6-1e61b73d3aa7",
"firstName": "sample string 3",
"lastName": "sample string 4",
"phone": "sample string 5",
"mobile": "sample string 6",
"email": "sample string 7",
"organisationId": "4249cdad-48aa-4868-b9f1-bc9f425bfc67",
"default": true,
"active": true
}
],
"reportKey": "sample string 14",
"digitalTwinUrl": "sample string 15"
}
text/html
Sample:
{"id":"e967b278-a204-4154-9040-7d9e8f28314d","name":"sample string 1","organisationTypeId":"66858da0-bb1f-454b-900d-fa550f673940","externalReference":"sample string 2","languageId":"5450bfca-84ef-4a42-b3ac-bc81812c2e97","timezone":"sample string 4","address1":"sample string 5","address2":"sample string 6","address3":"sample string 7","address4":"sample string 8","city":"sample string 9","country":"sample string 10","county":"sample string 11","zip":"sample string 12","image":"sample string 13","parentId":"453b4e36-7de0-4ba2-b898-68809cb8f7d8","contacts":[{"id":"c29a2c3c-ddea-43db-9d85-af62baa76379","contactTypeId":"16684fdc-4dd9-4ae5-a211-64bc5cfe1168","jobTitle":"sample string 2","titleId":"39745394-ccd7-4a7b-9fa6-1e61b73d3aa7","firstName":"sample string 3","lastName":"sample string 4","phone":"sample string 5","mobile":"sample string 6","email":"sample string 7","organisationId":"4249cdad-48aa-4868-b9f1-bc9f425bfc67","default":true,"active":true},{"id":"c29a2c3c-ddea-43db-9d85-af62baa76379","contactTypeId":"16684fdc-4dd9-4ae5-a211-64bc5cfe1168","jobTitle":"sample string 2","titleId":"39745394-ccd7-4a7b-9fa6-1e61b73d3aa7","firstName":"sample string 3","lastName":"sample string 4","phone":"sample string 5","mobile":"sample string 6","email":"sample string 7","organisationId":"4249cdad-48aa-4868-b9f1-bc9f425bfc67","default":true,"active":true}],"reportKey":"sample string 14","digitalTwinUrl":"sample string 15"}
Response Information
Resource Description
System.Web.Http.IHttpActionResultNone.
Response Formats
application/json, text/json, text/html
Sample:
Sample not available.