StratusVue API Services Internal

ProjectGetContractSummaryRequest

Internal API: Get Project Contract Summary.

The following routes are available for this service:
POST	/api/internal/project/get/contractsummarybyproject

**ProjectGetContractSummaryRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ProjectId	body	int	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
AuthSessionKey	form	string	No
AdditionalInfo	form	List<ItemNameValue>	No

**ItemNameValue** Parameters:
Name	Parameter	Data Type	Required	Description
PropertyName	form	string	No
PropertyValue	form	string	No

**ProjectGetContractSummaryResponse** Parameters:
Name	Parameter	Data Type	Required
SummaryData	form	List<Summary>	No
AllocationData	form	List<Allocation>	No
MarginData	form	List<Margin>	No
InvoicedData	form	List<Invoiced>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
UiErrorMessage	form	string	No
UiDevErrorMessage	form	string	No
ErrorOccured	form	bool	No
LogMessageType	form	ErrorMessageType	No
ResponseStatus	form	ResponseStatus	No
NumberOfRecordsEffected	form	int	No

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/ProjectGetContractSummaryRequest HTTP/1.1 
Host: api.sampson.sagecpc.com 
Content-Type: application/json
Content-Length: length

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

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

{"summaryData":[{"originalContract":0,"pendingChanges":0,"approvedChanges":0,"total":0,"pendingPlusApproved":0,"accountingApproved":0,"accountingTotal":0}],"allocationData":[{"allocation":"String","originalContract":0,"pendingChanges":0,"approvedChanges":0,"total":0,"accountingJTDCost":0,"amountInvoiced":0,"forecastJTDCost":0,"forecast":0,"totalCost":0}],"marginData":[{"description":"String","original":0,"pendingChanges":0,"approvedChanges":0,"total":0}],"invoicedData":[{"amountInvoiced":0,"amountRetained":0,"amountPaid":0,"arBalance":0,"totalContract":0,"percentComplete":0}],"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}