List Projects API

This API is used to request a summary of all submitted projects that are in the given state.

Command

"client/listProjects/1"


Input Special Rule


Inputs

The following values are expected in the JSON body:

Name Type Required Description
command String

Must be "client/listProjects/1"
state Integer

Possible values are:

  1. Pre-Launch
  2. In-Field
  3. Paused
  4. Closed - Waiting for IDs
  5. Closed - Ready for Billing
  6. Closed - Billed
onAlert Boolean

List projects that have an Alert.
details Boolean

Include details of projects.

Outputs

The JSON output will always contain the original command and a result. If the result > 0, an error has occurred (refer to Error Codes) and a message field will describe the error. If result = 0, the following is included in the response field:

Name Type Description
rfg_ids String[]

Array of the rfg_id that have been submitted to us in the given state.

If details are requested, output will be "projects" as a JSON array.

Example Command

{
     command": "client/listProjects/1",
     state: 2
}

Example Response

Without details:

response : {
     rfg_ids: [
          "RFG123456-001",
          "RFG345678-001",
          ...
     ]
}

With details:

response : {
     projects: [
          {
               name : "Test3" ,
               rfgNum : "TST100003-001" ,
               numberCustomer : "567" ,
               state : 1 ,
               stats : {
                    completes : 0 ,
                    terminates : 0 ,
                    overQuotas : 0 ,
                    starts : 0 ,
                    cr : 25,
                    ir: 37
               } ,
               country : 1 ,
               customerId : "Acme 123" ,
               customerManager : "Morgan"
          }
          ...
     ]
}