|
Virima API Specification - RequestProcurementService Services
The requests documented in this section are directed to
RequestProcurementService resources, which represent .
addRequest POST Interface
Method: POST Relative URL: request-pro-service/add Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: Field Name | Type | Description |
---|
requestpro | Requests | |
Response Structure: Field Name | Type | Description |
---|
response | Response | |
Example Request: ADDREQUEST
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"requestNumber":"?",
"openedDate":?,
"openedBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"location": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"approval":"?",
"dueDate":?,
"requestState":"?",
"price":?,
"isSourced":?,
"createdOn":?,
"archive":?,
"lastModifiedBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"lastModifiedOn":?,
"requestedFor": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"state":"?",
"stage":"?",
"uniqueId":"?"
}
Example Response: {
"id":2147483647,
"response":"?"
}
editRequest POST Interface
Method: POST Relative URL: request-pro-service/edit Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Request Structure: Field Name | Type | Description |
---|
requestpro | Requests | |
Response Structure: Field Name | Type | Description |
---|
response | Response | |
Example Request: EDITREQUEST
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"requestNumber":"?",
"openedDate":?,
"openedBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"location": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"approval":"?",
"dueDate":?,
"requestState":"?",
"price":?,
"isSourced":?,
"createdOn":?,
"archive":?,
"lastModifiedBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"lastModifiedOn":?,
"requestedFor": {
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"state":"?",
"stage":"?",
"uniqueId":"?"
}
Example Response: {
"id":2147483647,
"response":"?"
}
getAllRequests GET Interface
Method: GET Relative URL: request-pro-service/get Request Headers: Accept, Authorization Response Headers: Content-Length, Content-Type. Response Structure: Field Name | Type | Description |
---|
requestProList | ValueList | |
Example Request: Example Response: {
"id":2147483647,
"StringList":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"projectList":[
{
"id":2147483647,
"name":"?",
"description":?,
"plannedStart":?,
"plannedEnd":?,
"actualStart":?,
"actualEnd":?,
"baselineStart":?,
"baselineEnd":?,
"status":"?",
"billingCode":"?",
"costCenter": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"percentageComplete":?,
"duration":?,
"archive":?,
"projectManager": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"isTemplate":?,
"templateName":"?",
"createdFromTemplate":?,
"createdFromTemplateName":"?",
"validationError":?,
"programs":[
{
"id":1838045502,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"associatedCis":[
{
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
} ],
"lastModifiedBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdBy": {
"id":2147483647,
"stringobj":"?",
"shortName":"?",
"s3Name":"?",
"uniqueId":"?",
"lineType":"?",
},
"createdOn":?,
"lastModifiedOn":?,
"uniqueId":"?",
"totalTimeSpent":?
} ]
}
|