...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
NOTE : This
...
web method is currently only
...
available in the staging environment and will be released to the production environment soon.
Description
This method is used to search for companies which are members of the a franchise of by using the input organisation number as an input. Only active companies will be are returned from by this web APImethod.
Request
Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
|---|---|---|---|---|
input | GetFranchiseMembersInput | Mandatory | Not relevant | Model containing the GetFranchiseMembers Inputinput |
| applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
...
| Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
|---|---|---|---|---|
| OrganizationNumber | int | Mandatory | Not relevant | Number which contains 9 digits E.g. 910747711. |
Request - sample input
<GetFranchiseMembers>
<MethodParameters>
<UserAuthentication>
<UserName><username></UserName>
<Password><password></Password>
<AnyAttr attr0="XmlAttributeArray" isNull="false">
<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
</AnyAttr>
</UserAuthentication>
<Input>
<OrganizationNumber>945873973</OrganizationNumber>
</Input>
<applicationName>applocationName</applicationName>
</MethodParameters>
</GetFranchiseMembers>
Response
| Property | Description |
|---|---|
| GetFranchiseMembersOutput | The GetFranchiseMembers Outputoutput |
GetFranchiseMembersOutput
| Property | Type | Description |
|---|---|---|
| FranchiseMembers | List<Company> | List of franchised Companiesfranchise companies |
Response - sample output
<GetFranchiseMembers>
<MethodParameters>
<GetFranchiseMembersOutput>
<MemberCompanyList attr0="CompanyArray" isNull="false">
<CompanyArray0>
<Id>12345</Id>
<OrganizationNumber>914350840</OrganizationNumber>
<CompanyName>VEGA 1 AS</CompanyName>
<Address>
<StreetName>,</StreetName>
<HouseNumber>0</HouseNumber>
<HouseLetter isNull="false" />
<ZipCode>0000</ZipCode>
<City isNull="false" />
</Address>
<Municipality isNull="true" />
<Longitude>10.8257204</Longitude>
<Latitude>59.9144125</Latitude>
<ContactPerson>Sudaraka</ContactPerson>
<PhoneNumber>34567</PhoneNumber>
<Email>test@com.lk</Email>
<UseBoligmappa>True</UseBoligmappa>
<Professions isNull="true" />
<MemberAsssociations isNull="true" />
<ContactPersonDetails>
<ContactPersonName>Sudaraka</ContactPersonName>
<ContactPersonPhone>12341231</ContactPersonPhone>
<ContactPersonEmail>test@com.lk</ContactPersonEmail>
<ContactPersonRole>Admin</ContactPersonRole>
<ContactPersonImage>http://localhost:8080/Admin/GetCompanyCompanyContactPersonImage?storageId=914350840_contactperson_image.png</ContactPersonImage>
</ContactPersonDetails>
<CompanyDescription>There is a methodology </CompanyDescription>
<CompanyWebSite>companyweb.com</CompanyWebSite>
<CompanyLogo>http://localhost:8080/Admin/GetCompanyLogo?storageId=914350840_companylogo_16804186_10210664358436669_2877335564214169843_o.jpg</CompanyLogo>
<CompanyProfileImage>http://localhost:8080/Admin/GetCompanyProfileImage?storageId=914350840_companyprofile_image.png</CompanyProfileImage>
<FacebookAddress>facebook.com</FacebookAddress>
<ButtonTextForHelpLink>Test</ButtonTextForHelpLink>
<HelpLink>https://boligmappa.atlassian.net/browse/FP-1088</HelpLink>
<FranchiserCompanies attr0="FranchiserCompanyOutputArray" isNull="false" />
<EmployeeCount>25</EmployeeCount>
<LastFinancialStatementSubmissionYear>2015</LastFinancialStatementSubmissionYear>
<IsVatRegistered>True</IsVatRegistered>
<IsNavaaRegistered>True</IsNavaaRegistered>
<ShareCapital>30000.00</ShareCapital>
<Equity>137</Equity>
<CreditRating>C1</CreditRating>
<StartBankStatus>test 234@</StartBankStatus>
<Revenue>0</Revenue>
<Earning>0</Earning>
<IsNHOAuthorized>False</IsNHOAuthorized>
<CompanyStatistics>
<PlantCount>24</PlantCount>
<DocumentCount>43</DocumentCount>
</CompanyStatistics>
<Certifications attr0="CompanyCertificateArray" isNull="false">
<CompanyCertificateArray0>
<LogoImage>http://localhost:8080/Admin/GetCompanyCertificateImage?storageId=1.png</LogoImage>
<Name>Nelfo jobber for å bedre konkurransekraften til våre medlems</Name>
</CompanyCertificateArray0>
<CompanyCertificateArray1>
<LogoImage>http://localhost:8080/Admin/GetCompanyCertificateImage?storageId=3.png</LogoImage>
<Name>Nelfo jobber for å bedre konkurransekraften til våre medlems</Name>
</CompanyCertificateArray1>
<CompanyCertificateArray2>
<LogoImage>http://localhost:8080/Admin/GetCompanyCertificateImage?storageId=4.png</LogoImage>
<Name>Nelfo jobber for å bedre konkurransekraften til våre medlems</Name>
</CompanyCertificateArray2>
</Certifications>
<FeatureGallery attr0="CompanyFeatureArray" isNull="false">
<CompanyFeatureArray0>
<FeatureName>Abeywardena</FeatureName>
<Url>Abeywardena</Url>
<Image>http://localhost:8080/Admin/GetCompanyFeatureImage?storageId=914350840_featuregallery_0_image.png</Image>
</CompanyFeatureArray0>
<CompanyFeatureArray1>
<FeatureName>Abeywardena1</FeatureName>
<Url>Abeywardena1</Url>
<Image>http://localhost:8080/Admin/GetCompanyFeatureImage?storageId=914350840_featuregallery_1_image.png</Image>
</CompanyFeatureArray1>
</FeatureGallery>
</CompanyArray0>
</MemberCompanyList>
</GetFranchiseMembersOutput>
</MethodParameters>
</GetFranchiseMembers>
Exceptions
| Error Code | Description |
|---|---|
| 123 | An exception occurred while processing your request |
| 138 | applicationName length has exceeded the maximum character limit allowed (10) |
| 146 | The applicationName is not set |
| 167 | You are not authorized to use this method |
| 248 | Please provide organization the organisation number |
| 249 | You are not authorized to perform this action (This exception occurs when the input organisation number that was input, is different from the organisation number of the user company's organisation numbercompany) |