DH-1006 Organisaation tietojen noutaminen
POST-menetelmä
Resurssin kuvaus | ||
|---|---|---|
Määritelmä | Rajapinta organisaation eli markkinaosapuolen tietojen pyytämiseen | |
Polun parametrit | ||
{funktio} | GetOrganisationDataPost | |
Sanoman parametrit | ||
Nimi | Tyyppi | Velvoite |
{OrganisaationKäyttäjä} | Merkkijono | Pakollinen |
{OrganisaationTunnus} | Merkkijono | Valinnainen |
{OsapuolenTyyppi} | Merkkijono | Valinnainen |
Kelpoisuussäännöt | ||
Ei tarkistusta | ||
Vastaus | ||
Organisaatiotiedot, jotka ovat voimassa pyynnön esittämisen aikaan. Jos mitään syöttöparametreja ei anneta, kaikkien organisaatioiden tiedot palautetaan. | ||
Esimerkkipyyntö | ||
https://{palvelin}/rest/FGR/GetOrganisationDataPostSanoman sisältö: {
"GetOrganisationDataRequest": {
"organisationUser": "{OrganisaationKäyttäjä}",
"Filters": {
"organisationID": "{OrganisaationTunnus}",
"marketRole": "{OsapuolenTyyppi}"
}
}
} | ||
Palautetut organisaatiotiedot
DH-1006 – Get organisation data return | |
|---|---|
Nimi | Pakollisuus |
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 |