POST v1/IdentifierTypes

Description

Add a new identifier type.

Base Url

https://api-zion.wsohosting.com/


Rest Call Syntax


POST SecurityMaster/v1/IdentifierTypes

POST SecurityMaster/v1/IdentifierTypes

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete



IdentifierTypeAdd

Name

Description

Type

Additional Information

IdentifierTypeName

The name of the identifier type

string

Required

IdcPrefix

A prefix used in IDC integration

string




Limitations

There are no limitations specified.




Request Information


Request body formats


application/json, text/json

Sample:
{
  "identifierTypeName": "sample string 1",
  "idcPrefix": "sample string 2"
}

application/xml, text/xml

Sample:
<IdentifierTypeAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <IdcPrefix>sample string 2</IdcPrefix>
  <IdentifierTypeName>sample string 1</IdentifierTypeName>
</IdentifierTypeAdd>

application/x-www-form-urlencoded

Sample:

Sample not available.




Response Information



IdentifierType

Name

Description

Type

Additional Information

Id

The WSO ID of the identifier type

integer

IdcPrefix

A prefix used in IDC integration

string

IdentifierTypeName

The name of the identifier type

string

IsDeleted

A flag indicating if the identifier type is soft-deleted in the system

boolean

Links

The Hateoas links to related object

Collection of Link




Response Body Formats



application/json, text/json

Sample:
{
  "id": 1,
  "identifierTypeName": "sample string 2",
  "idcPrefix": "sample string 3",
  "isDeleted": 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"
    }
  ]
}

application/xml, text/xml

Sample:
<IdentifierType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WSO.API.SecurityMaster.Models.v1">
  <Id>1</Id>
  <IdcPrefix>sample string 3</IdcPrefix>
  <IdentifierTypeName>sample string 2</IdentifierTypeName>
  <IsDeleted>true</IsDeleted>
  <Links>
    <Link xmlns="">
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
    <Link xmlns="">
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
  </Links>
</IdentifierType>



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.