POST v1/ABS/{id}/Identifiers

Description

Add an identifier for ABS with WSO ID of {id}.

Base Url

https://api-mgi.uat.wsohosting.com/


Rest Call Syntax


POST SecurityMaster/v1/ABS/{id}/Identifiers

POST SecurityMaster/v1/ABS/{id}/Identifiers

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete



IdentifierAdd

Name

Description

Type

Additional Information

IdentifierTypeId

WSO ID of the identifier type

integer

Required, Identifier Type must be unique.

IdentifierValue

The identifier value

string

Required, Identifier value must be unique to the Identifier Type.

IsPrimary

The flag indicating if this is the primary security ID for the asset

boolean




Limitations

There are no limitations specified.




Request Information


Parameters

Name

Description

Type

Additional Information

id

The WSO ID of ABS

integer

Required



Request body formats


application/json, text/json

Sample:
{
  "identifierTypeId": 1,
  "identifierValue": "sample string 3",
  "isPrimary": true
}

application/xml, text/xml

Sample:
<IdentifierAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WSO.API.SecurityMaster.Models.v1">
  <IdentifierTypeId>1</IdentifierTypeId>
  <IdentifierValue>sample string 3</IdentifierValue>
  <IsPrimary>true</IsPrimary>
</IdentifierAdd>

application/x-www-form-urlencoded

Sample:

Sample not available.




Response Information



Identifier

Name

Description

Type

Additional Information

AddDate

date

AddId

string

AddNode

string

Id

The WSO ID for the identifier object

integer

IdentifierType

The identifier type name

string

IdentifierTypeId

WSO ID of the identifier type

integer

IdentifierValue

The identifier value

string

IsPrimary

The flag indicating if this is the primary security ID for the asset

boolean

LastChangeDate

date

LastChangeId

string

LastChangeNode

string

Links

A list of Hateoas links for the identifier

Collection of Link




Response Body Formats



application/json, text/json

Sample:
{
  "id": 1,
  "identifierTypeId": 3,
  "identifierType": "sample string 4",
  "identifierValue": "sample string 5",
  "isPrimary": true,
  "links": [
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    },
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    }
  ],
  "addDate": "2024-10-08T11:41:09.1545179+01:00",
  "addId": "sample string 9",
  "addNode": "sample string 10",
  "lastChangeDate": "2024-10-08T11:41:09.1545179+01:00",
  "lastChangeId": "sample string 12",
  "lastChangeNode": "sample string 13"
}

application/xml, text/xml

Sample:
<Identifier xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AddDate>2024-10-08T11:41:09.1545179+01:00</AddDate>
  <AddId>sample string 9</AddId>
  <AddNode>sample string 10</AddNode>
  <Id>1</Id>
  <IdentifierType>sample string 4</IdentifierType>
  <IdentifierTypeId>3</IdentifierTypeId>
  <IdentifierValue>sample string 5</IdentifierValue>
  <IsPrimary>true</IsPrimary>
  <LastChangeDate>2024-10-08T11:41:09.1545179+01:00</LastChangeDate>
  <LastChangeId>sample string 12</LastChangeId>
  <LastChangeNode>sample string 13</LastChangeNode>
  <Links>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
  </Links>
</Identifier>



Feedback



(0 out of 1500 characters used)
Feedback has been submitted. Thank you for your feedback.
Automatic feedback submission has been turned off by your system administrator. Your feedback has been logged to the exceptions table. Please contact support to find out how to manually send in your feedback. Thank you.