NbP

internet2 · Nov 4, 2020 · 5cbb014 · 5cbb014
1 parent de6638c
commit 5cbb014
Showing 1 changed file with 124 additions and 1 deletion.
diff --git a/id-match-api.yml b/id-match-api.yml
@@ -14,11 +14,134 @@ servers:
 
 paths:
   /people/{sorLabel}/{sorId}:
+    get:
+      tags:
+        - idMatch
+      summary: GET-based; Search only, similar to a regular request, except that a new identity will never be created as a result of the request
+      operationId: requestSerchOnlyGet
+      parameters:
+        - name: sorLabel
+          in: path
+          description: The official designation of the requesting SOR
+          required: true
+          schema:
+            type: string
+        - name: sorId
+          in: path
+          description: The SOR-assigned identifier for the person
+          required: true
+          schema:
+            type: string
+        - in: query
+          name: name.0
+          schema:
+            type: string
+          description: The
+        - in: query
+          name: dateOfBirth
+          schema:
+            type: string
+          description: The
+      responses:
+        '200':
+          description: An existing identity was found matching the specified attributes.
+        '201':
+          description: Return new referenceId for a person new to ID Match
+    post:
+      tags:
+        - idMatch
+      summary: POST-based; Search only, similar to a regular request, except that a new identity will never be created as a result of the request
+      operationId: requestSerchOnlyPost
+      parameters:
+        - name: sorLabel
+          in: path
+          description: The official designation of the requesting SOR
+          required: true
+          schema:
+            type: string
+        - name: sorId
+          in: path
+          description: The SOR-assigned identifier for the person
+          required: true
+          schema:
+            type: string
+
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/people'
+            example:
+              names:
+                -
+                  type: official
+                  given: Pat
+                  family: Lee
+              dateOfBirth: "1983-03-18"
+              identifiers:
+                -
+                  type: national
+                  identifier: 3B902AE12DF55196
+              telephoneNumbers:
+                -
+                  type: mobile
+                  number: 8185551234
+      responses:
+        '201':
+          description: Return new referenceId for a person new to ID Match
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/people'
+              example:
+                names:
+                  -
+                     type: official
+                     given: Pat
+                     family: Lee
+                dateOfBirth: "1983-03-18"
+                identifiers:
+                  -
+                    type: national
+                    identifier: 3B902AE12DF55196
+                telephoneNumbers:
+                  -
+                    type: mobile
+                    number: 8185551234
+                referenceId: M523441767
+
+        '200':
+          description: Return referenceId for a person known to ID Match
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/people'
+              example:
+                names:
+                  -
+                     type: official
+                     given: Pat
+                     family: Lee
+                dateOfBirth: "1983-03-18"
+                identifiers:
+                  -
+                    type: national
+                    identifier: 3B902AE12DF55196
+                telephoneNumbers:
+                  -
+                    type: mobile
+                    number: 8185551234
+                referenceId: M523441767
+
+
+        '400':
+          $ref: '#/components/responses/400Error'
+
     put:
       tags:
         - idMatch
       summary: Request a Reference Identifier for an SOR Person
-      operationId: request
+      operationId: requestRefId
       parameters:
         - name: sorLabel
           in: path