Microsoft Azure Prescriptions API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Prescriptions API
schemes:
- https
tags:
- name: Prescriptions
paths:
  /parties/{partyId}/prescriptions:
    get:
      tags:
      - Prescriptions
      description: Returns a paginated list of prescription resources under a particular party.
      operationId: microsoftAzurePrescriptionsListbypartyid
      produces:
      - application/json
      parameters:
      - in: path
        name: partyId
        description: Id of the associated party.
        required: true
        type: string
      - in: query
        name: prescriptionMapIds
        description: Prescription Map Ids of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: types
        description: Types of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: productCodes
        description: Product Codes of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: productNames
        description: Product Names of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: sources
        description: Sources for the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: ids
        description: Ids of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: names
        description: Names of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: propertyFilters
        description: "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\"."
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: statuses
        description: Statuses of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: minCreatedDateTime
        description: Minimum creation date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxCreatedDateTime
        description: Maximum creation date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: minLastModifiedDateTime
        description: Minimum last modified date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxLastModifiedDateTime
        description: Maximum last modified date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxPageSize
        description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50."
        type: integer
        format: int32
        default: 50
        maximum: 1000
        minimum: 10
      - in: query
        name: skipToken
        description: Skip token for getting next set of results.
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PrescriptionListResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Prescriptions_ListByPartyId:
          $ref: ./examples/Prescriptions_ListByPartyId.json
      summary: Microsoft Azure Get Parties Partyid Prescriptions
  /parties/{partyId}/prescriptions/{prescriptionId}:
    get:
      tags:
      - Prescriptions
      description: Gets a specified prescription resource under a particular party.
      operationId: microsoftAzurePrescriptionsGet
      produces:
      - application/json
      parameters:
      - in: path
        name: partyId
        description: Id of the associated party.
        required: true
        type: string
      - in: path
        name: prescriptionId
        description: Id of the prescription.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Prescription'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        Prescriptions_Get:
          $ref: ./examples/Prescriptions_Get.json
      summary: Microsoft Azure Get Parties Partyid Prescriptions Prescriptionid
    patch:
      tags:
      - Prescriptions
      description: Creates or Updates a prescription resource under a particular party.
      operationId: microsoftAzurePrescriptionsCreateorupdate
      consumes:
      - application/merge-patch+json
      produces:
      - application/json
      parameters:
      - in: path
        name: partyId
        description: Id of the associated party resource.
        required: true
        type: string
      - in: path
        name: prescriptionId
        description: Id of the prescription resource.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      - in: body
        name: prescription
        description: Prescription resource payload to create or update.
        required: true
        schema:
          $ref: '#/definitions/Prescription'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Prescription'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Prescription'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        Prescriptions_CreateOrUpdate:
          $ref: ./examples/Prescriptions_CreateOrUpdate.json
      summary: Microsoft Azure Patch Parties Partyid Prescriptions Prescriptionid
    delete:
      tags:
      - Prescriptions
      description: Deletes a specified prescription resource under a particular party.
      operationId: microsoftAzurePrescriptionsDelete
      produces:
      - application/json
      parameters:
      - in: path
        name: partyId
        description: Id of the party.
        required: true
        type: string
      - in: path
        name: prescriptionId
        description: Id of the prescription.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '204':
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        Prescriptions_Delete:
          $ref: ./examples/Prescriptions_Delete.json
      summary: Microsoft Azure Delete Parties Partyid Prescriptions Prescriptionid
  /prescriptions:
    get:
      tags:
      - Prescriptions
      description: Returns a paginated list of prescription resources across all parties.
      operationId: microsoftAzurePrescriptionsList
      produces:
      - application/json
      parameters:
      - in: query
        name: prescriptionMapIds
        description: Prescription Map Ids of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: types
        description: Types of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: productCodes
        description: Product Codes of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: productNames
        description: Product Names of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: sources
        description: Sources for the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: ids
        description: Ids of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: names
        description: Names of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: propertyFilters
        description: "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\"."
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: statuses
        description: Statuses of the resource.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: minCreatedDateTime
        description: Minimum creation date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxCreatedDateTime
        description: Maximum creation date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: minLastModifiedDateTime
        description: Minimum last modified date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxLastModifiedDateTime
        description: Maximum last modified date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxPageSize
        description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50."
        type: integer
        format: int32
        default: 50
        maximum: 1000
        minimum: 10
      - in: query
        name: skipToken
        description: Skip token for getting next set of results.
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PrescriptionListResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Prescriptions_List:
          $ref: ./examples/Prescriptions_List.json
      summary: Microsoft Azure Get Prescriptions
  /prescriptions/cascade-delete/{jobId}:
    get:
      tags:
      - Prescriptions
      description: Get a cascade delete job for specified prescription.
      operationId: microsoftAzurePrescriptionsGetcascadedeletejobdetails
      produces:
      - application/json
      parameters:
      - in: path
        name: jobId
        description: Id of the job.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CascadeDeleteJob'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        Prescriptions_GetCascadeDeleteJobDetails:
          $ref: ./examples/Prescriptions_GetCascadeDeleteJobDetails.json
      summary: Microsoft Azure Get Prescriptions Cascade Delete Jobid
    put:
      tags:
      - Prescriptions
      description: Create a cascade delete job for specified prescription.
      operationId: microsoftAzurePrescriptionsCreatecascadedeletejob
      produces:
      - application/json
      parameters:
      - in: path
        name: jobId
        description: Job ID supplied by end user.
        required: true
        type: string
      - in: query
        name: partyId
        description: ID of the associated party.
        required: true
        type: string
      - in: query
        name: prescriptionId
        description: ID of the prescription to be deleted.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/CascadeDeleteJob'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Prescriptions_CreateCascadeDeleteJob:
          $ref: ./examples/Prescriptions_CreateCascadeDeleteJob.json
      summary: Microsoft Azure Put Prescriptions Cascade Delete Jobid
  /prescription:search:
    post:
      tags:
      - Prescriptions
      description: Search for Prescriptions across all parties by intersecting geometry.
      operationId: microsoftAzurePrescriptionsSearch
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: query
        name: skipToken
        description: Skip token for getting next set of results.
        type: string
      - in: query
        name: maxPageSize
        description: Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.
        type: integer
        format: int32
        default: 50
        maximum: 1000
        minimum: 10
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      - in: body
        name: searchPrescriptionQuery
        description: Query filters.
        required: true
        schema:
          $ref: '#/definitions/SearchPrescriptionQuery'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PrescriptionMetaDataListResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        Prescriptions_Search:
          $ref: ./examples/Prescriptions_Search.json
      summary: Microsoft Azure Post Prescription:search
definitions:
  Prescription:
    description: Api Model for Prescription object.
    type: object
    properties:
      partyId:
        description: Party Id.
        type: string
        readOnly: true
      prescriptionMapId:
        description: Prescription map Id.
        type: string
      productCode:
        description: Product Code.
        maxLength: 100
        minLength: 0
        type: string
      productName:
        description: Product name.
        maxLength: 100
        minLength: 0
        type: string
      type:
        description: Prescription type.
        maxLength: 100
        minLength: 0
        type: string
      measurements:
        description: Measures.
        type: object
        additionalProperties:
          $ref: '#/definitions/Measure'
      id:
        description: Unique resource ID.
        type: string
        readOnly: true
      eTag:
        description: The ETag value to implement optimistic concurrency.
        type: string
        readOnly: true
      status:
        description: Status of the resource.
        maxLength: 100
        minLength: 0
        type: string
      createdDateTime:
        format: date-time
        description: 'Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
        example: '2020-12-31T11:10:21Z'
      modifiedDateTime:
        format: date-time
        description: 'Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
        example: '2020-12-31T11:10:21Z'
      source:
        description: Source of the resource.
        maxLength: 100
        minLength: 2
        type: string
      name:
        description: Name to identify resource.
        maxLength: 100
        minLength: 0
        type: string
      description:
        description: Textual description of the resource.
        maxLength: 500
        minLength: 0
        type: string
      createdBy:
        description: Created by user/tenant id.
        type: string
        readOnly: true
      modifiedBy:
        description: Modified by user/tenant id.
        type: string
        readOnly: true
      properties:
        description: "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported."
        type: object
        additionalProperties: {}
        example:
          key1: value1
          key2: 123.45
  ErrorResponse:
    description: An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.
    type: object
    properties:
      error:
        $ref: '#/definitions/Error'
      traceId:
        description: Unique trace Id.
        type: string
  Measure:
    description: Schema for storing measurement reading and unit.
    type: object
    properties:
      unit:
        description: Data unit.
        maxLength: 50
        minLength: 1
        type: string
      value:
        format: double
        description: Data value.
        type: number
  PrescriptionMetaDataListResponse:
    description: Paged response contains list of requested objects and a skipToken to get the next set of results.
    required:
    - value
    type: object
    properties:
      value:
        description: List of requested objects.
        type: array
        items:
          $ref: '#/definitions/PrescriptionMetaData'
      skipToken:
        description: Token used in retrieving the next page. If null, there are no additional pages.
        type: string
      nextLink:
        description: Continuation link (absolute URI) to the next page of results in the list.
        type: string
  CascadeDeleteJob:
    description: Schema of cascade delete job.
    required:
    - partyId
    - resourceId
    - resourceType
    type: object
    properties:
      partyId:
        description: Party Id.
        minLength: 1
        type: string
      resourceId:
        description: The id of the resource.
        minLength: 1
        type: string
      resourceType:
        description: The type of the resource.
        minLength: 1
        type: string
      id:
        description: Unique job id.
        type: string
        readOnly: true
      status:
        description: "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'."
        enum:
        - Waiting
        - Running
        - Succeeded
        - Failed
        - Cancelled
        type: string
        readOnly: true
        x-ms-enum:
          name: JobStatus
          modelAsString: true
      durationInSeconds:
        format: double
        description: Duration of the job in seconds.
        type: number
        readOnly: true
      message:
        description: Status message to capture more details of the job.
        type: string
        readOnly: true
      errorCode:
        description: Error Code when job failed.
        type: string
        readOnly: true
      createdDateTime:
        format: date-time
        description: 'Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      lastActionDateTime:
        format: date-time
        description: 'Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      startTime:
        format: date-time
        description: 'Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      endTime:
        format: date-time
        description: 'Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
  PrescriptionMetaData:
    description: Api Model for Prescription object.
    type: object
    properties:
      partyId:
        description: Party Id.
        type: string
        readOnly: true
      prescriptionMapId:
        description: Prescription map Id.
        type: string
      productCode:
        description: Product Code.
        maxLength: 100
        minLength: 0
        type: string
      productName:
        description: Product name.
        maxLength: 100
        minLength: 0
        type: string
      type:
        description: Prescription type.
        maxLength: 100
        minLength: 0
        type: string
      measurements:
        description: Measures.
        type: object
        additionalProperties:
          $ref: '#/definitions/Measure'
      id:
        description: Unique resource ID.
        type: string
        readOnly: true
      eTag:
        description: The ETag value to implement optimistic concurrency.
        type: string
        readOnly: true
      status:
        description: Status of the resource.
        maxLength: 100
        minLength: 0
        type: string
      createdDateTime:
        format: date-time
        description: 'Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
        example: '2020-12-31T11:10:21Z'
      modifiedDateTime:
        format: date-time
        description: 'Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
        example: '2020-12-31T11:10:21Z'
      source:
        description: Source of the resource.
        maxLength: 100
        minLength: 2
        type: string
      name:
        description: Name to identify resource.
        maxLength: 100
        minLength: 0
        type: string
      description:
        description: Textual description of the resource.
        maxLength: 500
        minLength: 0
        type: string
      createdBy:
        description: Created by user/tenant id.
        type: string
        readOnly: true
      modifiedBy:
        description: Modified by user/tenant id.
        type: string
        readOnly: true
      properties:
        description: "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported."
        type: object
        additionalProperties: {}
        example:
          key1: value1
          key2: 123.45
  SearchPrescriptionQuery:
    description: Get Zones query parameters.
    type: object
    properties:
      prescriptionMapIds:
        description: Prescription Map Ids of the resource.
        type: array
        items:
          type: string
      types:
        description: Types of the resource.
        type: array
        items:
          type: string
      productCodes:
        description: Product Codes of the resource.
        type: array
        items:
          type: string
      productNames:
        description: Product Names of the resource.
        type: array
        items:
          type: string
      sources:
        description: Sources of the resource.
        type: array
        items:
          type: string
      ids:
        description: Ids of the resource.
        type: array
        items:
          type: string
      names:
        description: Names of the resource.
        type: array
        items:
          type: string
      propertyFilters:
        description: "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\"."
        type: array
        items:
          type: string
      statuses:
        description: Statuses of the resource.
        type: array
        items:
          type: string
      minCreatedDateTime:
        format: date-time
        description: Minimum creation date of resource (inclusive).
        type: string
      maxCreatedDateTime:
        format: date-time
        description: Maximum creation date of resource (inclusive).
        type: string
      minLastModifiedDateTime:
        format: date-time
        description: Minimum last modified date of resource (inclusive).
        type: string
      maxLastModifiedDateTime:
        format: date-time
        description: Maximum last modified date of resource (inclusive).
        type: string
      intersectsWithGeometry:
        $ref: '#/definitions/GeoJsonObject'
      partyId:
        description: Party ID which belongs to the operation data.
        type: string
  InnerError:
    description: Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
    type: object
    properties:
      code:
        description: Specific error code than was provided by the containing error.
        type: string
      innererror:
        $ref: '#/definitions/InnerError'
  GeoJsonObject:
    description: 'GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format.'
    required:
    - type
    type: object
    properties:
      type:
        $ref: '#/definitions/GeoJsonObjectType'
    discriminator: type
  PrescriptionListResponse:
    description: Paged response contains list of requested objects and a URL link to get the next set of results.
    required:
    - value
    type: object
    properties:
      value:
        description: List of requested objects.
        type: array
        items:
          $ref: '#/definitions/Prescription'
      skipToken:
        description: Token used in retrieving the next page. If null, there are no additional pages.
        type: string
      nextLink:
        description: Continuation link (absolute URI) to the next page of results in the list.
        type: string
  GeoJsonObjectType:
    description: GeoJSON object type.
    enum:
    - Point
    - Polygon
    - MultiPolygon
    type: string
    x-ms-enum:
      name: GeoJsonObjectType
      modelAsString: true
  Error:
    description: An error from the Azure AgPlatform service.
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: Server-defined set of error codes.
        minLength: 1
        type: string
      message:
        description: Human-readable representation of the error.
        minLength: 1
        type: string
      target:
        description: Target of the error.
        type: string
      details:
        description: Array of details about specific errors that led to this reported error.
        type: array
        items:
          $ref: '#/definitions/Error'
      innererror:
        $ref: '#/definitions/InnerError'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'