POST api/organisations

Request Information

URI Parameters

None.

Body Parameters

API.Infrastructure.Dto.Organisations.OrganisationDto

Name	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": "32d29d99-5256-447a-8591-3fe466c7bf67",
  "name": "sample string 1",
  "organisationTypeId": "71f03958-4106-4543-8fce-07e32705be27",
  "externalReference": "sample string 2",
  "languageId": "6ea791c4-d3c6-480d-8100-321c6ddec0c8",
  "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": "71c0b978-51bf-4e0a-83fa-c5f6f03f2ff1",
  "contacts": [
    {
      "id": "4821e842-7e79-4d30-96e7-93220aa3fa92",
      "contactTypeId": "1461668b-da68-40f9-ae37-e0e35fdb0028",
      "jobTitle": "sample string 2",
      "titleId": "8390ad84-79ee-4780-98d9-c0c9ce697965",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "phone": "sample string 5",
      "mobile": "sample string 6",
      "email": "sample string 7",
      "organisationId": "8d3cad0d-a4f6-4bfa-af71-8026a3728560",
      "default": true,
      "active": true
    },
    {
      "id": "4821e842-7e79-4d30-96e7-93220aa3fa92",
      "contactTypeId": "1461668b-da68-40f9-ae37-e0e35fdb0028",
      "jobTitle": "sample string 2",
      "titleId": "8390ad84-79ee-4780-98d9-c0c9ce697965",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "phone": "sample string 5",
      "mobile": "sample string 6",
      "email": "sample string 7",
      "organisationId": "8d3cad0d-a4f6-4bfa-af71-8026a3728560",
      "default": true,
      "active": true
    }
  ],
  "reportKey": "sample string 14",
  "digitalTwinUrl": "sample string 15"
}

text/html

Sample:

{"id":"32d29d99-5256-447a-8591-3fe466c7bf67","name":"sample string 1","organisationTypeId":"71f03958-4106-4543-8fce-07e32705be27","externalReference":"sample string 2","languageId":"6ea791c4-d3c6-480d-8100-321c6ddec0c8","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":"71c0b978-51bf-4e0a-83fa-c5f6f03f2ff1","contacts":[{"id":"4821e842-7e79-4d30-96e7-93220aa3fa92","contactTypeId":"1461668b-da68-40f9-ae37-e0e35fdb0028","jobTitle":"sample string 2","titleId":"8390ad84-79ee-4780-98d9-c0c9ce697965","firstName":"sample string 3","lastName":"sample string 4","phone":"sample string 5","mobile":"sample string 6","email":"sample string 7","organisationId":"8d3cad0d-a4f6-4bfa-af71-8026a3728560","default":true,"active":true},{"id":"4821e842-7e79-4d30-96e7-93220aa3fa92","contactTypeId":"1461668b-da68-40f9-ae37-e0e35fdb0028","jobTitle":"sample string 2","titleId":"8390ad84-79ee-4780-98d9-c0c9ce697965","firstName":"sample string 3","lastName":"sample string 4","phone":"sample string 5","mobile":"sample string 6","email":"sample string 7","organisationId":"8d3cad0d-a4f6-4bfa-af71-8026a3728560","default":true,"active":true}],"reportKey":"sample string 14","digitalTwinUrl":"sample string 15"}

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, text/html

Sample:

Sample not available.