POST api/organisations

Request Information

URI Parameters

None.

Body Parameters

API.Infrastructure.Dto.Organisations.OrganisationDto
NameDescriptionTypeAdditional 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.

Request Formats

application/json, text/json

Sample:
{
  "id": "90ea3872-80f0-44fd-a5f8-0e33cc620ed3",
  "name": "sample string 1",
  "organisationTypeId": "3a871c82-f080-4285-82dd-7bd5f0c2ae78",
  "externalReference": "sample string 2",
  "languageId": "091ebf85-2af2-4cd4-8bb0-72f8ffd3d69f",
  "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": "a88ef07c-ffbc-4365-bc24-a1c70cd46b5f",
  "contacts": [
    {
      "id": "3de4b658-1310-4672-a04b-3d58ee23b3a4",
      "contactTypeId": "97eb8e44-33bd-4b49-acbc-964df9e8413c",
      "jobTitle": "sample string 2",
      "titleId": "53cbabfd-355d-4c3f-874b-14c8ade29dfb",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "phone": "sample string 5",
      "mobile": "sample string 6",
      "email": "sample string 7",
      "organisationId": "183f26e0-8ffe-4d40-90e1-db78cbd816e8",
      "default": true,
      "active": true
    },
    {
      "id": "3de4b658-1310-4672-a04b-3d58ee23b3a4",
      "contactTypeId": "97eb8e44-33bd-4b49-acbc-964df9e8413c",
      "jobTitle": "sample string 2",
      "titleId": "53cbabfd-355d-4c3f-874b-14c8ade29dfb",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "phone": "sample string 5",
      "mobile": "sample string 6",
      "email": "sample string 7",
      "organisationId": "183f26e0-8ffe-4d40-90e1-db78cbd816e8",
      "default": true,
      "active": true
    }
  ],
  "reportKey": "sample string 14"
}

text/html

Sample:
{"id":"90ea3872-80f0-44fd-a5f8-0e33cc620ed3","name":"sample string 1","organisationTypeId":"3a871c82-f080-4285-82dd-7bd5f0c2ae78","externalReference":"sample string 2","languageId":"091ebf85-2af2-4cd4-8bb0-72f8ffd3d69f","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":"a88ef07c-ffbc-4365-bc24-a1c70cd46b5f","contacts":[{"id":"3de4b658-1310-4672-a04b-3d58ee23b3a4","contactTypeId":"97eb8e44-33bd-4b49-acbc-964df9e8413c","jobTitle":"sample string 2","titleId":"53cbabfd-355d-4c3f-874b-14c8ade29dfb","firstName":"sample string 3","lastName":"sample string 4","phone":"sample string 5","mobile":"sample string 6","email":"sample string 7","organisationId":"183f26e0-8ffe-4d40-90e1-db78cbd816e8","default":true,"active":true},{"id":"3de4b658-1310-4672-a04b-3d58ee23b3a4","contactTypeId":"97eb8e44-33bd-4b49-acbc-964df9e8413c","jobTitle":"sample string 2","titleId":"53cbabfd-355d-4c3f-874b-14c8ade29dfb","firstName":"sample string 3","lastName":"sample string 4","phone":"sample string 5","mobile":"sample string 6","email":"sample string 7","organisationId":"183f26e0-8ffe-4d40-90e1-db78cbd816e8","default":true,"active":true}],"reportKey":"sample string 14"}

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, text/html

Sample:

Sample not available.