Clients

Search Clients

Search Clients

GET/api/client

Query parameters

Response

200404

Success

Body

text/plainapplication/jsontext/json

clientIDinteger (int32)

isActiveboolean

creatornullable string

creatednullable string (date-time)

updaternullable string

lastUpdatenullable string (date-time)

clientCustom1nullable string

contactContactDto (object)

clientContactsnullable array of ClientContactDto (object)

Request

JavaScriptCurl

const response = await fetch('/api/client', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "isActive": false,
  "creator": "text",
  "created": "2024-05-11T08:32:59.799Z",
  "updater": "text",
  "lastUpdate": "2024-05-11T08:32:59.799Z",
  "clientCustom1": "text",
  "contact": {
    "companyName": "text",
    "lastName": "text",
    "firstName": "text",
    "salutation": "text",
    "creator": "text",
    "created": "2024-05-11T08:32:59.799Z",
    "updater": "text",
    "lastUpdate": "2024-05-11T08:32:59.799Z",
    "website": "text",
    "contactAddress": {
      "street": "text",
      "number": "text",
      "poBox": "text",
      "city": "text",
      "zip": "text",
      "state": "text"
    },
    "contactDetails": [
      {
        "isPreferred": false,
        "value2": "text",
        "updater": "text",
        "lastUpdate": "2024-05-11T08:32:59.799Z"
      }
    ]
  },
  "clientContacts": [
    {
      "firstName": "text",
      "lastName": "text",
      "position": "text",
      "phone": "text",
      "mobile": "text",
      "email": "text",
      "department": "text"
    }
  ]
}

Add Client

Add clients

POST/api/client

Body

application/jsontext/jsonapplication/*+json

companyContactContactViewModel (object)

clientContactsnullable array of ClientContactViewModel (object)

Response

200400

Success

Body

text/plainapplication/jsontext/json

clientIDinteger (int32)

isActiveboolean

creatornullable string

creatednullable string (date-time)

updaternullable string

lastUpdatenullable string (date-time)

clientCustom1nullable string

contactContactDto (object)

clientContactsnullable array of ClientContactDto (object)

Request

JavaScriptCurl

const response = await fetch('/api/client', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {}
    ]),
});
const data = await response.json();

Response

[
  {
    "isActive": false,
    "creator": "text",
    "created": "2024-05-11T08:32:59.799Z",
    "updater": "text",
    "lastUpdate": "2024-05-11T08:32:59.799Z",
    "clientCustom1": "text",
    "contact": {
      "companyName": "text",
      "lastName": "text",
      "firstName": "text",
      "salutation": "text",
      "creator": "text",
      "created": "2024-05-11T08:32:59.799Z",
      "updater": "text",
      "lastUpdate": "2024-05-11T08:32:59.799Z",
      "website": "text",
      "contactAddress": {
        "street": "text",
        "number": "text",
        "poBox": "text",
        "city": "text",
        "zip": "text",
        "state": "text"
      },
      "contactDetails": [
        {
          "isPreferred": false,
          "value2": "text",
          "updater": "text",
          "lastUpdate": "2024-05-11T08:32:59.799Z"
        }
      ]
    },
    "clientContacts": [
      {
        "firstName": "text",
        "lastName": "text",
        "position": "text",
        "phone": "text",
        "mobile": "text",
        "email": "text",
        "department": "text"
      }
    ]
  }
]

Get Client By Id

Get client by Id

GET/api/client/{id}

Path parameters

id*integer (int32)

Response

200404

Success

Body

text/plainapplication/jsontext/json

clientIDinteger (int32)

isActiveboolean

creatornullable string

creatednullable string (date-time)

updaternullable string

lastUpdatenullable string (date-time)

clientCustom1nullable string

contactContactDto (object)

clientContactsnullable array of ClientContactDto (object)

Request

JavaScriptCurl

const response = await fetch('/api/client/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "isActive": false,
  "creator": "text",
  "created": "2024-05-11T08:32:59.799Z",
  "updater": "text",
  "lastUpdate": "2024-05-11T08:32:59.799Z",
  "clientCustom1": "text",
  "contact": {
    "companyName": "text",
    "lastName": "text",
    "firstName": "text",
    "salutation": "text",
    "creator": "text",
    "created": "2024-05-11T08:32:59.799Z",
    "updater": "text",
    "lastUpdate": "2024-05-11T08:32:59.799Z",
    "website": "text",
    "contactAddress": {
      "street": "text",
      "number": "text",
      "poBox": "text",
      "city": "text",
      "zip": "text",
      "state": "text"
    },
    "contactDetails": [
      {
        "isPreferred": false,
        "value2": "text",
        "updater": "text",
        "lastUpdate": "2024-05-11T08:32:59.799Z"
      }
    ]
  },
  "clientContacts": [
    {
      "firstName": "text",
      "lastName": "text",
      "position": "text",
      "phone": "text",
      "mobile": "text",
      "email": "text",
      "department": "text"
    }
  ]
}

Delete Client

Delete client by Id

DELETE/api/client/{id}

Path parameters

id*integer (int32)

Response

200404

Success

Request

JavaScriptCurl

const response = await fetch('/api/client/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();