Address Groups
Quick Navigation
- GET Organizations/{orgID}/addressgroups
- GET Addresses/{id}
- GET Addressgroups
- GET AddressGroups/{id}
- GET Addressgroups/{addressGroupId}/addresses
- GET AddressGroups/?name={name}
- POST AddressGroups/{id}/Addresses
- POST AddressGroups
- DELETE Addresses/{id}
- DELETE Addressgroups/{addressGroupId}
- DELETE Addressgroups/{addressGroupId}/addresses
- PUT Addresses/{id}
- PUT AddressGroups/{id}
GET Organizations/{orgID}/addressgroups
Purpose
List the address groups for a given organization.
Required Permissions
- Current user has access to the organization.
- Asset Management (Read).
URL Parameters
orgId: Organization ID.
Request Body
None.
Response Body
Content-Type: application/json
[ { AddressGroupID: int, Name: string, OrganizationID: guid // can be null } ]
Response Codes
200 - Request successful.
For more information, please see Common Response Codes.
GET Addressgroups
Purpose
List the address groups.
Required Permissions
- Current user has access to the organization.
- Asset Management (Read).
URL Parameters
None.
Request Body
None.
Response Body
Content-Type: application/json
[ { AddressGroupID: int, Name: string, OrganizationID: guid // can be null { ]
Response Codes
200 - Request successful.
For more information, please see Common Response Codes.
GET Addressgroups/{addressGroupId}/addresses
Purpose
List the addresses for an address group.
Required Permissions
- Current user has access to the organization.
- Asset Management (Read).
URL Parameters
addressGroupId: Address Group ID.
Request Body
None.
Response Body
Content-Type: application/json
[ { AddressID: int, AddressGroupID: int, Omit: boolean, Type: string, Value: string, LastUpdatedDate: datetime } ]
Response Codes
200 - Request successful.
For more information, please see Common Response Codes.
POST AddressGroups/{id}/Addresses
Purpose
Create an address in an Address Book.
Required Permissions
- Asset Management (Read/Write).
URL Parameters
addressGroupId: Address Group ID.
Request Body
{ Type: int, Value: string, Omit: bool }
Request Body Details
Max string length for Value is 225.
Response Body
Content-Type: application/json
{ AddressID: int, AddressGroupID: int, Omit: bool, Type: int, Value: string, LastUpdatedDate: datetime }
Response Codes
201 - Request successful. Address in the response body.
For more information, please see Common Response Codes.
DELETE Addressgroups/{addressGroupId}
Purpose
Delete the address group and all it's addresses.
Required Permissions
- Current user has access to the organization.
- Asset Management (Read/Write).
URL Parameters
addressGroupId: Address Group ID.
Request Body
None.
Response Body
None.
Response Codes
200 - Request successful.
For more information, please see Common Response Codes.
DELETE Addressgroups/{addressGroupId}/addresses
Purpose
Delete the addresses within the address group.
Required Permissions
- Current user has access to the organization.
- Asset Management (Read/Write).
URL Parameters
addressGroupId: Address Group ID.
Request Body
None.
Response Body
None.
Response Codes
200 - Request successful.
For more information, please see Common Response Codes.
GET AddressGroups/?name={name}
Purpose
Returns the Address Group by name.
Required Permissions
- Asset Management (Read).
Query Parameters
name: Name of the Address Group.
Request Body
None.
Response Body
Content-Type: application/json
{ AddressGroupID: int, Name: string }
Response Codes
200 - Request successful. Address Group in the response body.
For more information, please see Common Response Codes.
GET AddressGroups/{id}
Purpose
Returns the Address Group by ID.
Required Permissions
- Asset Management (Read).
URL Parameters
id: ID of the Address Group.
Request Body
None.
Response Body
Content-Type: application/json
{ AddressGroupID: int, Name: string }
Response Codes
200 - Request successful. Address Group in the response body.
For more information, please see Common Response Codes.
PUT Addresses/{id}
Purpose
Updates and Address by ID.
Required Permissions
- Asset Management (Read/Write).
Request Body
Content-Type: application/json
{ Type: int, Value: string, Omit: bool }
Request Body Details
Max string length for Value is 225.
Response Body
Content-Type: application/json
{ AddressD: int, AddressGroupID: int, Omit: bool, Type: int, Value: string, LastUpdateDate: datetime }
Response Codes
200 - Request successful. Address in the response body.
For more information, please see Common Response Codes.
PUT AddressGroups/{id}
Purpose
Updates and Address Group by ID.
Required Permissions
- Asset Management (Read/Write).
Request Body
Content-Type: application/json
{ Name: string, }
Request Body Details
Max string length for Name is 225.
Response Body
Content-Type: application/json
{ AddressGroupID: int, Name: string }
Response Codes
200 - Request successful. Address Group in the response body.
For more information, please see Common Response Codes.
POST AddressGroups
Purpose
Creates an Address Book.
Required Permissions
- Asset Management (Read/Write).
Request Body
Content-Type: application/json
{ Name: string }
Request Body Details
Max string length for Name is 225.
Response Body
Content-Type: application/json
{ AddressGroupID: int, Name: string }
Response Codes
201 - Request successful. Address Group in the response body.
For more information, please see Common Response Codes.
GET Addresses/{id}
Purpose
Returns the Address by ID.
Required Permissions
- Asset Management (Read).
URL Parameters
id: ID of the Address.
Request Body
None.
Response Body
Content-Type: application/json
{ AddressId: int, AddressGroupId : int, Omit: bool, Type: string, Value: string, LastUpdateDate: datetime }
Response Codes
200 - Request successful. Address in the response body.
For more information, please see Common Response Codes.
DELETE Addresses/{id}
Purpose
Deletes an Address by ID.
Required Permissions
Asset Management (Read/Write).
Request Body
None.
Response Body
None.
Response Codes
200 - Request successful.
For more information, please see Common Response Codes.