POST request/user/{id}/subBroker/company

Add/Update a new Sub Broker Company

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

SubBrokerCompanyPost
NameDescriptionTypeAdditional information
BrokerCode

string

None.

CompanyName

string

None.

CompanyRegistrationNumber

string

None.

CompanyType

integer

None.

RegisteredAddress

AddressInfo

None.

Request Formats

application/json, text/json

Sample:
{
  "companyName": "sample string 1",
  "registeredAddress": {
    "line1": "sample string 1",
    "line2": "sample string 2",
    "city": "sample string 3",
    "county": "sample string 4",
    "postcode": "sample string 5"
  },
  "companyType": 1,
  "companyRegistrationNumber": "sample string 2",
  "brokerCode": "sample string 3"
}

text/html

Sample:
{"companyName":"sample string 1","registeredAddress":{"line1":"sample string 1","line2":"sample string 2","city":"sample string 3","county":"sample string 4","postcode":"sample string 5"},"companyType":1,"companyRegistrationNumber":"sample string 2","brokerCode":"sample string 3"}

application/xml, text/xml

Sample:
<SubBrokerCompanyPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.UsersDto">
  <BrokerCode>sample string 3</BrokerCode>
  <CompanyName>sample string 1</CompanyName>
  <CompanyRegistrationNumber>sample string 2</CompanyRegistrationNumber>
  <CompanyType>1</CompanyType>
  <RegisteredAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default">
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:County>sample string 4</d2p1:County>
    <d2p1:Line1>sample string 1</d2p1:Line1>
    <d2p1:Line2>sample string 2</d2p1:Line2>
    <d2p1:Postcode>sample string 5</d2p1:Postcode>
  </RegisteredAddress>
</SubBrokerCompanyPost>

Response Information

Resource Description

UserPostResponse
NameDescriptionTypeAdditional information
Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1
}

text/html

Sample:
{"id":1}

application/xml, text/xml

Sample:
<UserPostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.UsersDto">
  <Id>1</Id>
</UserPostResponse>