POST api/Depot/AddBusinessHub

Request Information

URI Parameters

None.

Body Parameters

AddBusinessHubPrm
NameDescriptionTypeAdditional information
depotId

integer

None.

businessId

integer

None.

loginUserId

integer

None.

businessName

string

None.

stateId

integer

None.

countryId

integer

None.

lgaId

integer

None.

areaId

integer

None.

location

string

None.

latitude

string

None.

longitude

string

None.

agentName

string

None.

phone

string

None.

email

string

None.

password

string

None.

fulfilementCenter

integer

None.

depotFCMapping

integer

None.

reportingToMainBusinessid

integer

None.

locationIds

string

None.

lgaIds

string

None.

lcdaIds

string

None.

locationNames

string

None.

streetName

string

None.

shopNo

string

None.

flag

integer

None.

depotFcMappingName

string

None.

stakeholdersEmail

string

None.

companyName

string

None.

bankName

string

None.

bankCode

string

None.

accountName

string

None.

accountNumber

string

None.

taxIDNumber

string

None.

distributorPhone

string

None.

isMfc

boolean

None.

notifyStakeholdersOnPriceChange

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "depotId": 1,
  "businessId": 2,
  "loginUserId": 3,
  "businessName": "sample string 4",
  "stateId": 5,
  "countryId": 6,
  "lgaId": 7,
  "areaId": 8,
  "location": "sample string 9",
  "latitude": "sample string 10",
  "longitude": "sample string 11",
  "agentName": "sample string 12",
  "phone": "sample string 13",
  "email": "sample string 14",
  "password": "sample string 15",
  "fulfilementCenter": 16,
  "depotFCMapping": 17,
  "reportingToMainBusinessid": 18,
  "locationIds": "sample string 19",
  "lgaIds": "sample string 20",
  "lcdaIds": "sample string 21",
  "locationNames": "sample string 22",
  "streetName": "sample string 23",
  "shopNo": "sample string 24",
  "flag": 25,
  "depotFcMappingName": "sample string 26",
  "stakeholdersEmail": "sample string 27",
  "companyName": "sample string 28",
  "bankName": "sample string 29",
  "bankCode": "sample string 30",
  "accountName": "sample string 31",
  "accountNumber": "sample string 32",
  "taxIDNumber": "sample string 33",
  "distributorPhone": "sample string 34",
  "isMfc": true,
  "notifyStakeholdersOnPriceChange": true
}

application/xml, text/xml

Sample:
<AddBusinessHubPrm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <accountName>sample string 31</accountName>
  <accountNumber>sample string 32</accountNumber>
  <agentName>sample string 12</agentName>
  <areaId>8</areaId>
  <bankCode>sample string 30</bankCode>
  <bankName>sample string 29</bankName>
  <businessId>2</businessId>
  <businessName>sample string 4</businessName>
  <companyName>sample string 28</companyName>
  <countryId>6</countryId>
  <depotFCMapping>17</depotFCMapping>
  <depotFcMappingName>sample string 26</depotFcMappingName>
  <depotId>1</depotId>
  <distributorPhone>sample string 34</distributorPhone>
  <email>sample string 14</email>
  <flag>25</flag>
  <fulfilementCenter>16</fulfilementCenter>
  <isMfc>true</isMfc>
  <latitude>sample string 10</latitude>
  <lcdaIds>sample string 21</lcdaIds>
  <lgaId>7</lgaId>
  <lgaIds>sample string 20</lgaIds>
  <location>sample string 9</location>
  <locationIds>sample string 19</locationIds>
  <locationNames>sample string 22</locationNames>
  <loginUserId>3</loginUserId>
  <longitude>sample string 11</longitude>
  <notifyStakeholdersOnPriceChange>true</notifyStakeholdersOnPriceChange>
  <password>sample string 15</password>
  <phone>sample string 13</phone>
  <reportingToMainBusinessid>18</reportingToMainBusinessid>
  <shopNo>sample string 24</shopNo>
  <stakeholdersEmail>sample string 27</stakeholdersEmail>
  <stateId>5</stateId>
  <streetName>sample string 23</streetName>
  <taxIDNumber>sample string 33</taxIDNumber>
</AddBusinessHubPrm>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AddBusinessHubPrm'.

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": "2024/09/19 18:32:28",
  "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>