Jump to

• Request
• Response

Search Accounts and Services for Sharing

get

/sharing/accounts

Finds accounts and their services for addition to a sharing group. Text filters accept * as a wildcard.

Request

Query Parameters

• accountNo: string
  Account number to match.
• address: string
  Contact street address to match.
• city: string
  Contact city to match.
• company: string
  Contact company name to match.
• country: string
  Contact country to match.
• firstName: string
  Contact first name to match.
• lastName: string
  Contact last name to match.
• limit: integer(int32)
  Maximum results; defaults to the configured account fetch size. Use -1 for all results.
• serviceID: string
  Service login or alias to match.
• serviceType: string
  BRM service type to match, such as /service/telco/gsm.
• state: string
  Contact state or province to match.
• zip: string
  Contact postal code to match.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Matching accounts and their services returned.

Body ()

Root Schema : SharingGroupMembers

Type: object

Show Source

• extension: object extension
  The extended attributes.
• groupType(required): string
  The sharing group type. Allowed Values:

  • H_PSG (Hierarchy product sharing group)
  • PR_PSG (Payment responsibility product sharing group)
  • H_DSG (Hierarchy discount sharing group)
  • PR_DSG (Payment responsibility discount sharing group)
• memberDetails: array memberDetails
  The list of sharing group members.

{
    "required":[
        "groupType"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "groupType":{
            "type":"string",
            "description":"The sharing group type. Allowed Values: <ul><li><b>H_PSG</b> (Hierarchy product sharing group)</li><li><b>PR_PSG</b> (Payment responsibility product sharing group)</li><li><b>H_DSG</b> (Hierarchy discount sharing group)</li><li><b>PR_DSG</b> (Payment responsibility discount sharing group)</li></ul>"
        },
        "memberDetails":{
            "type":"array",
            "description":"The list of sharing group members.",
            "items":{
                "$ref":"#/components/schemas/MemberDetails"
            }
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : memberDetails

Type: array

The list of sharing group members.

Show Source

• Array of: object MemberDetails
  The list of sharing group members.

{
    "type":"array",
    "description":"The list of sharing group members.",
    "items":{
        "$ref":"#/components/schemas/MemberDetails"
    }
}

Nested Schema : MemberDetails

Type: object

The list of sharing group members.

Show Source

• accountNumber: string
  The member's account number.
• accountRef: object ResourceRef
• firstName: string
  The member's first name.
• lastName: string
  The member's last name.
• memberIndex: integer (int32)
  The index of the non-service charge that is a member of the group.
• services: array services
  The list of services shared in the group.

{
    "type":"object",
    "properties":{
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "services":{
            "type":"array",
            "description":"The list of services shared in the group.",
            "items":{
                "$ref":"#/components/schemas/Services"
            }
        },
        "accountNumber":{
            "type":"string",
            "description":"The member's account number."
        },
        "firstName":{
            "type":"string",
            "description":"The member's first name."
        },
        "lastName":{
            "type":"string",
            "description":"The member's last name."
        },
        "memberIndex":{
            "type":"integer",
            "description":"The index of the non-service charge that is a member of the group.",
            "format":"int32"
        }
    },
    "description":"The list of sharing group members."
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : services

Type: array

The list of services shared in the group.

Show Source

• Array of: object Services
  The list of services shared in the group.

{
    "type":"array",
    "description":"The list of services shared in the group.",
    "items":{
        "$ref":"#/components/schemas/Services"
    }
}

Nested Schema : Services

Type: object

The list of services shared in the group.

Show Source

• aliasList: array aliasList
  The list of aliases associated with the service.
• index: integer (int32)
  The position of the entry in the index. For example, the first service in a list would have an index value of 1.
• login(required): string
  The login associated with the service.
• serviceRef: object ResourceRef
• serviceType(required): string
  The service type of the service member.

{
    "required":[
        "login",
        "serviceType"
    ],
    "type":"object",
    "properties":{
        "serviceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "index":{
            "type":"integer",
            "description":"The position of the entry in the index. For example, the first service in a list would have an <b>index</b> value of <b>1</b>.",
            "format":"int32"
        },
        "login":{
            "type":"string",
            "description":"The login associated with the service."
        },
        "serviceType":{
            "type":"string",
            "description":"The service type of the service member."
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases associated with the service.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        }
    },
    "description":"The list of services shared in the group."
}

Nested Schema : aliasList

Type: array

The list of aliases associated with the service.

Show Source

• Array of: object AliasList
  The list of aliases associated with the service.

{
    "type":"array",
    "description":"The list of aliases associated with the service.",
    "items":{
        "$ref":"#/components/schemas/AliasList"
    }
}

Nested Schema : AliasList

Type: object

The list of aliases associated with the service.

Show Source

• elem: integer (int32)
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "elem":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"The list of aliases associated with the service."
}

403 Response

Access was denied.

500 Response

An internal server error occurred.

Back to Top