POST v1/Institutions/{id}/Contact

Description

Add a new Contact

Base Url

https://services.wsoweb.com/


Rest Call Syntax


POST Reference/v1/Institutions/{id}/Contact

POST Reference/v1/Institutions/{id}/Contact

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete



ContactAdd

Name

Description

Type

Additional Information

ContactName

The name of the Contact Type

string

Required

Index

The index of the Contact

string

Required

InstitutionId

The WSO ID of the Institution the Contact is associated with

integer

Required

Address

The Address of the Contact

string

Email

The email address of the Contact

string

Fax

The Fax number of the Contact

string

Notes

The notes for the Contact

string

Phone

The Phone number of the Contact

string




Limitations

There are no limitations specified.




Request Information


Parameters

Name

Description

Type

Additional Information

id

Institution Id

integer

Required



Request body formats


application/json, text/json

Sample:
{
  "contactName": "sample string 1",
  "index": "sample string 2",
  "institutionId": 3,
  "address": "sample string 4",
  "phone": "sample string 5",
  "fax": "sample string 6",
  "email": "sample string 7",
  "notes": "sample string 8"
}

application/xml, text/xml

Sample:
<ContactAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Address>sample string 4</Address>
  <ContactName>sample string 1</ContactName>
  <Email>sample string 7</Email>
  <Fax>sample string 6</Fax>
  <Index>sample string 2</Index>
  <InstitutionId>3</InstitutionId>
  <Notes>sample string 8</Notes>
  <Phone>sample string 5</Phone>
</ContactAdd>

application/x-www-form-urlencoded

Sample:

Sample not available.




Response Information



Contact

Name

Description

Type

Additional Information

AddDate

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

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

The address of the contact

string

ContactName

The name of the contact

string

Email

The email address for this contact

string

Fax

The FAX number of the contact.

string

Id

The unique id for the item

integer

Index

The value by which this contact should be indexed - usually last name.

string

Institution

Link to the Bank/Institution id for the item

InstitutionId

The Bank/Institution id for the item

integer

IsDeleted

True or False - Has this contact been deleted?

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 to related object

Collection of Link

Notes

Notes about the contact.

string

Phone

The phone number of the contact.

string




Response Body Formats



application/json, text/json

Sample:
{
  "id": 1,
  "institutionId": 2,
  "institution": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "address": "sample string 3",
  "contactName": "sample string 4",
  "fax": "sample string 5",
  "index": "sample string 6",
  "isDeleted": true,
  "notes": "sample string 8",
  "phone": "sample string 9",
  "email": "sample string 10",
  "addDate": "2024-11-23T01:46:52.6893672-06:00",
  "addId": "sample string 13",
  "addNode": "sample string 14",
  "lastChangeDate": "2024-11-23T01:46:52.6902056-06:00",
  "lastChangeId": "sample string 16",
  "lastChangeNode": "sample string 17",
  "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:
<Contact xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AddDate>2024-11-23T01:46:52.6893672-06:00</AddDate>
  <AddId>sample string 13</AddId>
  <AddNode>sample string 14</AddNode>
  <Address>sample string 3</Address>
  <ContactName>sample string 4</ContactName>
  <Email>sample string 10</Email>
  <Fax>sample string 5</Fax>
  <Id>1</Id>
  <Index>sample string 6</Index>
  <Institution>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Institution>
  <InstitutionId>2</InstitutionId>
  <IsDeleted>true</IsDeleted>
  <LastChangeDate>2024-11-23T01:46:52.6902056-06:00</LastChangeDate>
  <LastChangeId>sample string 16</LastChangeId>
  <LastChangeNode>sample string 17</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 8</Notes>
  <Phone>sample string 9</Phone>
</Contact>



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.