---
swagger: "2.0"
info:
  title: Partner Notification Update AWB API
  version: 1.0.0
  x-ibm-name: partner-notification-update-awb-api
  description: This API is used by Delivery partners to update delivery status
  contact:
    email: apideveloper@rakbank.ae
    name: API Developer
  name: ""
schemes:
- https
host: sandboxapi.rakbank.ae
basePath: /v1
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  oauth:
    type: oauth2
    description: ""
    flow: application
    scopes:
      update_awb: ""
    tokenUrl: https://sandboxapi.rakbank.ae/rb/api/v1/partner_auth/token
  clientIdHeader:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
security:
- clientIdHeader: []
  oauth:
  - update_awb
x-ibm-configuration:
  testable: false
  enforced: true
  phase: realized
paths:
  /update/awb/{awb_number}:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/update_awb_response'
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/error_response'
        403:
          description: Forbidden
          schema:
            $ref: '#/definitions/error_response'
        422:
          description: Error
          schema:
            $ref: '#/definitions/error_response'
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/error_response'
      tags: []
      summary: This is used to update Status of the delivery for the AWB.
      operationId: UpdateAWB
      parameters:
      - name: awb_number
        required: true
        in: path
        type: string
        maxLength: 30
        description: AWB Number returned in the AWB Generation API response.
      - name: update_awb
        required: true
        in: body
        schema:
          $ref: '#/definitions/update_awb'
        description: additional details of the application
      - name: channelid
        type: string
        maxLength: 20
        required: true
        in: header
        description: Channel Id
      - name: msgid
        type: string
        maxLength: 50
        required: true
        in: header
        description: Unique Id sent by client. Value should be a unique identifier
          of the request in UUID format.
definitions:
  error_response:
    properties:
      response_code:
        type: string
        description: API specific error code
      response_message:
        type: string
        description: breif details of the error
      status:
        type: string
        description: HTTP Status
      description:
        type: string
        description: detailed description of the error
      property:
        type: string
    additionalProperties: false
    description: Response in case of error
    required:
    - response_code
    - response_message
    - status
  documents:
    properties:
      document_name:
        type: string
        description: For POD & Single Pager document
        maxLength: 100
      document_type:
        type: string
        description: 'Possible values: jpg, png'
        maxLength: 50
      Document_url:
        type: string
        description: URL of a uploaded image
    additionalProperties: false
  update_awb:
    properties:
      emirates_id_ping_data:
        $ref: '#/definitions/emirates_id_ping_data'
      delivery_status:
        type: string
        description: Delivery status
        maxLength: 70
      status_code:
        type: string
        description: Status code
        maxLength: 10
      documents:
        type: array
        items:
          $ref: '#/definitions/documents'
        description: Array of documents
    additionalProperties: false
    required:
    - status_code
  update_awb_response:
    properties:
      awb_number:
        type: string
        description: AWB Number returned in the AWB Generation API response.
    additionalProperties: false
  emirates_id_ping_data:
    properties:
      emirates_id:
        type: string
        description: Emirates Id
        example: "784197772697591"
        maxLength: 20
      expiry_date:
        type: string
        description: Emirates Id expiry date
        example: "2031-10-17"
        maxLength: 10
      card_number:
        type: string
        description: Card number
        example: "10000000"
        maxLength: 20
      date_of_birth:
        type: string
        description: Date of birth
        example: "2031-10-17"
        maxLength: 10
      gender:
        type: string
        description: gender
        example: M
        maxLength: 10
      name_english:
        type: string
        description: Name in English
        example: Jhon Smith
        maxLength: 80
      nationality:
        type: string
        description: Nationality in English
        example: India
        maxLength: 50
    additionalProperties: false
    required:
    - emirates_id
    - gender
    - name_english
tags: []
x-ibm-endpoints:
- endpointUrl: https://sandboxapi.rakbank.ae/sb/api
  type:
  - production
  - development
...