POST api/BOProfile/SaveKeywords

Request Information

URI Parameters

None.

Body Parameters

AddKeyword
NameDescriptionTypeAdditional information
BusinessId

integer

None.

CreatedBy

integer

None.

KeyWordsList

Collection of SaveKeywords

None.

CategoriesList

Collection of Categories

None.

Request Formats

application/json, text/json

Sample:
{
  "BusinessId": 1,
  "CreatedBy": 2,
  "KeyWordsList": [
    {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 2"
    }
  ],
  "CategoriesList": [
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "CatType": 3
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "CatType": 3
    }
  ]
}

application/xml, text/xml

Sample:
<AddKeyword xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <BusinessId>1</BusinessId>
  <CategoriesList>
    <Categories>
      <CatType>3</CatType>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </Categories>
    <Categories>
      <CatType>3</CatType>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </Categories>
  </CategoriesList>
  <CreatedBy>2</CreatedBy>
  <KeyWordsList>
    <SaveKeywords>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </SaveKeywords>
    <SaveKeywords>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </SaveKeywords>
  </KeyWordsList>
</AddKeyword>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse
NameDescriptionTypeAdditional information
Version

string

None.

dateTime

string

None.

StatusCode

integer

None.

ErrorMessage

string

None.

Result

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "Version": "1.0.0",
  "dateTime": "2020/09/26 12:07:00",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:
<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>