Fetch signing combinations from company
GET {{baseUrl}}/search?requestKey=<string>&pageSize=<integer>&from=<integer>&companyName=<string>&town=<string>&county=<string>&zipCode=<string>&industryCode=<string>&legalGroupCode=<string>&vatReg=<integer>&statusCode=<integer>&companyRegistrationDate=<string>
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
requestKey | string | Used when paging in a previous searched result | |
pageSize | string | Number of results to return per pagination page | |
from | string | first result to return from the resultset that is being paged through | |
companyName | string | Company name string to search for | |
town | string | Town the searched for company should be registered in | |
county | string | County the searched for company should be registered in | |
zipCode | string | Zip code the searched for company should be registered in | |
industryCode | string | The primary industry code the company to search for belongs to | |
legalGroupCode | string | The legal group code for the type of company to search for | |
vatReg | string | Wheather the company searched for should be registered for VAT or not (0 or 1) | |
statusCode | string | Status code that the searched for company should be referenced as | |
companyRegistrationDate | string | The date the company searched for should have been registered, range input with : between is accepted |
RESPONSES
status: OK
{"hitCount":"\u003cinteger\u003e","hits":[{"companyName":"\u003cstring\u003e","legalGroupCode":"\u003cstring\u003e","legalGroupText":"\u003cstring\u003e","links":[{"method":"\u003cstring\u003e","type":"\u003cstring\u003e","url":"\u003cstring\u003e"},{"method":"\u003cstring\u003e","type":"\u003cstring\u003e","url":"\u003cstring\u003e"}],"registeredTown":"\u003cstring\u003e"},{"companyName":"\u003cstring\u003e","legalGroupCode":"\u003cstring\u003e","legalGroupText":"\u003cstring\u003e","links":[{"method":"\u003cstring\u003e","type":"\u003cstring\u003e","url":"\u003cstring\u003e"},{"method":"\u003cstring\u003e","type":"\u003cstring\u003e","url":"\u003cstring\u003e"}],"registeredTown":"\u003cstring\u003e"}],"metrics":{"industryCode":"\u003cobject\u003e","legalGroupCode":"\u003cobject\u003e","registeredTown":"\u003cobject\u003e","registeredZipCode":"\u003cobject\u003e","statusCode":"\u003cobject\u003e"},"next":"\u003cstring\u003e","previous":"\u003cstring\u003e","requests":[{"method":"\u003cstring\u003e","payload":{"requestKey":"\u003cstring\u003e"},"type":"\u003cstring\u003e","url":"\u003cstring\u003e"},{"method":"\u003cstring\u003e","payload":{"requestKey":"\u003cstring\u003e"},"type":"\u003cstring\u003e","url":"\u003cstring\u003e"}]}