Developers can retrieve master data through the YOUnite API. The differences between YOUnite Data Store and federated require different access patterns.
...
YOUnite Data Store Access Pattern
Make the Request
Payload
Federated Access
...
Patterns
blah blah about federated access... more can be found in the https://younite.us/api
TODO - Do we want to make a deal of the coexistence model??
Search a Domain Version's FDDPs
what is a FDDP (pointer to more). TODO - add request a response payload example
Make the Request
TODO... Default timeout is, it can be overriden using
TODO fix callbackURL
POST http://openmdm.dev.ccctechcenter.org/api/drs/da53c1c5-945c-42fb-821f-77ea6e20302c/assembler
| Code Block | ||||
|---|---|---|---|---|
|
...
Zone Gold/Silver Adaptors
Setting the Gold/Silver Adaptors
Response payload
Metadata payload
Limit Access to a Single Adaptor
...
| |
{
"callbackUrl": "https://openmdm.dev.ccctechcenter.org/openmdm-metadata/6c5a754b-6ce0-4871-8dec-d39e255eccc3/drs/da53c1c5-945c-42fb-821f-77ea6e20302c/assembler",
"zoneUuid": "6c5a754b-6ce0-4871-8dec-d39e255eccc3",
"timeout": 10,
"notificationRegistrationType": "WEB_SOCKET"
} |
Callback Payload
The data is delivered in the request method body specified by notificationRegistrationType and the callbackUrl specified:
TODO fix callback URL
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"callbackUrl": "https://openmdm.dev.ccctechcenter.org/openmdm-metadata/6c5a754b-6ce0-4871-8dec-d39e255eccc3/drs/da53c1c5-945c-42fb-821f-77ea6e20302c/assembler",
"oneTimePad": null,
"data": {
"zip": "46406",
"lastName": "Jadczak",
"address": "959 Barby Place",
"gender": "F",
"city": "Gary",
"lastVisit": "2013-01-12",
"birthDate": "1978-03-25",
"firstName": "Viki",
"phone": "219-375-6563",
"customerId": "0A0V6HWEIL",
"serviceRep": "Eileen",
"state": "IN",
"accountBalance": 1666.78,
"email": "ejadczak5@cbslocal.com"
},
"assemblerUuid": "25e1b386-48db-45b9-a8e9-dc1499c56e23",
"notificationRegistrationType": "WEB_SOCKET"
}
|
Gold/Silver Adaptors
The zone data steward or the API consumer can specify gold and silver adaptors (TODO: New page or gold/silver and put a link to it here). To override the zone's default gold and silver adaptor specify the UUIDs of the goldAdaptors or silverAdaptors in the assembler request payload. TODO - add UUIDs and are they quoted or not?
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"callbackUrl": "https://openmdm.dev.ccctechcenter.org/openmdm-metadata/6c5a754b-6ce0-4871-8dec-d39e255eccc3/drs/da53c1c5-945c-42fb-821f-77ea6e20302c/assembler",
"zoneUuid": "6c5a754b-6ce0-4871-8dec-d39e255eccc3",
"goldAdaptors": {
"uuids": []
},
"silverAdaptors": {
"uuids": []
},
"timeout": 10,
"notificationRegistrationType": "WEB_SOCKET"
} |
Metadata payload
TODO the metadata for the request can be retrieved...
TODO add example content
Limit Access to a Set or a Single Adaptor
TODO explain the need. Example of what some call the Coexistence model. Add example .. no need for response content.
Other Related Endpoints
TODO: Are there any??