Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: add/remove exceptions and clarify proj id/code priority

...

ParameterTypeMandatory/OptionalComments

projectId

long

Mandatory/OptionalEmpty*The project Id of the project
projectCodestringOptional/Mandatory*Project code of the project E.g. ABC0001-A1 

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)

Note: * Need to provide at least one of these fields (project Id, project code). Always project ID will be given first priority and considered as the only input whenever provided.

Response

TypeDescription

List<GetRoomsForProjectDetails>

List of rooms in given project

...

Error CodeDescription

123

An exception occured while processing your request

138

ApplicationName length is exceeded: maximum allowed character limit (10)

146

The application name is not set

227

The project does not exist or the company is not connected to the given project

252

No input is provided to project Id or project code. Need atleast at least one of them

253Ambiguous inputs. Make sure projet code and project id referred to the same project
254Invalid project code
273Project does not exist