StratusVue API Services Internal

<back to all web services

ProjectsGetFavoritesByUserRequest

Internal API: Get Favorite Projects by Logged in user.

The following routes are available for this service:
POST/api/internal/project/get/projectsbyuser/favorites
ProjectsGetFavoritesByUserRequest Parameters:
NameParameterData TypeRequiredDescription
SessionIdbodystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
AuthSessionKeyformstringNo
AdditionalInfoformList<ItemNameValue>No
ItemNameValue Parameters:
NameParameterData TypeRequiredDescription
PropertyNameformstringNo
PropertyValueformstringNo
ProjectsGetFavoritesByUserResponse Parameters:
NameParameterData TypeRequiredDescription
ProjectsformList<Project>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
UiErrorMessageformstringNo
UiDevErrorMessageformstringNo
ErrorOccuredformboolNo
LogMessageTypeformErrorMessageTypeNo
ResponseStatusformResponseStatusNo
NumberOfRecordsEffectedformintNo
Project Parameters:
NameParameterData TypeRequiredDescription
ProjectIdformintNo
ProjectStatusformintNo
ProjectOwnerIdformintNo
ProjectNameformstringNo
ProjectNumberformstringNo
DescriptionformstringNo
AddressformAddressNo
PhoneformstringNo
FaxformstringNo
LogoformintNo
LogoUrlformstringNo
FilePathformstringNo
RootFolderIdformintNo
StartDateformDateTimeNo
EndDateformDateTimeNo
NumberOwnerformstringNo
NumberArchitectformstringNo
IsProjectDisabledformboolNo
SubmitToformstringNo
SubmitFromformstringNo
ReturnToformstringNo
ReturnFromformstringNo
BudgetformdecimalNo
ContingencyformdecimalNo
ProjectValuationformstringNo
OrganizationformstringNo
LocationformstringNo
StratusDriveOrgIDformstringNo
Address Parameters:
NameParameterData TypeRequiredDescription
Line1formstringNo
Line2formstringNo
CityformstringNo
ZipformstringNo
StateformstringNo
CountyformstringNo
CountryformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/ProjectsGetFavoritesByUserRequest HTTP/1.1 
Host: api.sagecpc.com 
Content-Type: application/json
Content-Length: length

{"sessionId":"String","authSessionKey":"String","additionalInfo":[{"propertyName":"String","propertyValue":"String"}]}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"projects":[{"projectId":0,"projectStatus":0,"projectOwnerId":0,"projectName":"String","projectNumber":"String","description":"String","address":{"line1":"String","line2":"String","city":"String","zip":"String","state":"String","county":"String","country":"String"},"phone":"String","fax":"String","logo":0,"logoUrl":"String","filePath":"String","rootFolderId":0,"startDate":"\/Date(-62135596800000-0000)\/","endDate":"\/Date(-62135596800000-0000)\/","numberOwner":"String","numberArchitect":"String","isProjectDisabled":false,"submitTo":"String","submitFrom":"String","returnTo":"String","returnFrom":"String","budget":0,"contingency":0,"projectValuation":"String","organization":"String","location":"String","stratusDriveOrgID":"String"}],"uiErrorMessage":"String","uiDevErrorMessage":"String","errorOccured":false,"logMessageType":"DEBUG","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"numberOfRecordsEffected":0}