Description
This web method allows a Franchiser company to send a list of member company Organization Numbers and Franchiser company logo. This web method can only be accessed by users with Special Franchiser Role. It is required to send all the member company's Organization Numbers when updating the member company list. Previous member companies would be removed from membership if their organisation Numbers are not provided.If the company logo is not provided, the existing value in Database for company logo will be replaced with an empty value.
If an error occurred while updating a member company, relevant error code will be given in the output along with the relevant Organization number. Then that member company won't be updated in Database. If no error occurred while updating a member company then error code for that organization number will be 0.
Request
| Parameter | Type | Mandatory/Optional | Comments |
|---|---|---|---|
| input | SetMemberStatusInput | Mandatory | Set member status input model |
| applicationName | string | Mandatory | Third party application identifier, identifying the client consuming the web service – (Length of the ApplicationName should be less than or equal to 10) |
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 is exceeded maximum allowed character limit (10) |
| 146 | The application name is not set |
| 167 | You are not authorized to use this web method |
| 258 | Unable to find a company registered for the given organization number |
| 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 not a valid Image |
| 388 | The Given image input is not valid |