Description
This web method allows a Franchiser franchise company to send a list of member company Organization Numbers OrganizationNumbers and Franchiser the franchiser company logo. This web method can only be accessed by users with Special special Franchiser Rolerole access. It is required to send all the member company's Organization Numbers companies OrganizationNumbers when updating the member company list. Previous member companies would be are removed from membership if their organisation Numbers numbers are not provided. If the company logo is not provided, the existing value in Database the database for the company logo will be replaced with by an empty value.
If an error occurred occurs while updating a member company, the relevant error code will be is given in the output along with the relevant Organization number. Then that member company won't be updated in DatabaseOrganizationNumber and the database is not be updated. If no error occurred while updating a member company then error errors occur during the update, the error code for that organization number OrganizationNumber will be 0.
Note :
Make sure to provide full list of members every time an update is done as it will remove the member companies which are not provided. For eg. if you already have 100 member companies and wants to add 5 new member companies you have to provide the list with all 105 members. If you provide only the 5 new members, you will have only 5 member companies ultimately. So, this same web method can be used to add or remove members by providing the current member company list.
Request
| Parameter | Type | Mandatory/OptionalComments | Maximum character length/limit | Description |
|---|---|---|---|---|
| input | SetMemberStatusInput | Mandatory | Not relevant | Set member status input model |
| applicationName | string | Mandatory | Third party application identifier, identifying the client consuming the web service – (Length of the ApplicationName should Should be less than or equal to 10 ) |
...
| characters | The name of the integration partner. |
Response
| Type | Description |
|---|---|
| SetMemberStatusOutput | Set Member Status Output Model |
...
| model |
Exceptions
| Error Code | Description |
|---|---|
| 113 | One or more mandatory fields have not been provided |
| 123 | An exception occurred while processing your request |
| 138 | ApplicationName applicationName length is has exceeded the maximum allowed character limit allowed (10) |
| 146 | The application name applicationName is not set |
| 167 | You are not authorized to use this web method |
| 258 | Unable to find a company registered for to the given organization numberOrganizationNumber |
| 374 | The given URL Url is not a valid image file type |
| 375 | The Given Image given image is more than 2MB in size |
| 376 | The Given given Base64 String is not a valid Imagestring is invalid |
| 388 | The Given given image input is not valid |