POST request/Company/Query/Registration-Number/v2

Returns info about companies with a company registration number.

Request Information

URI Parameters

None.

Body Parameters

CompanyRegistrationNumberQueryBindingModel
NameDescriptionTypeAdditional information
RegistrationNumber

string

Required

Max length: 40
Skip

integer

None.
Take

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "registrationNumber": "sample string 1",
  "skip": 1,
  "take": 1
}

text/html

Sample: 
{"registrationNumber":"sample string 1","skip":1,"take":1}

application/xml, text/xml

Sample: 
<CompanyRegistrationNumberQueryBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Domain.Default.CreditSafe">
  <Skip>1</Skip>
  <Take>1</Take>
  <RegistrationNumber>sample string 1</RegistrationNumber>
</CompanyRegistrationNumberQueryBindingModel>

Response Information

Resource Description

CompanyQueryDtoResponse
NameDescriptionTypeAdditional information
ApiVersion

string

None.
CompanyQueryDto

CompanyQueryDto

None.
Uri

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "apiVersion": "sample string 1",
  "uri": "sample string 2",
  "companyQueryDto": {
    "companyQueryEssentialDtos": [
      {
        "id": "sample string 1",
        "name": "sample string 2",
        "status": "sample string 3",
        "registrationNumber": "sample string 4",
        "vatNumber": "sample string 5",
        "postcode": "sample string 6",
        "creditRatingInfoEssentialDto": {
          "currentCommonValue": "sample string 1",
          "currentCommonDescription": "sample string 2",
          "currentProviderValue": "sample string 3",
          "currentProviderDescription": "sample string 4",
          "currentCreditLimit": "sample string 5",
          "currentCreditLimitCurrency": "sample string 6"
        },
        "addressParts": {
          "siteName": "sample string 1"
        },
        "addressText": "sample string 7"
      },
      {
        "id": "sample string 1",
        "name": "sample string 2",
        "status": "sample string 3",
        "registrationNumber": "sample string 4",
        "vatNumber": "sample string 5",
        "postcode": "sample string 6",
        "creditRatingInfoEssentialDto": {
          "currentCommonValue": "sample string 1",
          "currentCommonDescription": "sample string 2",
          "currentProviderValue": "sample string 3",
          "currentProviderDescription": "sample string 4",
          "currentCreditLimit": "sample string 5",
          "currentCreditLimitCurrency": "sample string 6"
        },
        "addressParts": {
          "siteName": "sample string 1"
        },
        "addressText": "sample string 7"
      }
    ]
  }
}

text/html

Sample: 
{"apiVersion":"sample string 1","uri":"sample string 2","companyQueryDto":{"companyQueryEssentialDtos":[{"id":"sample string 1","name":"sample string 2","status":"sample string 3","registrationNumber":"sample string 4","vatNumber":"sample string 5","postcode":"sample string 6","creditRatingInfoEssentialDto":{"currentCommonValue":"sample string 1","currentCommonDescription":"sample string 2","currentProviderValue":"sample string 3","currentProviderDescription":"sample string 4","currentCreditLimit":"sample string 5","currentCreditLimitCurrency":"sample string 6"},"addressParts":{"siteName":"sample string 1"},"addressText":"sample string 7"},{"id":"sample string 1","name":"sample string 2","status":"sample string 3","registrationNumber":"sample string 4","vatNumber":"sample string 5","postcode":"sample string 6","creditRatingInfoEssentialDto":{"currentCommonValue":"sample string 1","currentCommonDescription":"sample string 2","currentProviderValue":"sample string 3","currentProviderDescription":"sample string 4","currentCreditLimit":"sample string 5","currentCreditLimitCurrency":"sample string 6"},"addressParts":{"siteName":"sample string 1"},"addressText":"sample string 7"}]}}

application/xml, text/xml

Sample: 
<CompanyQueryDtoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.DtoResponse">
  <ApiVersion>sample string 1</ApiVersion>
  <CompanyQueryDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Dto">
    <d2p1:CompanyQueryEssentialDtos>
      <d2p1:CompanyQueryEssentialDto>
        <d2p1:AddressParts xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfAddressEntityPartstring6sETvV8_S>
            <d5p1:Key>SiteName</d5p1:Key>
            <d5p1:Value>sample string 1</d5p1:Value>
          </d5p1:KeyValueOfAddressEntityPartstring6sETvV8_S>
        </d2p1:AddressParts>
        <d2p1:AddressText>sample string 7</d2p1:AddressText>
        <d2p1:CreditRatingInfoEssentialDto>
          <d2p1:CurrentCommonDescription>sample string 2</d2p1:CurrentCommonDescription>
          <d2p1:CurrentCommonValue>sample string 1</d2p1:CurrentCommonValue>
          <d2p1:CurrentCreditLimit>sample string 5</d2p1:CurrentCreditLimit>
          <d2p1:CurrentCreditLimitCurrency>sample string 6</d2p1:CurrentCreditLimitCurrency>
          <d2p1:CurrentProviderDescription>sample string 4</d2p1:CurrentProviderDescription>
          <d2p1:CurrentProviderValue>sample string 3</d2p1:CurrentProviderValue>
        </d2p1:CreditRatingInfoEssentialDto>
        <d2p1:Id>sample string 1</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
        <d2p1:Postcode>sample string 6</d2p1:Postcode>
        <d2p1:RegistrationNumber>sample string 4</d2p1:RegistrationNumber>
        <d2p1:Status>sample string 3</d2p1:Status>
        <d2p1:VatNumber>sample string 5</d2p1:VatNumber>
      </d2p1:CompanyQueryEssentialDto>
      <d2p1:CompanyQueryEssentialDto>
        <d2p1:AddressParts xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfAddressEntityPartstring6sETvV8_S>
            <d5p1:Key>SiteName</d5p1:Key>
            <d5p1:Value>sample string 1</d5p1:Value>
          </d5p1:KeyValueOfAddressEntityPartstring6sETvV8_S>
        </d2p1:AddressParts>
        <d2p1:AddressText>sample string 7</d2p1:AddressText>
        <d2p1:CreditRatingInfoEssentialDto>
          <d2p1:CurrentCommonDescription>sample string 2</d2p1:CurrentCommonDescription>
          <d2p1:CurrentCommonValue>sample string 1</d2p1:CurrentCommonValue>
          <d2p1:CurrentCreditLimit>sample string 5</d2p1:CurrentCreditLimit>
          <d2p1:CurrentCreditLimitCurrency>sample string 6</d2p1:CurrentCreditLimitCurrency>
          <d2p1:CurrentProviderDescription>sample string 4</d2p1:CurrentProviderDescription>
          <d2p1:CurrentProviderValue>sample string 3</d2p1:CurrentProviderValue>
        </d2p1:CreditRatingInfoEssentialDto>
        <d2p1:Id>sample string 1</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
        <d2p1:Postcode>sample string 6</d2p1:Postcode>
        <d2p1:RegistrationNumber>sample string 4</d2p1:RegistrationNumber>
        <d2p1:Status>sample string 3</d2p1:Status>
        <d2p1:VatNumber>sample string 5</d2p1:VatNumber>
      </d2p1:CompanyQueryEssentialDto>
    </d2p1:CompanyQueryEssentialDtos>
  </CompanyQueryDto>
  <Uri>sample string 2</Uri>
</CompanyQueryDtoResponse>