GET v1/Traders/{id}

Description

Retrieve a trader with WSO ID of {id}.

Base Url

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


Rest Call Syntax


GET TradeManagement/v1/Traders/{id}

GET TradeManagement/v1/Traders/{id}

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete




Limitations

There are no limitations specified.




Request Information


Parameters

Name

Description

Type

Additional Information

id

WSO ID of the trader

integer

Required




Response Information


Get All Traders


Trader

Name

Description

Type

Additional Information

AddDate

Gets or sets the date that a record was added to the database.

date

AddId

Gets or sets the UserId of the user who added the record.

string

AddNode

Gets or sets the name of the machine where the record was added from.

string

Address

Gets or sets the address of the Trader.

string

CompanyId

Gets or sets the Company related to the Trader

integer

Email

Gets or sets the email address of the Trader.

string

Fax

Gets or sets the fax number of the Trader.

string

Id

Gets or sets the Id of the trader.

integer

Index

Gets or sets the Trader index.

string

IsDeleted

Gets or sets a flag indicating whether or not the trader has been soft-deleted in the system.

boolean

LastChangeDate

Gets or sets the date when the record was last changed.

date

LastChangeId

Gets or sets the UserId of the user who last changed this record.

string

LastChangeNode

Gets or sets the name of the machine where the record was last changed from.

string

Links

The Hateoas links related to this trader item

Collection of Link

Notes

Gets or sets notes related to the Trader.

string

Phone

Gets or sets the phone number of the Trader.

string

TraderName

Gets or sets the name of the Trader.

string

Udfs

Link to Udfs




Response Body Formats



application/json, text/json

Sample:
{
  "id": 1,
  "isDeleted": true,
  "traderName": "sample string 3",
  "index": "sample string 4",
  "address": "sample string 5",
  "phone": "sample string 6",
  "fax": "sample string 7",
  "email": "sample string 8",
  "notes": "sample string 9",
  "companyId": 1,
  "addDate": "2024-10-08T11:40:13.768518+01:00",
  "addId": "sample string 12",
  "addNode": "sample string 13",
  "lastChangeDate": "2024-10-08T11:40:13.768518+01:00",
  "lastChangeId": "sample string 15",
  "lastChangeNode": "sample string 16",
  "udfs": {
    "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:
<Trader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AddDate>2024-10-08T11:40:13.768518+01:00</AddDate>
  <AddId>sample string 12</AddId>
  <AddNode>sample string 13</AddNode>
  <Address>sample string 5</Address>
  <CompanyId>1</CompanyId>
  <Email>sample string 8</Email>
  <Fax>sample string 7</Fax>
  <Id>1</Id>
  <Index>sample string 4</Index>
  <IsDeleted>true</IsDeleted>
  <LastChangeDate>2024-10-08T11:40:13.768518+01:00</LastChangeDate>
  <LastChangeId>sample string 15</LastChangeId>
  <LastChangeNode>sample string 16</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>
  <Notes>sample string 9</Notes>
  <Phone>sample string 6</Phone>
  <TraderName>sample string 3</TraderName>
  <Udfs>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Udfs>
</Trader>



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.