Updates a company

Request Information

Parameters

NameDescriptionAdditional information
companyId The id of the company

Define this parameter in the request URI.

model The company model

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "CompanyName": "sample string 1",
  "VatNumber": "sample string 2",
  "RegistrationNumber": "sample string 3",
  "Email": "sample string 4",
  "Phone": "sample string 5",
  "Fax": "sample string 6",
  "Roles": [
    0,
    0,
    0
  ]
}

application/xml, text/xml

Sample:
<CompanyRest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CompanyName>sample string 1</CompanyName>
  <VatNumber>sample string 2</VatNumber>
  <RegistrationNumber>sample string 3</RegistrationNumber>
  <Email>sample string 4</Email>
  <Phone>sample string 5</Phone>
  <Fax>sample string 6</Fax>
  <Roles>
    <RoleDiscriminator>None</RoleDiscriminator>
    <RoleDiscriminator>None</RoleDiscriminator>
    <RoleDiscriminator>None</RoleDiscriminator>
  </Roles>
</CompanyRest>

Response Information

Returns: The company model

Response body formats

application/json, text/json

Sample:
{
  "Uri": "/companies/1",
  "Id": 1,
  "Enabled": false,
  "CompanyName": "ExampleCompany",
  "VatNumber": "BE0123456789",
  "RegistrationNumber": null,
  "Email": "example@company.com",
  "Phone": "051123456",
  "Fax": "051123456",
  "Roles": [
    8,
    4
  ]
}

application/xml, text/xml

Sample:
<CompanyRestGet xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CompanyName>ExampleCompany</CompanyName>
  <VatNumber>BE0123456789</VatNumber>
  <Email>example@company.com</Email>
  <Phone>051123456</Phone>
  <Fax>051123456</Fax>
  <Roles>
    <RoleDiscriminator>Dispatcher</RoleDiscriminator>
    <RoleDiscriminator>Sender</RoleDiscriminator>
  </Roles>
  <Uri>/companies/1</Uri>
  <Id>1</Id>
  <Enabled>false</Enabled>
</CompanyRestGet>