Address Groups

Quick Navigation

GET Organizations/{orgID}/addressgroups

List the address groups for a given organization.

  • Current user has access to the organization.
  • Asset Management (Read)

orgId: Organization ID.

None

Content-Type: application/json

[
    {
        AddressGroupID: int,
        Name: string,
        OrganizationID: guid // can be null
    }
]

200 - Request successful

For more information, please see Common Response Codes.

GET Addressgroups

List the address groups.

  • Current user has access to the organization.
  • Asset Management (Read)

None

None

Content-Type: application/json

[
    {
        AddressGroupID: int,
        Name: string,
        OrganizationID: guid // can be null
    {
]

200 - Request successful

For more information, please see Common Response Codes.

GET Addressgroups/{addressGroupId}/addresses

List the addresses for an address group.

  • Current user has access to the organization.
  • Asset Management (Read)

addressGroupId: Address Group ID.

None

Content-Type: application/json

[
    {
        AddressID: int,
        AddressGroupID: int,
        Omit: boolean,
        Type: string,
        Value: string,
        LastUpdatedDate: datetime
    }
]

200 - Request successful

For more information, please see Common Response Codes.

POST AddressGroups/{id}/Addresses

Create an address in an Address Book.

  • Asset Management (Read/Write)

addressGroupId: Address Group ID.

{
    Type: int,
    Value: string,
    Omit: bool
}

Max string length for Value is 225.

Content-Type: application/json

{
    AddressID: int,
    AddressGroupID: int,
    Omit: bool,
    Type: int,
    Value: string,
    LastUpdatedDate: datetime
}

201 - Request successful. Address in the response body.

For more information, please see Common Response Codes.

DELETE Addressgroups/{addressGroupId}

Delete the address group and all it's addresses.

  • Current user has access to the organization.
  • Asset Management (Read/Write)

addressGroupId: Address Group ID.

None

None

200 - Request successful

For more information, please see Common Response Codes.

DELETE Addressgroups/{addressGroupId}/addresses

Delete the addresses within the address group.

  • Current user has access to the organization.
  • Asset Management (Read/Write)

addressGroupId: Address Group ID.

None

None

200 - Request successful

For more information, please see Common Response Codes.

GET AddressGroups/?name={name}

Returns the Address Group by name.

  • Asset Management (Read)

name: Name of the Address Group.

None.

Content-Type: application/json

{
    AddressGroupID: int,
    Name: string
}

200 - Request successful. Address Group in the response body.

For more information, please see Common Response Codes.

GET AddressGroups/{id}

Returns the Address Group by ID.

  • Asset Management (Read)

id: ID of the Address Group.

None.

Content-Type: application/json

{
    AddressGroupID: int,
    Name: string
}

200 - Request successful. Address Group in the response body.

For more information, please see Common Response Codes.

PUT Addresses/{id}

Updates and Address by ID.

  • Asset Management (Read/Write)

Content-Type: application/json

{
    Type: int,
    Value: string,
    Omit: bool
}

Max string length for Value is 225.

Content-Type: application/json

{
    AddressD: int,
    AddressGroupID: int,
    Omit: bool,
    Type: int,
    Value: string,
    LastUpdateDate: datetime
}

200 - Request successful. Address in the response body.

For more information, please see Common Response Codes.

PUT AddressGroups/{id}

Updates and Address Group by ID.

  • Asset Management (Read/Write)

Content-Type: application/json

{
    Name: string,
}

Max string length for Name is 225.

Content-Type: application/json

{
    AddressGroupID: int,
    Name: string
}

200 - Request successful. Address Group in the response body.

For more information, please see Common Response Codes.

POST AddressGroups

Creates an Address Book.

  • Asset Management (Read/Write)

Content-Type: application/json

{
    Name: string
}

Max string length for Name is 225.

Content-Type: application/json

{
    AddressGroupID: int,
    Name: string
}

201 - Request successful. Address Group in the response body.

For more information, please see Common Response Codes.

GET Addresses/{id}

Returns the Address by ID.

  • Asset Management (Read)

id: ID of the Address

None

Content-Type: application/json

{
    AddressId: int,
    AddressGroupId : int,
    Omit: bool,
    Type: string,
    Value: string,
    LastUpdateDate: datetime
}

200 - Request successful. Address in the response body.

For more information, please see Common Response Codes.

DELETE Addresses/{id}

Deletes an Address by ID.

Asset Management (Read/Write)

None

None

200 - Request successful.

For more information, please see Common Response Codes.