Update Appointments

This API updates an existing appointment. If the appointment cannot be updated, the API call will return an error.

Swagger

         
swagger: '2.0'
info:
  x-ibm-name: appointments
  title: Appointments
  version: 1.0.0
schemes:
  - https
host: $(catalog.host)
basePath: /v1
consumes:
  - application/json
produces:
  - application/json
  - fsc-api-admin@fedex.com
  - satayoday.sinha@fedex.com
securityDefinitions:
  oauth2:
    type: oauth2
    description: Enter Access token
    flow: accessCode
    scopes:
      Fulfillment_Returns: 'Read/Write access to Orders, Items, RMAs, Inventory,ASN ,Inbound Shipments and Appointments objects'
    authorizationUrl: 'https://<........................>/fsc/oauth2/authorize'
    tokenUrl: 'https://<........................>/fsc/oauth2/token'
    x-tokenIntrospect:
      url: 'https://vp1npmqdp01-v1.genco.com:2443/api/test/fsc/oauth/introspect'
  Client_Secret:
    type: apiKey
    description: Enter Client Secret
    in: header
    name: X-IBM-Client-Secret
  Client_Id:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
    description: Enter Client ID
security:
  - Client_Secret: []
    oauth2:
      - Fulfillment_Returns
    Client_Id: []
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /appointments/{appointmentId}:
    put:
      responses:
        '200':
          description: 200 OK
      summary: 'This API updates an existing appointment. If the appointment cannot be updated, the API call will return an error'
      parameters:
        - name: appointmentId
          type: string
          required: true
          in: path
          description: appointmentId as input parameter
        - name: AccessToken
          type: string
          required: false
          in: header
          description: Mandatory access token
        - name: UpdateAppointments_json_body
          required: true

      

Sample Request

         
{
   "appointmentType": "Live Unload",
   "facility": "HFY",
   "appointmentDttm" :"2019-06-8T00:00:00-05:00",
   "duration": 120,
   "objectType": "ASN",
   "objectIds": ["12223","3333","4444"],
   "loadType": "Pallets",
   "trailerType": "LTL",
   "palletHeight": "7 ft",
   "numberOfPallets": 1,
   "numberOfCases": 100,
   "singleSkuFlag": True,
   "trailerNumber": "123",
   "notes": ""    
}

 
      

Sample Response

Success Response

         
{
    "requestIdentifier": "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
    "transactionDate": "2019-06-20T15:12:54-05:00",
    "status": true,
    "appointments": 
        {
            "appointmentId": "010201-031219-355",
            "appointmentDttm": "2019-06-8T00:00:00-05:00",
            "duration": 120,
            "appointmentStatus": "Scheduled"
        }


      

Error Response

Error Response

         
{
   "requestIdentifier": "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
   "transactionDate": "2019-06-20T15:12:54-05:00",
   "status": false,
   "errors": [
        {
            "code": "ERR-APT-0002",
            "description": "Requested Appointment Time not available"
        }
    ]
}


      

OAuth 2.0

Custom authentication

Request Attributes

Response Attribute

HTTP Status Code

Error Code