PUT v1/IdentifierTypes/{id}

Description

Update the identifier type with WSO ID of {id}.

Base Url

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

Rest Call Syntax


PUT SecurityMaster/v1/IdentifierTypes/{id}

Execute API

PUT SecurityMaster/v1/IdentifierTypes/{id}

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete

 

Delete



IdentifierTypeUpdate

Name

Description

Type

Additional Information

IdcPrefix

A prefix used in IDC integration

string

IdentifierTypeName

The name of the identifier type

string



Limitations

There are no limitations specified.



Request Information


Parameters

Name

Description

Type

Additional Information

id

WSO ID of identifier type

integer

Required



Request body formats


application/json, text/json

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

application/xml, text/xml

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

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