POST api/Company

Request Information

URI Parameters

None.

Body Parameters

CompanyEntity
NameDescriptionTypeAdditional information
CompanyID

integer

None.

Name

string

None.

Website

string

None.

Logo

string

None.

AddressID

integer

None.

PhoneNumber

string

None.

Exentsion

string

None.

FaxNumber

string

None.

EmailID

string

None.

ModifiedDate

date

None.

ModifiedUserID

integer

None.

CreatedDate

date

None.

CreatedUserID

integer

None.

TimeZoneID

integer

None.

Address

AddressEntity

None.

Branches

Collection of BranchEntity

None.

LookUpValue

LookUpValueEntity

None.

IsFirstTime

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "CompanyID": 1,
  "Name": "sample string 2",
  "Website": "sample string 3",
  "Logo": "sample string 4",
  "AddressID": 1,
  "PhoneNumber": "sample string 5",
  "Exentsion": "sample string 6",
  "FaxNumber": "sample string 7",
  "EmailID": "sample string 8",
  "ModifiedDate": "2025-08-02T14:11:32.4882394-04:00",
  "ModifiedUserID": 1,
  "CreatedDate": "2025-08-02T14:11:32.4882394-04:00",
  "CreatedUserID": 1,
  "TimeZoneID": 1,
  "Address": {
    "AddressID": 1,
    "Address1": "sample string 2",
    "Address2": "sample string 3",
    "ZipCode": "sample string 4",
    "CountryID": 1,
    "StateID": 1,
    "CityID": 1
  },
  "Branches": [
    {
      "BranchID": 1,
      "CompanyID": 2,
      "Name": "sample string 3",
      "AddressID": 1,
      "PhoneNumber": "sample string 4",
      "Exentsion": "sample string 5",
      "FaxNumber": "sample string 6",
      "EmailID": "sample string 7",
      "ModifiedDate": "2025-08-02T14:11:32.4882394-04:00",
      "ModifiedUserID": 1,
      "CreatedDate": "2025-08-02T14:11:32.4882394-04:00",
      "CreatedUserID": 1,
      "IsDeleted": true,
      "TimeZoneID": 1,
      "IsHeadquarter": true,
      "Address": {
        "AddressID": 1,
        "Address1": "sample string 2",
        "Address2": "sample string 3",
        "ZipCode": "sample string 4",
        "CountryID": 1,
        "StateID": 1,
        "CityID": 1
      },
      "Cities": [
        {
          "City_ID": 1,
          "City_Name": "sample string 2",
          "State_ID": 3
        },
        {
          "City_ID": 1,
          "City_Name": "sample string 2",
          "State_ID": 3
        }
      ],
      "LookUpValue": {
        "ID": 1,
        "MasterType_ID": 2,
        "Description": "sample string 3"
      },
      "Address1": "sample string 8",
      "Address2": "sample string 9",
      "ZipCode": "sample string 10",
      "City": "sample string 11",
      "State": "sample string 12",
      "Country": "sample string 13",
      "Timezone": "sample string 14"
    },
    {
      "BranchID": 1,
      "CompanyID": 2,
      "Name": "sample string 3",
      "AddressID": 1,
      "PhoneNumber": "sample string 4",
      "Exentsion": "sample string 5",
      "FaxNumber": "sample string 6",
      "EmailID": "sample string 7",
      "ModifiedDate": "2025-08-02T14:11:32.4882394-04:00",
      "ModifiedUserID": 1,
      "CreatedDate": "2025-08-02T14:11:32.4882394-04:00",
      "CreatedUserID": 1,
      "IsDeleted": true,
      "TimeZoneID": 1,
      "IsHeadquarter": true,
      "Address": {
        "AddressID": 1,
        "Address1": "sample string 2",
        "Address2": "sample string 3",
        "ZipCode": "sample string 4",
        "CountryID": 1,
        "StateID": 1,
        "CityID": 1
      },
      "Cities": [
        {
          "City_ID": 1,
          "City_Name": "sample string 2",
          "State_ID": 3
        },
        {
          "City_ID": 1,
          "City_Name": "sample string 2",
          "State_ID": 3
        }
      ],
      "LookUpValue": {
        "ID": 1,
        "MasterType_ID": 2,
        "Description": "sample string 3"
      },
      "Address1": "sample string 8",
      "Address2": "sample string 9",
      "ZipCode": "sample string 10",
      "City": "sample string 11",
      "State": "sample string 12",
      "Country": "sample string 13",
      "Timezone": "sample string 14"
    }
  ],
  "LookUpValue": {
    "ID": 1,
    "MasterType_ID": 2,
    "Description": "sample string 3"
  },
  "IsFirstTime": true
}

application/xml, text/xml

Sample:
<CompanyEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cyzerg.Model">
  <Address>
    <Address1>sample string 2</Address1>
    <Address2>sample string 3</Address2>
    <AddressID>1</AddressID>
    <CityID>1</CityID>
    <CountryID>1</CountryID>
    <StateID>1</StateID>
    <ZipCode>sample string 4</ZipCode>
  </Address>
  <AddressID>1</AddressID>
  <Branches>
    <BranchEntity>
      <Address>
        <Address1>sample string 2</Address1>
        <Address2>sample string 3</Address2>
        <AddressID>1</AddressID>
        <CityID>1</CityID>
        <CountryID>1</CountryID>
        <StateID>1</StateID>
        <ZipCode>sample string 4</ZipCode>
      </Address>
      <Address1>sample string 8</Address1>
      <Address2>sample string 9</Address2>
      <AddressID>1</AddressID>
      <BranchID>1</BranchID>
      <Cities>
        <CityEntity>
          <City_ID>1</City_ID>
          <City_Name>sample string 2</City_Name>
          <State_ID>3</State_ID>
        </CityEntity>
        <CityEntity>
          <City_ID>1</City_ID>
          <City_Name>sample string 2</City_Name>
          <State_ID>3</State_ID>
        </CityEntity>
      </Cities>
      <City>sample string 11</City>
      <CompanyID>2</CompanyID>
      <Country>sample string 13</Country>
      <CreatedDate>2025-08-02T14:11:32.4882394-04:00</CreatedDate>
      <CreatedUserID>1</CreatedUserID>
      <EmailID>sample string 7</EmailID>
      <Exentsion>sample string 5</Exentsion>
      <FaxNumber>sample string 6</FaxNumber>
      <IsDeleted>true</IsDeleted>
      <IsHeadquarter>true</IsHeadquarter>
      <LookUpValue>
        <Description>sample string 3</Description>
        <ID>1</ID>
        <MasterType_ID>2</MasterType_ID>
      </LookUpValue>
      <ModifiedDate>2025-08-02T14:11:32.4882394-04:00</ModifiedDate>
      <ModifiedUserID>1</ModifiedUserID>
      <Name>sample string 3</Name>
      <PhoneNumber>sample string 4</PhoneNumber>
      <State>sample string 12</State>
      <TimeZoneID>1</TimeZoneID>
      <Timezone>sample string 14</Timezone>
      <ZipCode>sample string 10</ZipCode>
    </BranchEntity>
    <BranchEntity>
      <Address>
        <Address1>sample string 2</Address1>
        <Address2>sample string 3</Address2>
        <AddressID>1</AddressID>
        <CityID>1</CityID>
        <CountryID>1</CountryID>
        <StateID>1</StateID>
        <ZipCode>sample string 4</ZipCode>
      </Address>
      <Address1>sample string 8</Address1>
      <Address2>sample string 9</Address2>
      <AddressID>1</AddressID>
      <BranchID>1</BranchID>
      <Cities>
        <CityEntity>
          <City_ID>1</City_ID>
          <City_Name>sample string 2</City_Name>
          <State_ID>3</State_ID>
        </CityEntity>
        <CityEntity>
          <City_ID>1</City_ID>
          <City_Name>sample string 2</City_Name>
          <State_ID>3</State_ID>
        </CityEntity>
      </Cities>
      <City>sample string 11</City>
      <CompanyID>2</CompanyID>
      <Country>sample string 13</Country>
      <CreatedDate>2025-08-02T14:11:32.4882394-04:00</CreatedDate>
      <CreatedUserID>1</CreatedUserID>
      <EmailID>sample string 7</EmailID>
      <Exentsion>sample string 5</Exentsion>
      <FaxNumber>sample string 6</FaxNumber>
      <IsDeleted>true</IsDeleted>
      <IsHeadquarter>true</IsHeadquarter>
      <LookUpValue>
        <Description>sample string 3</Description>
        <ID>1</ID>
        <MasterType_ID>2</MasterType_ID>
      </LookUpValue>
      <ModifiedDate>2025-08-02T14:11:32.4882394-04:00</ModifiedDate>
      <ModifiedUserID>1</ModifiedUserID>
      <Name>sample string 3</Name>
      <PhoneNumber>sample string 4</PhoneNumber>
      <State>sample string 12</State>
      <TimeZoneID>1</TimeZoneID>
      <Timezone>sample string 14</Timezone>
      <ZipCode>sample string 10</ZipCode>
    </BranchEntity>
  </Branches>
  <CompanyID>1</CompanyID>
  <CreatedDate>2025-08-02T14:11:32.4882394-04:00</CreatedDate>
  <CreatedUserID>1</CreatedUserID>
  <EmailID>sample string 8</EmailID>
  <Exentsion>sample string 6</Exentsion>
  <FaxNumber>sample string 7</FaxNumber>
  <IsFirstTime>true</IsFirstTime>
  <Logo>sample string 4</Logo>
  <LookUpValue>
    <Description>sample string 3</Description>
    <ID>1</ID>
    <MasterType_ID>2</MasterType_ID>
  </LookUpValue>
  <ModifiedDate>2025-08-02T14:11:32.4882394-04:00</ModifiedDate>
  <ModifiedUserID>1</ModifiedUserID>
  <Name>sample string 2</Name>
  <PhoneNumber>sample string 5</PhoneNumber>
  <TimeZoneID>1</TimeZoneID>
  <Website>sample string 3</Website>
</CompanyEntity>

application/x-www-form-urlencoded

Sample:

Sample not available.

text/html

Sample:
{"CompanyID":1,"Name":"sample string 2","Website":"sample string 3","Logo":"sample string 4","AddressID":1,"PhoneNumber":"sample string 5","Exentsion":"sample string 6","FaxNumber":"sample string 7","EmailID":"sample string 8","ModifiedDate":"2025-08-02T14:11:32.4882394-04:00","ModifiedUserID":1,"CreatedDate":"2025-08-02T14:11:32.4882394-04:00","CreatedUserID":1,"TimeZoneID":1,"Address":{"AddressID":1,"Address1":"sample string 2","Address2":"sample string 3","ZipCode":"sample string 4","CountryID":1,"StateID":1,"CityID":1},"Branches":[{"BranchID":1,"CompanyID":2,"Name":"sample string 3","AddressID":1,"PhoneNumber":"sample string 4","Exentsion":"sample string 5","FaxNumber":"sample string 6","EmailID":"sample string 7","ModifiedDate":"2025-08-02T14:11:32.4882394-04:00","ModifiedUserID":1,"CreatedDate":"2025-08-02T14:11:32.4882394-04:00","CreatedUserID":1,"IsDeleted":true,"TimeZoneID":1,"IsHeadquarter":true,"Address":{"AddressID":1,"Address1":"sample string 2","Address2":"sample string 3","ZipCode":"sample string 4","CountryID":1,"StateID":1,"CityID":1},"Cities":[{"City_ID":1,"City_Name":"sample string 2","State_ID":3},{"City_ID":1,"City_Name":"sample string 2","State_ID":3}],"LookUpValue":{"ID":1,"MasterType_ID":2,"Description":"sample string 3"},"Address1":"sample string 8","Address2":"sample string 9","ZipCode":"sample string 10","City":"sample string 11","State":"sample string 12","Country":"sample string 13","Timezone":"sample string 14"},{"BranchID":1,"CompanyID":2,"Name":"sample string 3","AddressID":1,"PhoneNumber":"sample string 4","Exentsion":"sample string 5","FaxNumber":"sample string 6","EmailID":"sample string 7","ModifiedDate":"2025-08-02T14:11:32.4882394-04:00","ModifiedUserID":1,"CreatedDate":"2025-08-02T14:11:32.4882394-04:00","CreatedUserID":1,"IsDeleted":true,"TimeZoneID":1,"IsHeadquarter":true,"Address":{"AddressID":1,"Address1":"sample string 2","Address2":"sample string 3","ZipCode":"sample string 4","CountryID":1,"StateID":1,"CityID":1},"Cities":[{"City_ID":1,"City_Name":"sample string 2","State_ID":3},{"City_ID":1,"City_Name":"sample string 2","State_ID":3}],"LookUpValue":{"ID":1,"MasterType_ID":2,"Description":"sample string 3"},"Address1":"sample string 8","Address2":"sample string 9","ZipCode":"sample string 10","City":"sample string 11","State":"sample string 12","Country":"sample string 13","Timezone":"sample string 14"}],"LookUpValue":{"ID":1,"MasterType_ID":2,"Description":"sample string 3"},"IsFirstTime":true}

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml, text/html

Sample:

Sample not available.