Jump to

• Request
• Response

[Deprecated]: v1.0

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupply/initial

Deprecated: Creates a first shipment as part of a study's predictive resupply group. Rights: OrsSupplyManagerPost.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Initial resupply request object.

Show Source

• jobInstanceId: string
  Title: Job Instance ID

  Job instance ID.

  Example: 4FEBE3E166454E2687C6FAC306E7C86E
• siteId(required): string (uuid)
  Site ID.

{
    "required":[
        "siteId"
    ],
    "type":"object",
    "properties":{
        "jobInstanceId":{
            "title":"Job Instance ID",
            "type":"string",
            "description":"Job instance ID.",
            "example":"4FEBE3E166454E2687C6FAC306E7C86E"
        },
        "siteId":{
            "type":"string",
            "description":"Site ID.",
            "format":"uuid"
        }
    },
    "description":"Initial resupply request object."
}

Examples

Select an example Create Initial Resupply Request

Back to Top

Response

Supported Media Types

• application/json

410 Response

Deprecated: This endpoint is no longer available.

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Create Initial Resupply Gone Response

Back to Top