PUT business-partners/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required

Body Parameters

BusinessPartner

Name	Type	Additional information
companyAmforiId	string	Required Matching regular expression pattern: ^[0-9]{3}-[0-9]{6}-000$ String length: inclusive between 0 and 14
legalName	string	Required String length: inclusive between 0 and 150
localName	string	String length: inclusive between 0 and 150
address	Address	Required
contactDetails	ContactDetails	None.
gicsMainActivityClassification	GicsActivityClassification	Required
externalCompanyReferences	Collection of string	None.
customLabels	Collection of string	None.
AdditionalProperties	Dictionary of string [key] and Object [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "companyAmforiId": "sample string 1",
  "legalName": "sample string 2",
  "localName": "sample string 3",
  "address": {
    "street": "sample string 1",
    "zip": "sample string 2",
    "city": "sample string 3",
    "stateProvince": {
      "code": "sample string 1",
      "name": "sample string 2",
      "sample string 1": {},
      "sample string 3": {}
    },
    "country": "sample string 4",
    "sample string 1": {},
    "sample string 3": {}
  },
  "contactDetails": {
    "emailAddress": "sample string 1",
    "phoneNumber": "sample string 2",
    "faxNumber": "sample string 3",
    "website": "sample string 4",
    "sample string 1": {},
    "sample string 3": {}
  },
  "gicsMainActivityClassification": {
    "description": "sample string 1",
    "sector": {
      "code": 1,
      "name": "sample string 2",
      "sample string 1": {},
      "sample string 3": {}
    },
    "industryGroup": {
      "code": 1,
      "name": "sample string 2",
      "sample string 1": {},
      "sample string 3": {}
    },
    "industry": {
      "code": 1,
      "name": "sample string 2",
      "sample string 1": {},
      "sample string 3": {}
    },
    "subIndustry": {
      "code": 1,
      "name": "sample string 2",
      "sample string 1": {},
      "sample string 3": {}
    },
    "sample string 1": {},
    "sample string 3": {}
  },
  "externalCompanyReferences": [
    "sample string 1",
    "sample string 2"
  ],
  "customLabels": [
    "sample string 1",
    "sample string 2"
  ],
  "sample string 1": {},
  "sample string 3": {}
}

application/xml, text/xml

Sample:

<BusinessPartner xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MetroAG.SSM.Amfori.Client">
  <AdditionalProperties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </AdditionalProperties>
  <Address>
    <AdditionalProperties xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </AdditionalProperties>
    <City>sample string 3</City>
    <Country>sample string 4</Country>
    <StateProvince>
      <AdditionalProperties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </AdditionalProperties>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </StateProvince>
    <Street>sample string 1</Street>
    <Zip>sample string 2</Zip>
  </Address>
  <CompanyAmforiId>sample string 1</CompanyAmforiId>
  <ContactDetails>
    <AdditionalProperties xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </AdditionalProperties>
    <EmailAddress>sample string 1</EmailAddress>
    <FaxNumber>sample string 3</FaxNumber>
    <PhoneNumber>sample string 2</PhoneNumber>
    <Website>sample string 4</Website>
  </ContactDetails>
  <CustomLabels xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CustomLabels>
  <ExternalCompanyReferences xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExternalCompanyReferences>
  <GicsMainActivityClassification>
    <AdditionalProperties xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </AdditionalProperties>
    <Description>sample string 1</Description>
    <Industry>
      <AdditionalProperties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </AdditionalProperties>
      <Code>1</Code>
      <Name>sample string 2</Name>
    </Industry>
    <IndustryGroup>
      <AdditionalProperties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </AdditionalProperties>
      <Code>1</Code>
      <Name>sample string 2</Name>
    </IndustryGroup>
    <Sector>
      <AdditionalProperties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </AdditionalProperties>
      <Code>1</Code>
      <Name>sample string 2</Name>
    </Sector>
    <SubIndustry>
      <AdditionalProperties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </AdditionalProperties>
      <Code>1</Code>
      <Name>sample string 2</Name>
    </SubIndustry>
  </GicsMainActivityClassification>
  <LegalName>sample string 2</LegalName>
  <LocalName>sample string 3</LocalName>
</BusinessPartner>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.