GET v1/Associations

Description

Retrieve list of associationTypes satisfying the input search criteria.

Base Url

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


Rest Call Syntax


GET SecurityMaster/v1/Associations

GET SecurityMaster/v1/Associations

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

AssociationTypeNameStartsWith

AssociationTypeNameStartsWith value to search

string

IsDeleted

IsDeleted value to search

PageNumber

Specified Page number to search

integer

PageSize

Specified Page size to search

integer




Response Information



PagedList Of AssociationType

Name

Description

Type

Additional Information

Items

Collection of AssociationType

Links

Collection of Link

PagingInformation




Response Body Formats



application/json, text/json

Sample:
{
  "items": [
    {
      "abbreviation": "sample string 1",
      "id": 2,
      "associationTypeName": "sample string 3",
      "isDefault": true,
      "isDeleted": true,
      "addDate": "2024-10-08T05:31:21.5543316-05:00",
      "addId": "sample string 8",
      "addNode": "sample string 9",
      "lastChangeDate": "2024-10-08T05:31:21.5543316-05:00",
      "lastChangeId": "sample string 11",
      "lastChangeNode": "sample string 12",
      "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"
        }
      ]
    },
    {
      "abbreviation": "sample string 1",
      "id": 2,
      "associationTypeName": "sample string 3",
      "isDefault": true,
      "isDeleted": true,
      "addDate": "2024-10-08T05:31:21.5543316-05:00",
      "addId": "sample string 8",
      "addNode": "sample string 9",
      "lastChangeDate": "2024-10-08T05:31:21.5543316-05:00",
      "lastChangeId": "sample string 11",
      "lastChangeNode": "sample string 12",
      "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"
        }
      ]
    }
  ],
  "pagingInformation": {
    "totalItems": 1,
    "totalPages": 2,
    "itemsPerPage": 3,
    "currentPage": 4,
    "startRow": 5,
    "endRow": 6
  },
  "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:
<PagedListOfAssociationType xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <AssociationType>
      <Abbreviation>sample string 1</Abbreviation>
      <AddDate>2024-10-08T05:31:21.5543316-05:00</AddDate>
      <AddId>sample string 8</AddId>
      <AddNode>sample string 9</AddNode>
      <AssociationTypeName>sample string 3</AssociationTypeName>
      <Id>2</Id>
      <IsDefault>true</IsDefault>
      <IsDeleted>true</IsDeleted>
      <LastChangeDate>2024-10-08T05:31:21.5543316-05:00</LastChangeDate>
      <LastChangeId>sample string 11</LastChangeId>
      <LastChangeNode>sample string 12</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>
    </AssociationType>
    <AssociationType>
      <Abbreviation>sample string 1</Abbreviation>
      <AddDate>2024-10-08T05:31:21.5543316-05:00</AddDate>
      <AddId>sample string 8</AddId>
      <AddNode>sample string 9</AddNode>
      <AssociationTypeName>sample string 3</AssociationTypeName>
      <Id>2</Id>
      <IsDefault>true</IsDefault>
      <IsDeleted>true</IsDeleted>
      <LastChangeDate>2024-10-08T05:31:21.5543316-05:00</LastChangeDate>
      <LastChangeId>sample string 11</LastChangeId>
      <LastChangeNode>sample string 12</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>
    </AssociationType>
  </Items>
  <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>
  <PagingInformation>
    <CurrentPage>4</CurrentPage>
    <EndRow>6</EndRow>
    <ItemsPerPage>3</ItemsPerPage>
    <StartRow>5</StartRow>
    <TotalItems>1</TotalItems>
    <TotalPages>2</TotalPages>
  </PagingInformation>
</PagedListOfAssociationType>



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.