POST api/v1/portals/{portalUid}/clients/registration

Registers a client for the Eclipse Web API.

Request Information

URI Parameters

Name	Description	Type	Additional information
portalUid	The portal UID.	globally unique identifier	Required

Body Parameters

The client registration model.

ClientRegistration

Name	Description	Type	Additional information
Company	The company.	globally unique identifier	Required
Name	The client name.	string	Required String length: inclusive between 0 and 100
AddressLine1	The client address line1.	string	String length: inclusive between 0 and 100
AddressLine2	The client address line2.	string	String length: inclusive between 0 and 100
AddressLine3	The client address line3.	string	String length: inclusive between 0 and 100
AddressLine4	The client address line4.	string	String length: inclusive between 0 and 100
PostCode	The client post code.	string	String length: inclusive between 0 and 50
Country	The client country.	globally unique identifier	None.
Forename	The client contact forename.	string	Required String length: inclusive between 0 and 100
OtherNames	The client contact other names.	string	String length: inclusive between 0 and 100
Surname	The client contact surname.	string	Required String length: inclusive between 0 and 100
Telephone	The client contact telephone	string	String length: inclusive between 0 and 100
Mobile	The client contact mobile.	string	String length: inclusive between 0 and 100
Email		string	Required String length: inclusive between 0 and 100
Notes		string	Required String length: inclusive between 0 and 100

Request Formats

application/json, text/json

Sample:

{
  "Company": "e99384a5-0af3-4b2f-8a75-864f236a25c9",
  "Name": "sample string 2",
  "AddressLine1": "sample string 3",
  "AddressLine2": "sample string 4",
  "AddressLine3": "sample string 5",
  "AddressLine4": "sample string 6",
  "PostCode": "sample string 7",
  "Country": "f43dfac2-bbed-4c89-82f1-ea4db02059a6",
  "Forename": "sample string 9",
  "OtherNames": "sample string 10",
  "Surname": "sample string 11",
  "Telephone": "sample string 12",
  "Mobile": "sample string 13",
  "Email": "sample string 14",
  "Notes": "sample string 15"
}

application/xml, text/xml

Sample:

<ClientRegistration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <AddressLine1>sample string 3</AddressLine1>
  <AddressLine2>sample string 4</AddressLine2>
  <AddressLine3>sample string 5</AddressLine3>
  <AddressLine4>sample string 6</AddressLine4>
  <Company>e99384a5-0af3-4b2f-8a75-864f236a25c9</Company>
  <Country>f43dfac2-bbed-4c89-82f1-ea4db02059a6</Country>
  <Email>sample string 14</Email>
  <Forename>sample string 9</Forename>
  <Mobile>sample string 13</Mobile>
  <Name>sample string 2</Name>
  <Notes>sample string 15</Notes>
  <OtherNames>sample string 10</OtherNames>
  <PostCode>sample string 7</PostCode>
  <Surname>sample string 11</Surname>
  <Telephone>sample string 12</Telephone>
</ClientRegistration>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the user confirmation.

ClientRegistrationViewModel

Name	Description	Type	Additional information
Company	The company.	CompanyViewModel	None.
Name	The client name.	string	None.
AddressLine1	Client address.	string	None.
AddressLine2	Client address.	string	None.
AddressLine3	Client address.	string	None.
AddressLine4	Client address.	string	None.
PostCode	Client postcode.	string	None.
Country	The client country.	CountryViewModel	None.
Forename	The client contact forename.	string	None.
OtherNames	The client contact other names.	string	None.
Surname	The client contact surname.	string	None.
Telephone	The client contact telephone.	string	None.
Mobile	The client contact mobile.	string	None.
Email	The client contact email.	string	None.
Notes	The client contact notes.	string	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:

{
  "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": "4c154c0a-9627-4d7b-9e01-bb716ee11b6a",
        "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-12-21T17:51:15.0380064+00:00",
        "UpdatedBy": "sample string 3"
      },
      "CountryGuid": "ec3e2304-7a8d-4bae-a2a1-02e5ae9b4590",
      "Uid": "588f645b-d753-43ab-acce-4d4e2102431a",
      "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-12-21T17:51:15.0380064+00:00",
      "UpdatedBy": "sample string 5"
    },
    "Latitude": "sample string 7",
    "Longitude": "sample string 8",
    "PortalUid": "3e6d1f72-c861-48bc-bc81-03f728283efe",
    "PortalGuid": "da6a33b5-8146-487c-b32e-ebda25fe9792",
    "CompanyGuid": "abdc1c24-40bf-4dbd-85b1-fed535cddd88",
    "Uid": "d1dd4eae-2edd-4e8f-aa47-4240efff2a3a",
    "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-12-21T17:51:15.0380064+00:00",
    "UpdatedBy": "sample string 13"
  },
  "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": "4c154c0a-9627-4d7b-9e01-bb716ee11b6a",
      "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-12-21T17:51:15.0380064+00:00",
      "UpdatedBy": "sample string 3"
    },
    "CountryGuid": "ec3e2304-7a8d-4bae-a2a1-02e5ae9b4590",
    "Uid": "588f645b-d753-43ab-acce-4d4e2102431a",
    "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-12-21T17:51:15.0380064+00:00",
    "UpdatedBy": "sample string 5"
  },
  "Forename": "sample string 7",
  "OtherNames": "sample string 8",
  "Surname": "sample string 9",
  "Telephone": "sample string 10",
  "Mobile": "sample string 11",
  "Email": "sample string 12",
  "Notes": "sample string 13",
  "Uid": "469a3788-c989-4e56-b2c3-a46458eb2216",
  "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-12-21T17:51:15.0380064+00:00",
  "UpdatedBy": "sample string 15"
}

application/xml, text/xml

Sample:

<ClientRegistrationViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-12-21T17:51:15.0380064+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>469a3788-c989-4e56-b2c3-a46458eb2216</Uid>
  <UpdatedBy>sample string 15</UpdatedBy>
  <AddressLine1>sample string 2</AddressLine1>
  <AddressLine2>sample string 3</AddressLine2>
  <AddressLine3>sample string 4</AddressLine3>
  <AddressLine4>sample string 5</AddressLine4>
  <Company>
    <DateUpdated>2025-12-21T17:51:15.0380064+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>d1dd4eae-2edd-4e8f-aa47-4240efff2a3a</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>abdc1c24-40bf-4dbd-85b1-fed535cddd88</CompanyGuid>
    <Country>
      <DateUpdated>2025-12-21T17:51:15.0380064+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>588f645b-d753-43ab-acce-4d4e2102431a</Uid>
      <UpdatedBy>sample string 5</UpdatedBy>
      <CountryGuid>ec3e2304-7a8d-4bae-a2a1-02e5ae9b4590</CountryGuid>
      <Iso3Code>sample string 1</Iso3Code>
      <Name>sample string 2</Name>
      <Portal>
        <DateUpdated>2025-12-21T17:51:15.0380064+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>4c154c0a-9627-4d7b-9e01-bb716ee11b6a</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>da6a33b5-8146-487c-b32e-ebda25fe9792</PortalGuid>
    <PortalUid>3e6d1f72-c861-48bc-bc81-03f728283efe</PortalUid>
    <PostCode>sample string 6</PostCode>
  </Company>
  <Country>
    <DateUpdated>2025-12-21T17:51:15.0380064+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>588f645b-d753-43ab-acce-4d4e2102431a</Uid>
    <UpdatedBy>sample string 5</UpdatedBy>
    <CountryGuid>ec3e2304-7a8d-4bae-a2a1-02e5ae9b4590</CountryGuid>
    <Iso3Code>sample string 1</Iso3Code>
    <Name>sample string 2</Name>
    <Portal>
      <DateUpdated>2025-12-21T17:51:15.0380064+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>4c154c0a-9627-4d7b-9e01-bb716ee11b6a</Uid>
      <UpdatedBy>sample string 3</UpdatedBy>
      <Name>sample string 1</Name>
    </Portal>
  </Country>
  <Email>sample string 12</Email>
  <Forename>sample string 7</Forename>
  <Mobile>sample string 11</Mobile>
  <Name>sample string 1</Name>
  <Notes>sample string 13</Notes>
  <OtherNames>sample string 8</OtherNames>
  <PostCode>sample string 6</PostCode>
  <Surname>sample string 9</Surname>
  <Telephone>sample string 10</Telephone>
</ClientRegistrationViewModel>