Unified Record Format - Vanilla Success
<main> <article class="userContent"> <div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/SL92LIGYYEAI/microsoftteams-image-288-29.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/SL92LIGYYEAI/microsoftteams-image-288-29.png" alt="MicrosoftTeams-image (8).png" height="108" width="1356" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>For the sake of consistency and ease of consuming its endpoints, usage of common field names is recommended.</p><h2 data-id="common-fields">Common Fields</h2><ul><li><code class="code codeInline" spellcheck="false" tabindex="0">name</code>: A title for the resource (e.g. a discussion’s title).</li><li><code class="code codeInline" spellcheck="false" tabindex="0">body</code>: The primary text content of a resource (e.g. a comment’s text).</li><li><code class="code codeInline" spellcheck="false" tabindex="0">format</code>: Field specifying what format <strong>body</strong> is in.</li><li><code class="code codeInline" spellcheck="false" tabindex="0">insertUserID</code>: Unique numeric ID of the user who created this resource.</li><li><code class="code codeInline" spellcheck="false" tabindex="0">dateInserted</code>: Full datetime the resource was created.</li><li><code class="code codeInline" spellcheck="false" tabindex="0">insertIPAddress</code>: IP address associated with the user who created this resource, at the time it was created.</li><li><code class="code codeInline" spellcheck="false" tabindex="0">updateUserID</code>: Unique numeric ID of the user who last updated this resource.</li><li><code class="code codeInline" spellcheck="false" tabindex="0">dateUpdated</code>: Full datetime the resource was last updated.</li><li><code class="code codeInline" spellcheck="false" tabindex="0">updateIPAddress</code>: IP address associated with the user who last updated this resource, at the time the update was made.</li><li><code class="code codeInline" spellcheck="false" tabindex="0">key</code>: A unique string identifier for a resource (e.g. “urlCode”).</li><li><code class="code codeInline" spellcheck="false" tabindex="0">status</code>: An indicator for the condition of a resource (e.g. “state”).</li></ul><p>If a resource has a field that is analogous to a common field, it should populate that field with its value. For example, if a row has a <code class="code codeInline" spellcheck="false" tabindex="0">text</code> field and no <code class="code codeInline" spellcheck="false" tabindex="0">body</code> field, and the purpose is the same, a <code class="code codeInline" spellcheck="false" tabindex="0">body</code> field should be added with the contents of <code class="code codeInline" spellcheck="false" tabindex="0">text</code>. This would be done so the data is easily consumed. No further modification of the rows is necessary. Various fields, unique to each resource type, remain in the row as part of the full dataset.</p><h2 data-id="multi-resource-responses">Multi-Resource Responses</h2><p>API endpoints returning datasets containing different types of resources (e.g. search) will need to include two additional fields for each row.</p><ul><li><code class="code codeInline" spellcheck="false" tabindex="0">recordType</code>: The type of resource (e.g. discussion).</li><li><code class="code codeInline" spellcheck="false" tabindex="0">recordID</code>: The unique ID of the resource row (e.g. a discussion’s numerical ID).</li></ul><p>The unique ID field for a row should not be removed when <code class="code codeInline" spellcheck="false" tabindex="0">recordID</code> is added. For example, <code class="code codeInline" spellcheck="false" tabindex="0">commentID</code> and <code class="code codeInline" spellcheck="false" tabindex="0">recordID</code> are valid on a single row, simultaneously.</p> </article> </main>