IdentityPersonMerge
This service accesses and maintains the person merge queues in the Person (PRO) System.
Base URL: /domains/legacy/identity/person/merge
Version: v1
Summary
Path | Operation | Description |
---|---|---|
/documentation | GET | service definition |
/{subscriber} | GET | Gets a list of pending person merges for a subscriber. |
/{subscriber}/{old_person_id} | GET | Indicates that a particular person merge has been completed for a subscriber. |
Paths
GET /documentation
service definition
Uses default content-types: application/json application/xml
- 200 OK
-
Success
Gets a list of pending person merges for a subscriber.
subscriber | string -> | path | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Service request is OK and a response has been generated.
Example for application/json{
"MergeService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/CCURE",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"merges": [
{
"date_time_updated": "2018-01-15T12:00:00",
"new_person_id": "987654321",
"old_person_id": "123456789",
"source_application": "",
"source_function": "",
"source_institution": "",
"updated_by_id": "111222333"
}
],
"subscriber": "CCURE"
}
}
} - 400 Bad Request
-
There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
- 401 Unauthorized
-
Failure to authenticate
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource can not be found for the provided resource identifiers.
- 500 Internal Server Error
-
An error occurred generating the response to the service request. This is strictly a server error and not an application error.
GET /{subscriber}/{old_person_id}
Tags: MergeServiceIndicates that a particular person merge has been completed for a subscriber.
subscriber | string -> | path | string | |
old_person_id | string -> | path | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Service request is OK and a response has been generated.
- 400 Bad Request
-
There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
- 401 Unauthorized
-
Failure to authenticate
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource can not be found for the provided resource identifiers.
- 500 Internal Server Error
-
An error occurred generating the response to the service request. This is strictly a server error and not an application error.
Schema definitions
- WebService: object
-
- name: string
-
- operations: operations
-
- errors: errors
-
- httpStatusCodes: httpStatusCodes
-
- old_person_id: string
-
- new_person_id: string
-
- date_time_updated: string
-
- updated_by_id: string
-
- source_institution: string
-
- source_application: string
-
- source_function: string
-
- name: string
-
- description: string
-
- method: string
-
- path: string
-
- path_identifiers: object[]
-
object - name: string
-
- type: string
-
- format: string
-
- query_attributes: object[]
-
object - name: string
-
- type: string
-
- format: string
-
- required: string
-
- method: string
-
- resource: string
-
- attributes: string
-
- status: integer
-
- statusMessage: string
-
- subscriber: string
-
- merges: merges
-