GET api/market/announcementtypes
Gets all the announcement types and associated subtypes. These values are used as part of the search parameters in the announcements endpoint.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of AnnouncementTypeAndSubTypeDetailsName | Description | Type | Additional information |
---|---|---|---|
PrimaryCode |
Announcement type code |
integer |
None. |
PrimaryDescription |
Announcement type description |
string |
None. |
SubTypes |
List of all subtypes associated with the announcement type |
Collection of AnnouncementSubType |
None. |
Response Formats
application/json, text/json
Sample:
[ { "PrimaryCode": 1, "PrimaryDescription": "Takeover Announcement", "SubTypes": [ { "SubTypeCode": 0, "SubTypeDescription": "Takeover Announcement" }, { "SubTypeCode": 1, "SubTypeDescription": "Intention to Make Takeover Bid" } ] }, { "PrimaryCode": 2, "PrimaryDescription": "Security Holder Details", "SubTypes": [ { "SubTypeCode": 0, "SubTypeDescription": "Security Holder Details" }, { "SubTypeCode": 1, "SubTypeDescription": "Becoming a substantial holder" } ] } ]
application/xml, text/xml
Sample:
<ArrayOfAnnouncementTypeAndSubTypeDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Market"> <AnnouncementTypeAndSubTypeDetails> <PrimaryCode>1</PrimaryCode> <PrimaryDescription>Takeover Announcement</PrimaryDescription> <SubTypes> <AnnouncementSubType> <SubTypeCode>0</SubTypeCode> <SubTypeDescription>Takeover Announcement</SubTypeDescription> </AnnouncementSubType> <AnnouncementSubType> <SubTypeCode>1</SubTypeCode> <SubTypeDescription>Intention to Make Takeover Bid</SubTypeDescription> </AnnouncementSubType> </SubTypes> </AnnouncementTypeAndSubTypeDetails> <AnnouncementTypeAndSubTypeDetails> <PrimaryCode>2</PrimaryCode> <PrimaryDescription>Security Holder Details</PrimaryDescription> <SubTypes> <AnnouncementSubType> <SubTypeCode>0</SubTypeCode> <SubTypeDescription>Security Holder Details</SubTypeDescription> </AnnouncementSubType> <AnnouncementSubType> <SubTypeCode>1</SubTypeCode> <SubTypeDescription>Becoming a substantial holder</SubTypeDescription> </AnnouncementSubType> </SubTypes> </AnnouncementTypeAndSubTypeDetails> </ArrayOfAnnouncementTypeAndSubTypeDetails>