SetMemberStatus
Description
This method allows a franchise company to send a list of member company OrganizationNumbers and the franchiser company logo. This method can only be accessed by users with special Franchiser role access. It is required to send all the member companies OrganizationNumbers when updating the member company list. Previous member companies are removed from membership if their organisation numbers are not provided. If the company logo is not provided, the existing value in the database for the company logo will be replaced by an empty value.
If an error occurs while updating a member company, the relevant error code is given in the output along with the relevant OrganizationNumber and the database is not be updated. If no errors occur during the update, the error code for that 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/Optional | Maximum character length/limit | Description |
|---|---|---|---|---|
| input | SetMemberStatusInput | Mandatory | Not relevant | Set member status input model |
| applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner. |
Response
| Type | Description |
|---|---|
| SetMemberStatusOutput | Set Member Status Output 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 length has exceeded the maximum character limit allowed (10) |
| 146 | The applicationName is not set |
| 167 | You are not authorized to use this method |
| 258 | Unable to find a company registered to the given OrganizationNumber |
| 374 | The given Url is not a valid image file type |
| 375 | The given image is more than 2MB in size |
| 376 | The given Base64 string is invalid |
| 388 | The given image input is not valid |