PUT v1/IndustryCodeTypes/{id}/Values/{industryCodeValueId}

Description

Update industry code value with WSO ID of {industryCodeValueId} for industry code type with WSO ID of {id}.

Base Url

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


Rest Call Syntax


PUT SecurityMaster/v1/IndustryCodeTypes/{id}/Values/{industryCodeValueId}

PUT SecurityMaster/v1/IndustryCodeTypes/{id}/Values/{industryCodeValueId}

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete



IndustryCodeValueUpdate

Name

Description

Type

Additional Information

Code

The code

string

IndustryCodeValueNameUpdated

The name of the Industry Code Value to update

string

Notes

The Notes

string

SortOrder

The sort order for the Industry Code

integer




Limitations

There are no limitations specified.




Request Information


Parameters

Name

Description

Type

Additional Information

id

WSO ID of industry code type

integer

Required

industryCodeValueId

WSO ID of industry code value

integer

Required



Request body formats


application/json, text/json

Sample:
{
  "industryCodeValueNameUpdated": "sample string 2",
  "code": "sample string 3",
  "notes": "sample string 4",
  "sortOrder": 1
}

application/xml, text/xml

Sample:
<IndustryCodeValueUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Code>sample string 3</Code>
  <IndustryCodeValueNameUpdated>sample string 2</IndustryCodeValueNameUpdated>
  <Notes>sample string 4</Notes>
  <SortOrder>1</SortOrder>
</IndustryCodeValueUpdate>

application/x-www-form-urlencoded

Sample:

Sample not available.




Response Information



IndustryCodeValue

Name

Description

Type

Additional Information

Code

The code of the Industry Code Value

string

Id

integer

IndustryCodeType

The Hateoas Link to the parent Industry Code Type

IndustryCodeTypeId

The WSO ID of the industry code type

integer

IndustryCodeTypeName

The name of the industry code type

string

IndustryCodeValueName

The name of the industry code value

string

IsDeleted

The flag indicating if the industry code value is deleted

boolean

Links

A list of Hateoas links for the industry code

Collection of Link

Notes

The notes for the industry code value

string

SortOrder

The sort order of the industry code value

integer




Response Body Formats



application/json, text/json

Sample:
{
  "id": 1,
  "code": "sample string 2",
  "isDeleted": true,
  "notes": "sample string 4",
  "industryCodeTypeId": 5,
  "industryCodeTypeName": "sample string 6",
  "industryCodeValueName": "sample string 7",
  "sortOrder": 1,
  "industryCodeType": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "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:
<IndustryCodeValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Code>sample string 2</Code>
  <Id>1</Id>
  <IndustryCodeType>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </IndustryCodeType>
  <IndustryCodeTypeId>5</IndustryCodeTypeId>
  <IndustryCodeTypeName>sample string 6</IndustryCodeTypeName>
  <IndustryCodeValueName>sample string 7</IndustryCodeValueName>
  <IsDeleted>true</IsDeleted>
  <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>
  <Notes>sample string 4</Notes>
  <SortOrder>1</SortOrder>
</IndustryCodeValue>



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.