POST api/v1/companies/{companyUid}/consultants

Creates the consultant by the specified company UID.

Request Information

URI Parameters

Name	Description	Type	Additional information
companyUid	The company UID.	globally unique identifier	Required

Body Parameters

The consultant.

Consultant

Name	Description	Type	Additional information
Email	The consultant email.	string	String length: inclusive between 0 and 255
Forename	The consultant forename.	string	Required String length: inclusive between 0 and 100
Surname	The consultant surname.	string	Required String length: inclusive between 0 and 100
JobTitle	The consultant consultant job title.	string	Required String length: inclusive between 0 and 100
Mobile	The consultant mobile telephone number.	string	String length: inclusive between 0 and 100
OtherNames	The consultant other names.	string	String length: inclusive between 0 and 100
Telephone	The consultant telephone number.	string	String length: inclusive between 0 and 100
Company	The company.	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "Email": "sample string 1",
  "Forename": "sample string 2",
  "Surname": "sample string 3",
  "JobTitle": "sample string 4",
  "Mobile": "sample string 5",
  "OtherNames": "sample string 6",
  "Telephone": "sample string 7",
  "Company": "16aa6e95-a5e5-414c-8c03-1882ea5e3f08"
}

application/xml, text/xml

Sample:

<Consultant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <Company>16aa6e95-a5e5-414c-8c03-1882ea5e3f08</Company>
  <Email>sample string 1</Email>
  <Forename>sample string 2</Forename>
  <JobTitle>sample string 4</JobTitle>
  <Mobile>sample string 5</Mobile>
  <OtherNames>sample string 6</OtherNames>
  <Surname>sample string 3</Surname>
  <Telephone>sample string 7</Telephone>
</Consultant>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Return the created consultant.

ConsultantViewModel

Name	Description	Type	Additional information
Email	The email.	string	None.
Forename	The forename.	string	None.
Surname	The surname.	string	None.
JobTitle	The job title.	string	None.
Mobile	The mobile.	string	None.
OtherNames	The other names.	string	None.
Telephone	The telephone.	string	None.
Company	The company.	CompanyViewModel	None.
ConsultantGuid	The consultant unique identifier	globally unique identifier	None.
Uid	The GUID.	globally unique identifier	None.
Links	The links.	Collection of Link	None.
DateUpdated	Last time the record was updated	date	None.
UpdatedBy	Who updated the record last	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Email": "sample string 1",
  "Forename": "sample string 2",
  "Surname": "sample string 3",
  "JobTitle": "sample string 4",
  "Mobile": "sample string 5",
  "OtherNames": "sample string 6",
  "Telephone": "sample string 7",
  "Company": {
    "Name": "sample string 1",
    "AddressLine1": "sample string 2",
    "AddressLine2": "sample string 3",
    "AddressLine3": "sample string 4",
    "AddressLine4": "sample string 5",
    "PostCode": "sample string 6",
    "Country": {
      "Iso3Code": "sample string 1",
      "Name": "sample string 2",
      "Portal": {
        "Name": "sample string 1",
        "Uid": "1bf80223-714e-483b-8daa-b2cfb1cc79dc",
        "Links": [
          {
            "Href": "http://webapihelppage1.com",
            "Method": "sample string 2",
            "Rel": "sample string 3",
            "Title": "sample string 4",
            "Type": "sample string 5"
          },
          {
            "Href": "http://webapihelppage1.com",
            "Method": "sample string 2",
            "Rel": "sample string 3",
            "Title": "sample string 4",
            "Type": "sample string 5"
          }
        ],
        "DateUpdated": "2025-10-27T14:01:21.9135475+00:00",
        "UpdatedBy": "sample string 3"
      },
      "CountryGuid": "892b156d-a60c-4907-a578-46937f5a6455",
      "Uid": "d9e46d22-8a1d-4dcd-9e39-f17caf32d8d5",
      "Links": [
        {
          "Href": "http://webapihelppage1.com",
          "Method": "sample string 2",
          "Rel": "sample string 3",
          "Title": "sample string 4",
          "Type": "sample string 5"
        },
        {
          "Href": "http://webapihelppage1.com",
          "Method": "sample string 2",
          "Rel": "sample string 3",
          "Title": "sample string 4",
          "Type": "sample string 5"
        }
      ],
      "DateUpdated": "2025-10-27T14:01:21.9135475+00:00",
      "UpdatedBy": "sample string 5"
    },
    "Latitude": "sample string 7",
    "Longitude": "sample string 8",
    "PortalUid": "b8641801-ab1f-46ac-aec7-fb8dd8cd46cd",
    "PortalGuid": "17c0275e-2ff5-428b-870e-9cf3581e64c9",
    "CompanyGuid": "2a999a31-40d4-4907-9369-3508d86ca3f5",
    "Uid": "cf45804c-7b5a-4c2f-bd87-c1a04b5c9d58",
    "Links": [
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      },
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      }
    ],
    "DateUpdated": "2025-10-27T14:01:21.9135475+00:00",
    "UpdatedBy": "sample string 13"
  },
  "ConsultantGuid": "c786888d-2140-4fb7-ad83-c472f6197c0a",
  "Uid": "57fbd969-5ba6-4d37-86ce-45ff9a6d7140",
  "Links": [
    {
      "Href": "http://webapihelppage1.com",
      "Method": "sample string 2",
      "Rel": "sample string 3",
      "Title": "sample string 4",
      "Type": "sample string 5"
    },
    {
      "Href": "http://webapihelppage1.com",
      "Method": "sample string 2",
      "Rel": "sample string 3",
      "Title": "sample string 4",
      "Type": "sample string 5"
    }
  ],
  "DateUpdated": "2025-10-27T14:01:21.9135475+00:00",
  "UpdatedBy": "sample string 10"
}

application/xml, text/xml

Sample:

<ConsultantViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-10-27T14:01:21.9135475+00:00</DateUpdated>
  <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
    <d2p1:Link>
      <d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
      <d2p1:Method>sample string 2</d2p1:Method>
      <d2p1:Rel>sample string 3</d2p1:Rel>
      <d2p1:Title>sample string 4</d2p1:Title>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:Link>
    <d2p1:Link>
      <d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
      <d2p1:Method>sample string 2</d2p1:Method>
      <d2p1:Rel>sample string 3</d2p1:Rel>
      <d2p1:Title>sample string 4</d2p1:Title>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:Link>
  </Links>
  <Uid>57fbd969-5ba6-4d37-86ce-45ff9a6d7140</Uid>
  <UpdatedBy>sample string 10</UpdatedBy>
  <Company>
    <DateUpdated>2025-10-27T14:01:21.9135475+00:00</DateUpdated>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
    </Links>
    <Uid>cf45804c-7b5a-4c2f-bd87-c1a04b5c9d58</Uid>
    <UpdatedBy>sample string 13</UpdatedBy>
    <AddressLine1>sample string 2</AddressLine1>
    <AddressLine2>sample string 3</AddressLine2>
    <AddressLine3>sample string 4</AddressLine3>
    <AddressLine4>sample string 5</AddressLine4>
    <CompanyGuid>2a999a31-40d4-4907-9369-3508d86ca3f5</CompanyGuid>
    <Country>
      <DateUpdated>2025-10-27T14:01:21.9135475+00:00</DateUpdated>
      <Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
      </Links>
      <Uid>d9e46d22-8a1d-4dcd-9e39-f17caf32d8d5</Uid>
      <UpdatedBy>sample string 5</UpdatedBy>
      <CountryGuid>892b156d-a60c-4907-a578-46937f5a6455</CountryGuid>
      <Iso3Code>sample string 1</Iso3Code>
      <Name>sample string 2</Name>
      <Portal>
        <DateUpdated>2025-10-27T14:01:21.9135475+00:00</DateUpdated>
        <Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
          <d5p1:Link>
            <d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
            <d5p1:Method>sample string 2</d5p1:Method>
            <d5p1:Rel>sample string 3</d5p1:Rel>
            <d5p1:Title>sample string 4</d5p1:Title>
            <d5p1:Type>sample string 5</d5p1:Type>
          </d5p1:Link>
          <d5p1:Link>
            <d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
            <d5p1:Method>sample string 2</d5p1:Method>
            <d5p1:Rel>sample string 3</d5p1:Rel>
            <d5p1:Title>sample string 4</d5p1:Title>
            <d5p1:Type>sample string 5</d5p1:Type>
          </d5p1:Link>
        </Links>
        <Uid>1bf80223-714e-483b-8daa-b2cfb1cc79dc</Uid>
        <UpdatedBy>sample string 3</UpdatedBy>
        <Name>sample string 1</Name>
      </Portal>
    </Country>
    <Latitude>sample string 7</Latitude>
    <Longitude>sample string 8</Longitude>
    <Name>sample string 1</Name>
    <PortalGuid>17c0275e-2ff5-428b-870e-9cf3581e64c9</PortalGuid>
    <PortalUid>b8641801-ab1f-46ac-aec7-fb8dd8cd46cd</PortalUid>
    <PostCode>sample string 6</PostCode>
  </Company>
  <ConsultantGuid>c786888d-2140-4fb7-ad83-c472f6197c0a</ConsultantGuid>
  <Email>sample string 1</Email>
  <Forename>sample string 2</Forename>
  <JobTitle>sample string 4</JobTitle>
  <Mobile>sample string 5</Mobile>
  <OtherNames>sample string 6</OtherNames>
  <Surname>sample string 3</Surname>
  <Telephone>sample string 7</Telephone>
</ConsultantViewModel>