Jump to

• Request
• Response

Update a shipment's ship date

put

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/{shipmentId}/ship-date

Updates a shipment's ship date. Rights: OrsInventoryPost and either OrsBlinded or OrsUnblinded.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training
• shipmentId(required): string(uuid)
  ID of the shipment.
• studyId(required): string(uuid)
  ID of the study

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: object

Request object containing shipment ship date.

Show Source

• shipDate: string
  Pattern: (\d){4}-(\d){2}-(\d){2}

  Ship date.

  Example: 2019-06-17
• shipmentId: string
  ID of the shipment.

  Example: 8ECE2C9D389645B09740DC7926DEFB69

{
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "example":"8ECE2C9D389645B09740DC7926DEFB69"
        },
        "shipDate":{
            "pattern":"(\\d){4}-(\\d){2}-(\\d){2}",
            "type":"string",
            "description":"Ship date.",
            "example":"2019-06-17"
        }
    },
    "description":"Request object containing shipment ship date."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: string(uuid)

400 Response

'Invalid ship date. It must be in YYYY-MM-DD format', 'Invalid shipment type', 'Invalid current shipment status'

Body ()

Root Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object

403 Response

'User doesn't have access to the site'

Body ()

Root Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object

404 Response

Shipment not found

Body ()

Root Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object

500 Response

Internal server error

Body ()

Root Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object

Back to Top