POST api/cli

The purpose of this method is to add CLIs to a site

Error messages
  • 404/NotFound - Site with id = X not found
  • 400/BadRequest - The End date can't be set before the Start date
  • 409/Conflict - (Validation error message)

Request Information

URI Parameters

None.

Body Parameters

CLIPostRequest
NameDescriptionTypeAdditional information
SiteId Site ID integer

Required
CLI CLI number string

Required

String length: inclusive between 0 and 17
StartDate Start Date date

None.
EndDate End Date date

None.
ContractStartDate date

None.
ContractEndDate date

None.
CustomColumns Custom columns that can be used to add extra data to the CLI CLICustomColumns

None.

Request Formats

application/json, text/json

Sample: 
{
  "SiteId": 1,
  "CLI": "sample string 2",
  "StartDate": "2025-04-25T13:59:53.164",
  "EndDate": "2025-04-25T13:59:53.164",
  "ContractStartDate": "2025-04-25T13:59:53.164",
  "ContractEndDate": "2025-04-25T13:59:53.164",
  "CustomColumns": {
    "CustomColumn1": "sample string 1",
    "CustomColumn2": "sample string 2",
    "CustomColumn3": "sample string 3",
    "CustomColumn4": "sample string 4",
    "CustomColumn5": "sample string 5",
    "CustomColumn6": "sample string 6",
    "CustomColumn7": "sample string 7",
    "CustomColumn8": "sample string 8",
    "CustomColumn9": "sample string 9",
    "CustomColumn10": "sample string 10"
  }
}

application/xml, text/xml

Sample: 
<CLIPostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.WebAPI.Models.Company">
  <ContractEndDate>2025-04-25T13:59:53.164</ContractEndDate>
  <ContractStartDate>2025-04-25T13:59:53.164</ContractStartDate>
  <CustomColumns>
    <CustomColumn1>sample string 1</CustomColumn1>
    <CustomColumn10>sample string 10</CustomColumn10>
    <CustomColumn2>sample string 2</CustomColumn2>
    <CustomColumn3>sample string 3</CustomColumn3>
    <CustomColumn4>sample string 4</CustomColumn4>
    <CustomColumn5>sample string 5</CustomColumn5>
    <CustomColumn6>sample string 6</CustomColumn6>
    <CustomColumn7>sample string 7</CustomColumn7>
    <CustomColumn8>sample string 8</CustomColumn8>
    <CustomColumn9>sample string 9</CustomColumn9>
  </CustomColumns>
  <EndDate>2025-04-25T13:59:53.164</EndDate>
  <StartDate>2025-04-25T13:59:53.164</StartDate>
  <CLI>sample string 2</CLI>
  <SiteId>1</SiteId>
</CLIPostRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CLIPostResponse
NameDescriptionTypeAdditional information
Id Id of new CLI integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1
}

application/xml, text/xml

Sample: 
<CLIPostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.WebAPI.Models.Company">
  <Id>1</Id>
</CLIPostResponse>