POST v1/Associations/{id}/Values/{associationValueId}/Details

Description

Add a association detail with WSO ID of {associationDetailId} for association value and type with a WSO ID of {associationValueId} and {associationTypeId}.

Base Url

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


Rest Call Syntax


POST SecurityMaster/v1/Associations/{id}/Values/{associationValueId}/Details

POST SecurityMaster/v1/Associations/{id}/Values/{associationValueId}/Details

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete



AssociationDetailAdd

Name

Description

Type

Additional Information

AssociationDetailName

Gets or sets the associationDetailName of the associationDetail.

string

EndDate

The end of date of the associationDetail

date

PositionId

Gets or sets the PositionId of the associationDetail.

integer

StartDate

The start of date of the associationDetail

date




Limitations

There are no limitations specified.




Request Information


Parameters

Name

Description

Type

Additional Information

associationValueId

WSO ID of association value

integer

Required

id

WSO ID of association type

integer

Required



Request body formats


application/json, text/json

Sample:
{
  "positionId": 3,
  "associationDetailName": "sample string 4",
  "startDate": "2024-10-08T05:38:09.2180178-05:00",
  "endDate": "2024-10-08T05:38:09.2180178-05:00"
}

application/xml, text/xml

Sample:
<AssociationDetailAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AssociationDetailName>sample string 4</AssociationDetailName>
  <EndDate>2024-10-08T05:38:09.2180178-05:00</EndDate>
  <PositionId>3</PositionId>
  <StartDate>2024-10-08T05:38:09.2180178-05:00</StartDate>
</AssociationDetailAdd>

application/x-www-form-urlencoded

Sample:

Sample not available.




Response Information



AssociationDetail

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

AssociationDetailName

AssociationDetail name

string

AssociationDisplayName

AssociationDetail display name

string

AssociationType

The Hateoas Link to the parent AssociationType.

AssociationValue

The Hateoas Link to the parent AssociationType.

AssociationValueId

The AssociationValue ID for this object.

integer

EndDate

Date the object was removed from the AssociationDetail

date

Id

The unique ID for this object.

integer

IsActive

isActive AssociationDetail

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 issuer

Collection of Link

PositionId

Data object that belongs to the AssociationDetail

integer

StartDate

Date the object was added to the AssociationDetail

date




Response Body Formats



application/json, text/json

Sample:
{
  "associationValueId": 1,
  "associationDetailName": "sample string 2",
  "associationDisplayName": "sample string 3",
  "id": 4,
  "startDate": "2024-10-08T05:38:09.2336245-05:00",
  "endDate": "2024-10-08T05:38:09.2336245-05:00",
  "isActive": true,
  "positionId": 7,
  "addDate": "2024-10-08T05:38:09.2336245-05:00",
  "addId": "sample string 9",
  "addNode": "sample string 10",
  "lastChangeDate": "2024-10-08T05:38:09.2336245-05:00",
  "lastChangeId": "sample string 12",
  "lastChangeNode": "sample string 13",
  "associationType": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "associationValue": {
    "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:
<AssociationDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WSO.API.SecurityMaster.Models.v1">
  <AddDate>2024-10-08T05:38:09.2336245-05:00</AddDate>
  <AddId>sample string 9</AddId>
  <AddNode>sample string 10</AddNode>
  <AssociationDetailName>sample string 2</AssociationDetailName>
  <AssociationDisplayName>sample string 3</AssociationDisplayName>
  <AssociationType>
    <Rel xmlns="">sample string 2</Rel>
    <Uri xmlns="">http://webapihelppage3.com/</Uri>
    <Verb xmlns="">sample string 1</Verb>
  </AssociationType>
  <AssociationValue>
    <Rel xmlns="">sample string 2</Rel>
    <Uri xmlns="">http://webapihelppage3.com/</Uri>
    <Verb xmlns="">sample string 1</Verb>
  </AssociationValue>
  <AssociationValueId>1</AssociationValueId>
  <EndDate>2024-10-08T05:38:09.2336245-05:00</EndDate>
  <Id>4</Id>
  <IsActive>true</IsActive>
  <LastChangeDate>2024-10-08T05:38:09.2336245-05:00</LastChangeDate>
  <LastChangeId>sample string 12</LastChangeId>
  <LastChangeNode>sample string 13</LastChangeNode>
  <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>
  <PositionId>7</PositionId>
  <StartDate>2024-10-08T05:38:09.2336245-05:00</StartDate>
</AssociationDetail>



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.