DH-1006 Market party information retrieval
POST method
Resource description | ||
|---|---|---|
Definition | Interface for requesting organisational (market party) information | |
Path parameters | ||
{function} | GetOrganisationDataPost | |
Query string parameters | ||
Name | Type | Obligation |
{organisationUser} | String | Mandatory |
{organisationID} | String | Optional |
{marketRole} | String | Optional |
Validation rules | ||
No validation | ||
Response | ||
Market party information valid at the time of request. If no input parameters are given, information for all market parties is returned. | ||
Request example | ||
https://{hostname}/rest/FGR/GetOrganisationDataPostContent of the posted message: {
"GetOrganisationDataRequest": {
"organisationUser": "{organisationUser}",
"Filters": {
"organisationID": "{organisationID}",
"marketRole": "{marketRole}"
}
}
} | ||
GET method
The GET method will be discontinued when version 2.6 is deployed.
Resource description | ||
|---|---|---|
Definition | Interface for requesting organisational (market party) information | |
Path parameters | ||
{function} | GetOrganisationData | |
Query string parameters | ||
Name | Type | Obligation |
{organisationUser} | String | Mandatory |
{organisationID} | String | Optional |
{marketRole} | String | Optional |
Validation rules | ||
No validation | ||
Response | ||
Market party information valid at the time of request. If no input parameters are given, information for all market parties is returned. | ||
Request example | ||
https://{hostname}/rest/FGR/GetOrganisationData?organisationUser={organisationUser}&organisationID={organisationID}&marketRole={marketRole} | ||
Returned market party information
DH-1006 – Get organisation data return | |
|---|---|
Name | Obligation |
Organisations | 0..n |
CountryCode | 1..1 |
MarketRole | 1..1 |
Name | 1..1 |
OrganisationIdentifier | 1..1 |
RegistrationCOC | 1..1 |
OrganisationAddresses | 1..n |
AddressSpecification | 0..1 |
AddressType | 1..1 |
BuildingNumber | 0..1 |
CityName | 1..1 |
CountryCode | 1..1 |
FloorID | 0..1 |
Postcode | 1..1 |
PostOfficeBox | 0..1 |
RoomID | 0..1 |
StreetName | 0..1 |
OrganisationContacts | 1..n |
EmailAddress | 1..1 |
FirstName | 0..1 |
FullName | 0..1 |
LastName | 0..1 |
PhoneNumber1 | 1..1 |
WebAddressURL | 0..1 |