GET api/oids?lastUpdated={lastUpdated}&branchOID={branchOID}&includeGrandChildren={includeGrandChildren}

API to retreive OIDs stored in the AAVLD OID arc. Pass in a date to search for OIDs that have been updated since then. Limit to a specific branch by passing in the branch OID as the branchOID parameter. Leaveing both parameters blank will return all OIDs in the AAVLD arc.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
lastUpdated

All OIDs will be returned that have been updated since this date. All dates are stored as UTC.

 string

None.
branchOID

Passing in a specific branch oid will return all OIDs under that branch.

 string

None.
includeGrandChildren

Pass this parameter with a value of true to include all grand children for the branchOID passed in.

 boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of OID
NameDescriptionTypeAdditional information
symbol

Symbol or short name to identify the OID.

 string

None.
description

A description of what the OID represents.

 string

None.
dateCreated

The date the OID was created. Stored as UTC.

 string

None.
lastUpdated

The date the OID was last updated or was deprecated. Stored as UTC.

 string

None.
isActive

Denotes whether the OID is still in use or not.

 boolean

None.
entityAbbreviation

The abbreviation of the OID's entity if applicable.

 string

None.
entityName

The name of the OID's entity if applicable.

 string

None.
entityAddress1

The first address line of the OID's entity if applicable.

 string

None.
entityPhone

The phone number of the OID's entity if applicable.

 string

None.
entityEmail

The email of the OID's entity if applicable.

 string

None.
entityURL

The URL of the OID's entity if applicable.

 string

None.
entityState

The state of the OID's entity if applicable.

 string

None.
entityCity

The city of the OID's entity if applicable.

 string

None.
entityCountry

The country of the OID's entity if applicable.

 string

None.
entityPostalCode

The postal code of the OID's entity if applicable.

 string

None.
entityAddress2

The second address line of the OID's entity if applicable.

 string

None.
entityAddress3

The third address line of the OID's entity if applicable.

 string

None.
ContactPersonName

string

None.
contactPersonEmail

The contact person's email of the OID's entity if applicable.

 string

None.
oid

The full OID code.

 string

None.

Response Formats

Add an Accept header to the request with your preferred format.

application/json, text/json

Sample: 
[
  {
    "contactPersonName": "sample string 27",
    "symbol": "sample string 3",
    "description": "sample string 4",
    "dateCreated": "05/19/2024",
    "lastUpdated": "05/19/2024",
    "isActive": true,
    "entityAbbreviation": "sample string 14",
    "entityName": "sample string 15",
    "entityAddress1": "sample string 16",
    "entityPhone": "sample string 17",
    "entityEmail": "sample string 18",
    "entityURL": "sample string 19",
    "entityState": "sample string 20",
    "entityCity": "sample string 21",
    "entityCountry": "sample string 22",
    "entityPostalCode": "sample string 23",
    "entityAddress2": "sample string 24",
    "entityAddress3": "sample string 25",
    "ContactPersonName": "sample string 27",
    "contactPersonEmail": "sample string 28",
    "oid": "2.16.840.1.113883.3.5.sample string 2"
  },
  {
    "contactPersonName": "sample string 27",
    "symbol": "sample string 3",
    "description": "sample string 4",
    "dateCreated": "05/19/2024",
    "lastUpdated": "05/19/2024",
    "isActive": true,
    "entityAbbreviation": "sample string 14",
    "entityName": "sample string 15",
    "entityAddress1": "sample string 16",
    "entityPhone": "sample string 17",
    "entityEmail": "sample string 18",
    "entityURL": "sample string 19",
    "entityState": "sample string 20",
    "entityCity": "sample string 21",
    "entityCountry": "sample string 22",
    "entityPostalCode": "sample string 23",
    "entityAddress2": "sample string 24",
    "entityAddress3": "sample string 25",
    "ContactPersonName": "sample string 27",
    "contactPersonEmail": "sample string 28",
    "oid": "2.16.840.1.113883.3.5.sample string 2"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfOIDObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AAVLD_OID.Models">
  <OIDObject>
    <ContactPersonEmail>sample string 28</ContactPersonEmail>
    <ContactPersonName>sample string 27</ContactPersonName>
    <DateCreated>05/19/2024</DateCreated>
    <Description>sample string 4</Description>
    <EntityAbbreviation>sample string 14</EntityAbbreviation>
    <EntityAddress1>sample string 16</EntityAddress1>
    <EntityAddress2>sample string 24</EntityAddress2>
    <EntityAddress3>sample string 25</EntityAddress3>
    <EntityCity>sample string 21</EntityCity>
    <EntityCountry>sample string 22</EntityCountry>
    <EntityEmail>sample string 18</EntityEmail>
    <EntityName>sample string 15</EntityName>
    <EntityPhone>sample string 17</EntityPhone>
    <EntityState>sample string 20</EntityState>
    <EntityURL>sample string 19</EntityURL>
    <EntityZip>sample string 23</EntityZip>
    <IsActive>true</IsActive>
    <LastUpdated>05/19/2024</LastUpdated>
    <OID>2.16.840.1.113883.3.5.sample string 2</OID>
    <Symbol>sample string 3</Symbol>
  </OIDObject>
  <OIDObject>
    <ContactPersonEmail>sample string 28</ContactPersonEmail>
    <ContactPersonName>sample string 27</ContactPersonName>
    <DateCreated>05/19/2024</DateCreated>
    <Description>sample string 4</Description>
    <EntityAbbreviation>sample string 14</EntityAbbreviation>
    <EntityAddress1>sample string 16</EntityAddress1>
    <EntityAddress2>sample string 24</EntityAddress2>
    <EntityAddress3>sample string 25</EntityAddress3>
    <EntityCity>sample string 21</EntityCity>
    <EntityCountry>sample string 22</EntityCountry>
    <EntityEmail>sample string 18</EntityEmail>
    <EntityName>sample string 15</EntityName>
    <EntityPhone>sample string 17</EntityPhone>
    <EntityState>sample string 20</EntityState>
    <EntityURL>sample string 19</EntityURL>
    <EntityZip>sample string 23</EntityZip>
    <IsActive>true</IsActive>
    <LastUpdated>05/19/2024</LastUpdated>
    <OID>2.16.840.1.113883.3.5.sample string 2</OID>
    <Symbol>sample string 3</Symbol>
  </OIDObject>
</ArrayOfOIDObject>